Face List Operations - Create Face List
ユーザー指定の faceListId、name、省略可能な userData、recognitionModel を含む空の Face List をCreateします。
1 つのサブスクリプションで最大 64 個の Face Listsを使用できます。
顔リストは、最大 1,000 個の顔の一覧であり、"顔リストから類似を検索" で使用されます。
作成後、ユーザーは "顔リストの顔の追加" を使用して顔をインポートする必要があります。 イメージは保存されません。 "顔リストの削除" が呼び出されるまで、抽出された顔機能のみがサーバーに格納されます。
"類似の検索" は、著名人のような顔を見つける、似た顔をフィルター処理する、または顔識別を簡単に行うなどのシナリオに使用されます。 ただし、実際に個人を特定する場合は、人物グループ/大人物グループと「識別」を使用してください。
顔番号が大きい場合は、大きな顔リストを検討してください。 最大 1,000,000 個の顔をサポートできます。
PUT {endpoint}/face/{apiVersion}/facelists/{faceListId}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api
|
path | True |
string |
API バージョン |
endpoint
|
path | True |
string uri |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。 |
face
|
path | True |
string |
有効な文字は小文字、数字、'-' または '_' の文字で、最大長は 64 です。 Regex pattern: |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
name | True |
string |
ユーザー定義名、最大長は 128 です。 |
recognitionModel |
Recognition |
この顔リストに関連付けられている 'recognitionModel'。 サポートされている 'recognitionModel' の値には、'recognition_01'、'recognition_02、'recognition_03'、'recognition_04' があります。 既定値は 'recognition_01' です。 'recognition_03' と比較してマスクを装着している顔の精度が向上し、"recognition_01" や "recognition_02" と比較して全体的な精度が向上するため、'recognition_04' をお勧めします。 |
|
userData |
string |
省略可能なユーザー定義データ。 長さは 16K を超えてはなりません。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 |
|
Other Status Codes |
予期しないエラー応答。 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 |
例
Create FaceList
Sample Request
PUT {endpoint}/face/v1.1-preview.1/facelists/your_face_list_id
{
"name": "your_face_list_name",
"userData": "your_user_data",
"recognitionModel": "recognition_01"
}
Sample Response
定義
名前 | 説明 |
---|---|
Face |
error オブジェクト。 Face Service によって返されるエラー コードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages |
Face |
エラーの詳細を含む応答。 |
FaceError
error オブジェクト。 Face Service によって返されるエラー コードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
message |
string |
エラーの人間が判読できる表現。 |
FaceErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |