Liveness Session Operations - Get Liveness Session Result

Referenz

Dienst:: Azure AI Services

API-Version:: v1.2

Abrufen des Sitzungsergebnisses des DetectLiveness/singleModal-Aufrufs.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiVersion	path	True	string	API-Version
endpoint	path	True	string (uri)	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://{resource-name}.cognitiveservices.azure.com).
sessionId	path	True	string	Die eindeutige ID, die auf diese Sitzung verweist.

Antworten

Name	Typ	Beschreibung
200 OK	LivenessSession	Die Anforderung ist erfolgreich.
Other Status Codes	FaceErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

LivenessSession

Die Anforderung ist erfolgreich.

Other Status Codes

FaceErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure AI Face-Abonnement.

Typ: apiKey
In: header

AADToken

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://api.example.com/oauth2/authorize
Token-URL: https://api.example.com/oauth2/token

Bereiche

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

Beispiele

Get LivenessSession Result

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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
              }
            }
          }
        }
      }
    ]
  }
}

Definitionen

Name	Beschreibung
FaceError	Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, die vom Face Service zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Eine Antwort, die Fehlerdetails enthält.
FaceRectangle	Ein Rechteck, in dem ein Gesicht gefunden werden kann.
LivenessColorDecisionTarget	Das Ziel des Farbbilds, das für die Livenessklassifizierung verwendet wird.
LivenessDecision	Das Ergebnis der Livenessklassifizierung.
LivenessDecisionTargets	Die für die Livenessklassifizierung verwendeten Ziele.
LivenessError	Der Fehler der Livenessklassifizierung.
LivenessModel	Die Modellversion, die für die Livenessklassifizierung verwendet wird.
LivenessResult	Die Ergebnisse der Livenessklassifizierung.
LivenessSession	Sitzungsergebnis der Erkennung von Liveität.
LivenessSessionAttempt	Der Liveness-Sitzungsversuch.
LivenessSessionResults	Die Ergebnisse der Liveness-Sitzung.
OperationState	Der aktuelle Status der Sitzung.

FaceError

Objekt

Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, die vom Face Service zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
message	string	Eine lesbare Darstellung des Fehlers.

FaceErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.

FaceRectangle

Objekt

Ein Rechteck, in dem ein Gesicht gefunden werden kann.

Name	Typ	Beschreibung
height	integer (int32)	Die Höhe des Rechtecks in Pixel.
left	integer (int32)	Der Abstand vom linken Rand, wenn das Bild zum linken Rand des Rechtecks in Pixeln angezeigt wird.
top	integer (int32)	Der Abstand vom oberen Rand, wenn das Bild zum oberen Rand des Rechtecks in Pixeln liegt.
width	integer (int32)	Die Breite des Rechtecks in Pixel.

LivenessColorDecisionTarget

Objekt

Das Ziel des Farbbilds, das für die Livenessklassifizierung verwendet wird.

Name	Typ	Beschreibung
faceRectangle	FaceRectangle	Die Gesichtsregion, in der die Livenessklassifizierung vorgenommen wurde.

LivenessDecision

Enumeration

Das Ergebnis der Livenessklassifizierung.

Wert	Beschreibung
realface	Der Algorithmus hat das Zielgesicht als real klassifiziert.
spoofface	Der Algorithmus hat das Zielgesicht als Spoof klassifiziert.
uncertain	Der Algorithmus konnte das Zielgesicht weder als real noch als Spoof klassifizieren.

LivenessDecisionTargets

Objekt

Die für die Livenessklassifizierung verwendeten Ziele.

Name	Typ	Beschreibung
color	LivenessColorDecisionTarget	Das Ziel des Farbbilds, das für die Livenessklassifizierung verwendet wird.

LivenessError

Objekt

Der Fehler der Livenessklassifizierung.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
targets	LivenessDecisionTargets	Ziele, die für die Livenessklassifizierung verwendet werden.

LivenessModel

Enumeration

Die Modellversion, die für die Livenessklassifizierung verwendet wird.

Wert	Beschreibung
2024-11-15

LivenessResult

Objekt

Die Ergebnisse der Livenessklassifizierung.

Name	Typ	Beschreibung
digest	string	Der vom Server berechnete Digest für diese Anforderung. Wenn sich der vom Client gemeldete Digest vom vom Server berechneten Digest unterscheidet, wurde die Nachrichtenintegrität zwischen Client und Dienst kompromittiert, und das Ergebnis sollte nicht vertrauenswürdig sein. Weitere Informationen finden Sie in anleitungen zum Nutzen dieses Werts, um Ihre End-to-End-Lösung zu sichern.
livenessDecision	LivenessDecision	Die Livenessklassifizierung für das Zielgesicht.
sessionImageId	string	Die Bild-ID der Sitzungsanforderung.
targets	LivenessDecisionTargets	Ziele, die für die Livenessklassifizierung verwendet werden.