Person Group Operations - Create Person Group

  • リファレンス
サービス:
Azure AI Services
API バージョン:
v1.2-preview.1

指定した personGroupId、名前、ユーザー指定の userData、recognitionModel を使用して、新しい人物グループを作成します。
人物グループは、顔認識機能を含む、アップロードされた人物データを保持するコンテナーです。

作成後、"ユーザー グループユーザーの作成" を使用してグループにユーザーを追加し、"Train Person Group" を呼び出して、このグループを "ユーザー グループから識別" の準備をします。

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

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

手記

    • Free レベルのサブスクリプション クォータ: 1,000 人のユーザー グループ。 各ユーザーは最大 1,000 人まで収容できます。
    • S0 レベルのサブスクリプション クォータ: 1,000,000 人グループ。 各ユーザーは最大 10,000 人まで収容できます。
    • 大規模な顔識別の問題を処理するには、大規模な人物グループの使用を検討してください。
PUT {endpoint}/face/{apiVersion}/persongroups/{personGroupId}

URI パラメーター

名前 / 必須 型 説明
apiVersion
 path True

string

API バージョン
endpoint
 path True

string

uri

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。
personGroupId
 path True

string

コンテナーの ID。

正規表現パターン: ^[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 PersonGroup

要求のサンプル

PUT {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id

{
  "name": "your_person_group_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

エラー オブジェクト。