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

Person Group Operations - Get Person Group Persons

服务:

Azure AI Services

API 版本:

v1.2-preview.1

列出指定人员组中的所有人员信息，包括 personId、name、userData 和已注册人员人脸的 persistedFaceId。
人员按字母顺序存储“创建人员组人员”中创建的 personId。

• • “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}/persongroups/{personGroupId}/persons

具有可选参数:

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons?start={start}&top={top}

URI 参数

名称	在	必需	类型	说明
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的认知服务终结点（协议和主机名，例如：https://{resource-name}.cognitiveservices.azure.com）。
personGroupId	path	True	string	容器的 ID。 正则表达式模式: ^[a-z0-9-_]+$
start	query		string	列出大于“start”的资源。 它包含不超过 64 个字符。 默认值为空。
top	query		integer int32	要列出的项目数，范围为 [1， 1000]。 默认值为 1000。

响应

名称	类型	说明
200 OK	PersonGroupPerson[]	成功的呼叫返回属于人员组的人员信息的数组。
Other Status Codes	FaceErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 人脸订阅的密钥。

类型: apiKey
在: header

AADToken

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://api.example.com/oauth2/authorize
令牌 URL: https://api.example.com/oauth2/token

作用域

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

示例

Get Persons from PersonGroup

示例请求

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons?start=00000000-0000-0000-0000-000000000000&top=20

示例响应

状态代码:

200

[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_person_group_person_name",
    "userData": "your_user_data",
    "persistedFaceIds": [
      "43897a75-8d6f-42cf-885e-74832febb055"
    ]
  }
]

定义

名称	说明
FaceError	错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含错误详细信息的响应。
PersonGroupPerson	指定人员组中的人员。 若要向此人添加人脸，请调用“添加大型人员组人脸”。

FaceError

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

名称	类型	说明
code	string	服务器定义的错误代码集之一。
message	string	错误的人工可读表示形式。

FaceErrorResponse

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

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

PersonGroupPerson

指定人员组中的人员。 若要向此人添加人脸，请调用“添加大型人员组人脸”。

名称	类型	说明
name	string	用户定义的名称，最大长度为 128。
persistedFaceIds	string[]	人员中已注册人脸的面部 ID。
personId	string	人员的 ID。
userData	string	可选用户定义数据。 长度不应超过 16K。