Person Directory Operations - Create Dynamic Person Group With Person

サービス:

Azure AI Services

API バージョン:

v1.2-preview.1

指定した dynamicPersonGroupId、名前、およびユーザー指定の userData を使用して、新しい動的人物グループを作成します。
動的人物グループは、Person Directory "Create Person" を参照するコンテナーです。 作成後、ユーザー ディレクトリ "動的人物グループの更新" を使用して、動的人物グループとの間でユーザーを追加または削除します。

動的人物グループとユーザー データは、Person Directory "Delete Dynamic Person Group" が呼び出されるまでサーバーに格納されます。 dynamicPersonGroupId パラメーターと共に "動的人物グループから識別" を使用して、個人に対して識別します。

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

"recognitionModel" は、動的人物グループで指定する必要はありません。 動的人物グループは、Person Directory "Create Person" への参照であるため、ほとんどの "recognitionModels" で動作します。 "Identify" の間に提供される faceId によって、使用される 'recognitionModel' が決まります。

PUT {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
dynamicPersonGroupId	path	True	string	動的人物グループの ID。 正規表現パターン: ^[a-z0-9-_]+$
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。

要求本文

名前	必須	型	説明
addPersonIds	True	string[]	追加する Person Directory "Create Person" によって作成された personId の配列。
name	True	string	ユーザー定義の名前。最大長は 128 です。
userData		string	省略可能なユーザー定義データ。 長さは 16K を超えないようにしてください。

応答

名前	型	説明
202 Accepted		呼び出しが成功すると、空の応答本文が返されます。 サービスは要求を受け入れ、間もなく処理を開始します。 クライアントは、'Operation-Location' 応答ヘッダーで指定された URL を使用して、操作の状態と結果を照会できます。 URL の有効期限は 48 時間です。 この URL は、Person Directory "Get Dynamic Person Group References" が、この要求で行われた変更をいつ返すのかの状態を示します。 ヘッダー operation-Location: string
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 DynamicPersonGroup

要求のサンプル

HTTP

PUT {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ]
}

応答のサンプル

状態コード:

202

operation-Location: https://contoso.com/operationstatus

定義

名前	説明
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	エラー オブジェクト。