Person Group Operations - Get Large Person Group Persons

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

Kayıtlı kişi yüzlerinin personId, name, userData ve persistedFaceId'leri de dahil olmak üzere belirtilen Büyük Kişi Grubundaki tüm kişilerin bilgilerini listeleyin.
Kişiler, "Büyük Kişi Grubu Kişisi Oluşturma" içinde oluşturulan personId'nin alfabetik sırasına göre 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.

Bahşiş

  • Ö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}/largepersongroups/{largePersonGroupId}/persons
İsteğe bağlı parametrelerle: 
GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/persons?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).
largePersonGroupId
 path True

string

Kapsayıcının kimliği.

Normal ifade deseni: ^[a-z0-9-_]+$
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

[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

LargePersonGroupPerson[]

Başarılı bir çağrı, Büyük Kişi Grubuna ait bir kişi bilgileri dizisi 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 Persons from LargePersonGroup

Örnek isteği

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

Örnek yanıt

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

Tanımlar

Name Description
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.
LargePersonGroupPerson

Belirtilen büyük kişi grubundaki kişi. Bu kişiye yüz eklemek için lütfen "Büyük Kişi Grubu Kişi Yüzü Ekle"yi arayın.

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.

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

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

Name Tür Description
error

FaceError

Hata nesnesi.

LargePersonGroupPerson

Belirtilen büyük kişi grubundaki kişi. Bu kişiye yüz eklemek için lütfen "Büyük Kişi Grubu Kişi Yüzü Ekle"yi arayın.

Name Tür Description
name

string

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

string[]

Kişideki kayıtlı yüzlerin yüz kimlikleri.
personId

string

Kişinin kimliği.
userData

string

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