Snapshot - Take

Dienst:

Azure AI Services

API-Version:

1.0-preview

Übermitteln Sie einen Vorgang, um eine Momentaufnahme der Gesichtsliste, einer großen Gesichtsliste, einer Personengruppe oder einer großen Personengruppe mit vom Benutzer angegebenen Momentaufnahme Typ, Quellobjekt-ID, Anwendungsbereich und optionalen Benutzerdaten zu übernehmen.
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 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 Erstellen des Momentaufnahme verwendet werden soll. Die Momentaufnahme-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 Quellobjekt ab. Es kann in Sekunden oder bis zu mehreren Stunden 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. Der Benutzer kann die Momentaufnahme mithilfe von Momentaufnahme – Selbst löschen jederzeit vor Ablauf löschen.
Durch Momentaufnahme für ein bestimmtes Objekt werden keine anderen Vorgänge für das Objekt blockiert. Alle schreibgeschützten Vorgänge (Get/List und Identify/FindSimilar/Verify) können wie gewohnt ausgeführt werden. Für alle beschreibbaren Vorgänge, einschließlich Hinzufügen/Aktualisieren/Löschen des Quellobjekts oder seiner Personen/Gesichter und Train, werden sie nicht blockiert, aber nicht empfohlen, da beschreibbare Updates während der Aufnahme möglicherweise nicht im Momentaufnahme reflektiert werden. Nachdem Momentaufnahme Einnahme abgeschlossen ist, können alle lesbaren und beschreibbaren Vorgänge wie gewohnt funktionieren. Die Momentaufnahme enthält auch die Trainingsergebnisse des Quellobjekts. Dies bedeutet, dass das Zielabonnement, auf das das Momentaufnahme angewendet wird, das Zielobjekt vor dem Aufrufen von Identify/FindSimilar nicht erneut trainiert werden muss.

• Abonnementkontingent des kostenlosen Tarifs: 100 Take-Vorgänge pro Monat.
• S0-Tarif-Abonnementkontingent: 100 Vorgänge pro Tag.

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

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

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
applyScope	True	string[]	Vom Benutzer angegebenes Array von Ziel-Gesichtserkennungsabonnements für die Momentaufnahme. Für jede Momentaufnahme können nur Abonnements angewendet werden, die im applyScope of Snapshot – Take enthalten sind.
objectId	True	string	Vom Benutzer angegebene Quellobjekt-ID, aus der Momentaufnahme.
type	True	SnapshotObjectType	Vom Benutzer angegebene Typ für das Quellobjekt, aus dem Momentaufnahme. Derzeit werden FaceList, PersonGroup, LargeFaceList und LargePersonGroup unterstützt.
userData		string	Vom Benutzer angegebene Daten über die Momentaufnahme für jeden Zweck. Die Länge sollte 16 KB nicht überschreiten.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Momentaufnahme 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

Take a snapshot example

Beispielanforderung

HTTP

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."
}

Beispiel für eine Antwort

Statuscode:

202

Definitionen

Name	Beschreibung
APIError	Von der API zurückgegebene Fehlerinformationen
Error	Fehlertext.
SnapshotObjectType	Typ des Quellobjekts im Momentaufnahme, der vom Abonnenten angegeben wird, der die Momentaufnahme erstellt hat, wenn Snapshot – Take aufgerufen wird. Derzeit werden FaceList, PersonGroup, LargeFaceList und LargePersonGroup unterstützt.
TakeSnapshotRequest	Anforderungstext für Momentaufnahme Vorgang.

APIError

Von der API zurückgegebene Fehlerinformationen

Name	Typ	Beschreibung
error	Error	Fehlertext.

Error

Fehlertext.

Name	Typ	Beschreibung
code	string
message	string

SnapshotObjectType

Typ des Quellobjekts im Momentaufnahme, der vom Abonnenten angegeben wird, der die Momentaufnahme erstellt hat, wenn Snapshot – Take aufgerufen wird. Derzeit werden FaceList, PersonGroup, LargeFaceList und LargePersonGroup unterstützt.

Name	Typ	Beschreibung
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

TakeSnapshotRequest

Anforderungstext für Momentaufnahme Vorgang.

Name	Typ	Beschreibung
applyScope	string[]	Vom Benutzer angegebenes Array von Ziel-Gesichtserkennungsabonnements für die Momentaufnahme. Für jede Momentaufnahme können nur Abonnements angewendet werden, die im applyScope of Snapshot – Take enthalten sind.
objectId	string	Vom Benutzer angegebene Quellobjekt-ID, aus der Momentaufnahme.
type	SnapshotObjectType	Vom Benutzer angegebene Typ für das Quellobjekt, aus dem Momentaufnahme. Derzeit werden FaceList, PersonGroup, LargeFaceList und LargePersonGroup unterstützt.
userData	string	Vom Benutzer angegebene Daten über die Momentaufnahme für jeden Zweck. Die Länge sollte 16 KB nicht überschreiten.