Large Person Group Person - Get

服务:

Azure AI Services

API 版本:

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 maxLength: 64 pattern: ^[a-z0-9-_]+$	引用特定大型人员组的 ID。
personId	path	True	string (uuid)	引用特定人员的 ID。

请求头

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

响应

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

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

Get person example

示例请求

HTTP

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

示例响应

状态代码:

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

Object

API 返回的错误信息

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

Error

Object

错误正文。

名称	类型	说明
code	string
message	string

Person

Object

Person 对象。

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