Bagikan melalui

Person Directory Operations - Get Dynamic Person Groups

  • Referensi
Layanan:
Azure AI Services
Versi API:
v1.1-preview.1

Cantumkan semua Grup Orang Dinamis yang ada menurut dynamicPersonGroupId bersama dengan nama dan userData.
Grup Orang Dinamis disimpan dalam urutan alfabet dynamicPersonGroupId.

    • 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}/dynamicpersongroups
Dengan parameter opsional: 
GET {endpoint}/face/{apiVersion}/dynamicpersongroups?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).
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

DynamicPersonGroup[]

Panggilan yang berhasil mengembalikan array Grup Orang Dinamis dan informasinya (dynamicPersonGroupId, nama, dan userData).
Other Status Codes

FaceErrorResponse

Respons kesalahan yang tidak 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 DynamicPersonGroups

Permintaan sampel

GET {endpoint}/face/v1.1-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

Respon sampel

Kode status:
200 
[
  {
    "dynamicPersonGroupId": "your_dynamic_person_group_id",
    "name": "your_dynamic_person_group_name",
    "userData": "your_user_data"
  }
]

Definisi

Nama Deskripsi
DynamicPersonGroup

Kontainer yang mereferensikan Person Directory "Create Person".
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.

DynamicPersonGroup

Kontainer yang mereferensikan Person Directory "Create Person".

Nama Jenis Deskripsi
dynamicPersonGroupId

string

ID grup orang dinamis.
name

string

Nama yang ditentukan pengguna, panjang maksimum adalah 128.
userData

string

Data opsional yang ditentukan pengguna. Panjang tidak boleh melebihi 16K.

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.