Liveness Session Operations - Get Liveness Session Result

Reference

Služba:: Azure AI Services

Verze rozhraní API:: v1.2

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

GET {endpoint}/face/{apiVersion}/detectLiveness-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/detectLiveness-sessions/b12e033e-bda7-4b83-a211-e721c661f30e

Ukázková odpověď

Stavový kód:: 200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm",
  "status": "NotStarted",
  "modelVersion": "2024-11-15",
  "results": {
    "attempts": [
      {
        "attemptId": 2,
        "attemptStatus": "Succeeded",
        "result": {
          "livenessDecision": "realface",
          "targets": {
            "color": {
              "faceRectangle": {
                "top": 669,
                "left": 203,
                "width": 646,
                "height": 724
              }
            }
          },
          "digest": "B0A803BB7B26F3C8F29CD36030F8E63ED3FAF955FEEF8E01C88AB8FD89CCF761",
          "sessionImageId": "Ae3PVWlXAmVAnXgkAFt1QSjGUWONKzWiSr2iPh9p9G4I"
        }
      },
      {
        "attemptId": 1,
        "attemptStatus": "Failed",
        "error": {
          "code": "FaceWithMaskDetected",
          "message": "Mask detected on face image.",
          "targets": {
            "color": {
              "faceRectangle": {
                "top": 669,
                "left": 203,
                "width": 646,
                "height": 724
              }
            }
          }
        }
      }
    ]
  }
}

Definice

Name	Description
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ář.
LivenessColorDecisionTarget	Cíl z barevného obrázku použitého pro klasifikaci živé aktivity.
LivenessDecision	Výsledek klasifikace aktivity.
LivenessDecisionTargets	Cíle používané pro klasifikaci aktivity.
LivenessError	Chyba klasifikace aktivity.
LivenessModel	Verze modelu používaná pro klasifikaci aktivity.
LivenessResult	Výsledky klasifikace aktivity.
LivenessSession	Výsledek relace detekce živé aktivity.
LivenessSessionAttempt	Pokus o relaci živé aktivity.
LivenessSessionResults	Výsledky relace živé aktivity.
OperationState	Aktuální stav relace.

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.

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

FaceErrorResponse

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

Name	Typ	Description
error	FaceError	Objekt chyby.

FaceRectangle

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

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

LivenessColorDecisionTarget

Cíl z barevného obrázku použitého pro klasifikaci živé aktivity.

Name	Typ	Description
faceRectangle	FaceRectangle	Oblast tváře, ve které byla klasifikace aktivity provedena.

LivenessDecision

Výsledek klasifikace aktivity.

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

LivenessDecisionTargets

Cíle používané pro klasifikaci aktivity.

Name	Typ	Description
color	LivenessColorDecisionTarget	Cíl z barevného obrázku použitého pro klasifikaci živé aktivity.

LivenessError

Chyba klasifikace aktivity.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.
targets	LivenessDecisionTargets	Cíle používané pro klasifikaci aktivity

LivenessModel

Verze modelu používaná pro klasifikaci aktivity.

Name	Typ	Description
2024-11-15	string

LivenessResult

Výsledky klasifikace aktivity.

Name	Typ	Description
digest	string	Server vypočítal hodnotu hash pro tento požadavek. Pokud se hodnota hash hlášeného klientem liší od počítané hodnoty hash serveru, došlo k ohrožení integrity zpráv mezi klientem a službou a výsledek by neměl být důvěryhodný. Další informace najdete v průvodcích, jak tuto hodnotu využít k zabezpečení kompletního řešení.
livenessDecision	LivenessDecision	Klasifikace aktivity pro cílovou tvář.
sessionImageId	string	ID image žádosti o relaci.
targets	LivenessDecisionTargets	Cíle používané pro klasifikaci aktivity