Person Group Operations - Create Person Group Person
Create 指定之人員群組中的新人員。 若要將臉部新增至此人,請呼叫「新增人員群組人員臉部」。
注意
-
- 免費層訂用帳戶配額:
- 所有人員 群組 1,000 人。
- S0 層訂用帳戶配額:
- 每一個人群組 10,000 人。
- 1,000,000 個人 群組。
- 所有人員 群組 100,000,000 人。
- 免費層訂用帳戶配額:
POST {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
api
|
path | True |
string |
API 版本 |
endpoint
|
path | True |
string uri |
支持的認知服務端點 (通訊協定和主機名,例如:https://{resource-name}.cognitiveservices.azure.com) 。 |
person
|
path | True |
string |
容器的標識碼。 Regex pattern: |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
name | True |
string |
用戶定義的名稱,最大長度為128。 |
userData |
string |
選擇性的使用者定義數據。 長度不應超過 16K。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
成功的呼叫會傳回新建立的personId。 |
|
Other Status Codes |
非預期的錯誤回應。 Headers x-ms-error-code: string |
安全性
Ocp-Apim-Subscription-Key
Azure AI 臉部訂用帳戶的秘密密鑰。
Type:
apiKey
In:
header
AADToken
Azure Active Directory OAuth2 流程
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://api.example.com/oauth2/authorize
Token URL:
https://api.example.com/oauth2/token
Scopes
名稱 | Description |
---|---|
https://cognitiveservices.azure.com/.default |
範例
Create Person in PersonGroup
Sample Request
POST {endpoint}/face/v1.1-preview.1/persongroups/your_person_group_id/persons
{
"name": "your_person_group_person_name",
"userData": "your_user_data"
}
Sample Response
{
"personId": "25985303-c537-4467-b41d-bdb45cd95ca1"
}
定義
名稱 | Description |
---|---|
Create |
建立人員的回應。 |
Face |
error 物件。 如需臉部服務所傳回之錯誤碼和訊息的完整詳細數據,請參閱下列連結: https://aka.ms/face-error-codes-and-messages。 |
Face |
包含錯誤詳細數據的回應。 |
CreatePersonResult
建立人員的回應。
名稱 | 類型 | Description |
---|---|---|
personId |
string |
人員的身分識別碼。 |
FaceError
error 物件。 如需臉部服務所傳回之錯誤碼和訊息的完整詳細數據,請參閱下列連結: https://aka.ms/face-error-codes-and-messages。
名稱 | 類型 | Description |
---|---|---|
code |
string |
其中一組伺服器定義的錯誤碼。 |
message |
string |
人類可讀取的錯誤表示法。 |
FaceErrorResponse
包含錯誤詳細數據的回應。
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |