Person Group Operations - Create Large Person Group

Service:

Azure AI Services

API Version:

v1.1-preview.1

ユーザー指定の largePersonGroupId、name、省略可能な userData および recognitionModel を使用して、新しい Large Person Group をCreateします。
Large Person Group は、顔認識機能を含む、アップロードされた人物データを保持するコンテナーです。 最大 1,000,000 個のエンティティを保持できます。

作成後、"Create Large Person Group Person" を使用してグループにユーザーを追加し、"大きなユーザー グループのトレーニング" を呼び出して、このグループを "大きな人物グループから識別する" 準備をします。

イメージは保存されません。 "Delete Large Person Group Person" または "Delete Large Person Group" が呼び出されるまで、ユーザーの抽出された顔機能と userData のみがサーバーに格納されます。

この Large Person Group に関連付けるには、'recognitionModel' を指定する必要があります。 'recognitionModel' の既定値は 'recognition_01' です。最新のモデルが必要な場合は、このパラメーターで必要なモデルを明示的に指定してください。 既存の Large Person Group に追加された新しい顔では、コレクションに既に関連付けられている認識モデルが使用されます。 大規模人物グループ内の既存の顔の特徴を、別のバージョンの認識モデルによって抽出された特徴に更新することはできません。

注意

• • Free レベルのサブスクリプション クォータ: 1,000 Large Person グループ。
  • S0 レベルのサブスクリプション クォータ: 1,000,000 Large Person グループ。

PUT {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。
largePersonGroupId	path	True	string	コンテナーの ID。 Regex pattern: ^[a-z0-9-_]+$

要求本文

名前	必須	型	説明
name	True	string	ユーザー定義名、最大長は 128 です。
recognitionModel		RecognitionModel	この顔リストに関連付けられている '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	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

例

Create LargePersonGroup

Sample Request

HTTP

PUT {endpoint}/face/v1.1-preview.1/largepersongroups/your_large_person_group_id

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

Sample Response

Status code:

200

定義

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

FaceError

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

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

FaceErrorResponse

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

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