Liveness Session Operations - Get Liveness Session Audit Entries

Dienst:

Azure AI Services

API-Version:

v1.1-preview.1

Ruft Sitzungsanforderungen und Antworttext für die Sitzung ab.

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

Mit optionalen Parametern:

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions/{sessionId}/audit?start={start}&top={top}

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.
start	query		string	Listen Sie Ressourcen auf, die größer als "start" sind. Sie enthält nicht mehr als 64 Zeichen. Der Standardwert ist leer.
top	query		integer int32	Die Anzahl der auflistenden Elemente im Bereich [1, 1000]. Der Standard ist 1000.

Antworten

Name	Typ	Beschreibung
200 OK	LivenessSessionAuditEntry[]	Die Anforderung war erfolgreich.
Other Status Codes	FaceErrorResponse	Eine unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure KI-Gesichtserkennungsabonnement.

Typ: apiKey
In: header

AADToken

Der Azure Active Directory OAuth2-Flow

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 Audit Entries

Beispielanforderung

HTTP

GET {endpoint}/face/v1.1-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e/audit?start=0&top=20

Beispiel für eine Antwort

Statuscode:

200

[
  {
    "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.1-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 Meldungen, die vom Gesichtserkennungsdienst 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.
ImageType	Der Typ des Bilds.
LivenessDecision	Das Ergebnis der Live-Klassifizierung.
LivenessModel	Die Modellversion, die für die Live-Klassifizierung verwendet wird.
LivenessOutputsTarget	Die Liveheitsklassifizierung für das Zielgesicht.
LivenessResponseBody	Der Antworttext des API-Aufrufs zur Erkennung der Liveität.
LivenessSessionAuditEntry	Überwachungseintrag für eine Anforderung in einer Sitzung.
LivenessWithVerifyImage	Das Detail des Gesichts zur Überprüfung.
LivenessWithVerifyOutputs	Die Ausgabe der Gesichtsü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 request.url und der request.method ab, die vom Client verwendet werden.
latencyInMilliseconds	integer	Der Server hat die Latenz für diese Anforderung in Millisekunden gemessen.
statusCode	integer	Der HTTP-status Code, 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 Bytes.
contentType	string	Der Inhaltstyp der Anforderung.
method	string	Die HTTP-Methode der Anforderung (d. h. GET, POST, DELETE).
url	string	Die relative URL und Abfrage der Live-Anforderung.
userAgent	string	Der Benutzer-Agent, der zum Übermitteln der Anforderung verwendet wird.

FaceError

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

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz 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 angezeigt wird.
width	integer	Die Breite des Rechtecks in Pixel.

ImageType

Der Typ des Bilds.

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

LivenessDecision

Das Ergebnis der Live-Klassifizierung.

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 nicht als real oder spoof klassifizieren.

LivenessModel

Die Modellversion, die für die Live-Klassifizierung verwendet wird.

Name	Typ	Beschreibung
2020-02-15-preview.01	string
2021-11-12-preview.03	string
2022-10-15-preview.04	string
2023-03-02-preview.05	string

LivenessOutputsTarget

Die Liveheitsklassifizierung für das Zielgesicht.

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

LivenessResponseBody

Der Antworttext des API-Aufrufs zur Erkennung der Liveität.

Name	Typ	Beschreibung
livenessDecision	LivenessDecision	Die Liveheitsklassifizierung für das Zielgesicht.
modelVersionUsed	LivenessModel	Die Modellversion, die für die Live-Klassifizierung verwendet wird.
target	LivenessOutputsTarget	Bestimmte Ziele, die für die Live-Klassifizierung verwendet werden.
verifyResult	LivenessWithVerifyOutputs	Die Ausgabe der Gesichtsüberprüfung. Nur verfügbar, wenn die Anforderung live mit verify ist.

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 berechnete Server-Digest für diese Anforderung. Wenn sich der vom Client gemeldete Digest vom vom Server berechneten Digest unterscheidet, wurde die Nachrichtenintegrität zwischen dem Client und dem Dienst kompromittiert, und das Ergebnis sollte nicht vertrauenswürdig sein. Weitere Informationen finden Sie unter Anleitungen zum Nutzen dieses Werts, um Ihre End-to-End-Lösung zu schützen.
id	integer	Die eindeutige ID, die auf diese Überwachungsanforderung verweisen soll. Verwenden Sie diese ID mit dem Abfrageparameter "start", um mit der nächsten Seite der Überwachungsergebnisse fortzufahren.
receivedDateTime	string	Die UTC-DateTime, die die Anforderung empfangen hat.
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. Sie läuft 48 Stunden nach der Erstellung ab oder kann mithilfe des entsprechenden DELETE-Vorgangs der Sitzung früher gelöscht werden.

LivenessWithVerifyImage

Das Detail 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 das Ziellebensgesicht und das Vergleichsbildgesicht übereinstimmen.
matchConfidence	number	Die Zuverlässigkeit der Zielgesichtserkennung und der Vergleichsbild-Gesichtsüberprüfung.
verifyImage	LivenessWithVerifyImage	Das Detail des Gesichts zur Überprüfung.

QualityForRecognition

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

Name	Typ	Beschreibung
high	string	Hohe Qualität.
low	string	Geringe Qualität.
medium	string	Mittlere Qualität.