Liveness Session Operations - Get Liveness Session Result

Reference

Služba:: Azure AI Services

Verze rozhraní API:: v1.2-preview.1

Získejte výsledek relace volání detectLiveness/singleModal.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
endpoint	path	True	string (uri)	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://{název_prostředku}.cognitiveservices.azure.com).
sessionId	path	True	string	Jedinečné ID pro odkaz na tuto relaci.

Odpovědi

Name	Typ	Description
200 OK	LivenessSession	Požadavek byl úspěšný.
Other Status Codes	FaceErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

LivenessSession

Požadavek byl úspěšný.

Other Status Codes

FaceErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč předplatného Azure AI Face.

Typ: apiKey
V: header

AADToken

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://api.example.com/oauth2/authorize
URL tokenu: https://api.example.com/oauth2/token

Rozsahy

Name	Description
https://cognitiveservices.azure.com/.default

Příklady

Get LivenessSession Result

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
AuditLivenessResponseInfo	Auditovat položku pro odpověď v relaci.
AuditRequestInfo	Auditovat položku pro požadavek v relaci.
FaceError	Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpověď obsahující podrobnosti o chybě.
FaceRectangle	Obdélník, ve kterém lze najít tvář.
FaceSessionStatus	Aktuální stav relace.
ImageType	Typ obrázku.
LivenessDecision	Výsledek klasifikace aktivity.
LivenessModel	Verze modelu používaná pro klasifikaci aktivity.
LivenessOutputsTarget	Klasifikace aktivity pro cílovou tvář.
LivenessResponseBody	Tělo odpovědi volání rozhraní API pro detekci aktivity
LivenessSession	Výsledek relace detekce živé aktivity.
LivenessSessionAuditEntry	Auditovat položku požadavku v relaci.
LivenessWithVerifyImage	Podrobnosti o tváři pro ověření.
LivenessWithVerifyOutputs	Výstup ověření tváře.
QualityForRecognition	Označuje kvalitu obrázku pro rozpoznávání.

AuditLivenessResponseInfo

Objekt

Auditovat položku pro odpověď v relaci.

Name	Typ	Description
body	LivenessResponseBody	Tělo odpovědi. Schéma tohoto pole bude záviset na adrese request.url a request.method používané klientem.
latencyInMilliseconds	integer (int64)	Server měří latenci pro tento požadavek v milisekundách.
statusCode	integer (int32)	Stavový kód HTTP vrácený klientovi.

AuditRequestInfo

Objekt

Auditovat položku pro požadavek v relaci.

Name	Typ	Description
contentLength	integer (int64)	Délka textu požadavku v bajtech.
contentType	string	Typ obsahu požadavku.
method	string	Metoda HTTP požadavku (tj. GET, POST, DELETE).
url	string	Relativní adresa URL a dotaz žádosti o liveness.
userAgent	string	Uživatelský agent použitý k odeslání požadavku.

FaceError

Objekt

Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
message	string	Čitelné znázornění chyby člověkem.

FaceErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	FaceError	Objekt chyby.

FaceRectangle

Objekt

Obdélník, ve kterém lze najít tvář.

Name	Typ	Description
height	integer (int32)	Výška obdélníku v pixelech.
left	integer (int32)	Vzdálenost od levého okraje, pokud je obrázek na levém okraji obdélníku v pixelech.
top	integer (int32)	Vzdálenost od horního okraje, pokud je obrázek na horním okraji obdélníku v pixelech.
width	integer (int32)	Šířka obdélníku v pixelech.

FaceSessionStatus

Výčet

Aktuální stav relace.

Hodnota	Description
NotStarted	Relace nebyla spuštěna.
ResultAvailable	Relace má k dispozici výsledek.
Started	Relace se spustila.

ImageType

Výčet

Typ obrázku.

Hodnota	Description
Color	Barevný obrázek
Depth	Obrázek hloubky
Infrared	Infračervený obraz.

LivenessDecision

Výčet

Výsledek klasifikace aktivity.

Hodnota	Description
realface	Algoritmus klasifikoval cílovou tvář jako skutečnou.
spoofface	Algoritmus klasifikoval cílovou tvář jako falšování identity.
uncertain	Algoritmus nemohl klasifikovat cílovou tvář jako skutečnou ani jako falšování identity.

LivenessModel

Výčet

Verze modelu používaná pro klasifikaci aktivity.

Hodnota	Description
2022-10-15-preview.04
2023-12-20-preview.06

LivenessOutputsTarget

Objekt

Klasifikace aktivity pro cílovou tvář.

Name	Typ	Description
faceRectangle	FaceRectangle	Oblast tváře, ve které byla klasifikace aktivity provedena.
fileName	string	Název souboru, který obsahuje obdélník tváře, na kterém byla provedena klasifikace liveness.
imageType	ImageType	Typ obrázku, který obsahuje obdélník tváře, na kterém byla provedena klasifikace aktivity.
timeOffsetWithinFile	integer (int32)	Časový posun v souboru rámce, který obsahuje obdélník tváře, na kterém byla provedena klasifikace živé aktivity.

LivenessResponseBody

Objekt

Tělo odpovědi volání rozhraní API pro detekci aktivity

Name	Typ	Description
livenessDecision	LivenessDecision	Klasifikace aktivity pro cílovou tvář.
modelVersionUsed	LivenessModel	Verze modelu používaná pro klasifikaci aktivity.
target	LivenessOutputsTarget	Konkrétní cíle používané pro klasifikaci aktivity
verifyResult	LivenessWithVerifyOutputs	Výstup ověření tváře. K dispozici pouze v případech, kdy je žádost aktivní s ověřením.