Bagikan melalui


Liveness Session Operations - Get Liveness Session Result

Dapatkan hasil sesi dari detectLiveness/singleModal call.

GET {endpoint}/face/{apiVersion}/detectLiveness-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 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 LivenessSession Result

Permintaan sampel

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

Respon sampel

{
  "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
              }
            }
          },
          "digest": "B0A803BB7B26F3C8F29CD36030F8E63ED3FAF955FEEF8E01C88AB8FD89CCF761",
          "sessionImageId": "Ae3PVWlXAmVAnXgkAFt1QSjGUWONKzWiSr2iPh9p9G4I"
        }
      },
      {
        "attemptId": 1,
        "attemptStatus": "Failed",
        "error": {
          "code": "FaceWithMaskDetected",
          "message": "Mask detected on face image.",
          "targets": {
            "color": {
              "faceRectangle": {
                "top": 669,
                "left": 203,
                "width": 646,
                "height": 724
              }
            }
          }
        }
      }
    ]
  }
}

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.

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.

LivenessResult

Hasil klasifikasi liveness.

LivenessSession

Hasil sesi mendeteksi keakuratan.

LivenessSessionAttempt

Upaya sesi liveness.

LivenessSessionResults

Hasil sesi liveness.

OperationState

Status sesi saat ini.

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.

Nama Jenis Deskripsi
code

string

Salah satu sekumpulan 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 (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.

LivenessColorDecisionTarget

Target dari gambar warna yang digunakan untuk klasifikasi liveness.

Nama Jenis Deskripsi
faceRectangle

FaceRectangle

Wilayah wajah tempat klasifikasi liveness dibuat.

LivenessDecision

Hasil klasifikasi keakuratan.

Nilai Deskripsi
uncertain

Algoritma tidak dapat mengklasifikasikan wajah target sebagai nyata atau spoof.

realface

Algoritma telah mengklasifikasikan wajah target sebagai nyata.

spoofface

Algoritma telah mengklasifikasikan wajah target sebagai spoof.

LivenessDecisionTargets

Target yang digunakan untuk klasifikasi liveness.

Nama Jenis Deskripsi
color

LivenessColorDecisionTarget

Target dari gambar warna yang digunakan untuk klasifikasi liveness.

LivenessError

Kesalahan klasifikasi liveness.

Nama Jenis Deskripsi
code

string

Kode kesalahan.

message

string

Pesan kesalahan.

targets

LivenessDecisionTargets

Target yang digunakan untuk klasifikasi liveness.

LivenessModel

Versi model yang digunakan untuk klasifikasi liveness.

Nilai Deskripsi
2024-11-15

LivenessResult

Hasil klasifikasi liveness.

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.

LivenessSession

Hasil sesi mendeteksi keakuratan.

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

LivenessSessionResults

Hasil sesi liveness.

sessionId

string

ID unik untuk mereferensikan sesi ini.

status

OperationState

Status sesi saat ini.

LivenessSessionAttempt

Upaya sesi liveness.

Nama Jenis Deskripsi
attemptId

integer (int32)

ID upaya, mulai dari 1.

attemptStatus

OperationState

Status upaya.

error

LivenessError

Kesalahan panggilan liveness, akan null jika ada hasil.

result

LivenessResult

Hasil panggilan liveness, akan null jika ada kesalahan.

LivenessSessionResults

Hasil sesi liveness.

Nama Jenis Deskripsi
attempts

LivenessSessionAttempt[]

Data upaya panggilan keakuratan yang mendasar dengan sesi.

OperationState

Status sesi saat ini.

Nilai Deskripsi
NotStarted

Operasi belum dimulai.

Running

Operasi sedang berlangsung.

Succeeded

Operasi berhasil diselesaikan.

Failed

Operasi gagal.

Canceled

Operasi telah dibatalkan oleh pengguna.