Liveness Session Operations - Get Liveness With Verify Sessions

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Wyświetla sesje /detectLivenessWithVerify/SingleModal.
Wyświetl sesje z ostatniego identyfikatora sesji większe niż "start".

Wynik powinien być uporządkowany według identyfikatora sessionId w kolejności rosnącej.

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

Z parametrami opcjonalnymi:

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions?start={start}&top={top}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiVersion	path	True	string	Wersja interfejsu API
endpoint	path	True	string uri	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://{nazwa-zasobu}.cognitiveservices.azure.com).
start	query		string	Wyświetl listę zasobów większych niż "start". Zawiera nie więcej niż 64 znaki. Wartość domyślna jest pusta.
top	query		integer int32	Liczba elementów do wyświetlenia, począwszy od [1, 1000]. Wartość domyślna to 1000.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LivenessSessionItem[]	Żądanie zakończyło się pomyślnie.
Other Status Codes	FaceErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz tajny subskrypcji rozpoznawania twarzy w usłudze Azure AI.

Typ: apiKey
W: header

AADToken

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://api.example.com/oauth2/authorize
Adres URL tokenu: https://api.example.com/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get LivenessWithVerify Sessions

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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
  }
]

Definicje

Nazwa	Opis
FaceError	Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpowiedź zawierająca szczegóły błędu.
LivenessSessionItem	Dane sesji zwrócone dla wyliczenia.

FaceError

Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
message	string	Czytelna dla człowieka reprezentacja błędu.

FaceErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	FaceError	Obiekt błędu.

LivenessSessionItem

Dane sesji zwrócone dla wyliczenia.

Nazwa	Typ	Domyślna wartość	Opis
authTokenTimeToLiveInSeconds	integer	600	Sekundy sesji powinny trwać. Zakres wynosi od 60 do 86400 sekund. Wartość domyślna to 600.
createdDateTime	string		Data/godzina utworzenia tej sesji.
deviceCorrelationId	string		Unikatowy identyfikator GUID dla każdego urządzenia użytkownika końcowego. Ma to zapewnić ograniczenie szybkości i anty-młotek. Jeśli parametr "deviceCorrelationIdSetInClient" ma wartość true w tym żądaniu, ten parametr "deviceCorrelationId" musi mieć wartość null.
id	string		Unikatowy identyfikator do odwołowania się do tej sesji.
sessionExpired	boolean		Bez względu na to, czy sesja wygasła.
sessionStartDateTime	string		Data/godzina rozpoczęcia tej sesji przez klienta.