Liveness Session Operations - Create Liveness With Verify Session

Referensi

Service:: Azure AI Services

API Version:: v1.1-preview.1

Create sesi keaktifan baru dengan verifikasi. Perangkat klien mengirimkan VerifyImage selama panggilan /detectLivenessWithVerify/singleModal.
Sesi adalah yang terbaik untuk skenario perangkat klien di mana pengembang ingin mengotorisasi perangkat klien untuk hanya melakukan deteksi keaktifan tanpa memberikan akses penuh ke sumber daya mereka. Sesi yang dibuat memiliki rentang masa pakai terbatas dan hanya mengotorisasi klien untuk melakukan tindakan yang diinginkan sebelum akses kedaluwarsa.

Izin mencakup...

- Kemampuan untuk memanggil /detectLivenessWithVerify/singleModal hingga 3 percobaan ulang.
- Masa pakai token 10 menit.

Catatan

- Akses klien dapat dicabut dengan menghapus sesi menggunakan operasi Hapus Keaktifan Dengan Verifikasi Sesi.
- Untuk mengambil hasil, gunakan Dapatkan Keaktifan Dengan Verifikasi Sesi.
- Untuk mengaudit permintaan individual yang telah dibuat klien ke sumber daya Anda, gunakan Daftar Keaktifan Dengan Verifikasi Entri Audit Sesi.

Opsi Alternatif: Perangkat klien mengirimkan VerifyImage selama panggilan /detectLivenessWithVerify/singleModal.

Catatan

Tindakan tambahan harus diambil untuk memvalidasi bahwa klien mengirim VerifyImage yang diharapkan.

POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions

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

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
livenessOperationMode	True	LivenessOperationMode	Jenis mode keaktifan yang harus diikuti klien.
authTokenTimeToLiveInSeconds		integer	Detik sesi akan berlangsung selamanya. Rentangnya adalah 60 hingga 86400 detik. Nilai defaultnya adalah 600.
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.
deviceCorrelationIdSetInClient		boolean	Apakah mengizinkan klien untuk mengatur 'deviceCorrelationId' mereka sendiri melalui Vision SDK atau tidak. Defaultnya adalah false, dan 'deviceCorrelationId' harus diatur dalam isi permintaan ini.
sendResultsToClient		boolean	Apakah akan mengizinkan isi respons '200 - Success' dikirim ke klien atau tidak, yang mungkin tidak diinginkan karena alasan keamanan. Defaultnya adalah false, klien akan menerima respons isi kosong '204 - NoContent'. Terlepas dari pilihannya, memanggil Sesi GetResult akan selalu berisi isi respons yang memungkinkan logika bisnis diimplementasikan.

Respons

Nama	Jenis	Deskripsi
200 OK	CreateLivenessWithVerifySessionResult	Panggilan yang berhasil membuat sesi untuk perangkat klien dan menyediakan token otorisasi untuk digunakan oleh aplikasi klien untuk tujuan dan waktu terbatas.
Other Status Codes	FaceErrorResponse	Respons kesalahan yang tidak terduga. Headers x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

CreateLivenessWithVerifySessionResult

Panggilan yang berhasil membuat sesi untuk perangkat klien dan menyediakan token otorisasi untuk digunakan oleh aplikasi klien untuk tujuan dan waktu terbatas.

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

Create LivenessWithVerify Session

Sample Request

HTTP

POST {endpoint}/face/v1.1-preview.1/detectLivenessWithVerify/singleModal/sessions

{
  "livenessOperationMode": "Passive",
  "sendResultsToClient": true,
  "deviceCorrelationIdSetInClient": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 60
}

Sample Response

Status code:: 200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm"
}

Definisi

Nama	Deskripsi
CreateLivenessSessionContent	Permintaan untuk membuat sesi keaktifan.
CreateLivenessWithVerifySessionResult	Respons sesi keaktifan dengan memverifikasi pembuatan dengan memverifikasi gambar yang disediakan.
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.
LivenessOperationMode	Mode operasi keaktifan untuk mendorong pengalaman pengguna akhir klien.
LivenessWithVerifyImage	Detail wajah untuk verifikasi.
QualityForRecognition	Menunjukkan kualitas gambar untuk pengenalan.

CreateLivenessSessionContent

Permintaan untuk membuat sesi keaktifan.

Nama	Jenis	Nilai Default	Deskripsi
authTokenTimeToLiveInSeconds	integer	600	Detik sesi akan berlangsung selamanya. Rentangnya adalah 60 hingga 86400 detik. Nilai defaultnya adalah 600.
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.
deviceCorrelationIdSetInClient	boolean		Apakah mengizinkan klien untuk mengatur 'deviceCorrelationId' mereka sendiri melalui Vision SDK atau tidak. Defaultnya adalah false, dan 'deviceCorrelationId' harus diatur dalam isi permintaan ini.
livenessOperationMode	LivenessOperationMode		Jenis mode keaktifan yang harus diikuti klien.
sendResultsToClient	boolean		Apakah akan mengizinkan isi respons '200 - Success' dikirim ke klien atau tidak, yang mungkin tidak diinginkan karena alasan keamanan. Defaultnya adalah false, klien akan menerima respons isi kosong '204 - NoContent'. Terlepas dari pilihannya, memanggil Sesi GetResult akan selalu berisi isi respons yang memungkinkan logika bisnis diimplementasikan.

CreateLivenessWithVerifySessionResult

Respons sesi keaktifan dengan memverifikasi pembuatan dengan memverifikasi gambar yang disediakan.

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.
sessionId	string	ID sesi unik dari sesi yang dibuat. Ini akan kedaluwarsa 48 jam setelah dibuat atau dapat dihapus lebih cepat menggunakan operasi HAPUS Sesi yang sesuai.
verifyImage	LivenessWithVerifyImage	Detail wajah untuk verifikasi.

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.

LivenessOperationMode

Mode operasi keaktifan untuk mendorong pengalaman pengguna akhir klien.

Nama	Jenis	Deskripsi
Passive	string	Menggunakan teknik keaktifan pasif yang tidak memerlukan tindakan tambahan dari pengguna. Membutuhkan pencahayaan dalam ruangan normal dan kecerahan layar tinggi untuk performa optimal. Dengan demikian, mode ini memiliki amplop operasional yang sempit dan tidak akan cocok untuk skenario yang mengharuskan pengguna akhir berada dalam kondisi pencahayaan yang cerah. Catatan: ini adalah satu-satunya mode yang didukung untuk solusi Seluler (iOS dan Android).
PassiveActive	string	Mode ini menggunakan teknik liveness pasif atau aktif hibrid yang mengharuskan kerja sama pengguna. Dioptimalkan untuk memerlukan gerakan aktif hanya dalam kondisi pencahayaan suboptimal. Tidak seperti mode pasif, mode ini tidak memiliki batasan pencahayaan, dan dengan demikian menawarkan amplop operasional yang lebih luas. Mode ini lebih disukai pada solusi berbasis Web karena kurangnya kontrol kecerahan layar otomatis yang tersedia di browser yang menghambat amplop operasional mode Pasif pada solusi berbasis Web.

LivenessWithVerifyImage

Detail wajah untuk verifikasi.

Nama	Jenis	Deskripsi
faceRectangle	FaceRectangle	Wilayah wajah tempat klasifikasi gambar perbandingan dibuat.
qualityForRecognition	QualityForRecognition	Kualitas gambar wajah untuk pengenalan.

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 - Create Liveness With Verify Session

Parameter URI

Isi Permintaan

Respons

Keamanan

Ocp-Apim-Subscription-Key

AADToken

Scopes

Contoh

Create LivenessWithVerify Session

Sample Request

Sample Response

Definisi

CreateLivenessSessionContent

CreateLivenessWithVerifySessionResult

FaceError

FaceErrorResponse

FaceRectangle

LivenessOperationMode

LivenessWithVerifyImage

QualityForRecognition

Sumber Daya Tambahan: