Person Directory Operations - Get Dynamic Person Group

服務:

Azure AI Services

API 版本:

v1.2-preview.1

擷取動態人員群組的資訊，包括其名稱和userData。
此 API 只會傳回動態人員群組資訊，請改用人員目錄「取得動態人員群組人員」，以擷取動態人員群組底下的人員資訊。

GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

URI 參數

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

回應

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

範例要求

HTTP

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

範例回覆

狀態碼:

200

{
  "dynamicPersonGroupId": "your_dynamic_person_group_id",
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data"
}

定義

名稱	Description
DynamicPersonGroup	參考 Person Directory “Create Person” 的容器。
FaceError	error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。

DynamicPersonGroup

參考 Person Directory “Create Person” 的容器。

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

FaceError

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

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

FaceErrorResponse

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

名稱	類型	Description
error	FaceError	error 物件。