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

Large Person Group Person - Get

Service:

Cognitive Services - Face

API Version:

1.0

检索人员的姓名和 userData，以及表示注册人员人脸功能的持久化 faceId。

GET {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}/persons/{personId}

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点 (协议和主机名，例如： https://westus.api.cognitive.microsoft.com) 。
largePersonGroupId	path	True	string	引用特定大型人员组的 ID。 Regex pattern: ^[a-z0-9-_]+$
personId	path	True	string uuid	引用特定人员的 ID。

请求头

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

响应

名称	类型	说明
200 OK	Person	成功的调用将返回人员的信息。
Other Status Codes	APIError	错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Get person example

Sample Request

HTTP

GET {Endpoint}/face/v1.0/largepersongroups/abc/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Sample Response

Status code:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "persistedFaceIds": [
    "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
    "fce92aed-d578-4d2e-8114-068f8af4492e",
    "b64d5e15-8257-4af2-b20a-5a750f8940e7"
  ],
  "name": "person-name",
  "userData": "User-provided data attached to the person."
}

定义

名称	说明
APIError	API 返回的错误信息
Error	错误正文。
Person	Person 对象。

APIError

API 返回的错误信息

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

Error

错误正文。

名称	类型	说明
code	string
message	string

Person

Person 对象。

名称	类型	说明
name	string	用户定义的名称，最大长度为 128。
persistedFaceIds	string[]	人员中已注册人脸的 PersistedFaceIds。 这些 persistedFaceId 从 Person - Add a Person Face 返回，并且不会过期。
personId	string	目标人脸列表的 PersonId。
userData	string	用户指定的数据。 长度不应超过 16KB。