Liveness Session Operations - Get Liveness Sessions

Dienst:

Azure AI Services

API-Version:

v1.1-preview.1

Listen Sitzungen für /detectLiveness/SingleModal.
Listen Sie Sitzungen der letzten sessionId auf, die größer als "start" ist.

Das Ergebnis sollte nach sessionId in aufsteigender Reihenfolge sortiert werden.

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

Mit optionalen Parametern:

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions?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).
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	LivenessSessionItem[]	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 LivenessSessions

Beispielanforderung

HTTP

GET {endpoint}/face/v1.1-preview.1/detectLiveness/singleModal/sessions?start=00000000-0000-0000-0000-000000000000&top=20

Beispiel für eine Antwort

Statuscode:

200

[
  {
    "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "createdDateTime": "2024-03-05T11:07:28.540Z",
    "sessionStartDateTime": "2024-03-05T11:07:28.540Z",
    "sessionExpired": true,
    "deviceCorrelationId": "your_device_correlation_id",
    "authTokenTimeToLiveInSeconds": 60
  }
]

Definitionen

Name	Beschreibung
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.
LivenessSessionItem	Sitzungsdaten, die für die Enumeration zurückgegeben werden.

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.

LivenessSessionItem

Sitzungsdaten, die für die Enumeration zurückgegeben werden.

Name	Typ	Standardwert	Beschreibung
authTokenTimeToLiveInSeconds	integer	600	Sekunden, die die Sitzung dauern sollte. Der Bereich beträgt 60 bis 86400 Sekunden. Der Standardwert ist 600.
createdDateTime	string		DateTime, wann diese Sitzung erstellt wurde.
deviceCorrelationId	string		Eindeutige GUID pro Endbenutzergerät. Dies soll ratenbegrenzung und anti-hämmern. Wenn "deviceCorrelationIdSetInClient" in dieser Anforderung true ist, muss diese "deviceCorrelationId" NULL sein.
id	string		Die eindeutige ID, die auf diese Sitzung verweist.
sessionExpired	boolean		Gibt an, ob die Sitzung abgelaufen ist.
sessionStartDateTime	string		DateTime, wenn diese Sitzung vom Client gestartet wurde.