Person Group Operations - Get Person Group Persons

Layanan:

Azure AI Services

Versi API:

v1.2-preview.1

Cantumkan semua informasi orang dalam Grup Orang yang ditentukan, termasuk personId, nama, userData, dan persistedFaceIds wajah orang terdaftar.
Orang disimpan dalam urutan alfabet personId yang dibuat di "Buat Orang Grup Orang".

• • 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/{personGroupId}/persons

Dengan parameter opsional:

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons?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).
personGroupId	path	True	string	ID kontainer. Pola regex: ^[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, mulai dari [1, 1000]. Defaultnya adalah 1000.

Respons

Nama	Jenis	Deskripsi
200 OK	PersonGroupPerson[]	Panggilan yang berhasil mengembalikan array informasi orang yang termasuk dalam Grup Orang.
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 Persons from PersonGroup

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_person_group_person_name",
    "userData": "your_user_data",
    "persistedFaceIds": [
      "43897a75-8d6f-42cf-885e-74832febb055"
    ]
  }
]

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.
PersonGroupPerson	Orang dalam grup orang tertentu. Untuk menambahkan wajah ke orang ini, silakan hubungi "Tambahkan Wajah Orang Grup Orang Besar".

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.

PersonGroupPerson

Orang dalam grup orang tertentu. Untuk menambahkan wajah ke orang ini, silakan hubungi "Tambahkan Wajah Orang Grup Orang Besar".

Nama	Jenis	Deskripsi
name	string	Nama yang ditentukan pengguna, panjang maksimum adalah 128.
persistedFaceIds	string[]	Id wajah wajah terdaftar pada orang tersebut.
personId	string	ID orang tersebut.
userData	string	Data yang ditentukan pengguna opsional. Panjang tidak boleh melebihi 16K.