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

Face List Operations - Get Face List

Service:

Azure AI Services

API Version:

v1.1-preview.1

在人脸列表中检索人脸列表的 faceListId、name、userData、recognitionModel 和人脸。

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}

With optional parameters:

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

URI 参数

名称	在	必需	类型	说明
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的认知服务终结点 (协议和主机名，例如：https://{resource-name}.cognitiveservices.azure.com) 。
faceListId	path	True	string	有效字符是小写字母、数字或“-”或“_”，最大长度为 64。 Regex pattern: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	是否返回“recognitionModel”。 默认值为 false。

响应

名称	类型	说明
200 OK	FaceList	成功调用将返回人脸列表的信息。
Other Status Codes	FaceErrorResponse	意外的错误响应。 Headers x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 人脸订阅的密钥。

Type: apiKey
In: header

AADToken

Azure Active Directory OAuth2 流

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

名称	说明
https://cognitiveservices.azure.com/.default

示例

Get FaceList

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

Sample Response

Status code:

200

{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "faceListId": "your_face_list_id"
}

定义

名称	说明
FaceError	错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接： https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含错误详细信息的响应。
FaceList	人脸列表是人脸列表，最多包含 1,000 张人脸。
FaceListFace	人脸列表的人脸资源。
RecognitionModel	人脸的识别模型。

FaceError

错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接： https://aka.ms/face-error-codes-and-messages。

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
message	string	错误的用户可读表示形式。

FaceErrorResponse

包含错误详细信息的响应。

名称	类型	说明
error	FaceError	错误对象。

FaceList

人脸列表是人脸列表，最多包含 1,000 张人脸。

名称	类型	说明
faceListId	string	有效字符是小写字母、数字或“-”或“_”，最大长度为 64。
name	string	用户定义的名称，最大长度为 128。
persistedFaces	FaceListFace[]	人脸列表中已注册人脸的人脸 ID。
recognitionModel	RecognitionModel	识别模型的名称。 提取人脸特征并将其与检测到的 faceId 相关联时，将使用识别模型。
userData	string	用户定义的可选数据。 长度不应超过 16K。

FaceListFace

人脸列表的人脸资源。

名称	类型	说明
persistedFaceId	string	人脸的 ID。
userData	string	用户提供的数据附加到人脸。 长度限制为 1K。

RecognitionModel

人脸的识别模型。

名称	类型	说明
recognition_01	string	“检测”的默认识别模型。 2019 年 3 月之前创建的所有这些 faceId 都与此识别模型绑定。
recognition_02	string	识别模型于 2019 年 3 月发布。
recognition_03	string	识别模型于 2020 年 5 月发布。
recognition_04	string	识别模型于 2021 年 2 月发布。 建议使用此识别模型来提高识别准确性。