Liveness Session Operations - Get Liveness Session Result

Referensi

Service:: Azure AI Services

API Version:: v1.1-preview.1

Dapatkan hasil sesi dari detectLiveness/singleModal call.

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

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).
sessionId	path	True	string	ID unik untuk mereferensikan sesi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	LivenessSession	Permintaan telah berhasil.
Other Status Codes	FaceErrorResponse	Respons kesalahan yang tidak terduga. Headers x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

LivenessSession

Permintaan telah berhasil.

Other Status Codes

FaceErrorResponse

Respons kesalahan yang tidak terduga.

Headers

x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Kunci rahasia untuk langganan Azure AI Face Anda.

Type: apiKey
In: header

AADToken

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Contoh

Get LivenessSession Result

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e

Sample Response

Status code:: 200

{
  "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "createdDateTime": "2024-03-05T11:07:29.698Z",
  "sessionStartDateTime": "2024-03-05T11:07:29.698Z",
  "sessionExpired": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 600,
  "status": "NotStarted",
  "result": {
    "id": 4,
    "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "requestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "clientRequestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "receivedDateTime": "2024-03-05T11:07:29.698Z",
    "request": {
      "url": "/face/v1.1-preview.1/detectliveness/singlemodal",
      "method": "POST",
      "contentLength": 18,
      "contentType": "multipart/form-data",
      "userAgent": "Mozilla/5.0 (Linux) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Mobile Safari/537.36"
    },
    "response": {
      "body": {},
      "statusCode": 200,
      "latencyInMilliseconds": 1200
    },
    "digest": "1CC98BA83EAF1D0FF7F566FAEFCCCC787819FFA01251E2D9299143F7AD6651DB"
  }
}

Definisi

Nama	Deskripsi
AuditLivenessResponseInfo	Entri audit untuk respons dalam sesi.
AuditRequestInfo	Entri audit untuk permintaan dalam sesi.
FaceError	Objek kesalahan. Untuk detail komprehensif tentang kode kesalahan dan pesan yang dikembalikan oleh Layanan Wajah, silakan lihat tautan berikut: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Respons yang berisi detail kesalahan.
FaceRectangle	Persegi panjang di mana wajah dapat ditemukan.
FaceSessionStatus	Status sesi saat ini.
ImageType	Jenis gambar.
LivenessDecision	Hasil klasifikasi keaktivaan.
LivenessModel	Versi model yang digunakan untuk klasifikasi liveness.
LivenessOutputsTarget	Klasifikasi liveness untuk wajah target.
LivenessResponseBody	Isi respons deteksi panggilan API keaktivaan.
LivenessSession	Hasil sesi mendeteksi liveness.
LivenessSessionAuditEntry	Entri audit untuk permintaan dalam sesi.
LivenessWithVerifyImage	Detail wajah untuk verifikasi.
LivenessWithVerifyOutputs	Output verifikasi wajah.
QualityForRecognition	Menunjukkan kualitas gambar untuk pengenalan.

AuditLivenessResponseInfo

Entri audit untuk respons dalam sesi.

Nama	Jenis	Deskripsi
body	LivenessResponseBody	Isi respons. Skema bidang ini akan bergantung pada request.url dan request.method yang digunakan oleh klien.
latencyInMilliseconds	integer	Latensi terukur server untuk permintaan ini dalam milidetik.
statusCode	integer	Kode status HTTP dikembalikan ke klien.

AuditRequestInfo

Entri audit untuk permintaan dalam sesi.

Nama	Jenis	Deskripsi
contentLength	integer	Panjang isi permintaan dalam byte.
contentType	string	Jenis konten permintaan.
method	string	Metode HTTP permintaan (yaitu, GET, POST, DELETE).
url	string	URL relatif dan kueri permintaan keaktivaan.
userAgent	string	Agen pengguna yang digunakan untuk mengirimkan permintaan.

FaceError

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

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

FaceErrorResponse

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	FaceError	Objek kesalahan.

FaceRectangle

Persegi panjang di mana wajah dapat ditemukan.

Nama	Jenis	Deskripsi
height	integer	Tinggi persegi panjang, dalam piksel.
left	integer	Jarak dari tepi kiri jika gambar ke tepi kiri persegi panjang, dalam piksel.
top	integer	Jarak dari tepi atas jika gambar ke tepi atas persegi panjang, dalam piksel.
width	integer	Lebar persegi panjang, dalam piksel.

FaceSessionStatus

Status sesi saat ini.

Nama	Jenis	Deskripsi
NotStarted	string	Sesi belum dimulai.
ResultAvailable	string	Sesi memiliki hasil yang tersedia.
Started	string	Sesi telah dimulai.

ImageType

Jenis gambar.

Nama	Jenis	Deskripsi
Color	string	Gambar warna.
Depth	string	Gambar kedalaman.
Infrared	string	Gambar inframerah.

LivenessDecision

Hasil klasifikasi keaktivaan.

Nama	Jenis	Deskripsi
realface	string	Algoritma telah mengklasifikasikan wajah target sebagai nyata.
spoofface	string	Algoritma telah mengklasifikasikan wajah target sebagai spoof.
uncertain	string	Algoritma tidak dapat mengklasifikasikan wajah target sebagai nyata atau spoof.

LivenessModel

Versi model yang digunakan untuk klasifikasi liveness.

Nama	Jenis	Deskripsi
2020-02-15-preview.01	string
2021-11-12-preview.03	string
2022-10-15-preview.04	string
2023-03-02-preview.05	string

LivenessOutputsTarget

Klasifikasi liveness untuk wajah target.

Nama	Jenis	Deskripsi
faceRectangle	FaceRectangle	Wilayah wajah tempat klasifikasi liveness dibuat.
fileName	string	Nama file yang berisi persegi wajah tempat klasifikasi liveness dibuat.
imageType	ImageType	Jenis gambar yang berisi persegi wajah tempat klasifikasi keaktivan dibuat.
timeOffsetWithinFile	integer	Offset waktu dalam file bingkai yang berisi persegi wajah tempat klasifikasi keaktifan dibuat.

LivenessResponseBody

Isi respons deteksi panggilan API keaktivaan.

Nama	Jenis	Deskripsi
livenessDecision	LivenessDecision	Klasifikasi liveness untuk wajah target.
modelVersionUsed	LivenessModel	Versi model yang digunakan untuk klasifikasi liveness.
target	LivenessOutputsTarget	Target khusus yang digunakan untuk klasifikasi keaktivaan.
verifyResult	LivenessWithVerifyOutputs	Output verifikasi wajah. Hanya tersedia saat permintaan diaktivasi dengan verifikasi.