Person Directory Operations - Update Dynamic Person Group With Person Changes

Service:

Azure AI Services

API Version:

v1.1-preview.1

既存の動的人物グループの名前または userData を更新し、ユーザーを追加または削除してメンバーを管理します。
プロパティが要求本文にない場合、プロパティは変更されません。

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

URI パラメーター

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

要求本文

名前	型	説明
addPersonIds	string[]	追加する Person Directory "Create Person" によって作成された personId の配列。
name	string	ユーザー定義名、最大長は 128 です。
removePersonIds	string[]	削除する Person Directory "Create Person" によって作成された personId の配列。
userData	string	省略可能なユーザー定義データ。 長さは 16K を超えてはなりません。

応答

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

例

Update DynamicPersonGroup

Sample Request

HTTP

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

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ],
  "removePersonIds": [
    "67f7e96d-823a-4318-9bf6-e9a2a2608899"
  ]
}

Sample Response

Status code:

202

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

定義

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