Bagikan melalui

Person Group Operations - Get Large Person Group Persons

  • Referensi
Service:
Azure AI Services
API Version:
v1.1-preview.1

Cantumkan semua informasi orang dalam Grup Orang Besar yang ditentukan, termasuk personId, nama, userData, dan persistedFaceIds wajah orang terdaftar.
Orang disimpan dalam urutan abjad personId yang dibuat dalam "Create Orang Grup Orang Besar".

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

Tip

  • 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}/largepersongroups/{largePersonGroupId}/persons
With optional parameters: 
GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/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).
largePersonGroupId
 path True

string

ID kontainer.

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

LargePersonGroupPerson[]

Panggilan yang berhasil mengembalikan array informasi orang yang termasuk dalam Grup Orang Besar.
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 Persons from LargePersonGroup

Sample Request

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

Sample Response

Status code:
200 
[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_large_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 Face Service, silakan lihat tautan berikut: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

Respons yang berisi detail kesalahan.
LargePersonGroupPerson

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

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.

LargePersonGroupPerson

Orang dalam grup orang besar tertentu. Untuk menambahkan wajah ke orang ini, silakan panggil "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 opsional yang ditentukan pengguna. Panjang tidak boleh melebihi 16K.