Aracılığıyla paylaş

Person Directory Operations - Get Dynamic Person Groups

  • Başvuru
Hizmet:
Azure AI Services
API Sürümü:
v1.2-preview.1

Mevcut tüm Dinamik Kişi Gruplarını ad ve userData ile birlikte dynamicPersonGroupId'ye göre listeleyin.
Dinamik Kişi Grupları, dynamicPersonGroupId alfabetik sırada depolanır.

    • "start" parametresi (dize, isteğe bağlı), döndürülen girişlerin dize karşılaştırması temelinde daha büyük kimliklere sahip olacağı bir kimlik değeri belirtir. "start" değerinin boş bir değere ayarlanması, ilk öğeden başlayarak girişlerin döndürülmesi gerektiğini gösterir.
    • "top" parametresi (int, isteğe bağlı), çağrı başına en fazla 1000 giriş sınırıyla döndürülecek en fazla girdi sayısını belirler. Bu sınırı aşan ek girişleri almak için, geçerli çağrıda döndürülen son girişin personId değeriyle "start" değerini belirtin.

Tavsiye

  • Örneğin, kimlikleriyle birlikte toplam 5 öğe vardır: "itemId1", ..., "itemId5".
    • "start=&top=" 5 öğenin tümünü döndürür.
    • "start=&top=2", "itemId1", "itemId2" döndürür.
    • "start=itemId2&top=3", "itemId3", "itemId4", "itemId5" döndürür.
GET {endpoint}/face/{apiVersion}/dynamicpersongroups
İsteğe bağlı parametrelerle: 
GET {endpoint}/face/{apiVersion}/dynamicpersongroups?start={start}&top={top}

URI Parametreleri

Name İçinde Gerekli Tür Description
apiVersion
 path True

string

API Sürümü
endpoint
 path True

string (uri)

Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://{resource-name}.cognitiveservices.azure.com).
start
 query

string

"Başlangıç" değerinden büyük kaynakları listeleyin. En fazla 64 karakter içerir. Varsayılan boş.
top
 query

integer (int32)

minimum: 1
maximum: 1000

[1, 1000] ile değişen, listelenmesi gereken öğe sayısı. Varsayılan değer 1000'dir.

Yanıtlar

Name Tür Description
200 OK

DynamicPersonGroup[]

Başarılı bir çağrı, Dinamik Kişi Grupları ve bilgilerini (dynamicPersonGroupId, name ve userData) içeren bir dizi döndürür.
Other Status Codes

FaceErrorResponse

Beklenmeyen bir hata yanıtı.

Üst Bilgiler

x-ms-error-code: string

Güvenlik

Ocp-Apim-Subscription-Key

Azure Yapay Zeka Yüz Tanıma aboneliğinizin gizli anahtarı.

Tür: apiKey
İçinde: header

AADToken

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://api.example.com/oauth2/authorize
Belirteç URL'si: https://api.example.com/oauth2/token

Kapsamlar

Name Description
https://cognitiveservices.azure.com/.default

Örnekler

Get DynamicPersonGroups

Örnek isteği

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

Örnek yanıt

Durum kodu:
200 
[
  {
    "dynamicPersonGroupId": "your_dynamic_person_group_id",
    "name": "your_dynamic_person_group_name",
    "userData": "your_user_data"
  }
]

Tanımlar

Name Description
DynamicPersonGroup

Kişi Dizini "Kişi Oluştur" öğesine başvuran bir kapsayıcı.
FaceError

Hata nesnesi. Yüz Tanıma Hizmeti tarafından döndürülen hata kodları ve iletiler hakkında ayrıntılı bilgi için lütfen şu bağlantıya bakın: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

Hata ayrıntılarını içeren bir yanıt.

DynamicPersonGroup

Object

Kişi Dizini "Kişi Oluştur" öğesine başvuran bir kapsayıcı.

Name Tür Description
dynamicPersonGroupId

string

minLength: 1
maxLength: 64
pattern: ^[a-z0-9-_]+$

Dinamik kişi grubunun kimliği.
name

string

minLength: 1
maxLength: 128

Kullanıcı tanımlı ad, uzunluk üst sınırı 128'dir.
userData

string

maxLength: 16384

İsteğe bağlı kullanıcı tanımlı veriler. Uzunluk 16K'yi aşmamalıdır.

FaceError

Object

Hata nesnesi. Yüz Tanıma Hizmeti tarafından döndürülen hata kodları ve iletiler hakkında ayrıntılı bilgi için lütfen şu bağlantıya bakın: https://aka.ms/face-error-codes-and-messages.

Name Tür Description
code

string

Sunucu tanımlı hata kodları kümesinden biri.
message

string

Hatanın insan tarafından okunabilir bir gösterimi.

FaceErrorResponse

Object

Hata ayrıntılarını içeren bir yanıt.

Name Tür Description
error

FaceError

Hata nesnesi.