Person Group Operations - Get Person Groups

リファレンス

サービス:: Azure AI Services

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

ユーザーグループの personGroupId、名前、userData、recognitionModel を一覧表示します。
人物グループは、personGroupId のアルファベット順に格納されます。

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

先端

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

GET {endpoint}/face/{apiVersion}/persongroups

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

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

URI パラメーター

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

応答

名前	型	説明
200 OK	PersonGroup[]	呼び出しが成功すると、Person Groups とその情報 (personGroupId、name、userData) の配列が返されます。
Other Status Codes	FaceErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

PersonGroup[]

呼び出しが成功すると、Person Groups とその情報 (personGroupId、name、userData) の配列が返されます。

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 PersonGroups

要求のサンプル

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups?start=00000000-0000-0000-0000-000000000000&top=20&returnRecognitionModel=True

応答のサンプル

状態コード:: 200

[
  {
    "name": "your_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "personGroupId": "your_person_group_id"
  }
]

定義

名前	説明
FaceError	エラーオブジェクト。 Face サービスによって返されるエラーコードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	エラーの詳細を含む応答。
PersonGroup	顔認識機能と最大 10,000 人を含む、アップロードされた人物データのコンテナー。大規模な顔識別の問題を処理するには、大規模人物グループの使用を検討してください。
RecognitionModel	顔の認識モデル。

FaceError

Object

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

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

FaceErrorResponse

Object

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

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

PersonGroup

Object

顔認識機能と最大 10,000 人を含む、アップロードされた人物データのコンテナー。大規模な顔識別の問題を処理するには、大規模人物グループの使用を検討してください。

名前	型	説明
name	string minLength: 1 maxLength: 128	ユーザー定義の名前。最大長は 128 です。
personGroupId	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	コンテナーの ID。
recognitionModel	RecognitionModel	認識モデルの名前。認識モデルは、顔の特徴が抽出され、検出された faceId に関連付けられている場合に使用されます。
userData	string maxLength: 16384	省略可能なユーザー定義データ。長さは 16K を超えないようにしてください。

RecognitionModel

列挙

顔の認識モデル。

値	説明
recognition_01	"Detect" の既定の認識モデル。 2019 年 3 月より前に作成されたすべての faceId は、この認識モデルと結合されます。
recognition_02	2019 年 3 月にリリースされた認識モデル。
recognition_03	2020 年 5 月にリリースされた認識モデル。
recognition_04	2021 年 2 月にリリースされた認識モデル。認識精度を向上させるために、この認識モデルを使用することをお勧めします。

次の方法で共有

Person Group Operations - Get Person Groups

URI パラメーター

応答

セキュリティ

Ocp-Apim-Subscription-Key

AADToken

スコープ

例

Get PersonGroups

要求のサンプル

応答のサンプル

定義

FaceError

FaceErrorResponse

PersonGroup

RecognitionModel

その他のリソース