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

Image Moderation - Find Faces File Input

服务:

Azure AI Services

API 版本:

1.0

返回找到的人脸列表。

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

具有可选参数:

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/FindFaces?overload=stream&CacheImage={CacheImage}

URI 参数

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

请求头

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

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

请求正文

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

名称	类型	说明
ImageStream	object (file)	图像文件。

响应

名称	类型	说明
200 OK	FoundFaces	找到的人脸列表。
Other Status Codes	APIError	错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

定义

名称	说明
APIError	API 返回的错误信息。
Error	错误正文。
Face	指向找到的人脸的坐标。
FoundFaces	请求包含找到的人脸的对象。
KeyValuePair	键/值对对象属性。
Status	状态属性。

APIError

Object

API 返回的错误信息。

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

Error

Object

错误正文。

名称	类型	说明
Code	string
Message	string

Face

Object

指向找到的人脸的坐标。

名称	类型	说明
Bottom	integer	底部坐标。
Left	integer	左坐标。
Right	integer	右坐标。
Top	integer	顶部坐标。

FoundFaces

Object

请求包含找到的人脸的对象。

名称	类型	说明
AdvancedInfo	KeyValuePair[]	高级信息。
CacheId	string	缓存 ID。
Count	integer	找到的人脸数。
Faces	Face[]	人脸列表。
Result	boolean	如果找到结果，则为 True。
Status	Status	评估状态。
TrackingId	string	跟踪 ID。

KeyValuePair

Object

键/值对对象属性。

名称	类型	说明
Key	string	键参数。
Value	string	值参数。

Status

Object

状态属性。

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