Snapshot - Apply
Übermitteln Sie einen Vorgang, um eine Momentaufnahme auf das aktuelle Abonnement anzuwenden. Für jede Momentaufnahme können nur Abonnements angewendet werden, die im applyScope of Snapshot – Take enthalten sind.
Die Momentaufnahme Schnittstellen dienen dazu, dass Benutzer ihre Gesichtsdaten aus einem Gesichtsabonnement in einem anderen, innerhalb derselben Region oder regionenübergreifend sichern und wiederherstellen können. Der Workflow enthält zwei Phasen. Der Benutzer ruft zunächst Snapshot – Take auf, um eine Kopie des Quellobjekts zu erstellen und es als Momentaufnahme zu speichern, und ruft dann Momentaufnahme – Anwenden auf, um die Momentaufnahme in das Zielabonnement einzufügen. Die Momentaufnahmen werden an einem zentralen Speicherort (gemäß Azure instance) gespeichert, sodass sie konten- und regionsübergreifend angewendet werden können.
Das Anwenden Momentaufnahme ist ein asynchroner Vorgang. Eine Vorgangs-ID kann aus dem Feld "Operation-Location" im Antwortheader abgerufen werden, das in OperationStatus – Get zum Nachverfolgen des Fortschritts beim Anwenden der Momentaufnahme verwendet werden soll. Die Zielobjekt-ID wird im Feld "resourceLocation" in OperationStatus – Abrufen der Antwort angegeben, wenn der Vorgang status "erfolgreich" ist.
Die Momentaufnahmezeit hängt von der Anzahl der Personen- und Gesichtseinträge im Momentaufnahme-Objekt ab. Es kann in Sekunden oder bis zu 1 Stunde für 1.000.000 Personen mit mehreren Gesichtern sein.
Momentaufnahmen werden automatisch abgelaufen und in 48 Stunden bereinigt, nachdem sie von Snapshot – Take erstellt wurden. Daher ist das Zielabonnement erforderlich, um die Momentaufnahme in 48 Stunden seit seiner Erstellung anzuwenden.
Durch das Anwenden eines Momentaufnahme werden keine anderen Vorgänge für das Zielobjekt blockiert. Dies wird jedoch nicht empfohlen, da die Richtigkeit während der Momentaufnahme Anwendung nicht garantiert werden kann. Nachdem Momentaufnahme Anwendung abgeschlossen ist, können alle Vorgänge für das Zielobjekt wie gewohnt funktionieren. Die Momentaufnahme enthält auch die Trainingsergebnisse des Quellobjekts. Das bedeutet, dass das Zielabonnement, auf das Momentaufnahme angewendet wird, das Zielobjekt vor dem Aufruf von Identify/FindSimilar nicht erneut trainiert werden muss.
Ein Momentaufnahme kann mehrmals parallel angewendet werden, während derzeit nur createNew apply mode unterstützt wird. Dies bedeutet, dass der Apply-Vorgang fehlschlägt, wenn das Zielabonnement bereits ein Objekt desselben Typs enthält und dieselbe objectId verwendet. Benutzer können die "objectId" im Anforderungstext angeben, um solche Konflikte zu vermeiden.
- Abonnementkontingent im free-Tarif: 100 Anwenden von Vorgängen pro Monat.
- S0-Tarif-Abonnementkontingent: 100 angewendete Vorgänge pro Tag.
POST {Endpoint}/face/v1.0/snapshots/{snapshotId}/apply
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus.api.cognitive.microsoft.com |
snapshot
|
path | True |
string uuid |
Id, die auf einen bestimmten Momentaufnahme verweist. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
objectId | True |
string |
Vom Benutzer angegebene Zielobjekt-ID, die aus dem Momentaufnahme erstellt werden soll. |
mode |
Momentaufnahme-Anwendungsmodus. Derzeit wird nur CreateNew unterstützt. Dies bedeutet, dass der Apply-Vorgang fehlschlägt, wenn das Zielabonnement bereits ein Objekt desselben Typs enthält und dieselbe objectId verwendet. Benutzer können die "objectId" im Anforderungstext angeben, um solche Konflikte zu vermeiden. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
202 Accepted |
Die Momentaufnahme anwendenden Aufgabe wurde erfolgreich in die Warteschlange gestellt. Headers Operation-Location: string |
|
Other Status Codes |
Fehlerantwort. |
Sicherheit
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Beispiele
Apply snapshot example
Sample Request
POST {Endpoint}/face/v1.0/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc/apply
{
"objectId": "target-face-list-id",
"mode": "CreateNew"
}
Sample Response
Definitionen
Name | Beschreibung |
---|---|
APIError |
Von der API zurückgegebene Fehlerinformationen |
Apply |
Anforderungstext zum Anwenden Momentaufnahme Vorgangs. |
Error |
Fehlertext. |
Snapshot |
Momentaufnahme-Anwendungsmodus. Derzeit wird nur CreateNew unterstützt. Dies bedeutet, dass der Apply-Vorgang fehlschlägt, wenn das Zielabonnement bereits ein Objekt desselben Typs enthält und dieselbe objectId verwendet. Benutzer können die "objectId" im Anforderungstext angeben, um solche Konflikte zu vermeiden. |
APIError
Von der API zurückgegebene Fehlerinformationen
Name | Typ | Beschreibung |
---|---|---|
error |
Fehlertext. |
ApplySnapshotRequest
Anforderungstext zum Anwenden Momentaufnahme Vorgangs.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
mode | CreateNew |
Momentaufnahme-Anwendungsmodus. Derzeit wird nur CreateNew unterstützt. Dies bedeutet, dass der Apply-Vorgang fehlschlägt, wenn das Zielabonnement bereits ein Objekt desselben Typs enthält und dieselbe objectId verwendet. Benutzer können die "objectId" im Anforderungstext angeben, um solche Konflikte zu vermeiden. |
|
objectId |
string |
Vom Benutzer angegebene Zielobjekt-ID, die aus dem Momentaufnahme erstellt werden soll. |
Error
Fehlertext.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
|
message |
string |
SnapshotApplyMode
Momentaufnahme-Anwendungsmodus. Derzeit wird nur CreateNew unterstützt. Dies bedeutet, dass der Apply-Vorgang fehlschlägt, wenn das Zielabonnement bereits ein Objekt desselben Typs enthält und dieselbe objectId verwendet. Benutzer können die "objectId" im Anforderungstext angeben, um solche Konflikte zu vermeiden.
Name | Typ | Beschreibung |
---|---|---|
CreateNew |
string |