共用方式為

Person Directory Operations - Create Person

  • 參考
服務:
Azure AI Services
API 版本:
v1.2-preview.1

在 Person Directory 中建立新人員。 若要將臉部新增至此人員，請呼叫人員目錄「新增人員臉部」。

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

URI 參數

名稱 位於 必要 類型 Description
apiVersion
 path True

string

API 版本
endpoint
 path True

string

uri

支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。

要求本文

名稱 必要 類型 Description
name True

string

用戶定義的名稱，最大長度為128。
userData

string

選擇性的使用者定義數據。 長度不應超過 16K。

回應

名稱 類型 Description
202 Accepted

CreatePersonResult

成功的呼叫會傳回空的回應本文。 服務已接受要求，且即將開始處理。 用戶端可以使用 『Operation-Location』 回應標頭中指定的 URL 來查詢作業狀態和結果。 URL 會在 48 小時內到期。

標題

  • Location: string
  • operation-Location: string
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 PersonDirectory

範例要求

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

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

範例回覆

狀態碼:
202 
location: https://contoso.com/operationstatus
operation-Location: https://contoso.com/operationstatus
{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
}

定義

名稱 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 物件。