Snapshot - Update

Referenz

Dienst:: Azure AI Services

API-Version:: 1.0-preview

Aktualisieren Sie die Informationen einer Momentaufnahme. Nur das Quellabonnement, das die Momentaufnahme verwendet hat, kann die Momentaufnahme aktualisieren.

PATCH {Endpoint}/face/v1.0-preview/snapshots/{snapshotId}

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	Typ	Beschreibung
applyScope	string[]	Array der Ziel-Gesichtserkennungsabonnement-IDs für die Momentaufnahme, die vom Benutzer, der die Momentaufnahme erstellt hat, beim Aufruf von Snapshot – Take angegeben wurde. Für jede Momentaufnahme können nur Abonnements angewendet werden, die im applyScope of Snapshot – Take enthalten sind.
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
200 OK		Ein erfolgreicher Aufruf gibt einen leeren Antworttext zurück.
Other Status Codes	APIError	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Update snapshot example

Beispielanforderung

HTTP

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


{
  "applyScope": [
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

Beispiel für eine Antwort

Statuscode:: 200

Definitionen

Name	Beschreibung
APIError	Von der API zurückgegebene Fehlerinformationen
Error	Fehlertext.
UpdateSnapshotRequest	Anforderungstext zum Aktualisieren eines Momentaufnahme mit einer Kombination aus benutzerdefiniertem Anwendungsbereich und vom Benutzer angegebenen Daten.

APIError

Von der API zurückgegebene Fehlerinformationen

Name	Typ	Beschreibung
error	Error	Fehlertext.

Error

Fehlertext.

Name	Typ	Beschreibung
code	string
message	string

UpdateSnapshotRequest

Anforderungstext zum Aktualisieren eines Momentaufnahme mit einer Kombination aus benutzerdefiniertem Anwendungsbereich und vom Benutzer angegebenen Daten.

Name	Typ	Beschreibung
applyScope	string[]	Array der Ziel-Gesichtserkennungsabonnement-IDs für die Momentaufnahme, die vom Benutzer, der die Momentaufnahme erstellt hat, beim Aufruf von Snapshot – Take angegeben wurde. Für jede Momentaufnahme können nur Abonnements angewendet werden, die im applyScope of Snapshot – Take enthalten sind.
userData	string	Vom Benutzer angegebene Daten über die Momentaufnahme für jeden Zweck. Die Länge sollte 16 KB nicht überschreiten.

Freigeben über