Snapshot - Apply

サービス:

Azure AI Services

API バージョン:

1.0-preview

現在のサブスクリプションにスナップショットを適用する操作を送信します。 スナップショットごとに、スナップショットの applyScope - Take に含まれるサブスクリプションのみが適用できます。
スナップショット インターフェイスは、ユーザーが顔データを 1 つの顔サブスクリプションから別の顔サブスクリプション、同じリージョン内、またはリージョン間でバックアップおよび復元するためのインターフェイスです。 ワークフローには 2 つのフェーズが含まれています。ユーザーは最初に Snapshot - Take を呼び出してソース オブジェクトのコピーを作成し、それをスナップショットとして格納し、Snapshot - Apply を呼び出してターゲット サブスクリプションにスナップショットを貼り付けます。 スナップショットは(Azure インスタンスごとに) 一元化された場所に格納されるため、クロス アカウントとリージョンに適用できます。
スナップショットの適用は非同期操作です。 操作 ID は、応答ヘッダーの "Operation-Location" フィールドから取得して、OperationStatus - Get で使用して、スナップショットの適用の進行状況を追跡できます。 ターゲット オブジェクト ID は、OperationStatus - 操作の状態が "成功" の場合に応答を取得するの "resourceLocation" フィールドに含まれます。
スナップショットの適用時間は、スナップショット オブジェクト内の人物と顔のエントリの数によって異なります。 複数の顔を持つ 1,000,000 人の場合は、秒単位でも最大 1 時間でもかまいません。
スナップショットは、スナップショット - Take によって作成されてから 48 時間後に自動的に期限切れになり、クリーンアップされます。 そのため、ターゲット サブスクリプションは、作成から 48 時間以内にスナップショットを適用する必要があります。
スナップショットを適用してもターゲット オブジェクトに対する他の操作はブロックされませんが、適用中に正確性を保証できないため、推奨スナップショット。 スナップショット適用が完了すると、ターゲット オブジェクトに対するすべての操作が正常に機能します。 スナップショットには、ソース オブジェクトのトレーニング結果も含まれます。つまり、スナップショットが適用されるターゲット サブスクリプションでは、Identify/FindSimilar を呼び出す前にターゲット オブジェクトを再トレーニングする必要はありません。
1 つのスナップショットを並列で複数回適用できますが、現在は CreateNew 適用モードのみがサポートされています。つまり、ターゲット サブスクリプションに同じ種類のオブジェクトが既に含まれており、同じ objectId を使用している場合、適用操作は失敗します。 ユーザーは、このような競合を回避するために、要求本文で "objectId" を指定できます。

• Free レベルのサブスクリプション クォータ: 1 か月あたり 100 個の操作が適用されます。
• S0 レベルのサブスクリプション クォータ: 1 日あたり 100 個の操作が適用されます。

POST {Endpoint}/face/v1.0-preview/snapshots/{snapshotId}/apply

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

要求本文

名前	必須	型	説明
objectId	True	string	スナップショットから作成されるユーザー指定のターゲット オブジェクト ID。
mode		SnapshotApplyMode	スナップショット適用モード。 現在、CreateNew のみがサポートされています。つまり、ターゲット サブスクリプションに同じ種類のオブジェクトが既に含まれており、同じ objectId を使用している場合、適用操作は失敗します。 ユーザーは、このような競合を回避するために、要求本文で "objectId" を指定できます。

応答

名前	型	説明
202 Accepted		タスクの適用スナップショットが正常にキューに入れられます。 ヘッダー Operation-Location: string
Other Status Codes	APIError	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Apply snapshot example

要求のサンプル

HTTP

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


{
  "objectId": "target-face-list-id",
  "mode": "CreateNew"
}

応答のサンプル

状態コード:

202

定義

名前	説明
APIError	API によって返されるエラー情報
ApplySnapshotRequest	スナップショット操作を適用するための要求本文。
Error	エラー本文。
SnapshotApplyMode	スナップショット適用モード。 現在、CreateNew のみがサポートされています。つまり、ターゲット サブスクリプションに同じ種類のオブジェクトが既に含まれており、同じ objectId を使用している場合、適用操作は失敗します。 ユーザーは、このような競合を回避するために、要求本文で "objectId" を指定できます。

APIError

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

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

ApplySnapshotRequest

スナップショット操作を適用するための要求本文。

名前	型	規定値	説明
mode	SnapshotApplyMode	CreateNew	スナップショット適用モード。 現在、CreateNew のみがサポートされています。つまり、ターゲット サブスクリプションに同じ種類のオブジェクトが既に含まれており、同じ objectId を使用している場合、適用操作は失敗します。 ユーザーは、このような競合を回避するために、要求本文で "objectId" を指定できます。
objectId	string		スナップショットから作成されるユーザー指定のターゲット オブジェクト ID。

Error

エラー本文。

名前	型	説明
code	string
message	string

SnapshotApplyMode

スナップショット適用モード。 現在、CreateNew のみがサポートされています。つまり、ターゲット サブスクリプションに同じ種類のオブジェクトが既に含まれており、同じ objectId を使用している場合、適用操作は失敗します。 ユーザーは、このような競合を回避するために、要求本文で "objectId" を指定できます。

名前	型	説明
CreateNew	string