您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

借助 API 控制台中的自定义列表进行审查Moderate with custom image lists in the API console

在 Azure 内容审查器中使用列表管理 API 创建自定义图像列表。You use the List Management API in Azure Content Moderator to create custom lists of images. 通过图像审查 API 使用自定义图像列表。Use the custom lists of images with the Image Moderation API. 图像审查操作将评估图像。The image moderation operation evaluates your image. 如果创建自定义列表,该操作还会将其与自定义列表中的图像进行比较。If you create custom lists, the operation also compares it to the images in your custom lists. 可使用自定义列表来阻止或允许图像。You can use custom lists to block or allow the image.

备注

最大限制为 5 个图像列表,每个列表“不超过 10,000 个图像”。There is a maximum limit of 5 image lists with each list to not exceed 10,000 images.

使用列表管理 API 执行以下任务:You use the List Management API to do the following tasks:

  • 创建列表。Create a list.
  • 向列表添加图像。Add images to a list.
  • 针对列表中的图像屏蔽图像。Screen images against the images in a list.
  • 从列表中删除图像。Delete images from a list.
  • 删除列表。Delete a list.
  • 编辑列表信息。Edit list information.
  • 筛选索引,使新的扫描中包含列表更改项。Refresh the index so that changes to the list are included in a new scan.

使用 API 控制台Use the API console

必须有订阅密钥,才能在联机控制台中试用 API。Before you can test-drive the API in the online console, you need your subscription key. 订阅密钥位于“设置”选项卡上的“Ocp-Apim-Subscription-Key”框中。This is located on the Settings tab, in the Ocp-Apim-Subscription-Key box. 有关详细信息,请参阅概述For more information, see Overview.

刷新搜索索引Refresh search index

对图像列表进行更改后,必须刷新其索引,使更改包括在未来的扫描中。After you make changes to an image list, you must refresh its index for changes to be included in future scans. 此步骤类似于桌面上的搜索引擎(如果启用)或 Web 搜索引擎的操作,即不断刷新其索引以包含新文件或页面。This step is similar to how a search engine on your desktop (if enabled) or a web search engine continually refreshes its index to include new files or pages.

  1. 图像列表管理 API 引用的左侧菜单中,选择“图像列表”,然后选择“刷新搜索索引”。In the Image List Management API reference, in the left menu, select Image Lists, and then select Refresh Search Index.

    “图像列表 - 刷新搜索索引”页随即打开。The Image Lists - Refresh Search Index page opens.

  2. 对于“开放 API 测试控制台”,选择与所在位置最相关的区域。For Open API testing console, select the region that most closely describes your location.

    “图像列表 - 刷新搜索索引”页面上的区域选择

    “图像列表 - 刷新搜索索引”API 控制台随即打开。The Image Lists - Refresh Search Index API console opens.

  3. 在 listId 框中,输入列表 ID。In the listId box, enter the list ID. 输入订阅密钥,再选择“发送”。Enter your subscription key, and then select Send.

    “图像列表 - 刷新搜索索引”控制台响应内容框

创建图像列表Create an image list

  1. 转到图像列表管理 API 参考Go to the Image List Management API reference.

    “图像列表 - 创建”页随即打开。The Image Lists - Create page opens.

  2. 对于“开放 API 测试控制台”,选择与所在位置最相关的区域。For Open API testing console, select the region that most closely describes your location.

    “图像列表 - 创建”页面上的区域选择

    “图像列表 - 创建”API 控制台随即打开。The Image Lists - Create API console opens.

  3. 在“Ocp-Apim-Subscription-Key”框中,输入订阅密钥。In the Ocp-Apim-Subscription-Key box, enter your subscription key.

  4. 在“请求正文”框中,在“名称”中输入值(例如 MyList),在“说明”中输入相关说明。In the Request body box, enter values for Name (for example, MyList) and Description.

    “图像列表 - 创建”控制台上的请求正文名称和说明

  5. 使用键值对占位符向列表分配更具描述性的元数据。Use key-value pair placeholders to assign more descriptive metadata to your list.

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

    添加元数据作为键值对,而不是添加实际图像。Add list metadata as key-value pairs, and not the actual images.

  6. 选择“发送”。Select Send. 列表已创建。Your list is created. 请注意,ID 值与新的列表相关联。Note the ID value that is associated with the new list. 需在其他图像列表管理功能中使用此 ID。You need this ID for other image list management functions.

    “图像列表 - 创建”控制台上的“响应”内容框中会显示列表 ID

  7. 接下来,向 MyList 添加图像。Next, add images to MyList. 在左侧菜单中,选择“图像”,然后选择“添加图像”。In the left menu, select Image, and then select Add Image.

    “图像 - 添加图像”页随即打开。The Image - Add Image page opens.

  8. 对于“开放 API 测试控制台”,选择与所在位置最相关的区域。For Open API testing console, select the region that most closely describes your location.

    “图像 - 添加图像”页面上的区域选择

    “图像 - 添加图像”API 控制台随即打开。The Image - Add Image API console opens.

  9. 在 listId 框中输入生成的列表 ID,然后输入要添加的图像的 URL。In the listId box, enter the list ID that you generated, and then enter the URL of the image that you want to add. 输入订阅密钥,再选择“发送”。Enter your subscription key, and then select Send.

  10. 要验证已向列表添加图像,请在左侧菜单中选择“图像”,然后选择“获取所有图像 ID”。To verify that the image has been added to the list, in the left menu, select Image, and then select Get All Image Ids.

    “图像 - 获取所有图像 ID”API 控制台随即打开。The Image - Get All Image Ids API console opens.

  11. 在 listId 框中,输入列表 ID,然后输入订阅密钥。In the listId box, enter the list ID, and then enter your subscription key. 选择“发送”。Select Send.

    “图像 - 获取所有图像 ID”控制台上的“响应”内容框中列出了所输入的图像

  12. 再添加几个图像。Add a few more images. 现在,你已创建自定义图像列表,请使用自定义图像列表尝试评估图像Now that you have created a custom list of images, try evaluating images by using the custom image list.

删除图像和列表Delete images and lists

删除图像或列表非常简单。Deleting an image or a list is straightforward. 可使用 API 执行以下任务:You can use the API to do the following tasks:

  • 删除映像。Delete an image. (“图像 - 删除”)(Image - Delete)
  • 删除列表中的所有图像而不删除列表。Delete all the images in a list without deleting the list. (“图像 - 删除所有图像”)(Image - Delete All Images)
  • 删除列表及其所有内容。Delete a list and all of its contents. (“图像列表 - 删除”)(Image Lists - Delete)

此示例将删除单个图像:This example deletes a single image:

  1. 图像列表管理 API 引用的左侧菜单中,选择“图像”,然后选择“删除”。In the Image List Management API reference, in the left menu, select Image, and then select Delete.

    “图像 - 删除”页随即打开。The Image - Delete page opens.

  2. 对于“开放 API 测试控制台”,选择与所在位置最相关的区域。For Open API testing console, select the region that most closely describes your location.

    “图像 - 删除”页面上的区域选择

    “图像 - 删除”API 控制台随即打开。The Image - Delete API console opens.

  3. 在 listId 框中,输入要从中删除图像的列表 ID。In the listId box, enter the ID of the list to delete an image from. 这是对 MyList 在“图像 - 获取所有图像 ID”控制台中返回的数字。This is the number returned in the Image - Get All Image Ids console for MyList. 然后,输入要删除图像的 ImageId。Then, enter the ImageId of the image to delete.

在本示例中,列表 ID 为 58953,是 ContentSource 的值。In our example, the list ID is 58953, the value for ContentSource. 图像 ID 是 59021,是 ContentIds 的值。The image ID is 59021, the value for ContentIds.

  1. 输入订阅密钥,再选择“发送”。Enter your subscription key, and then select Send.

  2. 要验证已删除图像,请使用“图像 - 获取所有图像 ID”控制台。To verify that the image has been deleted, use the Image - Get All Image Ids console.

更改列表信息Change list information

可以编辑列表的名称和说明,并添加元数据项。You can edit a list’s name and description, and add metadata items.

  1. 图像列表管理 API 引用的左侧菜单中,选择“图像列表”,然后选择“更新详细信息”。In the Image List Management API reference, in the left menu, select Image Lists, and then select Update Details.

    “图像列表 - 更新详细信息”页随即打开。The Image Lists - Update Details page opens.

  2. 对于“开放 API 测试控制台”,选择与所在位置最相关的区域。For Open API testing console, select the region that most closely describes your location.

    “图像列表 - 更新详细信息”页面上的区域选择

    “图像列表 - 更新详细信息”API 控制台随即打开。The Image Lists - Update Details API console opens.

  3. 在 listId 框中,输入列表 ID,然后输入订阅密钥。In the listId box, enter the list ID, and then enter your subscription key.

  4. 在“请求正文”框中,进行编辑,然后选择页面上的“发送”按钮。In the Request body box, make your edits, and then select the Send button on the page.

    “图像列表 - 更新详细信息”控制台上的请求正文编辑

后续步骤Next steps

要与应用程序集成,请在代码中使用 REST API,或通过图像列表 .NET 快速入门开始。Use the REST API in your code or start with the Image lists .NET quickstart to integrate with your application.