Person Directory Operations - Get Dynamic Person Group

サービス:

Azure AI Services

API バージョン:

v1.1-preview.1

動的人物グループの名前や userData などの情報を取得します。
この API は、動的人物グループの情報のみを返します。代わりに、動的人物グループのユーザー情報を取得するには、代わりに Person Directory "Get Dynamic Person Group Persons" を使用します。

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

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
dynamicPersonGroupId	path	True	string	動的人物グループの ID。 正規表現パターン: ^[a-z0-9-_]+$
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。

応答

名前	型	説明
200 OK	DynamicPersonGroup	呼び出しが成功すると、動的人物グループの情報が返されます。
Other Status Codes	FaceErrorResponse	予期しないエラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

Azure AI Face サブスクリプションの秘密鍵。

型: apiKey
/: header

AADToken

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://api.example.com/oauth2/authorize
Token URL (トークン URL): https://api.example.com/oauth2/token

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Get DynamicPersonGroup

要求のサンプル

HTTP

GET {endpoint}/face/v1.1-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"
}

定義

名前	説明
DynamicPersonGroup	Person Directory "Create Person" を参照するコンテナー。
FaceError	error オブジェクト。 Face Service によって返されるエラー コードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
FaceErrorResponse	エラーの詳細を含む応答。

DynamicPersonGroup

Person Directory "Create Person" を参照するコンテナー。

名前	型	説明
dynamicPersonGroupId	string	動的人物グループの ID。
name	string	ユーザー定義名、最大長は 128 です。
userData	string	省略可能なユーザー定義データ。 長さは 16K を超えてはなりません。

FaceError

error オブジェクト。 Face Service によって返されるエラー コードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages

名前	型	説明
code	string	サーバー定義のエラー コードのセットの 1 つ。
message	string	エラーの人間が判読できる表現。

FaceErrorResponse

エラーの詳細を含む応答。

名前	型	説明
error	FaceError	error オブジェクト。