Face List Operations - Create Face List

サービス:

Azure AI Services

API バージョン:

v1.2-preview.1

ユーザー指定の faceListId、name、省略可能な userData、recognitionModel を使用して、空の Face List を作成します。
1 つのサブスクリプションで最大 64 個の Face Lists を使用できます。

顔リストは、最大 1,000 個の顔の一覧であり、"顔リストから類似を検索" で使用されます。

作成後、ユーザーは "顔リストの顔の追加" を使用して顔をインポートする必要があります。 イメージは保存されません。 抽出された顔機能のみが、"顔リストの削除" が呼び出されるまでサーバーに格納されます。

"類似の検索" は、有名人のような顔の検索、似た顔のフィルター処理、または簡単な方法での顔識別などのシナリオで使用されます。 ただし、実際に個人を識別する場合は、人物グループ/大規模人物グループと「識別」を使用してください。

顔番号が大きい場合は、大きな顔リストを検討してください。 最大 1,000,000 個の顔をサポートできます。

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

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-_]+$

要求本文

名前	必須	型	説明
name	True	string	ユーザー定義の名前。最大長は 128 です。
recognitionModel		RecognitionModel	この顔リストに関連付けられている 'recognitionModel' です。 サポートされている 'recognitionModel' 値には、'recognition_01'、'recognition_02、'recognition_03'、および 'recognition_04' があります。 既定値は 'recognition_01' です。 'recognition_04' は、マスクを装着している顔の精度が 'recognition_03' と比較して向上し、"recognition_01" や "recognition_02" と比較して全体的な精度が向上するため、推奨されます。
userData		string	省略可能なユーザー定義データ。 長さは 16K を超えないようにしてください。

応答

名前	型	説明
200 OK		要求は成功しました。
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

例

Create FaceList

要求のサンプル

HTTP

PUT {endpoint}/face/v1.2-preview.1/facelists/your_face_list_id

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

応答のサンプル

状態コード:

200

定義

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

FaceError

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

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

FaceErrorResponse

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

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