Liveness Session Operations - Create Liveness Session

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

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/singleModal/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	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.
livenessSingleModalModel		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.
sendResultsToClient		boolean	Gibt an, ob ein Antworttext vom Typ "200 - Success" an den Client gesendet werden soll, der aus Sicherheitsgründen möglicherweise nicht erwünscht ist. Der Standardwert ist "false", Clients erhalten eine leere Textantwort "204 - NoContent". Unabhängig von der Auswahl enthält das Aufrufen von Session GetResult immer einen Antworttext, der die Implementierung von Geschäftslogik ermöglicht.

Antworten

Name	Typ	Beschreibung
200 OK	CreateLivenessSessionResult	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-preview.1/detectLiveness/singleModal/sessions

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

Beispiel für eine Antwort

Statuscode:

200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm"
}

Definitionen

Name	Beschreibung
CreateLivenessSessionContent	Anforderungsmodell zum Erstellen von Livenesssitzungen.
CreateLivenessSessionResult	Antwort auf die Erstellung 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.
LivenessModel	Die Modellversion, die für die Livenessklassifizierung verwendet wird.
LivenessOperationMode	Der Liveness-Vorgangsmodus, um die Endbenutzerumgebung des Clients zu steuern.

CreateLivenessSessionContent

Anforderungsmodell zum Erstellen von Livenesssitzungen.

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.
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.
livenessOperationMode	LivenessOperationMode		Der Typ des Livenessmodus, dem der Client folgen soll.
livenessSingleModalModel	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.
sendResultsToClient	boolean		Gibt an, ob ein Antworttext vom Typ "200 - Success" an den Client gesendet werden soll, der aus Sicherheitsgründen möglicherweise nicht erwünscht ist. Der Standardwert ist "false", Clients erhalten eine leere Textantwort "204 - NoContent". Unabhängig von der Auswahl enthält das Aufrufen von Session GetResult immer einen Antworttext, der die Implementierung von Geschäftslogik ermöglicht.

CreateLivenessSessionResult

Antwort auf die Erstellung von Livenesssitzungen.

Name	Typ	Beschreibung
authToken	string	Bearertoken zum Bereitstellen der Authentifizierung für das Vision SDK, das auf einer Clientanwendung ausgeführt wird. Dieses Bearertoken verfügt über eingeschränkte Berechtigungen, um nur die erforderliche Aktion auszuführen und nach der TTL-Zeit abläuft. Es ist auch auditierbar.
sessionId	string	Die eindeutige Sitzungs-ID 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.

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.

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

LivenessOperationMode

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

Name	Typ	Beschreibung
Passive	string	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	string	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.