Face List Operations - Get Face List

サービス:

Azure AI Services

API バージョン:

v1.1-preview.1

Face List の faceListId、name、userData、recognitionModel、Face List 内の顔を取得します。

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}

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

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。
faceListId	path	True	string	有効な文字は小文字または数字、'-' または '_' の文字で、最大長は 64 です。 正規表現パターン: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	'recognitionModel' を返すかどうか。 既定値は false です。

応答

名前	型	説明
200 OK	FaceList	正常に呼び出されると、Face List の情報が返されます。
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 FaceList

要求のサンプル

HTTP

GET {endpoint}/face/v1.1-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

応答のサンプル

状態コード:

200

{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "faceListId": "your_face_list_id"
}

定義

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

FaceError

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

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

FaceErrorResponse

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

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

FaceList

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

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

FaceListFace

顔リストの顔リソース。

名前	型	説明
persistedFaceId	string	顔の顔 ID。
userData	string	顔にアタッチされたユーザー指定のデータ。 長さの制限は 1K です。

RecognitionModel

顔の認識モデル。

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