Person Group Operations - Get Person Groups

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

Kişi Gruplarının personGroupId, name, userData ve recognitionModel listeleyin.
Kişi Grupları, personGroupId 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.

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}/persongroups
İsteğe bağlı parametrelerle: 
GET {endpoint}/face/{apiVersion}/persongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

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).
returnRecognitionModel
 query

boolean

'recognitionModel' döndür veya döndürme. Varsayılan değer false'tur.
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

PersonGroup[]

Başarılı bir çağrı, Kişi Grupları ve bilgilerini (personGroupId, 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 PersonGroups

Örnek isteği

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

Örnek yanıt

Durum kodu:
200 
[
  {
    "name": "your_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "personGroupId": "your_person_group_id"
  }
]

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.
PersonGroup

Yüz tanıma özelliği ve en fazla 10.000 kişi dahil olmak üzere karşıya yüklenen kişi verilerinin kapsayıcısı. Büyük ölçekli yüz tanımlama sorununu çözmek için lütfen Büyük Kişi Grubu'na göz önünde bulundurun.
RecognitionModel

Yüzün tanıma modeli.

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.

PersonGroup

Yüz tanıma özelliği ve en fazla 10.000 kişi dahil olmak üzere karşıya yüklenen kişi verilerinin kapsayıcısı. Büyük ölçekli yüz tanımlama sorununu çözmek için lütfen Büyük Kişi Grubu'na göz önünde bulundurun.

Name Tür Description
name

string

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

string

Kapsayıcının kimliği.
recognitionModel

RecognitionModel

Tanıma modelinin adı. Tanıma modeli, yüz özellikleri ayıklandığında ve algılanan faceId'lerle ilişkilendirildiğinde kullanılır.
userData

string

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

RecognitionModel

Yüzün tanıma modeli.

Name Tür Description
recognition_01

string

"Algıla" için varsayılan tanıma modeli. 2019 Mart'tan önce oluşturulan tüm bu faceId'ler bu tanıma modeliyle birleştirilmiştir.
recognition_02

string

2019 Mart ayında yayınlanan tanıma modeli.
recognition_03

string

2020 Mayıs ayında yayımlanan tanıma modeli.
recognition_04

string

Tanıma modeli 2021 Şubat'ta yayımlandı. Daha iyi tanıma doğruluğu için bu tanıma modelinin kullanılması önerilir.