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

Image Moderation - Match

服务:

Azure AI Services

API 版本:

1.0

将图像与某个自定义图像列表进行模糊匹配。 可以使用 此 API 创建和管理自定义图像列表。

返回匹配图像的 ID 和标记。

注意：必须刷新相应图像列表上的索引，以确保添加和删除操作反映在响应中。

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/Match

具有可选参数:

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/Match?listId={listId}&CacheImage={CacheImage}

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的 Azure 认知服务终结点 (协议和主机名，例如 https://westus.api.cognitive.microsoft.com) 。
CacheImage	query		boolean	是否保留提交的映像供将来使用。 如果省略，则默认值为 false。
listId	query		string	列表 ID。

请求头

Media Types: "application/json", "image/gif", "image/jpeg", "image/png", "image/bmp", "image/tiff"

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

响应

名称	类型	说明
200 OK	MatchResponse	支持的标记值为： 101： 裸体 102：性内容 201：酒精 202： 烟草 203： 毒品 301： 儿童剥削 401：暴力 402： 武器 403： 戈尔 501： 亵渎 502： 粗俗 .
Other Status Codes	APIError	错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

定义

名称	说明
APIError	API 返回的错误信息。
Error	错误正文。
Match	匹配详细信息。
MatchResponse	匹配请求的响应。
Status	状态属性。

APIError

API 返回的错误信息。

名称	类型	说明
Error	Error	错误正文。

Error

错误正文。

名称	类型	说明
Code	string
Message	string

Match

匹配详细信息。

名称	类型	说明
Label	string	标签。
MatchId	integer	匹配 ID。
Score	number	图像匹配的置信度分数。
Source	string	源。
Tags	integer[]	匹配详细信息的标记。

MatchResponse

匹配请求的响应。

名称	类型	说明
CacheID	string	缓存 ID。
IsMatch	boolean	指示是否存在匹配项。
Matches	Match[]	匹配详细信息。
Status	Status	评估状态。
TrackingId	string	跟踪 ID。

Status

状态属性。

名称	类型	说明
Code	integer	状态代码。
Description	string	状态说明。
Exception	string	异常状态。