Face List Operations - Get Large Face List Faces

Service:

Azure AI Services

API Version:

v1.1-preview.1

Mencantumkan persistedFaceId wajah dan userData dalam Daftar Wajah Besar tertentu.
Wajah disimpan dalam urutan alfabet persistedFaceId yang dibuat di "Tambahkan Wajah Daftar Wajah Besar".

• • Parameter "start" (string, opsional) menentukan nilai ID dari mana entri yang dikembalikan akan memiliki ID yang lebih besar berdasarkan perbandingan string. Mengatur "mulai" ke nilai kosong menunjukkan bahwa entri harus dikembalikan mulai dari item pertama.
  • Parameter "atas" (int, opsional) menentukan jumlah maksimum entri yang akan dikembalikan, dengan batas hingga 1000 entri per panggilan. Untuk mengambil entri tambahan di luar batas ini, tentukan "mulai" dengan personId entri terakhir yang dikembalikan dalam panggilan saat ini.

Tip

• Misalnya, total ada 5 item dengan ID mereka: "itemId1", ..., "itemId5".
  • "start=&top=" akan mengembalikan 5 item.
  • "start=&top=2" akan mengembalikan "itemId1", "itemId2".
  • "start=itemId2&top=3" akan mengembalikan "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces

With optional parameters:

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces?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).
largeFaceListId	path	True	string	Karakter yang valid adalah huruf dalam huruf kecil atau digit atau '-' atau '_', panjang maksimum adalah 64. Regex pattern: ^[a-z0-9-_]+$
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	LargeFaceListFace[]	Panggilan yang berhasil mengembalikan array wajah yang bertahan dan informasinya (persistedFaceId dan userData).
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 Faces from LargeFaceList

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/largefacelists/your_large_face_list_id/persistedfaces?start=00000000-0000-0000-0000-000000000000&top=20

Sample Response

Status code:

200

[
  {
    "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
    "userData": "your_user_data"
  }
]

Definisi

Nama	Deskripsi
FaceError	Objek kesalahan. Untuk detail komprehensif tentang kode kesalahan dan pesan yang dikembalikan oleh Layanan Wajah, silakan lihat tautan berikut: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Respons yang berisi detail kesalahan.
LargeFaceListFace	Sumber daya wajah untuk daftar wajah besar.

FaceError

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

LargeFaceListFace

Sumber daya wajah untuk daftar wajah besar.

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