Snapshot - Take
ユーザー指定のスナップショットの種類、ソース オブジェクト ID、適用スコープ、およびオプションのユーザー データを使用して、顔リスト、大規模な顔リスト、人物グループ、または大規模人物グループのスナップショットを取得する操作を送信します。
スナップショット インターフェイスは、ユーザーが顔データを 1 つの顔サブスクリプションから別の顔サブスクリプションに、同じリージョン内またはリージョン間でバックアップおよび復元するためのインターフェイスです。 ワークフローには 2 つのフェーズが含まれています。ユーザーは最初に Snapshot を呼び出します。Take を使用してソース オブジェクトのコピーを作成し、スナップショットとして格納した後、Snapshot - Apply を呼び出して、スナップショットをターゲット サブスクリプションに貼り付けます。 スナップショットは、クロス アカウントとリージョンに適用できるように、(Azure インスタンスごとに) 一元化された場所に格納されます。
スナップショットの作成は非同期操作です。 OperationStatus - Get でスナップショットの作成の進行状況を追跡するために使用する、応答ヘッダーの "Operation-Location" フィールドから操作 ID を取得できます。 スナップショット 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-preview/snapshotsURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://westus.api.cognitive.microsoft.com)。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | True |
string |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| applyScope | True |
string[] (uuid) |
スナップショットのターゲット Face サブスクリプション ID のユーザー指定配列。 スナップショットごとに、applyScope of Snapshot - Take に含まれるサブスクリプションのみを適用できます。 |
| objectId | True |
string maxLength: 64pattern: ^[a-z0-9-_]+$ |
スナップショットを取得するソース オブジェクト ID をユーザーが指定しました。 |
| type | True |
スナップショットを取得するソース オブジェクトのユーザー指定の型。 現在、FaceList、PersonGroup、LargeFaceList、および LargePersonGroup がサポートされています。 |
|
| userData |
string maxLength: 16384 |
ユーザーが任意の目的でスナップショットに関するデータを指定しました。 長さは 16 KB を超えないようにしてください。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 202 Accepted |
スナップショット作成タスクが正常にキューに登録されました。 ヘッダー Operation-Location: string |
|
| Other Status Codes |
エラー応答。 |
セキュリティ
Ocp-Apim-Subscription-Key
型:
apiKey
/:
header
例
Take a snapshot example
要求のサンプル
POST {Endpoint}/face/v1.0-preview/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."
}
応答のサンプル
定義
| 名前 | 説明 |
|---|---|
| APIError |
API によって返されるエラー情報 |
| Error |
エラー本文。 |
|
Snapshot |
スナップショットの呼び出し時にスナップショットを作成したサブスクライバーによって指定された、スナップショット内のソース オブジェクトの種類 - Take。 現在、FaceList、PersonGroup、LargeFaceList、および LargePersonGroup がサポートされています。 |
|
Take |
スナップショット操作を取得するための要求本文。 |
APIError
API によって返されるエラー情報
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー本文。 |
Error
エラー本文。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
|
| message |
string |
SnapshotObjectType
スナップショットの呼び出し時にスナップショットを作成したサブスクライバーによって指定された、スナップショット内のソース オブジェクトの種類 - Take。 現在、FaceList、PersonGroup、LargeFaceList、および LargePersonGroup がサポートされています。
| 値 | 説明 |
|---|---|
| FaceList | |
| LargeFaceList | |
| LargePersonGroup | |
| PersonGroup |
TakeSnapshotRequest
スナップショット操作を取得するための要求本文。
| 名前 | 型 | 説明 |
|---|---|---|
| applyScope |
string[] (uuid) |
スナップショットのターゲット Face サブスクリプション ID のユーザー指定配列。 スナップショットごとに、applyScope of Snapshot - Take に含まれるサブスクリプションのみを適用できます。 |
| objectId |
string maxLength: 64pattern: ^[a-z0-9-_]+$ |
スナップショットを取得するソース オブジェクト ID をユーザーが指定しました。 |
| type |
スナップショットを取得するソース オブジェクトのユーザー指定の型。 現在、FaceList、PersonGroup、LargeFaceList、および LargePersonGroup がサポートされています。 |
|
| userData |
string maxLength: 16384 |
ユーザーが任意の目的でスナップショットに関するデータを指定しました。 長さは 16 KB を超えないようにしてください。 |