Face List Operations - Get Large Face Lists

サービス:

Azure AI Services

API バージョン:

v1.1-preview.1

largeFaceListId、name、userData、recognitionModel の Large Face Listsの情報を一覧表示します。
largeFaceList 内の顔情報を取得するには、"大きな顔リストの顔を取得" を使用します。

Large Face Listsは、largeFaceListId のアルファベット順に格納されます。

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

ヒント

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

GET {endpoint}/face/{apiVersion}/largefacelists

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

GET {endpoint}/face/{apiVersion}/largefacelists?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	[1, 1000] の範囲の、一覧表示する項目の数。 既定値は 1000 です。

応答

名前	型	説明
200 OK	LargeFaceList[]	呼び出しが成功すると、Large Face Listsとその情報 (largeFaceListId、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 LargeFaceLists

要求のサンプル

HTTP

GET {endpoint}/face/v1.1-preview.1/largefacelists?start=my_list_id&top=20&returnRecognitionModel=True

応答のサンプル

状態コード:

200

[
  {
    "name": "your_large_face_list_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "largeFaceListId": "your_large_face_list_id"
  }
]

定義

名前	説明
FaceError	error オブジェクト。 Face Service によって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
FaceErrorResponse	エラーの詳細を含む応答。
LargeFaceList	大きな顔リストは、最大 1,000,000 個の顔の一覧です。
RecognitionModel	顔の認識モデル。

FaceError

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

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

FaceErrorResponse

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

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

LargeFaceList

大きな顔リストは、最大 1,000,000 個の顔の一覧です。

名前	型	説明
largeFaceListId	string	有効な文字は小文字または数字、'-' または '_' の文字で、最大長は 64 です。
name	string	ユーザー定義の名前。最大長は 128 です。
recognitionModel	RecognitionModel	認識モデルの名前。 認識モデルは、顔の特徴が抽出され、検出された faceId に関連付けられるときに使用されます。
userData	string	省略可能なユーザー定義データ。 長さは 16,000 を超えないようにしてください。

RecognitionModel

顔の認識モデル。

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