Person Group Operations - Get Person Groups

Layanan:

Azure AI Services

Versi API:

v1.2-preview.1

Cantumkan personGroupId, nama, userData, dan recognitionModel milik Grup Orang.
Grup Orang disimpan dalam urutan alfabet personGroupId.

• • Parameter "start" (string, opsional) menentukan nilai ID dari mana entri yang dikembalikan akan memiliki ID yang lebih besar berdasarkan perbandingan string. Mengatur "start" 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 "start" dengan personId entri terakhir yang dikembalikan dalam panggilan saat ini.

Ujung

• Misalnya, ada total 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}/persongroups

Dengan parameter opsional:

GET {endpoint}/face/{apiVersion}/persongroups?start={start}&top={top}&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.
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, mulai dari [1, 1000]. Defaultnya adalah 1000.

Respons

Nama	Jenis	Deskripsi
200 OK	PersonGroup[]	Panggilan yang berhasil mengembalikan array Grup Orang dan informasinya (personGroupId, nama, dan userData).
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 PersonGroups

Permintaan sampel

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups?start=00000000-0000-0000-0000-000000000000&top=20&returnRecognitionModel=True

Respon sampel

Kode status:

200

[
  {
    "name": "your_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "personGroupId": "your_person_group_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.
PersonGroup	Kontainer data orang yang diunggah, termasuk fitur pengenalan wajah, dan hingga 10.000 orang. Untuk menangani masalah identifikasi wajah skala yang lebih besar, pertimbangkan untuk menggunakan Grup Orang Besar.
RecognitionModel	Model pengenalan untuk wajah.

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.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan 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.

PersonGroup

Kontainer data orang yang diunggah, termasuk fitur pengenalan wajah, dan hingga 10.000 orang. Untuk menangani masalah identifikasi wajah skala yang lebih besar, pertimbangkan untuk menggunakan Grup Orang Besar.

Nama	Jenis	Deskripsi
name	string	Nama yang ditentukan pengguna, panjang maksimum adalah 128.
personGroupId	string	ID kontainer.
recognitionModel	RecognitionModel	Nama model pengenalan. Model pengenalan digunakan saat fitur wajah diekstrak dan terkait dengan faceId yang terdeteksi.
userData	string	Data yang ditentukan pengguna opsional. Panjang tidak boleh melebihi 16K.

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.