Liveness Session Operations - Get Liveness With Verify Session Result

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

Sitzungsergebnis des detectLivenessWithVerify/singleModal-Aufrufs abrufen.

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/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	LivenessWithVerifySession	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 LivenessWithVerify Session Result

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
AuditLivenessResponseInfo	Überwachungseintrag für eine Antwort in der Sitzung.
AuditRequestInfo	Überwachungseintrag für eine Anforderung in der Sitzung.
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.
FaceSessionStatus	Der aktuelle Status der Sitzung.
ImageType	Der Typ des Bilds.
LivenessDecision	Das Ergebnis der Livenessklassifizierung.
LivenessModel	Die Modellversion, die für die Livenessklassifizierung verwendet wird.
LivenessOutputsTarget	Die Livenessklassifizierung für das Zielgesicht.
LivenessResponseBody	Der Antworttext des Aufrufs der Liveness-API.
LivenessSessionAuditEntry	Überwachungseintrag für eine Anforderung in einer Sitzung.
LivenessWithVerifyImage	Die Details des Gesichts zur Überprüfung.
LivenessWithVerifyOutputs	Die Ausgabe der Gesichtsüberprüfung.
LivenessWithVerifySession	Sitzungsergebnis der Erkennung von Liveität mit Überprüfung.
QualityForRecognition	Gibt die Qualität des Bilds für die Erkennung an.

AuditLivenessResponseInfo

Überwachungseintrag für eine Antwort in der Sitzung.

Name	Typ	Beschreibung
body	LivenessResponseBody	Der Antworttext. Das Schema dieses Felds hängt von der vom Client verwendeten Request.url und request.method ab.
latencyInMilliseconds	integer	Die Serverlatenz für diese Anforderung in Millisekunden gemessen.
statusCode	integer	Der HTTP-Statuscode, der an den Client zurückgegeben wird.

AuditRequestInfo

Überwachungseintrag für eine Anforderung in der Sitzung.

Name	Typ	Beschreibung
contentLength	integer	Die Länge des Anforderungstexts in Byte.
contentType	string	Der Inhaltstyp der Anforderung.
method	string	Die HTTP-Methode der Anforderung (z. B. GET, POST, DELETE).
url	string	Die relative URL und Abfrage der Liveness-Anforderung.
userAgent	string	Der Benutzer-Agent, der zum Übermitteln der Anforderung verwendet wurde.

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.

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

FaceErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.

FaceRectangle

Ein Rechteck, in dem ein Gesicht gefunden werden kann.

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

FaceSessionStatus

Der aktuelle Status der Sitzung.

Name	Typ	Beschreibung
NotStarted	string	Die Sitzung wurde nicht gestartet.
ResultAvailable	string	Die Sitzung hat ein verfügbares Ergebnis.
Started	string	Die Sitzung wurde gestartet.

ImageType

Der Typ des Bilds.

Name	Typ	Beschreibung
Color	string	Farbbild.
Depth	string	Tiefenbild.
Infrared	string	Infrarotbild.

LivenessDecision

Das Ergebnis der Livenessklassifizierung.

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

LivenessModel

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

Name	Typ	Beschreibung
2022-10-15-preview.04	string
2023-12-20-preview.06	string

LivenessOutputsTarget

Die Livenessklassifizierung für das Zielgesicht.

Name	Typ	Beschreibung
faceRectangle	FaceRectangle	Die Gesichtsregion, in der die Livenessklassifizierung vorgenommen wurde.
fileName	string	Der Dateiname, der das Gesichtsrechteck enthält, an dem die Livenessklassifizierung vorgenommen wurde.
imageType	ImageType	Der Bildtyp, der das Gesichtsrechteck enthält, auf dem die Livenessklassifizierung vorgenommen wurde.
timeOffsetWithinFile	integer	Der Zeitversatz innerhalb der Datei des Frames, das das Gesichtsrechteck enthält, auf dem die Livenessklassifizierung vorgenommen wurde.

LivenessResponseBody

Der Antworttext des Aufrufs der Liveness-API.

Name	Typ	Beschreibung
livenessDecision	LivenessDecision	Die Livenessklassifizierung für das Zielgesicht.
modelVersionUsed	LivenessModel	Die Modellversion, die für die Livenessklassifizierung verwendet wird.
target	LivenessOutputsTarget	Spezifische Ziele, die für die Livenessklassifizierung verwendet werden.
verifyResult	LivenessWithVerifyOutputs	Die Ausgabe der Gesichtsüberprüfung. Nur verfügbar, wenn die Anforderung live ist und überprüft wird.

LivenessSessionAuditEntry

Überwachungseintrag für eine Anforderung in einer Sitzung.

Name	Typ	Beschreibung
clientRequestId	string	Die eindeutige clientRequestId, die vom Client im Header "client-request-id" gesendet wird.
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.
id	integer	Die eindeutige ID, die auf diese Überwachungsanforderung verweist. Verwenden Sie diese ID mit dem Abfrageparameter "start", um mit der nächsten Seite der Überwachungsergebnisse fortzufahren.
receivedDateTime	string	Die UTC DateTime, zu der die Anforderung empfangen wurde.
request	AuditRequestInfo	Die Anforderung dieses Eintrags.
requestId	string	Die eindeutige requestId, die vom Dienst an den Client im Header "apim-request-id" zurückgegeben wird.
response	AuditLivenessResponseInfo	Die Antwort dieses Eintrags.
sessionId	string	Die eindeutige sessionId der erstellten Sitzung. Es läuft 48 Stunden nach der Erstellung ab oder kann früher mithilfe des entsprechenden Session DELETE-Vorgangs gelöscht werden.
sessionImageId	string	Die Bild-ID der Sitzungsanforderung.
verifyImageHash	string	Der Sha256-Hash des Prüfbilds in der Anforderung.

LivenessWithVerifyImage

Die Details des Gesichts zur Überprüfung.

Name	Typ	Beschreibung
faceRectangle	FaceRectangle	Der Gesichtsbereich, in dem die Klassifizierung des Vergleichsbilds vorgenommen wurde.
qualityForRecognition	QualityForRecognition	Qualität des Gesichtsbilds für die Erkennung.

LivenessWithVerifyOutputs

Die Ausgabe der Gesichtsüberprüfung.

Name	Typ	Beschreibung
isIdentical	boolean	Gibt an, ob die Ziel-Liveness-Gesichts- und Vergleichsbild-Gesichtsvergleiche übereinstimmen.
matchConfidence	number	Das Zielgesichts-Gesicht und das Vergleichsbild der Überprüfungssicherheit.
verifyImage	LivenessWithVerifyImage	Die Details des Gesichts zur Überprüfung.

LivenessWithVerifySession

Sitzungsergebnis der Erkennung von Liveität mit Überprüfung.

Name	Typ	Standardwert	Beschreibung
authTokenTimeToLiveInSeconds	integer	600	Sekunden, für die die Sitzung dauern sollte. Der Bereich beträgt 60 bis 86400 Sekunden. Der Standardwert ist 600.
createdDateTime	string		DateTime, als diese Sitzung erstellt wurde.
deviceCorrelationId	string		Eindeutige GUID pro Endbenutzergerät. Dies ist die Bereitstellung von Zinsbegrenzungen und Anti-Hammering. Wenn "deviceCorrelationIdSetInClient" in dieser Anforderung "true" ist, muss diese "deviceCorrelationId" null sein.
id	string		Die eindeutige ID, die auf diese Sitzung verweist.
result	LivenessSessionAuditEntry		Das neueste Sitzungsüberwachungsergebnis wird nur aufgefüllt, wenn status == 'ResultAvailable'.
sessionExpired	boolean		Gibt an, ob die Sitzung abgelaufen ist.
sessionStartDateTime	string		DateTime, als diese Sitzung vom Client gestartet wurde.
status	FaceSessionStatus		Der aktuelle Status der Sitzung.

QualityForRecognition

Gibt die Qualität des Bilds für die Erkennung an.

Name	Typ	Beschreibung
high	string	Hochwertige.
low	string	Niedrige Qualität.
medium	string	Mittlere Qualität.