Person Group Operations - Get Person Groups

Service:

Azure AI Services

API Version:

v1.1-preview.1

Person グループの personGroupId、name、userData、recognitionModel を一覧表示します。
person グループは、personGroupId のアルファベット順に格納されます。

• • "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}/persongroups

With optional parameters:

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	"開始" より大きいリソースを一覧表示します。 含まれる文字数は 64 文字以下です。 既定値は空です。
top	query		integer int32	[1, 1000] の範囲の、一覧表示する項目の数。 既定値は 1000 です。

応答

名前	型	説明
200 OK	PersonGroup[]	正常に呼び出されると、Person グループの配列とその情報 (personGroupId、name、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 PersonGroups

Sample Request

HTTP

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

Sample Response

Status code:

200

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

定義

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

FaceError

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

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

FaceErrorResponse

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

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

PersonGroup

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

名前	型	説明
name	string	ユーザー定義名、最大長は 128 です。
personGroupId	string	コンテナーの ID。
recognitionModel	RecognitionModel	認識モデルの名前。 認識モデルは、顔の特徴が抽出され、検出された faceId に関連付けられている場合に使用されます。
userData	string	省略可能なユーザー定義データ。 長さは 16K を超えてはなりません。

RecognitionModel

顔の認識モデル。

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