SnapshotOperations クラス

  • リファレンス

SnapshotOperations 操作。

このクラスを直接インスタンス化するのではなく、クライアント インスタンスを作成して属性としてアタッチします。

継承
builtins.object
SnapshotOperations

コンストラクター

SnapshotOperations(client, config, serializer, deserializer)

パラメーター

名前 説明
client
必須

サービス要求のクライアント。
config
必須

サービス クライアントの構成。
serializer
必須

オブジェクト モデル シリアライザー。
deserializer
必須

オブジェクト モデル逆シリアライザー。

メソッド

apply

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

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

snapshotId に従って既存のスナップショットを削除します。 スナップショット内のすべてのオブジェクト データと情報も削除されます。 スナップショットを削除できるのは、スナップショットを作成したソース サブスクリプションのみです。 ユーザーがこの API を使用してスナップショットを削除しない場合でも、スナップショットは作成後 48 時間以内に自動的に削除されます。
get

スナップショットに関する情報を取得します。 スナップショットには、スナップショットを取得したソース サブスクリプションと、スナップショット - Take の applyScope に含まれるターゲット サブスクリプションのみがアクセスできます。
get_operation_status

スナップショットの取得/適用操作の状態を取得します。
list

ユーザーが取得したスナップショット、またはユーザーに適用されるスナップショット (サブスクリプション ID がスナップショット - 取得で applyScope に含まれていた) など、関連する情報を含むすべてのアクセス可能なスナップショットを一覧表示します。
take

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

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

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

apply

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

  • Free レベルのサブスクリプション クォータ: 1 か月あたり 100 個の適用操作。
  • S0 レベルのサブスクリプション クォータ: 1 日あたり 100 個の操作が適用されます。
apply(snapshot_id, object_id, mode='CreateNew', custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
snapshot_id
必須
str

特定のスナップショットを参照する ID。
object_id
必須
str

スナップショットから作成するユーザー指定のターゲット オブジェクト ID。
mode
str または SnapshotApplyMode

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

既定値: CreateNew
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
None,
<xref:msrest.pipeline.ClientRawResponse>

raw=true の場合は None または ClientRawResponse

例外

型 説明
APIErrorException

delete

snapshotId に従って既存のスナップショットを削除します。 スナップショット内のすべてのオブジェクト データと情報も削除されます。 スナップショットを削除できるのは、スナップショットを作成したソース サブスクリプションのみです。 ユーザーがこの API を使用してスナップショットを削除しない場合でも、スナップショットは作成後 48 時間以内に自動的に削除されます。

delete(snapshot_id, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
snapshot_id
必須
str

特定のスナップショットを参照する ID。
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
None,
<xref:msrest.pipeline.ClientRawResponse>

raw=true の場合は None または ClientRawResponse

例外

型 説明
APIErrorException

get

スナップショットに関する情報を取得します。 スナップショットには、スナップショットを取得したソース サブスクリプションと、スナップショット - Take の applyScope に含まれるターゲット サブスクリプションのみがアクセスできます。

get(snapshot_id, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
snapshot_id
必須
str

特定のスナップショットを参照する ID。
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
Snapshot,
<xref:msrest.pipeline.ClientRawResponse>

スナップショットまたは ClientRawResponse (raw=true の場合)

例外

型 説明
APIErrorException

get_operation_status

スナップショットの取得/適用操作の状態を取得します。

get_operation_status(operation_id, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
operation_id
必須
str

特定の取得/適用スナップショット操作を参照する ID。
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
OperationStatus,
<xref:msrest.pipeline.ClientRawResponse>

operationStatus または ClientRawResponse (raw=true の場合)

例外

型 説明
APIErrorException

list

ユーザーが取得したスナップショット、またはユーザーに適用されるスナップショット (サブスクリプション ID がスナップショット - 取得で applyScope に含まれていた) など、関連する情報を含むすべてのアクセス可能なスナップショットを一覧表示します。

list(type=None, apply_scope=None, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
type
str または SnapshotObjectType

ユーザーが検索フィルターとしてオブジェクトの種類を指定しました。 使用できる値は、'FaceList'、'LargeFaceList'、'LargePersonGroup'、'PersonGroup' です。

既定値: None
apply_scope
list[str]

ユーザー指定のスナップショットは、検索フィルターとしてスコープを適用します。 ApplyScope は、スナップショットのターゲット Azure サブスクリプション ID の配列であり、スナップショットを作成したユーザーによってスナップショットを作成したユーザーによって指定されます。

既定値: None
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
list[Snapshot],
<xref:msrest.pipeline.ClientRawResponse>

raw=true の場合は list または ClientRawResponse

例外

型 説明
APIErrorException

take

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

  • Free レベルのサブスクリプション クォータ: 1 か月あたり 100 回の操作を受け取ります。
  • S0 レベルのサブスクリプション クォータ: 1 日あたり 100 回の操作を受け取ります。
take(type, object_id, apply_scope, user_data=None, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
type
必須
str または SnapshotObjectType

スナップショットを取得するソース オブジェクトのユーザー指定型。 現在、FaceList、PersonGroup、LargeFaceList、LargePersonGroup がサポートされています。 使用できる値は、'FaceList'、'LargeFaceList'、'LargePersonGroup'、'PersonGroup' です。
object_id
必須
str

スナップショットを取得するソース オブジェクト ID をユーザーが指定しました。
apply_scope
必須
list[str]

スナップショットのターゲット Face サブスクリプション ID のユーザー指定配列。 スナップショットごとに、スナップショットの applyScope - Take に含まれるサブスクリプションのみが適用できます。
user_data
str

ユーザーが任意の目的でスナップショットに関するデータを指定しました。 長さは 16 KB を超えないようにしてください。

既定値: None
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
None,
<xref:msrest.pipeline.ClientRawResponse>

raw=true の場合は None または ClientRawResponse

例外

型 説明
APIErrorException

update

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

update(snapshot_id, apply_scope=None, user_data=None, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
snapshot_id
必須
str

特定のスナップショットを参照する ID。
apply_scope
list[str]

スナップショット - Take を呼び出すときにスナップショットを作成したユーザーによって指定された、スナップショットのターゲット Face サブスクリプション ID の配列。 スナップショットごとに、スナップショットの applyScope - Take に含まれるサブスクリプションのみが適用できます。

既定値: None
user_data
str

ユーザーが任意の目的でスナップショットに関するデータを指定しました。 長さは 16 KB を超えないようにしてください。

既定値: None
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
None,
<xref:msrest.pipeline.ClientRawResponse>

raw=true の場合は None または ClientRawResponse

例外

型 説明
APIErrorException

属性

models 

models = <module 'azure.cognitiveservices.vision.face.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\vision\\face\\models\\__init__.py'>