Liveness Session Operations - Get Liveness With Verify Session Audit Entries

Referensi

Service:: Azure AI Services

API Version:: v1.1-preview.1

Mendapatkan permintaan sesi dan isi respons untuk sesi tersebut.

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

With optional parameters:

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions/{sessionId}/audit?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).
sessionId	path	True	string	ID unik untuk mereferensikan sesi ini.
start	query		string	Mencantumkan sumber daya yang lebih besar dari "mulai". Ini berisi tidak lebih dari 64 karakter. Defaultnya kosong.
top	query		integer int32	Jumlah item yang akan dicantumkan, berkisar di [1, 1000]. Defaultnya adalah 1000.

Respons

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

Nama

Jenis

Deskripsi

200 OK

LivenessSessionAuditEntry[]

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 LivenessWithVerify Session Audit Entries

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/detectLivenessWithVerify/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e/audit?start=0&top=20

Sample Response

Status code:: 200

[
  {
    "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 Face Service, 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.
ImageType	Jenis gambar.
LivenessDecision	Hasil klasifikasi keaktifan.
LivenessModel	Versi model yang digunakan untuk klasifikasi keaktifan.
LivenessOutputsTarget	Klasifikasi keaktifan untuk wajah target.
LivenessResponseBody	Isi respons mendeteksi panggilan API keaktifan.
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 keaktifan.
userAgent	string	Agen pengguna yang digunakan untuk mengirimkan permintaan.

FaceError

Objek kesalahan. Untuk detail komprehensif tentang kode kesalahan dan pesan yang dikembalikan oleh Face Service, 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.

ImageType

Jenis gambar.

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

LivenessDecision

Hasil klasifikasi keaktifan.

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 keaktifan.

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 keaktifan untuk wajah target.

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

LivenessResponseBody

Isi respons mendeteksi panggilan API keaktifan.

Nama	Jenis	Deskripsi
livenessDecision	LivenessDecision	Klasifikasi keaktifan untuk wajah target.
modelVersionUsed	LivenessModel	Versi model yang digunakan untuk klasifikasi keaktifan.
target	LivenessOutputsTarget	Target khusus yang digunakan untuk klasifikasi keaktifan.
verifyResult	LivenessWithVerifyOutputs	Output verifikasi wajah. Hanya tersedia ketika permintaan adalah keaktifan 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 yang dihitung server, maka integritas pesan antara klien dan layanan telah disusupi dan hasilnya tidak boleh dipercaya. Untuk informasi selengkapnya, lihat cara memandu tentang 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 hasil audit berikutnya.
receivedDateTime	string	DateTime UTC yang diterima permintaan.
request	AuditRequestInfo	Permintaan entri ini.
requestId	string	RequestId unik yang dikembalikan oleh layanan ke klien di header 'apim-request-id'.
response	AuditLivenessResponseInfo	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	FaceRectangle	Wilayah wajah tempat klasifikasi gambar perbandingan dibuat.
qualityForRecognition	QualityForRecognition	Kualitas gambar wajah untuk pengenalan.

LivenessWithVerifyOutputs

Output verifikasi wajah.

Nama	Jenis	Deskripsi
isIdentical	boolean	Apakah wajah keaktifan target dan kecocokan wajah gambar perbandingan.
matchConfidence	number	Wajah keaktifan wajah target dan keyakinan verifikasi wajah gambar perbandingan.
verifyImage	LivenessWithVerifyImage	Detail wajah untuk verifikasi.

QualityForRecognition

Menunjukkan kualitas gambar untuk pengenalan.

Nama	Jenis	Deskripsi
high	string	Kualitas tinggi.
low	string	Kualitas rendah.
medium	string	Kualitas sedang.

Bagikan melalui

Liveness Session Operations - Get Liveness With Verify Session Audit Entries

Parameter URI

Respons

Keamanan

Ocp-Apim-Subscription-Key

AADToken

Scopes

Contoh

Get LivenessWithVerify Session Audit Entries

Sample Request

Sample Response

Definisi

AuditLivenessResponseInfo

AuditRequestInfo

FaceError

FaceErrorResponse

FaceRectangle

ImageType

LivenessDecision

LivenessModel

LivenessOutputsTarget

LivenessResponseBody

LivenessSessionAuditEntry

LivenessWithVerifyImage

LivenessWithVerifyOutputs

QualityForRecognition

Sumber Daya Tambahan: