你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

借助 API 控制台中的自定义列表进行审查

在 Azure 内容审查器中使用列表管理 API 创建自定义图像列表。 通过图像审查 API 使用自定义图像列表。 图像审查操作将评估图像。 如果创建自定义列表,该操作还会将其与自定义列表中的图像进行比较。 可使用自定义列表来阻止或允许图像。

注意

最多只能使用 5 个图像列表,每个列表中的图像数不得超过 10,000 张

使用列表管理 API 执行以下任务:

  • 创建列表。
  • 向列表添加图像。
  • 针对列表中的图像屏蔽图像。
  • 从列表中删除图像。
  • 删除列表。
  • 编辑列表信息。
  • 筛选索引,使新的扫描中包含列表更改项。

使用 API 控制台

必须有订阅密钥,才能在联机控制台中试用 API。 订阅密钥位于“设置” 选项卡上的“Ocp-Apim-Subscription-Key” 框中。 有关详细信息,请参阅概述

刷新搜索索引

对图像列表进行更改后,必须刷新其索引,使更改包括在未来的扫描中。 此步骤类似于桌面上的搜索引擎(如果启用)或 Web 搜索引擎的操作,即不断刷新其索引以包含新文件或页面。

  1. 图像列表管理 API 引用的左侧菜单中,选择“图像列表”,然后选择“刷新搜索索引”

    “图像列表 - 刷新搜索索引”页随即打开

  2. 对于“开放 API 测试控制台” ,选择与所在位置最相关的区域。

    Image Lists - Refresh Search Index page region selection

    “图像列表 - 刷新搜索索引”API 控制台随即打开

  3. 在 listId 框中,输入列表 ID。 输入订阅密钥,再选择“发送”

    Image Lists - Refresh Search Index console Response content box

创建图像列表

  1. 转到图像列表管理 API 参考

    “图像列表 - 创建”页随即打开

  2. 对于“开放 API 测试控制台” ,选择与所在位置最相关的区域。

    Image Lists - Create page region selection

    “图像列表 - 创建”API 控制台随即打开

  3. 在“Ocp-Apim-Subscription-Key”框中,输入订阅密钥 。

  4. 在“请求正文”框中,在“名称”中输入值(例如 MyList),在“说明”中输入相关说明

    Image Lists - Create console Request body name and description

  5. 使用键值对占位符向列表分配更具描述性的元数据。

    {
        "Name": "MyExclusionList",
        "Description": "MyListDescription",
        "Metadata": 
        {
            "Category": "Competitors",
            "Type": "Exclude"
        }
    }
    

    添加元数据作为键值对,而不是添加实际图像。

  6. 选择Send。 列表已创建。 请注意,ID 值与新的列表相关联。 需在其他图像列表管理功能中使用此 ID。

    Image Lists - Create console Response content box shows the list ID

  7. 接下来,向 MyList 添加图像。 在左侧菜单中,选择“图像”,然后选择“添加图像”

    “图像 - 添加图像”页随即打开

  8. 对于“开放 API 测试控制台” ,选择与所在位置最相关的区域。

    Image - Add Image page region selection

    “图像 - 添加图像”API 控制台随即打开

  9. 在 listId 框中输入生成的列表 ID,然后输入要添加的图像的 URL。 输入订阅密钥,再选择“发送”

  10. 要验证已向列表添加图像,请在左侧菜单中选择“图像”,然后选择“获取所有图像 ID”

    “图像 - 获取所有图像 ID”API 控制台随即打开

  11. 在 listId 框中,输入列表 ID,然后输入订阅密钥。 选择Send

    Image - Get All Image Ids console Response content box lists the images that you entered

  12. 再添加几个图像。 现在,你已创建自定义图像列表,请使用自定义图像列表尝试评估图像

删除图像和列表

删除图像或列表非常简单。 可使用 API 执行以下任务:

  • 删除映像。 (“图像 - 删除”
  • 删除列表中的所有图像而不删除列表。 (“图像 - 删除所有图像”
  • 删除列表及其所有内容。 (“图像列表 - 删除”)

此示例将删除单个图像:

  1. 图像列表管理 API 引用的左侧菜单中,选择“图像”,然后选择“删除”

    “图像 - 删除”页随即打开

  2. 对于“开放 API 测试控制台” ,选择与所在位置最相关的区域。

    Image - Delete page region selection

    “图像 - 删除”API 控制台随即打开

  3. 在 listId 框中,输入要从中删除图像的列表 ID。 这是对 MyList 在“图像 - 获取所有图像 ID”控制台中返回的数字。 然后,输入要删除图像的 ImageId

在本示例中,列表 ID 为 58953,是 ContentSource 的值。 图像 ID 是 59021,是 ContentIds 的值

  1. 输入订阅密钥,再选择“发送”

  2. 要验证已删除图像,请使用“图像 - 获取所有图像 ID”控制台

更改列表信息

可编辑列表的名称和说明,还可添加元数据项。

  1. 图像列表管理 API 引用的左侧菜单中,选择“图像列表”,然后选择“更新详细信息”

    “图像列表 - 更新详细信息”页随即打开

  2. 对于“开放 API 测试控制台” ,选择与所在位置最相关的区域。

    Image Lists - Update Details page region selection

    “图像列表 - 更新详细信息”API 控制台随即打开

  3. 在 listId 框中,输入列表 ID,然后输入订阅密钥

  4. 在“请求正文”框中,进行编辑,然后选择页面上的“发送”按钮

    Image Lists - Update Details console Request body edits

后续步骤

要与应用程序集成,请在代码中使用 REST API,或通过图像列表 .NET 快速入门开始。