Face List - Update a Face List
更新一个face list的信息,包括:name , userData。face list 仅仅存放永久的faces,并且可以在Face - Find Similar作为可搜索资源。
Http Method
`PATCH`
Request URL
`https://api.cognitive.azure.cn/face/v1.0/facelists/{faceListId} `
Request parameters
| 参数 |类型 |描述 |
| --- | --- | --- |
| faceListId | string | 规范字符串包括小写字母,数字,‘—’,‘_’,字符串最大长度是64 |
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 | Face list 的name,最长为128 |
| userData | String | 可选参数,用户为该face list 定义数据,长度不能超过16KB. |
~~~
{
"name":"list1",
"userData":"User-provided data attached to the face list."
}
~~~
Response 200
请求成功返回空
Response 400
| Error code | message|
| --- | --- |
| BadArgument | Name过长 |
| BadArgument | userData过长 |
| BadArgument | 错误的或无法解析的json body |
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 |
| --- | --- |
| FaceListNotFound |Face list 未定义 |
| FaceListNotFound | 无效的Face list ID,合法的格式:字符串包括小写字母,数字,‘—’,‘_’,字符串最大长度是64 |
~~~
{
"error":{
"code":"PersistedFaceListNotFound",
"message":"Face list 'sample_list' is not found."
}
}
~~~
Response 409
~~~
{
"error":{
"code": ConcurrentOperationConflict,
"message": "There is a conflict operation on resource 'sample_group', please try later."
}
}
~~~
Response 415
不支持的媒体格式,该API支持application/json.
~~~
{
"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