Snapshot - Take

Usługa:

Azure AI Services

Wersja interfejsu API:

1.0-preview

Prześlij operację, aby utworzyć migawkę listy twarzy, dużej listy twarzy, grupy osób lub grupy dużej osoby, z określonym przez użytkownika typem migawki, identyfikatorem obiektu źródłowego, zastosowaniem zakresu i opcjonalnymi danymi użytkownika.
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.
Tworzenie migawki jest operacją asynchroniczną. Identyfikator operacji można uzyskać z pola "Operation-Location" w nagłówku odpowiedzi, które ma być używane w operationStatus — pobierz w celu śledzenia postępu tworzenia migawki. Identyfikator migawki zostanie uwzględniony w polu "resourceLocation" w obszarze OperationStatus — pobierz odpowiedź, gdy stan operacji to "Powodzenie".
Czas wykonywania migawki zależy od liczby wpisów osoby i twarzy w obiekcie źródłowym. Może to być w sekundach lub do kilku godzin 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. Użytkownik może usunąć migawkę przy użyciu migawki — usuń je samodzielnie w dowolnym momencie przed wygaśnięciem.
Utworzenie migawki dla określonego obiektu nie spowoduje zablokowania żadnych innych operacji względem obiektu. Wszystkie operacje tylko do odczytu (Get/List i Identify/FindSimilar/Verify) można przeprowadzać w zwykły sposób. W przypadku wszystkich operacji zapisywalnych, w tym dodawania/aktualizowania/usuwania obiektu źródłowego lub jego osób/twarzy i trenowania, nie są blokowane, ale niezalecane, ponieważ aktualizacje z możliwością zapisu mogą nie zostać odzwierciedlone na migawki podczas jego wykonywania. Po zakończeniu tworzenia migawki wszystkie operacje z możliwością odczytu i zapisu mogą działać normalnie. Migawka będzie również zawierać 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.

• Limit przydziału subskrypcji w warstwie Bezpłatna: 100 operacji na miesiąc.
• Limit przydziału subskrypcji warstwy S0: 100 operacji podejmowania dziennie.

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

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).

Nagłówek żądania

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

Treść żądania

Nazwa	Wymagane	Typ	Opis
applyScope	True	string[]	Tablica docelowych identyfikatorów subskrypcji rozpoznawania twarzy dla migawki została określona przez użytkownika. Dla każdej migawki można zastosować tylko subskrypcje uwzględnione w stoszakresie migawek .
objectId	True	string	Identyfikator obiektu źródłowego określony przez użytkownika do tworzenia migawki.
type	True	SnapshotObjectType	Użytkownik określił typ obiektu źródłowego do wykonania migawki. Obecnie obsługiwane są funkcje FaceList, PersonGroup, LargeFaceList i LargePersonGroup.
userData		string	Użytkownik określił dane dotyczące migawki w dowolnym celu. Długość nie powinna przekraczać 16 KB.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Zadanie tworzenia 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

Take a snapshot example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

202

Definicje

Nazwa	Opis
APIError	Informacje o błędzie zwrócone przez interfejs API
Error	Treść błędu.
SnapshotObjectType	Typ obiektu źródłowego w migawce określony przez subskrybenta, który utworzył migawkę podczas wywoływania migawki — Wykonaj. Obecnie obsługiwane są funkcje FaceList, PersonGroup, LargeFaceList i LargePersonGroup.
TakeSnapshotRequest	Treść żądania dotycząca wykonywania operacji migawki.

APIError

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

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

Error

Treść błędu.

Nazwa	Typ	Opis
code	string
message	string

SnapshotObjectType

Typ obiektu źródłowego w migawce określony przez subskrybenta, który utworzył migawkę podczas wywoływania migawki — Wykonaj. Obecnie obsługiwane są funkcje FaceList, PersonGroup, LargeFaceList i LargePersonGroup.

Nazwa	Typ	Opis
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

TakeSnapshotRequest

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

Nazwa	Typ	Opis
applyScope	string[]	Tablica docelowych identyfikatorów subskrypcji rozpoznawania twarzy dla migawki została określona przez użytkownika. Dla każdej migawki można zastosować tylko subskrypcje uwzględnione w stoszakresie migawek .
objectId	string	Identyfikator obiektu źródłowego określony przez użytkownika do tworzenia migawki.
type	SnapshotObjectType	Użytkownik określił typ obiektu źródłowego do wykonania migawki. Obecnie obsługiwane są funkcje FaceList, PersonGroup, LargeFaceList i LargePersonGroup.
userData	string	Użytkownik określił dane dotyczące migawki w dowolnym celu. Długość nie powinna przekraczać 16 KB.