Liveness Session Operations - Create Liveness With Verify Session With Verify Image

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

Erstellen Sie eine neue Liveness-Sitzung mit "verify". Stellen Sie das Überprüfungsbild während der Sitzungserstellung bereit.
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, /detectLivenessWithVerify/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 mit Sitzung überprüfen" gelöscht wird.
  • Verwenden Sie zum Abrufen eines Ergebnisses die Get Liveness With Verify Session.
  • Um die einzelnen Anforderungen zu überwachen, die ein Client an Ihrer Ressource vorgenommen hat, verwenden Sie die Listen liveness With Verify Session Audit Entries.

Empfohlene Option: VerifyImage wird während der Sitzungserstellung bereitgestellt.

POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Parameters	formData	True	string	Die Parameter zum Erstellen einer Sitzung.
VerifyImage	formData	True	file	Der Bilddatenstrom zur Überprüfung. Das Feld "Content-Disposition"-Kopfzeile für diesen Teil muss den Dateinamen aufweisen.
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).

Antworten

Name	Typ	Beschreibung
200 OK	CreateLivenessWithVerifySessionResult	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 LivenessWithVerify Session with VerifyImage

Beispielanforderung

HTTP

POST {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions

Beispiel für eine Antwort

Statuscode:

200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm",
  "verifyImage": {
    "faceRectangle": {
      "width": 78,
      "height": 78,
      "left": 394,
      "top": 54
    },
    "qualityForRecognition": "high"
  }
}

Definitionen

Name	Beschreibung
CreateLivenessWithVerifySessionResult	Antwort der Liveness-Sitzung mit überprüfungserstellung mit bereitgestellter Bestätigungsbild.
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.
LivenessWithVerifyImage	Die Details des Gesichts zur Überprüfung.
QualityForRecognition	Gibt die Qualität des Bilds für die Erkennung an.

CreateLivenessWithVerifySessionResult

Antwort der Liveness-Sitzung mit überprüfungserstellung mit bereitgestellter Bestätigungsbild.

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.
verifyImage	LivenessWithVerifyImage	Die Details des Gesichts zur Überprüfung.

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.

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.

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.