Person Group Operations - Create Person Group Person

服務:

Azure AI Services

API 版本:

v1.2-preview.1

在指定的人員群組中建立新的人員。 若要將臉部新增至此人員，請呼叫「新增人員群組人員臉部」。

注意

• • 免費層訂用帳戶配額：
    • 所有人員群組中有 1,000 人。
  • S0 層訂用帳戶配額：
    • 每人群組 10,000 人。
    • 1,000,000 個人員群組。
    • 所有人員群組中有10萬人。

POST {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。
personGroupId	path	True	string	容器的標識碼。 Regex 模式: ^[a-z0-9-_]+$

要求本文

名稱	必要	類型	Description
name	True	string	用戶定義的名稱，最大長度為128。
userData		string	選擇性的使用者定義數據。 長度不應超過 16K。

回應

名稱	類型	Description
200 OK	CreatePersonResult	成功的呼叫會傳回新建立的personId。
Other Status Codes	FaceErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 臉部訂用帳戶的秘密密鑰。

類型: apiKey
位於: header

AADToken

Azure Active Directory OAuth2 流程

類型: oauth2
Flow: accessCode
授權 URL: https://api.example.com/oauth2/authorize
權杖 URL: https://api.example.com/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Create Person in PersonGroup

範例要求

HTTP

POST {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons

{
  "name": "your_person_group_person_name",
  "userData": "your_user_data"
}

範例回覆

狀態碼:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1"
}

定義

名稱	Description
CreatePersonResult	建立人員的回應。
FaceError	error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。

CreatePersonResult

建立人員的回應。

名稱	類型	Description
personId	string	人員標識碼。

FaceError

error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
message	string	錯誤的人類可讀取表示法。

FaceErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	FaceError	error 物件。