Person Group - Create a Person Group
創建一個帶有特定personGroupId,name和user-provided userData的新person group。
Person group是Face - Identify API最重要的參數之一。在特定的person group中識別出搜索者人臉
Http Method
`PUT`
Request URL
`https://api.cognitive.azure.cn/face/v1.0/persongroups/{personGroupId} `
Request parameters
| 參數名|參數類型 |描述 |
| --- | --- | --- |
| personGroupId |string | 用戶提供personGroupId作為字符串。有效的字符串包括數字、小寫英文字符、‘-’和‘_’。personGroupId最大長度是64|
Request headers
| 請求頭 |類型 |描述 |
| --- | --- | --- |
| Content-Type (optional) |string |Media type of the body sent to the API. |
| Ocp-Apim-Subscription-Key | string | 提供訪問此API的訂閱密鑰。在您的認知服務帳戶中找到. |
Request body
JSON fields in request body
| Fields | Type | Description |
| --- | --- | --- |
| name | String | Person group顯示名稱。最大長度是128 |
| userData (可選) | String | 附加到Person group的用戶提供的數據。大小限制是16KB |
Response 200
成功的調用返回一個空的響應體
Response 400
Error code and message returned in JSON
| Error Code | Error Message Description |
| --- | --- |
| BadArgument |'name'太長了 |
| BadArgument | 'userData'太長了 |
| BadArgument | 錯誤和無法辨認的JSON |
| BadArgument | Person group ID無效。有效格式應該是由數字組成的字符串,英文字母小寫,' - ','_',不超過64個字符|
~~~
{
"error":{
"code":"BadArgument",
"message":"'name' 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 409
Error code and message returned in JSON
| Error Code | Error Message Description |
| --- | --- |
| PersonGroupExists |Person group已經存在 |
| ConcurrentOperationConflict | 當前資源運算有沖突 |
~~~
{
"error":{
"code":"PersonGroupExists",
"message":"Person group 'sample_group' already exists."
}
}
~~~
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