Person - Get a Person
检索一个人物的信息,包括已记录的永存人脸、name和userData。
Http Method
`GET`
Request URL
请求URL
`https://api.cognitive.azure.cn/face/v1.0/persongroups/{personGroupId}/persons/{personId} `
Request parameters
| 参数名|参数类型 |描述 |
| --- | --- | --- |
| personGroupId |string | 指定包含目标人物的人物组|
| personId |string | 指定人物|
Request headers
| 请求头 |类型 |描述 |
| --- | --- | --- |
| Ocp-Apim-Subscription-Key | string | Subscription key which provides access to this API. Found in your Cognitive Services accounts. |
Request body
Response 200
一个成功的调用返回该人的信息。
JSON fields in response body
| Fields | Type | Description |
| --- | --- | --- |
| personId | String| 检索到的人物的personId |
| persistedFaceIds | Array | 已有记录的人脸的persistedFaceIds。这些persistedFaceIds是从Person - Add Person Face中返回的,且不会过期|
| name | String | 人物显示名称 |
| userData | String | 用户提供的附加到该人的数据 |
~~~
{
"personId":"25985303-c537-4467-b41d-bdb45cd95ca1",
"persistedFaceIds":[
"015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
"fce92aed-d578-4d2e-8114-068f8af4492e",
"b64d5e15-8257-4af2-b20a-5a750f8940e7"
],
"name":"Ryan",
"userData":"User-provided data attached to the person"
}
~~~
Response 401
| Error Code | Error Message Description |
| --- | --- |
| Unspecified | 无效的subscription Key 或user/plan 被冻结 |
~~~
{
"error":{
"code": "Unspecified",
"message": "Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key."
}
}
~~~
响应403
~~~
{
"error":{
"statusCode": 403,
"message": "Out of call volume quota. Quota will be replenished in 2.12 days."
}
}
~~~
Response 404
Error code and message returned in JSON:
| Error Code | Error Message Description |
| --- | --- |
| PersonGroupNotFound | person groupID无效。有效的格式应该是由数字组成的字符串,英文字母小写,' - ','_',且不超过64个字符 |
| PersonGroupNotFound | 未找到person group |
| PersonNotFound |无效的Person ID|
| PersonNotFound | 未找到Person |
~~~
{
"error":{
"code":"PersonGroupNotFound",
"message":"Person group 'sample_group' is not found."
}
}
~~~
Response 409
~~~
{
"error":{
"code": ConcurrentOperationConflict,
"message": "There is a conflict operation on resource 'sample_group', please try later."
}
}
~~~
Response 429
~~~
{
"error":{
"statusCode": 429,
"message": "Rate limit is exceeded. Try again in 26 seconds."
}
}
~~~
- 空白目录
- Face
- Detect
- Find Similar
- Group
- Identify
- Verify
- Face List
- Add a Face to a Face List
- Create a Face List
- Delete a Face from a Face List
- Delete a Face List
- Get a Face List
- List Face Lists
- Update a Face List
- Person
- Add a Person Face
- Create a Person
- Delete a Person
- Delete a Person Face
- Get a Person
- Get a Person Face
- List Persons in a Person Group
- Update a Person
- Update a Person Face
- Person Group
- Create a Person Group
- Delete a Person Group
- Get a Person Group
- Get Person Group Training Status
- List Person Groups
- Train Person Group
- Update a Person Group