Liveness Session Operations - Get Liveness With Verify Session Result

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Uzyskaj wynik sesji wywołania detectLivenessWithVerify/singleModal.

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions/{sessionId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiVersion	path	True	string	Wersja interfejsu API
endpoint	path	True	string uri	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://{nazwa-zasobu}.cognitiveservices.azure.com).
sessionId	path	True	string	Unikatowy identyfikator do odwołowania się do tej sesji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LivenessWithVerifySession	Żądanie zakończyło się pomyślnie.
Other Status Codes	FaceErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz tajny subskrypcji rozpoznawania twarzy w usłudze Azure AI.

Typ: apiKey
W: header

AADToken

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://api.example.com/oauth2/authorize
Adres URL tokenu: https://api.example.com/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get LivenessWithVerify Session Result

Przykładowe żądanie

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "createdDateTime": "2024-03-05T11:07:29.698Z",
  "sessionStartDateTime": "2024-03-05T11:07:29.698Z",
  "sessionExpired": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 600,
  "status": "NotStarted",
  "result": {
    "id": 4,
    "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "requestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "clientRequestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "receivedDateTime": "2024-03-05T11:07:29.698Z",
    "request": {
      "url": "/face/v1.2-preview.1/detectliveness/singlemodal",
      "method": "POST",
      "contentLength": 18,
      "contentType": "multipart/form-data",
      "userAgent": "Mozilla/5.0 (Linux) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Mobile Safari/537.36"
    },
    "response": {
      "body": {},
      "statusCode": 200,
      "latencyInMilliseconds": 1200
    },
    "digest": "1CC98BA83EAF1D0FF7F566FAEFCCCC787819FFA01251E2D9299143F7AD6651DB"
  }
}

Definicje

Nazwa	Opis
AuditLivenessResponseInfo	Przeprowadź inspekcję wpisu odpowiedzi w sesji.
AuditRequestInfo	Wpis inspekcji dla żądania w sesji.
FaceError	Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpowiedź zawierająca szczegóły błędu.
FaceRectangle	Prostokąt, w którym można znaleźć twarz.
FaceSessionStatus	Bieżący stan sesji.
ImageType	Typ obrazu.
LivenessDecision	Wynik klasyfikacji liveness.
LivenessModel	Wersja modelu używana do klasyfikacji aktualności.
LivenessOutputsTarget	Klasyfikacja liveness dla docelowej twarzy.
LivenessResponseBody	Treść odpowiedzi wywołania interfejsu API wykrywania aktualności.
LivenessSessionAuditEntry	Inspekcja wpisu żądania w sesji.
LivenessWithVerifyImage	Szczegóły twarzy na potrzeby weryfikacji.
LivenessWithVerifyOutputs	Dane wyjściowe weryfikacji twarzy.
LivenessWithVerifySession	Wynik sesji wykrywania aktualności przy użyciu weryfikacji.
QualityForRecognition	Wskazuje jakość obrazu do rozpoznawania.

AuditLivenessResponseInfo

Przeprowadź inspekcję wpisu odpowiedzi w sesji.

Nazwa	Typ	Opis
body	LivenessResponseBody	Treść odpowiedzi. Schemat tego pola będzie zależeć od metody request.url i request.method używanej przez klienta.
latencyInMilliseconds	integer	Serwer mierzył opóźnienie dla tego żądania w milisekundach.
statusCode	integer	Kod stanu HTTP zwrócony klientowi.

AuditRequestInfo

Wpis inspekcji dla żądania w sesji.

Nazwa	Typ	Opis
contentLength	integer	Długość treści żądania w bajtach.
contentType	string	Typ zawartości żądania.
method	string	Metoda HTTP żądania (tj. GET, POST, DELETE).
url	string	Względny adres URL i zapytanie dotyczące żądania aktualności.
userAgent	string	Agent użytkownika używany do przesyłania żądania.

FaceError

Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
message	string	Czytelna dla człowieka reprezentacja błędu.

FaceErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	FaceError	Obiekt błędu.

FaceRectangle

Prostokąt, w którym można znaleźć twarz.

Nazwa	Typ	Opis
height	integer	Wysokość prostokąta w pikselach.
left	integer	Odległość od lewej krawędzi, jeśli obraz do lewej krawędzi prostokąta w pikselach.
top	integer	Odległość od górnej krawędzi, jeśli obraz do górnej krawędzi prostokąta w pikselach.
width	integer	Szerokość prostokąta w pikselach.

FaceSessionStatus

Bieżący stan sesji.

Nazwa	Typ	Opis
NotStarted	string	Sesja nie została uruchomiona.
ResultAvailable	string	Sesja ma dostępny wynik.
Started	string	Sesja została rozpoczęta.

ImageType

Typ obrazu.

Nazwa	Typ	Opis
Color	string	Obraz kolorowy.
Depth	string	Obraz głębokości.
Infrared	string	Obraz podczerwieni.

LivenessDecision

Wynik klasyfikacji liveness.

Nazwa	Typ	Opis
realface	string	Algorytm sklasyfikował docelową twarz jako rzeczywistą.
spoofface	string	Algorytm sklasyfikował docelową twarz jako fałsz.
uncertain	string	Algorytm nie może sklasyfikować twarzy docelowej jako rzeczywistej lub fałszowania.

LivenessModel

Wersja modelu używana do klasyfikacji aktualności.

Nazwa	Typ	Opis
2022-10-15-preview.04	string
2023-12-20-preview.06	string

LivenessOutputsTarget

Klasyfikacja liveness dla docelowej twarzy.

Nazwa	Typ	Opis
faceRectangle	FaceRectangle	Region twarzy, w którym dokonano klasyfikacji liveness.
fileName	string	Nazwa pliku zawierająca prostokąt twarzy, na którym została wykonana klasyfikacja liveness.
imageType	ImageType	Typ obrazu zawierający prostokąt twarzy, na którym utworzono klasyfikację liveness.
timeOffsetWithinFile	integer	Przesunięcie czasu w pliku ramki zawierającej prostokąt twarzy, na którym została wykonana klasyfikacja liveness.

LivenessResponseBody

Treść odpowiedzi wywołania interfejsu API wykrywania aktualności.

Nazwa	Typ	Opis
livenessDecision	LivenessDecision	Klasyfikacja liveness dla docelowej twarzy.
modelVersionUsed	LivenessModel	Wersja modelu używana do klasyfikacji aktualności.
target	LivenessOutputsTarget	Określone obiekty docelowe używane do klasyfikacji dostępności.
verifyResult	LivenessWithVerifyOutputs	Dane wyjściowe weryfikacji twarzy. Dostępne tylko wtedy, gdy żądanie jest aktywne z weryfikacją.

LivenessSessionAuditEntry

Inspekcja wpisu żądania w sesji.

Nazwa	Typ	Opis
clientRequestId	string	Unikatowy identyfikator clientRequestId wysyłany przez klienta w nagłówku "client-request-id".
digest	string	Serwer obliczył skrót dla tego żądania. Jeśli raportowany skrót klienta różni się od skrótu obliczeniowego serwera, integralność komunikatów między klientem a usługą została naruszona, a wynik nie powinien być zaufany. Aby uzyskać więcej informacji, zobacz przewodniki dotyczące sposobu wykorzystania tej wartości w celu zabezpieczenia kompleksowego rozwiązania.
id	integer	Unikatowy identyfikator do odwoływania się do tego żądania inspekcji. Użyj tego identyfikatora z parametrem zapytania "start", aby przejść do następnej strony wyników inspekcji.
receivedDateTime	string	Data i godzina UTC odebrania żądania.
request	AuditRequestInfo	Żądanie tego wpisu.
requestId	string	Unikatowy identyfikator requestId zwracany przez usługę do klienta w nagłówku "apim-request-id".
response	AuditLivenessResponseInfo	Odpowiedź tego wpisu.
sessionId	string	Unikatowy identyfikator sessionId utworzonej sesji. Wygaśnie on 48 godzin po jego utworzeniu lub może zostać usunięty wcześniej przy użyciu odpowiedniej operacji DELETE sesji.
sessionImageId	string	Identyfikator obrazu żądania sesji.
verifyImageHash	string	Skrót sha256 obrazu weryfikacji w żądaniu.

LivenessWithVerifyImage

Szczegóły twarzy na potrzeby weryfikacji.

Nazwa	Typ	Opis
faceRectangle	FaceRectangle	Region twarzy, w którym utworzono klasyfikację obrazu porównania.
qualityForRecognition	QualityForRecognition	Jakość obrazu twarzy do rozpoznawania.

LivenessWithVerifyOutputs

Dane wyjściowe weryfikacji twarzy.

Nazwa	Typ	Opis
isIdentical	boolean	Czy docelowa twarz na żywo i porównanie twarzy są zgodne.
matchConfidence	number	Docelowa twarz na żywo twarzy i porównanie obrazu weryfikacja twarzy.
verifyImage	LivenessWithVerifyImage	Szczegóły twarzy na potrzeby weryfikacji.

LivenessWithVerifySession

Wynik sesji wykrywania aktualności przy użyciu weryfikacji.

Nazwa	Typ	Domyślna wartość	Opis
authTokenTimeToLiveInSeconds	integer	600	Sekundy sesji powinny trwać. Zakres wynosi od 60 do 86400 sekund. Wartość domyślna to 600.
createdDateTime	string		Data/godzina utworzenia tej sesji.
deviceCorrelationId	string		Unikatowy identyfikator GUID dla każdego urządzenia użytkownika końcowego. Ma to zapewnić ograniczenie szybkości i anty-młotek. Jeśli parametr "deviceCorrelationIdSetInClient" ma wartość true w tym żądaniu, ten parametr "deviceCorrelationId" musi mieć wartość null.
id	string		Unikatowy identyfikator do odwołowania się do tej sesji.
result	LivenessSessionAuditEntry		Najnowszy wynik inspekcji sesji został wypełniony tylko wtedy, gdy stan == "ResultAvailable".
sessionExpired	boolean		Bez względu na to, czy sesja wygasła.
sessionStartDateTime	string		Data/godzina rozpoczęcia tej sesji przez klienta.
status	FaceSessionStatus		Bieżący stan sesji.

QualityForRecognition

Wskazuje jakość obrazu do rozpoznawania.

Nazwa	Typ	Opis
high	string	Wysoka jakość.
low	string	Niska jakość.
medium	string	Średnia jakość.