Snapshot - Take

サービス:

Azure AI Services

API バージョン:

1.0

ユーザー指定のスナップショットの種類、ソース オブジェクト ID、スコープの適用、オプションのユーザー データを使用して、顔リスト、大きな顔リスト、人物グループ、または大きな人物グループのスナップショットを実行する操作を送信します。
スナップショット インターフェイスは、ユーザーが顔データを 1 つの顔サブスクリプションから別の顔サブスクリプション、同じリージョン内、またはリージョン間でバックアップおよび復元するためのインターフェイスです。 ワークフローには 2 つのフェーズが含まれています。ユーザーは最初に Snapshot - Take を呼び出してソース オブジェクトのコピーを作成し、それをスナップショットとして格納し、Snapshot - Apply を呼び出してターゲット サブスクリプションにスナップショットを貼り付けます。 スナップショットは(Azure インスタンスごとに) 一元化された場所に格納されるため、クロス アカウントとリージョンに適用できます。
スナップショットの取得は非同期操作です。 操作 ID は、応答ヘッダーの "Operation-Location" フィールドから取得して、OperationStatus - Get で使用して、スナップショットの作成の進行状況を追跡できます。 スナップショット ID は、OperationStatus - 操作の状態が "成功" のときに応答を取得するの "resourceLocation" フィールドに含まれます。
スナップショットの所要時間は、ソース オブジェクト内の人物と顔のエントリの数によって異なります。 数秒で、複数の顔を持つ 1,000,000 人の場合は最大数時間です。
スナップショットは、スナップショット - Take によって作成されてから 48 時間後に自動的に期限切れになり、クリーンアップされます。 ユーザーは、有効期限が切れる前にいつでも、スナップショット - 削除を使用してスナップショットを削除できます。
特定のオブジェクトに対してスナップショットしても、オブジェクトに対する他の操作はブロックされません。 すべての読み取り専用操作 (Get/List および Identify/FindSimilar/Verify) は、通常どおり実行できます。 ソース オブジェクトまたはその人物/顔の追加/更新/削除、トレーニングなど、すべての書き込み可能な操作ではブロックされませんが、書き込み可能な更新が実行中にスナップショットに反映されない可能性があるため、推奨されません。 スナップショットの取得が完了すると、すべての読み取り可能な操作と書き込み可能な操作が正常に動作します。 スナップショットには、ソース オブジェクトのトレーニング結果も含まれます。つまり、ターゲット サブスクリプションに適用スナップショット、Identify/FindSimilar を呼び出す前にターゲット オブジェクトを再トレーニングする必要はありません。

• Free レベルのサブスクリプション クォータ: 1 か月あたり 100 回の操作を受け取ります。
• S0 レベルのサブスクリプション クォータ: 1 日あたり 100 回の操作を実行します。

POST {Endpoint}/face/v1.0/snapshots

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus.api.cognitive.microsoft.com

要求ヘッダー

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

要求本文

名前	必須	型	説明
applyScope	True	string[]	スナップショットのターゲット Face サブスクリプション ID のユーザー指定配列。 スナップショットごとに、スナップショットの applyScope - Take に含まれるサブスクリプションのみが適用できます。
objectId	True	string	スナップショットを取得するソース オブジェクト ID をユーザーが指定しました。
type	True	SnapshotObjectType	スナップショットを取得するソース オブジェクトのユーザー指定型。 現在、FaceList、PersonGroup、LargeFaceList、LargePersonGroup がサポートされています。
userData		string	ユーザーが任意の目的でスナップショットに関するデータを指定しました。 長さは 16 KB を超えないようにしてください。

応答

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

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Take a snapshot example

要求のサンプル

HTTP

POST {Endpoint}/face/v1.0/snapshots


{
  "type": "FaceList",
  "objectId": "source-face-list-id",
  "applyScope": [
    "35230F59-AA9C-45E0-AB5E-C859BF1A5429",
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

応答のサンプル

状態コード:

202

定義

名前	説明
APIError	API によって返されるエラー情報
Error	エラー本文。
SnapshotObjectType	スナップショット - Take を呼び出すときにスナップショットを作成したサブスクライバーによって指定された、スナップショット内のソース オブジェクトの型。 現在、FaceList、PersonGroup、LargeFaceList、LargePersonGroup がサポートされています。
TakeSnapshotRequest	スナップショット操作を実行するための要求本文。

APIError

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

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

Error

エラー本文。

名前	型	説明
code	string
message	string

SnapshotObjectType

スナップショット - Take を呼び出すときにスナップショットを作成したサブスクライバーによって指定された、スナップショット内のソース オブジェクトの型。 現在、FaceList、PersonGroup、LargeFaceList、LargePersonGroup がサポートされています。

名前	型	説明
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

TakeSnapshotRequest

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

名前	型	説明
applyScope	string[]	スナップショットのターゲット Face サブスクリプション ID のユーザー指定配列。 スナップショットごとに、スナップショットの applyScope - Take に含まれるサブスクリプションのみが適用できます。
objectId	string	スナップショットを取得するソース オブジェクト ID をユーザーが指定しました。
type	SnapshotObjectType	スナップショットを取得するソース オブジェクトのユーザー指定型。 現在、FaceList、PersonGroup、LargeFaceList、LargePersonGroup がサポートされています。
userData	string	ユーザーが任意の目的でスナップショットに関するデータを指定しました。 長さは 16 KB を超えないようにしてください。