Liveness Session Operations - Get Liveness With Verify Session Result

Referensi

Layanan:: Azure AI Services

Versi API:: v1.2

Dapatkan hasil sesi dari detectLivenessWithVerify/singleModal call.

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify-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	LivenessWithVerifySession	Permintaan telah berhasil.
Other Status Codes	FaceErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

LivenessWithVerifySession

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 Session Result

Permintaan sampel

HTTP

GET {endpoint}/face/v1.2/detectLivenessWithVerify-sessions/b12e033e-bda7-4b83-a211-e721c661f30e

Respon sampel

Kode status:: 200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm",
  "status": "NotStarted",
  "modelVersion": "2024-11-15",
  "results": {
    "attempts": [
      {
        "attemptId": 2,
        "attemptStatus": "Succeeded",
        "result": {
          "livenessDecision": "realface",
          "targets": {
            "color": {
              "faceRectangle": {
                "top": 669,
                "left": 203,
                "width": 646,
                "height": 724
              }
            }
          },
          "verifyResult": {
            "matchConfidence": 0.08871888,
            "isIdentical": false
          },
          "digest": "B0A803BB7B26F3C8F29CD36030F8E63ED3FAF955FEEF8E01C88AB8FD89CCF761",
          "sessionImageId": "Ae3PVWlXAmVAnXgkAFt1QSjGUWONKzWiSr2iPh9p9G4I",
          "verifyImageHash": "43B7D8E8769533C3290DBD37A84D821B2C28CB4381DF9C6784DBC4AAF7E45018"
        }
      },
      {
        "attemptId": 1,
        "attemptStatus": "Failed",
        "error": {
          "code": "FaceWithMaskDetected",
          "message": "Mask detected on face image.",
          "targets": {
            "color": {
              "faceRectangle": {
                "top": 669,
                "left": 203,
                "width": 646,
                "height": 724
              }
            }
          }
        }
      }
    ],
    "verifyReferences": [
      {
        "referenceType": "image",
        "faceRectangle": {
          "top": 316,
          "left": 131,
          "width": 498,
          "height": 677
        },
        "qualityForRecognition": "high"
      }
    ]
  }
}

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.
FaceRectangle	Persegi panjang di mana wajah dapat ditemukan.
ImageType	Jenis gambar.
LivenessColorDecisionTarget	Target dari gambar warna yang digunakan untuk klasifikasi liveness.
LivenessDecision	Hasil klasifikasi keakuratan.
LivenessDecisionTargets	Target yang digunakan untuk klasifikasi liveness.
LivenessError	Kesalahan klasifikasi liveness.
LivenessModel	Versi model yang digunakan untuk klasifikasi liveness.
LivenessWithVerifyOutputs	Output verifikasi wajah.
LivenessWithVerifyReference	Detail wajah untuk verifikasi.
LivenessWithVerifyResult	Hasil liveness dengan panggilan verifikasi.
LivenessWithVerifySession	Hasil sesi mendeteksi keakuratan dengan verifikasi.
LivenessWithVerifySessionAttempt	Keakuratan dengan upaya sesi verifikasi.
LivenessWithVerifySessionResults	Hasil liveness dengan sesi verifikasi.
OperationState	Status sesi saat ini.
QualityForRecognition	Menunjukkan kualitas gambar untuk pengenalan.

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.

FaceRectangle

Objek

Persegi panjang di mana wajah dapat ditemukan.

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

ImageType

Enumeration

Jenis gambar.

Nilai	Deskripsi
Color	Gambar warna.
Depth	Gambar kedalaman.
Infrared	Gambar inframerah.

LivenessColorDecisionTarget

Objek

Target dari gambar warna yang digunakan untuk klasifikasi liveness.

Nama	Jenis	Deskripsi
faceRectangle	FaceRectangle	Wilayah wajah tempat klasifikasi liveness dibuat.

LivenessDecision

Enumeration

Hasil klasifikasi keakuratan.

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

LivenessDecisionTargets

Objek

Target yang digunakan untuk klasifikasi liveness.

Nama	Jenis	Deskripsi
color	LivenessColorDecisionTarget	Target dari gambar warna yang digunakan untuk klasifikasi liveness.

LivenessError

Objek

Kesalahan klasifikasi liveness.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
targets	LivenessDecisionTargets	Target yang digunakan untuk klasifikasi liveness.

LivenessModel

Enumeration

Versi model yang digunakan untuk klasifikasi liveness.

Nilai	Deskripsi
2024-11-15

LivenessWithVerifyOutputs

Objek

Output verifikasi wajah.

Nama	Jenis	Deskripsi
isIdentical	boolean	Apakah wajah liveness target dan wajah perbandingan cocok.
matchConfidence	number (float) minimum: 0 maximum: 1	Wajah wajah target yang hidup dan keyakinan verifikasi wajah gambar perbandingan.

LivenessWithVerifyReference

Objek

Detail wajah untuk verifikasi.

Nama	Jenis	Deskripsi
faceRectangle	FaceRectangle	Wilayah wajah tempat klasifikasi gambar perbandingan dibuat.
qualityForRecognition	QualityForRecognition	Kualitas gambar wajah untuk pengenalan.
referenceType	ImageType	Jenis gambar yang berisi persegi panjang wajah tempat klasifikasi liveness dibuat.

LivenessWithVerifyResult

Objek

Hasil liveness dengan panggilan verifikasi.

Nama	Jenis	Deskripsi
digest	string	Server menghitung hash untuk permintaan ini. Jika klien melaporkan hash berbeda dari hash yang dihitung 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 menyeluruh Anda.
livenessDecision	LivenessDecision	Klasifikasi liveness untuk wajah target.
sessionImageId	string	ID gambar permintaan sesi.
targets	LivenessDecisionTargets	Target yang digunakan untuk klasifikasi liveness.
verifyImageHash	string	Hash sha256 dari gambar verifikasi dalam permintaan.
verifyResult	LivenessWithVerifyOutputs	Output verifikasi wajah. Hanya tersedia saat permintaan diaktivasi dengan verifikasi.

LivenessWithVerifySession

Objek

Hasil sesi mendeteksi keakuratan dengan verifikasi.

Nama	Jenis	Deskripsi
authToken	string	Token pembawa untuk menyediakan autentikasi untuk Vision SDK yang berjalan pada aplikasi klien. Token Pembawa ini memiliki izin terbatas untuk hanya melakukan tindakan yang diperlukan dan kedaluwarsa setelah waktu TTL. Ini juga dapat diaudit.
modelVersion	LivenessModel	Versi model yang digunakan untuk klasifikasi liveness. Ini adalah parameter opsional, dan jika ini tidak ditentukan, maka versi model terbaru yang didukung akan dipilih
results	LivenessWithVerifySessionResults	Hasil liveness dengan sesi verifikasi.
sessionId	string	ID unik untuk mereferensikan sesi ini.
status	OperationState	Status sesi saat ini.

LivenessWithVerifySessionAttempt

Objek

Keakuratan dengan upaya sesi verifikasi.

Nama	Jenis	Deskripsi
attemptId	integer (int32)	ID upaya, mulai dari 1.
attemptStatus	OperationState	Status upaya.
error	LivenessError	Kesalahan keakuratan dengan panggilan verifikasi, akan null jika ada hasilnya.
result	LivenessWithVerifyResult	Hasil dari liveness dengan panggilan verifikasi, akan null jika ada kesalahan.

LivenessWithVerifySessionResults

Objek

Hasil liveness dengan sesi verifikasi.

Nama	Jenis	Deskripsi
attempts	LivenessWithVerifySessionAttempt[]	Data upaya keakuratan yang mendasar dengan panggilan verifikasi dengan sesi.
verifyReferences	LivenessWithVerifyReference[]	Referensi yang digunakan untuk verifikasi wajah.

OperationState

Enumeration

Status sesi saat ini.

Nilai	Deskripsi
Canceled	Operasi telah dibatalkan oleh pengguna.
Failed	Operasi gagal.
NotStarted	Operasi belum dimulai.
Running	Operasi sedang berlangsung.
Succeeded	Operasi berhasil diselesaikan.

QualityForRecognition

Enumeration

Menunjukkan kualitas gambar untuk pengenalan.

Nilai	Deskripsi
high	Kualitas tinggi.
low	Kualitas rendah.
medium	Kualitas sedang.

Bagikan melalui

Liveness Session Operations - Get Liveness With Verify Session Result

Parameter URI

Respons

Keamanan

Ocp-Apim-Subscription-Key

AADToken

Cakupan

Contoh

Get LivenessWithVerify Session Result

Permintaan sampel

Respon sampel

Definisi

FaceError

FaceErrorResponse

FaceRectangle

ImageType

LivenessColorDecisionTarget

LivenessDecision

LivenessDecisionTargets

LivenessError

LivenessModel

LivenessWithVerifyOutputs

LivenessWithVerifyReference

LivenessWithVerifyResult

LivenessWithVerifySession

LivenessWithVerifySessionAttempt

LivenessWithVerifySessionResults

OperationState

QualityForRecognition