Person Directory Operations - Get Person

服務:

Azure AI Services

API 版本:

v1.2-preview.1

從 Person Directory 擷取人員名稱和 userData。

GET {endpoint}/face/{apiVersion}/persons/{personId}

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。
personId	path	True	string uuid	人員標識碼。

回應

名稱	類型	Description
200 OK	PersonDirectoryPerson	成功的呼叫會傳回人員的資訊。
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

範例

Get Person from PeronDirectory

範例要求

HTTP

GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5

範例回覆

狀態碼:

200

{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
  "name": "your_person_name",
  "userData": "your_user_data"
}

定義

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

FaceError

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

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

FaceErrorResponse

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

名稱	類型	Description
error	FaceError	error 物件。

PersonDirectoryPerson

人員目錄的人員資源

名稱	類型	Description
name	string	用戶定義的名稱，最大長度為128。
personId	string	人員標識碼。
userData	string	選擇性的使用者定義數據。 長度不應超過 16K。