Bagikan melalui

Face List Operations - Get Face Lists

  • Referensi
Layanan:
Azure AI Services
Versi API:
v1.2

Mencantumkan faceListId, nama, userData, dan recognitionModel Daftar Wajah.

Untuk mendapatkan informasi wajah di dalam Daftar Wajah, gunakan "Dapatkan Daftar Wajah".

GET {endpoint}/face/{apiVersion}/facelists
Dengan parameter opsional: 
GET {endpoint}/face/{apiVersion}/facelists?returnRecognitionModel={returnRecognitionModel}

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

boolean

Mengembalikan 'recognitionModel' atau tidak. Nilai defaultnya adalah false.

Respons

Nama Jenis Deskripsi
200 OK

FaceListItem[]

Panggilan yang berhasil mengembalikan array Daftar Wajah.
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 FaceLists

Permintaan sampel

GET {endpoint}/face/v1.2/facelists?returnRecognitionModel=True

Respon sampel

Kode status:
200 
[
  {
    "name": "your_face_list_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "faceListId": "your_face_list_id"
  }
]

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

Item daftar wajah untuk daftar wajah daftar.
RecognitionModel

Model pengenalan untuk wajah.

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.

FaceListItem

Objek

Item daftar wajah untuk daftar wajah daftar.

Nama Jenis Deskripsi
faceListId

string

minLength: 1
maxLength: 64
pattern: ^[a-z0-9-_]+$

Karakter yang valid adalah huruf dalam huruf kecil atau digit atau '-' atau '_', panjang maksimum adalah 64.
name

string

minLength: 1
maxLength: 128

Nama yang ditentukan pengguna, panjang maksimum adalah 128.
recognitionModel

RecognitionModel

Nama model pengenalan. Model pengenalan digunakan saat fitur wajah diekstrak dan terkait dengan faceId yang terdeteksi.
userData

string

maxLength: 16384

Data yang ditentukan pengguna opsional. Panjang tidak boleh melebihi 16K.

RecognitionModel

Enumeration

Model pengenalan untuk wajah.

Nilai Deskripsi
recognition_01

Model pengenalan default untuk "Deteksi". Semua faceId yang dibuat sebelum 2019 Maret diikat dengan model pengenalan ini.
recognition_02

Model pengenalan dirilis pada bulan Maret 2019.
recognition_03

Model pengenalan dirilis pada bulan Mei 2020.
recognition_04

Model pengenalan dirilis pada februari 2021. Disarankan untuk menggunakan model pengenalan ini untuk akurasi pengenalan yang lebih baik.