Snapshot - Apply

Dienst:

Azure AI Services

API-Version:

1.0-preview

Ü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 von 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 Momentaufnahme – Erstellen 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 (pro 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 des Momentaufnahme verwendet werden soll. Die Zielobjekt-ID wird im Feld "resourceLocation" in OperationStatus – Antwort abrufen enthalten, 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 das Momentaufnahme in 48 Stunden seit seiner Erstellung anzuwenden.
Das Anwenden eines Momentaufnahme blockiert keine anderen Vorgänge für das Zielobjekt. Dies wird jedoch nicht empfohlen, da die Richtigkeit während Momentaufnahme Anwendens nicht garantiert werden kann. Nachdem Momentaufnahme Anwenden abgeschlossen ist, können alle Vorgänge für das Zielobjekt normal funktionieren. Momentaufnahme enthält auch die Trainingsergebnisse des Quellobjekts. Das bedeutet, dass das Zielabonnement, auf das das Momentaufnahme angewendet wird, das Zielobjekt vor dem Aufrufen von Identify/FindSimilar nicht erneut trainiert werden muss.
Eine Momentaufnahme kann mehrmals parallel angewendet werden, während derzeit nur der CreateNew-Anwendungsmodus 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 des kostenlosen Tarifs: 100 Anwendungsvorgänge pro Monat.
• S0-Tarif-Abonnementkontingent: 100 Anwenden von Vorgängen pro Tag.

POST {Endpoint}/face/v1.0-preview/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
snapshotId	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		SnapshotApplyMode	Momentaufnahme-Anwendungsmodus. Derzeit wird nur CreateNew unterstützt. Das 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. Header Operation-Location: string
Other Status Codes	APIError	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Apply snapshot example

Beispielanforderung

HTTP

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


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

Beispiel für eine Antwort

Statuscode:

202

Definitionen

Name	Beschreibung
APIError	Von der API zurückgegebene Fehlerinformationen
ApplySnapshotRequest	Anforderungstext zum Anwenden Momentaufnahme Vorgangs.
Error	Fehlertext.
SnapshotApplyMode	Momentaufnahme-Anwendungsmodus. Derzeit wird nur CreateNew unterstützt. Das 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	Error	Fehlertext.

ApplySnapshotRequest

Anforderungstext zum Anwenden Momentaufnahme Vorgangs.

Name	Typ	Standardwert	Beschreibung
mode	SnapshotApplyMode	CreateNew	Momentaufnahme-Anwendungsmodus. Derzeit wird nur CreateNew unterstützt. Das 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. Das 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