Liveness Session Operations - Get Liveness With Verify Sessions

Layanan:

Azure AI Services

Versi API:

v1.2-preview.1

Mencantumkan sesi untuk /detectLivenessWithVerify/SingleModal.
Mencantumkan sesi dari sessionId terakhir yang lebih besar dari 'start'.

Hasilnya harus diurutkan berdasarkan sessionId dalam urutan naik.

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
apiVersion	path	True	string	Versi API
endpoint	path	True	string (uri)	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://{resource-name}.cognitiveservices.azure.com).
start	query		string	Mencantumkan sumber daya yang lebih besar dari "mulai". Ini berisi tidak lebih dari 64 karakter. Defaultnya kosong.
top	query		integer (int32) minimum: 1 maximum: 1000	Jumlah item yang akan dicantumkan, mulai dari [1, 1000]. Nilai default adalah 1000.

Respons

Nama	Jenis	Deskripsi
200 OK	LivenessSessionItem[]	Permintaan telah berhasil.
Other Status Codes	FaceErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Kunci rahasia untuk langganan Azure AI Face Anda.

Jenis: apiKey
Dalam: header

AADToken

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://api.example.com/oauth2/authorize
URL token: https://api.example.com/oauth2/token

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Get LivenessWithVerify Sessions

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
FaceError	Objek kesalahan. Untuk detail komprehensif tentang kode kesalahan dan pesan yang dikembalikan oleh Layanan Wajah, lihat tautan berikut: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Respons yang berisi detail kesalahan.
LivenessSessionItem	Data sesi dikembalikan untuk enumerasi.

FaceError

Objek

Objek kesalahan. Untuk detail komprehensif tentang kode kesalahan dan pesan yang dikembalikan oleh Layanan Wajah, lihat tautan berikut: https://aka.ms/face-error-codes-and-messages.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
message	string	Representasi kesalahan yang dapat dibaca manusia.

FaceErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	FaceError	Objek kesalahan.

LivenessSessionItem

Objek

Data sesi dikembalikan untuk enumerasi.

Nama	Jenis	Nilai default	Deskripsi
authTokenTimeToLiveInSeconds	integer (int32) minimum: 60 maximum: 86400	600	Detik sesi harus berlangsung untuk. Rentang adalah 60 hingga 86400 detik. Nilai defaultnya adalah 600.
createdDateTime	string (date-time)		DateTime ketika sesi ini dibuat.
deviceCorrelationId	string		Guid unik per setiap perangkat pengguna akhir. Ini untuk memberikan pembatasan tarif dan anti-palu. Jika 'deviceCorrelationIdSetInClient' benar dalam permintaan ini, 'deviceCorrelationId' ini harus null.
id	string		ID unik untuk mereferensikan sesi ini.
sessionExpired	boolean		Apakah sesi kedaluwarsa atau tidak.
sessionStartDateTime	string (date-time)		DateTime ketika sesi ini dimulai oleh klien.