Snapshot - Update

サービス:

Azure AI Services

API バージョン:

1.0

スナップショットの情報を更新します。 スナップショットを取得したソース サブスクリプションのみがスナップショットを更新できます。

PATCH {Endpoint}/face/v1.0/snapshots/{snapshotId}

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus.api.cognitive.microsoft.com
snapshotId	path	True	string uuid	特定のスナップショットを参照する ID。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string

要求本文

名前	型	説明
applyScope	string[]	Snapshot - Take を呼び出すときにスナップショットを作成したユーザーによって指定された、スナップショットのターゲット Face サブスクリプション ID の配列。 スナップショットごとに、スナップショットの applyScope - Take に含まれるサブスクリプションのみが適用できます。
userData	string	ユーザーが任意の目的でスナップショットに関するデータを指定しました。 長さは 16 KB を超えないようにしてください。

応答

名前	型	説明
200 OK		呼び出しが成功すると、空の応答本文が返されます。
Other Status Codes	APIError	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Update snapshot example

要求のサンプル

HTTP

PATCH {Endpoint}/face/v1.0/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc


{
  "applyScope": [
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

応答のサンプル

状態コード:

200

定義

名前	説明
APIError	API によって返されるエラー情報
Error	エラー本文。
UpdateSnapshotRequest	ユーザー定義の適用スコープとユーザー指定データの組み合わせで、スナップショットを更新するための要求本文。

APIError

API によって返されるエラー情報

名前	型	説明
error	Error	エラー本文。

Error

エラー本文。

名前	型	説明
code	string
message	string

UpdateSnapshotRequest

ユーザー定義の適用スコープとユーザー指定データの組み合わせで、スナップショットを更新するための要求本文。

名前	型	説明
applyScope	string[]	Snapshot - Take を呼び出すときにスナップショットを作成したユーザーによって指定された、スナップショットのターゲット Face サブスクリプション ID の配列。 スナップショットごとに、スナップショットの applyScope - Take に含まれるサブスクリプションのみが適用できます。
userData	string	ユーザーが任意の目的でスナップショットに関するデータを指定しました。 長さは 16 KB を超えないようにしてください。