Person Directory Operations - Get Dynamic Person Groups

Service:

Azure AI Services

API Version:

v1.1-preview.1

既存のすべての動的人物グループを、名前と userData と共に dynamicPersonGroupId で一覧表示します。
動的人物グループは、dynamicPersonGroupId のアルファベット順に格納されます。

• • "start" パラメーター (string, optional) は、文字列比較に基づいて、返されるエントリの ID が大きくなる ID 値を指定します。 "start" を空の値に設定すると、最初の項目からエントリを返す必要があることを示します。
  • "top" パラメーター (int、省略可能) は、返されるエントリの最大数を決定します。上限は 1 回の呼び出しあたり最大 1000 エントリです。 この制限を超える追加のエントリを取得するには、現在の呼び出しで返された最後のエントリの personId で "start" を指定します。

ヒント

• たとえば、ID を持つ合計 5 つの項目があります。"itemId1"、...、"itemId5" です。
  • "start=&top=" は、5 つの項目すべてを返します。
  • "start=&top=2" は、"itemId1"、"itemId2" を返します。
  • "start=itemId2&top=3" は、"itemId3"、"itemId4"、"itemId5" を返します。

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

With optional parameters:

GET {endpoint}/face/{apiVersion}/dynamicpersongroups?start={start}&top={top}

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。
start	query		string	"開始" より大きいリソースを一覧表示します。 含まれる文字数は 64 文字以下です。 既定値は空です。
top	query		integer int32	[1, 1000] の範囲の、一覧表示する項目の数。 既定値は 1000 です。

応答

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

セキュリティ

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

AADToken

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

例

Get DynamicPersonGroups

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

Sample Response

Status code:

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 オブジェクト。