Person - Update a Person
更新人物的名字或者userData
ttp Method
`PATCH`
Request URL
`https://api.cognitive.azure.cn/face/v1.0/persongroups/{personGroupId}/persons/{personId} `
Request parameters
Request parameters
| 参数名|参数类型 |描述 |
| --- | --- | --- |
| personGroupId |string | 指定包含目标人物的人物组|
| personId |string | 目标人物的personId|
Request headers
| 请求头 |类型 |描述 |
| --- | --- | --- |
| Content-Type (optional) |string |Media type of the body sent to the API. |
| Ocp-Apim-Subscription-Key | string | Subscription key which provides access to this API. Found in your Cognitive Services accounts. |
Request body
JSON fields in request body
| Fields | Type | Description|
| --- | --- | --- |
| name| String | 目标人物的显示名称。最大长度128 |
| userData | String | 用户提供的附加到该人物的数据。最大16KB. |
~~~
{
"name":"Person1",
"userData":"user-provided data attached to the person."
}
~~~
Response 200
一个成功的调用返回一个空的响应体。
Response 400
| Error code | message|
| --- | --- |
| BadArgument | Name过长 |
| BadArgument | userData过长 |
| BadArgument | 错误的或无法解析的json body |
~~~
{
"error":{
"code":"BadArgument",
"message":"'userData' is too long."
}
}
~~~
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."
}
}
~~~
Response 403
~~~
{
"error":{
"statusCode": 403,
"message": "Out of call volume quota. Quota will be replenished in 2.12 days."
}
}
~~~
Response 404
| 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 and message returned in JSON
| Error Code |Error Message Description |
| --- | --- |
| PersonGroupTrainingNotFinished |该人物组仍在接受培训。训练完成后重试 |
| ConcurrentOperationConflict | 资源并发操作冲突 |
~~~
{
"error":{
"code":"PersonGroupTrainingNotFinished",
"message":"Person group 'sample_group' is under training."
}
}
~~~
Response 415
不支持的媒体类型错误。只有“application / json”对API有效。
~~~
{
"error":{
"code":"BadArgument",
"message":"Invalid Media Type"
}
}
~~~
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