Snapshot - Apply

Usługa:

Azure AI Services

Wersja interfejsu API:

1.0-preview

Prześlij operację, aby zastosować migawkę do bieżącej subskrypcji. Dla każdej migawki można zastosować tylko subskrypcje uwzględnione w stoszakresie migawek .
Interfejsy migawek są przeznaczone dla użytkowników do tworzenia kopii zapasowych i przywracania danych twarzy z jednej subskrypcji twarzy do innej, w tym samym regionie lub w różnych regionach. Przepływ pracy zawiera dwie fazy, najpierw wywołuje funkcję Snapshot — utwórz kopię obiektu źródłowego i zapisz ją jako migawkę, a następnie wywołuje funkcję Snapshot — zastosuj, aby wkleić migawkę do subskrypcji docelowej. Migawki są przechowywane w centralnej lokalizacji (na wystąpienie platformy Azure), aby można je było stosować między kontami i regionami.
Stosowanie migawki jest operacją asynchroniczną. Identyfikator operacji można uzyskać z pola "Operation-Location" w nagłówku odpowiedzi, które ma być używane w funkcji OperationStatus — pobierz w celu śledzenia postępu stosowania migawki. Identyfikator obiektu docelowego zostanie uwzględniony w polu "resourceLocation" w obszarze OperationStatus — uzyskaj odpowiedź, gdy stan operacji to "powodzenie".
Czas stosowania migawki zależy od liczby wpisów osoby i twarzy w obiekcie migawki. Może to być w sekundach lub do 1 godziny dla 1000 000 osób z wieloma twarzami.
Migawki zostaną automatycznie wygasłe i wyczyszczone w ciągu 48 godzin po utworzeniu ich przez migawkę — wykonywanie. Dlatego subskrypcja docelowa jest wymagana do zastosowania migawki w ciągu 48 godzin od jej utworzenia.
Zastosowanie migawki nie spowoduje zablokowania żadnych innych operacji względem obiektu docelowego, jednak nie jest to zalecane, ponieważ nie można zagwarantować poprawności podczas stosowania migawki. Po zakończeniu stosowania migawki wszystkie operacje względem obiektu docelowego mogą działać normalnie. Migawka zawiera również wyniki trenowania obiektu źródłowego, co oznacza, że subskrypcja docelowa, do której zastosowano migawkę, nie wymaga ponownego trenowania obiektu docelowego przed wywołaniem metody Identify/FindSimilar.
Jedną migawkę można stosować wiele razy równolegle, podczas gdy obecnie obsługiwany jest tylko tryb TworzeniaNowy zastosowanie, co oznacza, że operacja stosowania zakończy się niepowodzeniem, jeśli subskrypcja docelowa zawiera już obiekt tego samego typu i używa tego samego identyfikatora objectId. Użytkownicy mogą określić identyfikator "objectId" w treści żądania, aby uniknąć takich konfliktów.

• Limit przydziału subskrypcji w warstwie Bezpłatna: 100 operacji stosowania miesięcznie.
• Limit przydziału subskrypcji warstwy S0: 100 operacji stosowania dziennie.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
snapshotId	path	True	string uuid	Identyfikator odwołujący się do określonej migawki.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Treść żądania

Nazwa	Wymagane	Typ	Opis
objectId	True	string	Identyfikator obiektu docelowego określony przez użytkownika, który ma zostać utworzony na podstawie migawki.
mode		SnapshotApplyMode	Tryb stosowania migawki. Obecnie obsługiwane jest tylko polecenie CreateNew, co oznacza, że operacja stosowania zakończy się niepowodzeniem, jeśli subskrypcja docelowa zawiera już obiekt tego samego typu i używa tego samego identyfikatora objectId. Użytkownicy mogą określić identyfikator "objectId" w treści żądania, aby uniknąć takich konfliktów.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Zadanie stosowania migawki zostało pomyślnie w kolejce. Nagłówki Operation-Location: string
Other Status Codes	APIError	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Apply snapshot example

Przykładowe żądanie

HTTP

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


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

Przykładowa odpowiedź

Kod stanu:

202

Definicje

Nazwa	Opis
APIError	Informacje o błędzie zwrócone przez interfejs API
ApplySnapshotRequest	Treść żądania dotycząca stosowania operacji migawki.
Error	Treść błędu.
SnapshotApplyMode	Tryb stosowania migawki. Obecnie obsługiwane jest tylko polecenie CreateNew, co oznacza, że operacja stosowania zakończy się niepowodzeniem, jeśli subskrypcja docelowa zawiera już obiekt tego samego typu i używa tego samego identyfikatora objectId. Użytkownicy mogą określić identyfikator "objectId" w treści żądania, aby uniknąć takich konfliktów.

APIError

Informacje o błędzie zwrócone przez interfejs API

Nazwa	Typ	Opis
error	Error	Treść błędu.

ApplySnapshotRequest

Treść żądania dotycząca stosowania operacji migawki.

Nazwa	Typ	Domyślna wartość	Opis
mode	SnapshotApplyMode	CreateNew	Tryb stosowania migawki. Obecnie obsługiwane jest tylko polecenie CreateNew, co oznacza, że operacja stosowania zakończy się niepowodzeniem, jeśli subskrypcja docelowa zawiera już obiekt tego samego typu i używa tego samego identyfikatora objectId. Użytkownicy mogą określić identyfikator "objectId" w treści żądania, aby uniknąć takich konfliktów.
objectId	string		Identyfikator obiektu docelowego określony przez użytkownika, który ma zostać utworzony na podstawie migawki.

Error

Treść błędu.

Nazwa	Typ	Opis
code	string
message	string

SnapshotApplyMode

Tryb stosowania migawki. Obecnie obsługiwane jest tylko polecenie CreateNew, co oznacza, że operacja stosowania zakończy się niepowodzeniem, jeśli subskrypcja docelowa zawiera już obiekt tego samego typu i używa tego samego identyfikatora objectId. Użytkownicy mogą określić identyfikator "objectId" w treści żądania, aby uniknąć takich konfliktów.

Nazwa	Typ	Opis
CreateNew	string