Large Person Group - List

Layanan:

Azure AI Services

Versi API:

1.0

Cantumkan semua largePersonGroupId, nama, userData, dan recognitionModel grup orang besar yang ada.

• Grup orang besar disimpan dalam urutan alfabet largePersonGroupId.
• Parameter "start" (string, opsional) adalah nilai largePersonGroupId yang disediakan pengguna yang mengembalikan entri memiliki id yang lebih besar berdasarkan perbandingan string. "start" diatur ke kosong untuk menunjukkan pengembalian dari item pertama.
• Parameter "atas" (int, opsional) menentukan jumlah entri yang akan dikembalikan. Maksimal 1000 entri dapat dikembalikan dalam satu panggilan. Untuk mengambil lebih banyak, Anda dapat menentukan "mulai" dengan Id entri terakhir yang dikembalikan dari panggilan saat ini.
  Misalnya, total 5 grup orang besar: "group1", ..., "group5".
  "start=&top=" akan mengembalikan 5 grup.
  "start=&top=2" akan mengembalikan "group1", "group2".
  "start=group2&top=3" akan mengembalikan "group3", "group4", "group5".

GET {Endpoint}/face/v1.0/largepersongroups

Dengan parameter opsional:

GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus.api.cognitive.microsoft.com).
returnRecognitionModel	query		boolean	Nilai yang menunjukkan apakah operasi harus mengembalikan 'recognitionModel' sebagai respons.
start	query		string maxLength: 64	Cantumkan grup orang besar dari yang paling tidak besarPersonGroupId lebih besar dari "start".
top	query		integer minimum: 1 maximum: 1000	Jumlah grup orang besar yang akan dicantumkan.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string

Respons

Nama	Jenis	Deskripsi
200 OK	LargePersonGroup[]	Panggilan yang berhasil mengembalikan array grup orang besar dan informasinya.
Other Status Codes	APIError	Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

Contoh

List large person groups example

Permintaan sampel

HTTP

GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

Respon sampel

Kode status:

200

[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

Definisi

Nama	Deskripsi
APIError	Informasi kesalahan yang dikembalikan oleh API
Error	Isi kesalahan.
LargePersonGroup	Objek grup orang besar.
RecognitionModel	Nama model pengenalan. Model pengenalan digunakan saat fitur wajah diekstrak dan dikaitkan dengan faceId yang terdeteksi, (Besar)FaceList atau (Besar)PersonGroup. Nama model pengenalan dapat disediakan saat melakukan Face - Detect atau (Large)FaceList - Create atau (Large)PersonGroup - Create. Nilai defaultnya adalah 'recognition_01', jika model terbaru diperlukan, tentukan model yang Anda butuhkan secara eksplisit.

APIError

Objek

Informasi kesalahan yang dikembalikan oleh API

Nama	Jenis	Deskripsi
error	Error	Isi kesalahan.

Error

Objek

Isi kesalahan.

Nama	Jenis	Deskripsi
code	string
message	string

LargePersonGroup

Objek

Objek grup orang besar.

Nama	Jenis	Nilai default	Deskripsi
largePersonGroupId	string maxLength: 64 pattern: ^[a-z0-9-_]+$		LargePersonGroupId dari grup orang besar target
name	string minLength: 1 maxLength: 128		Nama yang ditentukan pengguna, panjang maksimum adalah 128.
recognitionModel	RecognitionModel	recognition_01	Nama model pengenalan. Model pengenalan digunakan saat fitur wajah diekstrak dan dikaitkan dengan faceId yang terdeteksi, (Besar)FaceList atau (Besar)PersonGroup. Nama model pengenalan dapat disediakan saat melakukan Face - Detect atau (Large)FaceList - Create atau (Large)PersonGroup - Create. Nilai defaultnya adalah 'recognition_01', jika model terbaru diperlukan, tentukan model yang Anda butuhkan secara eksplisit.
userData	string maxLength: 16384		Data yang ditentukan pengguna. Panjang tidak boleh melebihi 16KB.

RecognitionModel

Enumeration

Nama model pengenalan. Model pengenalan digunakan saat fitur wajah diekstrak dan dikaitkan dengan faceId yang terdeteksi, (Besar)FaceList atau (Besar)PersonGroup. Nama model pengenalan dapat disediakan saat melakukan Face - Detect atau (Large)FaceList - Create atau (Large)PersonGroup - Create. Nilai defaultnya adalah 'recognition_01', jika model terbaru diperlukan, tentukan model yang Anda butuhkan secara eksplisit.

Nilai	Deskripsi
recognition_01
recognition_02
recognition_03
recognition_04