Person Group Operations - Get Large Person Group Persons

リファレンス

サービス:: Azure AI Services

API バージョン:: v1.1-preview.1

personId、name、userData、および登録済み人物の顔の persistedFaceId を含む、指定された Large Person Group 内のすべてのユーザーの情報を一覧表示します。
Persons は、"Create Large Person Group Person" で作成された personId のアルファベット順に格納されます。

- "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}/largepersongroups/{largePersonGroupId}/persons

省略可能なパラメーターを含む:

GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/persons?start={start}&top={top}

URI パラメーター

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

応答

名前	型	説明
200 OK	LargePersonGroupPerson[]	呼び出しが成功すると、Large Person Group に属する人物情報の配列が返されます。
Other Status Codes	FaceErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

LargePersonGroupPerson[]

呼び出しが成功すると、Large Person Group に属する人物情報の配列が返されます。

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 Persons from LargePersonGroup

要求のサンプル

HTTP

GET {endpoint}/face/v1.1-preview.1/largepersongroups/your_large_person_group_id/persons?start=00000000-0000-0000-0000-000000000000&top=20

応答のサンプル

状態コード:: 200

[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_large_person_group_person_name",
    "userData": "your_user_data",
    "persistedFaceIds": [
      "43897a75-8d6f-42cf-885e-74832febb055"
    ]
  }
]

定義

名前	説明
FaceError	error オブジェクト。 Face Service によって返されるエラーコードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
FaceErrorResponse	エラーの詳細を含む応答。
LargePersonGroupPerson	指定した大規模人物グループの人物。このユーザーに顔を追加するには、"Add Large Person Group Person Face" (大きな人物グループの人物の顔の追加) を呼び出してください。

FaceError

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

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

FaceErrorResponse

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

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

LargePersonGroupPerson

指定した大規模人物グループの人物。このユーザーに顔を追加するには、"Add Large Person Group Person Face" (大きな人物グループの人物の顔の追加) を呼び出してください。

名前	型	説明
name	string	ユーザー定義名、最大長は 128 です。
persistedFaceIds	string[]	人物に登録されている顔の顔 ID。
personId	string	ユーザーの ID。
userData	string	省略可能なユーザー定義データ。長さは 16K を超えてはなりません。

次の方法で共有

Person Group Operations - Get Large Person Group Persons

URI パラメーター

応答

セキュリティ

Ocp-Apim-Subscription-Key

AADToken

スコープ

例

Get Persons from LargePersonGroup

要求のサンプル

応答のサンプル

定義

FaceError

FaceErrorResponse

LargePersonGroupPerson

その他のリソース