Liveness Session Operations - Create Liveness Session

Referenz

Dienst:: Azure AI Services

API-Version:: v1.2

Erstellen Sie eine neue Erkennungs-Liveness-Sitzung.
Eine Sitzung eignet sich am besten für Clientgeräteszenarien, in denen Entwickler ein Clientgerät autorisieren möchten, nur eine Livenesserkennung durchzuführen, ohne vollzugriff auf ihre Ressource zu gewähren. Erstellte Sitzungen haben eine begrenzte Lebensdauer und autorisieren nur Clients, die gewünschte Aktion auszuführen, bevor der Zugriff abgelaufen ist.

Berechtigungen umfassen...

- Fähigkeit, /detectLiveness/singleModal für bis zu 3 Wiederholungen aufzurufen.
- Eine Tokenlebensdauer von 10 Minuten.

Anmerkung

Der Clientzugriff kann widerrufen werden, indem die Sitzung mithilfe des Vorgangs "Liveness-Sitzung löschen" gelöscht wird. Verwenden Sie zum Abrufen eines Ergebnisses die Get Liveness Session. Um die einzelnen Anforderungen zu überwachen, die ein Client an Ihrer Ressource vorgenommen hat, verwenden Sie die Listen-Liveness-Sitzungsüberwachungseinträge.

POST {endpoint}/face/{apiVersion}/detectLiveness-sessions

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).

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
livenessOperationMode	True	LivenessOperationMode	Der Typ des Livenessmodus, dem der Client folgen soll.
authTokenTimeToLiveInSeconds		integer (int32) minimum: 60 maximum: 86400	Sekunden, für die die Sitzung dauern sollte. Der Bereich beträgt 60 bis 86400 Sekunden. Der Standardwert ist 600.
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.
deviceCorrelationIdSetInClient		boolean	Gibt an, ob der Client seine eigene "deviceCorrelationId" über das Vision SDK festlegen darf. Der Standardwert ist "false", und "deviceCorrelationId" muss in diesem Anforderungstext festgelegt werden.
enableSessionImage		boolean	Gibt an, ob das Sitzungsbild gespeichert wird.
livenessModelVersion		LivenessModel	Die Modellversion, die für die Livenessklassifizierung verwendet wird. Dies ist ein optionaler Parameter, und wenn dies nicht angegeben ist, wird die neueste unterstützte Modellversion ausgewählt.

Antworten

Name	Typ	Beschreibung
200 OK	LivenessSession	Ein erfolgreicher Aufruf erstellt eine Sitzung für ein Clientgerät und stellt ein Autorisierungstoken für die Verwendung durch die Clientanwendung für einen begrenzten Zweck und eine begrenzte Zeit bereit.
Other Status Codes	FaceErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

LivenessSession

Ein erfolgreicher Aufruf erstellt eine Sitzung für ein Clientgerät und stellt ein Autorisierungstoken für die Verwendung durch die Clientanwendung für einen begrenzten Zweck und eine begrenzte Zeit bereit.

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

Create Liveness Session

Beispielanforderung

HTTP

POST {endpoint}/face/v1.2/detectLiveness-sessions

{
  "livenessOperationMode": "Passive",
  "deviceCorrelationIdSetInClient": false,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 60
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm",
  "status": "NotStarted",
  "modelVersion": "2024-11-15",
  "results": {
    "attempts": []
  }
}

Definitionen

Name	Beschreibung
CreateLivenessSessionContent	Anforderungsmodell zum Erstellen von Livenesssitzungen.
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.
LivenessOperationMode	Der Liveness-Vorgangsmodus, um die Endbenutzerumgebung des Clients zu steuern.
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.

CreateLivenessSessionContent

Objekt

Anforderungsmodell zum Erstellen von Livenesssitzungen.

Name	Typ	Standardwert	Beschreibung
authTokenTimeToLiveInSeconds	integer (int32) minimum: 60 maximum: 86400	600	Sekunden, für die die Sitzung dauern sollte. Der Bereich beträgt 60 bis 86400 Sekunden. Der Standardwert ist 600.
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.
deviceCorrelationIdSetInClient	boolean		Gibt an, ob der Client seine eigene "deviceCorrelationId" über das Vision SDK festlegen darf. Der Standardwert ist "false", und "deviceCorrelationId" muss in diesem Anforderungstext festgelegt werden.
enableSessionImage	boolean		Gibt an, ob das Sitzungsbild gespeichert wird.
livenessModelVersion	LivenessModel		Die Modellversion, die für die Livenessklassifizierung verwendet wird. Dies ist ein optionaler Parameter, und wenn dies nicht angegeben ist, wird die neueste unterstützte Modellversion ausgewählt.
livenessOperationMode	LivenessOperationMode		Der Typ des Livenessmodus, dem der Client folgen soll.

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

LivenessOperationMode

Enumeration

Der Liveness-Vorgangsmodus, um die Endbenutzerumgebung des Clients zu steuern.

Wert	Beschreibung
Passive	Verwendet eine passive Liveness-Technik, die keine zusätzlichen Aktionen des Benutzers erfordert. Erfordert normale Innenbeleuchtung und hohe Bildschirmhelligkeit für optimale Leistung. Und damit hat dieser Modus einen schmalen Betriebsumschlag und eignet sich nicht für Szenarien, die erfordern, dass der Endbenutzer in hellen Lichtverhältnissen sein muss. Hinweis: Dies ist der einzige unterstützte Modus für die Mobile-Lösung (iOS und Android).
PassiveActive	Dieser Modus verwendet eine hybride passive oder aktive Liveness-Technik, die die Zusammenarbeit der Benutzer erfordert. Es ist so optimiert, dass aktive Bewegung nur unter suboptimalen Beleuchtungsbedingungen erforderlich ist. Im Gegensatz zum passiven Modus hat dieser Modus keine Beleuchtungseinschränkungen und bietet somit einen breiteren Betriebsumschlag. Dieser Modus ist auf webbasierten Lösungen vorzuziehen, da keine automatische Bildschirmhelligkeitskontrolle in Browsern verfügbar ist, die den Betriebsumschlag des passiven Modus auf webbasierten Lösungen behindern.

Wert

Beschreibung

Passive

Verwendet eine passive Liveness-Technik, die keine zusätzlichen Aktionen des Benutzers erfordert. Erfordert normale Innenbeleuchtung und hohe Bildschirmhelligkeit für optimale Leistung. Und damit hat dieser Modus einen schmalen Betriebsumschlag und eignet sich nicht für Szenarien, die erfordern, dass der Endbenutzer in hellen Lichtverhältnissen sein muss. Hinweis: Dies ist der einzige unterstützte Modus für die Mobile-Lösung (iOS und Android).

PassiveActive

Dieser Modus verwendet eine hybride passive oder aktive Liveness-Technik, die die Zusammenarbeit der Benutzer erfordert. Es ist so optimiert, dass aktive Bewegung nur unter suboptimalen Beleuchtungsbedingungen erforderlich ist. Im Gegensatz zum passiven Modus hat dieser Modus keine Beleuchtungseinschränkungen und bietet somit einen breiteren Betriebsumschlag. Dieser Modus ist auf webbasierten Lösungen vorzuziehen, da keine automatische Bildschirmhelligkeitskontrolle in Browsern verfügbar ist, die den Betriebsumschlag des passiven Modus auf webbasierten Lösungen behindern.

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.