Face List Operations - Get Face List

Service:

Azure AI Services

API Version:

v1.1-preview.1

Ambil faceListId, nama, userData, recognitionModel, dan wajah Daftar Wajah di Daftar Wajah.

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}

With optional parameters:

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?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).
faceListId	path	True	string	Karakter yang valid adalah huruf dalam huruf kecil atau digit atau '-' atau '_', panjang maksimum adalah 64. Regex pattern: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Kembalikan 'recognitionModel' atau tidak. Nilai defaultnya adalah false.

Respons

Nama	Jenis	Deskripsi
200 OK	FaceList	Panggilan yang berhasil mengembalikan informasi Daftar Wajah.
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 FaceList

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

Sample Response

Status code:

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 Face Service, silakan lihat tautan berikut: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Respons yang berisi detail kesalahan.
FaceList	Daftar wajah adalah daftar wajah, hingga 1.000 wajah.
FaceListFace	Sumber daya wajah untuk daftar wajah.
RecognitionModel	Model pengenalan untuk wajah.

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.

FaceList

Daftar wajah adalah daftar wajah, hingga 1.000 wajah.

Nama	Jenis	Deskripsi
faceListId	string	Karakter yang valid adalah huruf dalam huruf kecil atau digit atau '-' atau '_', panjang maksimum adalah 64.
name	string	Nama yang ditentukan pengguna, panjang maksimum adalah 128.
persistedFaces	FaceListFace[]	Id wajah wajah terdaftar dalam daftar wajah.
recognitionModel	RecognitionModel	Nama model pengenalan. Model pengenalan digunakan saat fitur wajah diekstraksi dan dikaitkan dengan faceId yang terdeteksi.
userData	string	Data opsional yang ditentukan pengguna. Panjang tidak boleh melebihi 16K.

FaceListFace

Sumber daya wajah untuk daftar wajah.

Nama	Jenis	Deskripsi
persistedFaceId	string	ID wajah wajah.
userData	string	Data yang disediakan pengguna yang dilampirkan ke wajah. Batas panjangnya adalah 1K.

RecognitionModel

Model pengenalan untuk wajah.

Nama	Jenis	Deskripsi
recognition_01	string	Model pengenalan default untuk "Deteksi". Semua faceId yang dibuat sebelum 2019 Maret diikat dengan model pengenalan ini.
recognition_02	string	Model pengenalan dirilis pada bulan Maret 2019.
recognition_03	string	Model pengenalan dirilis pada bulan Mei 2020.
recognition_04	string	Model pengenalan dirilis pada februari 2021. Disarankan untuk menggunakan model pengenalan ini untuk akurasi pengenalan yang lebih baik.