Person - Create a Person
在指定的人物組中創建一個新人物。新創建的人物沒有已記錄過的臉,您可以調用Person - Add a Person Face API來給他添加人臉。
人物數量有訂閱等級限制和人物組級別限制。免費層的訂閱每個Person Group限制1,000人,每個訂閱共有1,000人。S0層訂閱有這些限制:每個Person Group有10,000Persons,總計100M Persons,每個訂閱有1M Person Groups。
Http Method
Http方法
`POST`
Request URL
請求URL
`https://api.cognitive.azure.cn/face/v1.0/persongroups/{personGroupId}/persons `
Request parameters
Request parameters
| 參數名|參數類型 |描述 |
| --- | --- | --- |
| personGroupId |string | 用來創建人物的指定目標人物組|
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 | 顯示目標人物的名字。最大長度是128 |
| userData (可選) | String | 可選,用戶提供的附加到一個人物上數據的字段。大小限制是16KB |
~~~
{
"name":"Person1",
"userData":"User-provided data attached to the person"
}
~~~
Response 200
一個成功的調用返回一個新創建的personId
| Fields | Type | Description |
| --- | --- | --- |
| personId | String | 新創建人物的personID |
~~~
{
"personId":"25985303-c537-4467-b41d-bdb45cd95ca1"
}
~~~
Response 400
Error code and message returned in JSON
| Error Code | Error Message Description |
| --- | --- |
| BadArgument |'name'太長了 |
| BadArgument | 'userData'太長了 |
| BadArgument | 錯誤和無法辨認的JSON |
~~~
{
"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
人物數量達到訂閱級別最大限制或人物組級別最大限制。免費層的訂閱每個Person Group限制1,000人,每個訂閱共有1,000人。S0層訂閱有這些限制:每個Person Group有10,000Persons,總計100M Persons,每個訂閱有1M Person Groups。
~~~
{
"error":{
"code":"QuotaExceeded",
"message":"Person number reached subscription level limit."
}
}
~~~
Response 404
Error code and message returned in JSON
| Error Code | Error Message Description |
| --- | --- |
| PersonGroupNotFound | Person group ID無效。有效的格式應該是由數字組成的字符串,英文字母小寫,' - ','_',且不超過64個字符 |
| PersonGroupNotFound | 找不到person group |
~~~
{
"error":{
"code":"PersonGroupNotFound",
"message":"Face list 'sample_list' 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