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

Face List Operations - Get Large Face Lists

Service:

Azure AI Services

API Version:

v1.1-preview.1

列出 largeFaceListId、name、userData 和 recognitionModel Lists的信息。
若要在 largeFaceList 中获取人脸信息，请使用“获取大型人脸列表人脸”。

大型人脸Lists按 largeFaceListId 的字母顺序存储。

• • “start”参数 (字符串，可选) 指定一个 ID 值，返回的条目将基于字符串比较具有更大的 ID。 将“start”设置为空值表示应从第一个项开始返回条目。
  • “top”参数 (int，可选) 确定要返回的最大条目数，每次调用最多 1000 个条目的限制。 若要检索超出此限制的其他条目，请使用当前调用中返回的最后一个条目的 personId 指定“start”。

提示

• 例如，总共有 5 个项目及其 ID：“itemId1”、“...”、“itemId5”。
  • “start=&top=”将返回所有 5 个项目。
  • “start=&top=2”将返回“itemId1”、“itemId2”。
  • “start=itemId2&top=3”将返回“itemId3”、“itemId4”、“itemId5”。

GET {endpoint}/face/{apiVersion}/largefacelists

With optional parameters:

GET {endpoint}/face/{apiVersion}/largefacelists?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI 参数

名称	在	必需	类型	说明
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的认知服务终结点 (协议和主机名，例如：https://{resource-name}.cognitiveservices.azure.com) 。
returnRecognitionModel	query		boolean	是否返回“recognitionModel”。 默认值为 false。
start	query		string	列出大于“start”的资源。 它包含不超过 64 个字符。 默认为空，
top	query		integer int32	要列出的项数，范围为 [1， 1000]。 默认值为 1000。

响应

名称	类型	说明
200 OK	LargeFaceList[]	成功调用将返回一个大型人脸Lists数组，其信息 (largeFaceListId、name 和 userData) 。
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 LargeFaceLists

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/largefacelists?start=my_list_id&top=20&returnRecognitionModel=True

Sample Response

Status code:

200

[
  {
    "name": "your_large_face_list_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "largeFaceListId": "your_large_face_list_id"
  }
]

定义

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

FaceError

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

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

FaceErrorResponse

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

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

LargeFaceList

大型人脸列表是一个人脸列表，最多包含 1,000,000 张人脸。

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

RecognitionModel

人脸的识别模型。

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