Liveness Session Operations - Get Liveness With Verify Session Result
Dapatkan hasil sesi dari detectLivenessWithVerify/singleModal call.
GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions/{sessionId}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
api
|
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). |
session
|
path | True |
string |
ID unik untuk mereferensikan sesi ini. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Permintaan telah berhasil. |
|
Other Status Codes |
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 LivenessWithVerify Session Result
Sample Request
GET {endpoint}/face/v1.1-preview.1/detectLivenessWithVerify/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e
Sample Response
{
"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 |
---|---|
Audit |
Entri audit untuk respons dalam sesi. |
Audit |
Entri audit untuk permintaan dalam sesi. |
Face |
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. |
Face |
Respons yang berisi detail kesalahan. |
Face |
Persegi panjang di mana wajah dapat ditemukan. |
Face |
Status sesi saat ini. |
Image |
Jenis gambar. |
Liveness |
Hasil klasifikasi keaktivaan. |
Liveness |
Versi model yang digunakan untuk klasifikasi liveness. |
Liveness |
Klasifikasi liveness untuk wajah target. |
Liveness |
Isi respons deteksi panggilan API keaktivaan. |
Liveness |
Entri audit untuk permintaan dalam sesi. |
Liveness |
Detail wajah untuk verifikasi. |
Liveness |
Output verifikasi wajah. |
Liveness |
Hasil sesi mendeteksi keakuratan dengan verifikasi. |
Quality |
Menunjukkan kualitas gambar untuk pengenalan. |
AuditLivenessResponseInfo
Entri audit untuk respons dalam sesi.
Nama | Jenis | Deskripsi |
---|---|---|
body |
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 |
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 |
Wilayah wajah tempat klasifikasi liveness dibuat. |
|
fileName |
string |
Nama file yang berisi persegi wajah tempat klasifikasi liveness dibuat. |
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 |
Klasifikasi liveness untuk wajah target. |
|
modelVersionUsed |
Versi model yang digunakan untuk klasifikasi liveness. |
|
target |
Target khusus yang digunakan untuk klasifikasi keaktivaan. |
|
verifyResult |
Output verifikasi wajah. Hanya tersedia saat permintaan diaktivasi dengan verifikasi. |
LivenessSessionAuditEntry
Entri audit untuk permintaan dalam sesi.
Nama | Jenis | Deskripsi |
---|---|---|
clientRequestId |
string |
ClientRequestId unik yang dikirim oleh klien di header 'client-request-id'. |
digest |
string |
Server menghitung hash untuk permintaan ini. Jika digest yang dilaporkan klien berbeda dari hash terhitung server, maka integritas pesan antara klien dan layanan telah disusupi dan hasilnya tidak boleh dipercaya. Untuk informasi selengkapnya, lihat cara memandu cara memanfaatkan nilai ini untuk mengamankan solusi end-to-end Anda. |
id |
integer |
Id unik untuk merujuk ke permintaan audit ini. Gunakan id ini dengan parameter kueri 'mulai' untuk melanjutkan ke halaman berikutnya dari hasil audit. |
receivedDateTime |
string |
DateTime UTC yang diterima permintaan. |
request |
Permintaan entri ini. |
|
requestId |
string |
RequestId unik yang dikembalikan oleh layanan ke klien di header 'apim-request-id'. |
response |
Respons entri ini. |
|
sessionId |
string |
SessionId unik dari sesi yang dibuat. Ini akan kedaluwarsa 48 jam setelah dibuat atau dapat dihapus lebih cepat menggunakan operasi DELETE sesi yang sesuai. |
LivenessWithVerifyImage
Detail wajah untuk verifikasi.
Nama | Jenis | Deskripsi |
---|---|---|
faceRectangle |
Wilayah wajah tempat klasifikasi gambar perbandingan dibuat. |
|
qualityForRecognition |
Kualitas gambar wajah untuk pengenalan. |
LivenessWithVerifyOutputs
Output verifikasi wajah.
Nama | Jenis | Deskripsi |
---|---|---|
isIdentical |
boolean |
Apakah wajah liveness target dan wajah gambar perbandingan cocok. |
matchConfidence |
number |
Wajah keakuratan wajah target dan keyakinan verifikasi wajah gambar perbandingan. |
verifyImage |
Detail wajah untuk verifikasi. |
LivenessWithVerifySession
Hasil sesi mendeteksi keakuratan dengan verifikasi.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
authTokenTimeToLiveInSeconds |
integer |
600 |
Detik sesi harus berlangsung untuk. Rentangnya adalah 60 hingga 86400 detik. Nilai defaultnya adalah 600. |
createdDateTime |
string |
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. |
|
result |
Hasil audit sesi terbaru hanya diisi jika status == 'ResultAvailable'. |
||
sessionExpired |
boolean |
Apakah sesi kedaluwarsa atau tidak. |
|
sessionStartDateTime |
string |
DateTime ketika sesi ini dimulai oleh klien. |
|
status |
Status sesi saat ini. |
QualityForRecognition
Menunjukkan kualitas gambar untuk pengenalan.
Nama | Jenis | Deskripsi |
---|---|---|
high |
string |
Kualitas tinggi. |
low |
string |
Kualitas rendah. |
medium |
string |
Kualitas sedang. |