Large Person Group - List
Tüm mevcut büyük kişi gruplarının largePersonGroupId, name, userData ve recognitionModel listeleyin.
- Büyük kişi grupları, largePersonGroupId alfabetik sırada depolanır.
- "start" parametresi (dize, isteğe bağlı), döndürülen girdilerin dize karşılaştırmaya göre daha büyük kimliklere sahip olduğu kullanıcı tarafından sağlanan bir largePersonGroupId değeridir. "start" ayarı, ilk öğeden gelen dönüşü belirtmek için boş olarak ayarlanır.
- "top" parametresi (int, isteğe bağlı) döndürülecek girdi sayısını belirtir. Bir çağrıda en fazla 1000 giriş döndürülebilir. Daha fazlasını getirmek için, son döndürülen girdinin geçerli çağrı kimliğiyle "start" değerini belirtebilirsiniz.
Örneğin, toplam 5 büyük kişi grubu: "grup1", ..., "grup5".
"start=&top=" 5 grubun tümünü döndürür.
"start=&top=2", "group1", "group2" döndürür.
"start=group2&top=3", "group3", "group4", "group5" döndürür.
GET {Endpoint}/face/v1.0/largepersongroups
GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}
URI Parametreleri
| Name | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://westus.api.cognitive.microsoft.com). |
|
return
|
query |
boolean |
İşlemin yanıt olarak 'recognitionModel' döndürerek döndürmeyeceğini belirten bir değer. |
|
|
start
|
query |
string maxLength: 64 |
"start" değerinden büyük olan en az largePersonGroupId değerinden büyük kişi gruplarını listeleyin. |
|
|
top
|
query |
integer minimum: 1maximum: 1000 |
Listelenecek büyük kişi gruplarının sayısı. |
İstek Başlığı
| Name | Gerekli | Tür | Description |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | True |
string |
Yanıtlar
| Name | Tür | Description |
|---|---|---|
| 200 OK |
Başarılı bir çağrı, büyük kişi gruplarını ve bilgilerini içeren bir dizi döndürür. |
|
| Other Status Codes |
Hata yanıtı. |
Güvenlik
Ocp-Apim-Subscription-Key
Tür:
apiKey
İçinde:
header
Örnekler
List large person groups example
Örnek isteği
GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True
Örnek yanıt
[
{
"largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
"name": "large-person-group-name1",
"userData": "User-provided data attached to the large person group.",
"recognitionModel": "recognition_01"
},
{
"largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
"name": "large-person-group-name2",
"userData": "User-provided data attached to the large person group.",
"recognitionModel": "recognition_01"
}
]
Tanımlar
| Name | Description |
|---|---|
| APIError |
API tarafından döndürülen hata bilgileri |
| Error |
Hata gövdesi. |
|
Large |
Büyük kişi grubu nesnesi. |
|
Recognition |
Tanıma modelinin adı. Tanıma modeli, yüz özellikleri ayıklandığında ve algılanan faceId'ler, (Büyük)FaceList veya (Büyük)PersonGroup ile ilişkilendirildiğinde kullanılır. Yüz Tanıma - Algılama veya (Büyük)FaceList - Oluştur veya (Büyük)PersonGroup - Oluştur işlemi gerçekleştirilirken bir tanıma modeli adı sağlanabilir. Varsayılan değer 'recognition_01'dır, en son model gerekiyorsa lütfen ihtiyacınız olan modeli açıkça belirtin. |
APIError
API tarafından döndürülen hata bilgileri
| Name | Tür | Description |
|---|---|---|
| error |
Hata gövdesi. |
Error
Hata gövdesi.
| Name | Tür | Description |
|---|---|---|
| code |
string |
|
| message |
string |
LargePersonGroup
Büyük kişi grubu nesnesi.
| Name | Tür | Default value | Description |
|---|---|---|---|
| largePersonGroupId |
string maxLength: 64pattern: ^[a-z0-9-_]+$ |
Hedef büyük kişi gruplarının LargePersonGroupId değeri |
|
| name |
string minLength: 1maxLength: 128 |
Kullanıcı tanımlı ad, uzunluk üst sınırı 128'dir. |
|
| recognitionModel | recognition_01 |
Tanıma modelinin adı. Tanıma modeli, yüz özellikleri ayıklandığında ve algılanan faceId'ler, (Büyük)FaceList veya (Büyük)PersonGroup ile ilişkilendirildiğinde kullanılır. Yüz Tanıma - Algılama veya (Büyük)FaceList - Oluştur veya (Büyük)PersonGroup - Oluştur işlemi gerçekleştirilirken bir tanıma modeli adı sağlanabilir. Varsayılan değer 'recognition_01'dır, en son model gerekiyorsa lütfen ihtiyacınız olan modeli açıkça belirtin. |
|
| userData |
string maxLength: 16384 |
Kullanıcı tarafından belirtilen veriler. Uzunluk 16 KB'ı aşmamalıdır. |
RecognitionModel
Tanıma modelinin adı. Tanıma modeli, yüz özellikleri ayıklandığında ve algılanan faceId'ler, (Büyük)FaceList veya (Büyük)PersonGroup ile ilişkilendirildiğinde kullanılır. Yüz Tanıma - Algılama veya (Büyük)FaceList - Oluştur veya (Büyük)PersonGroup - Oluştur işlemi gerçekleştirilirken bir tanıma modeli adı sağlanabilir. Varsayılan değer 'recognition_01'dır, en son model gerekiyorsa lütfen ihtiyacınız olan modeli açıkça belirtin.
| Değer | Description |
|---|---|
| recognition_01 | |
| recognition_02 | |
| recognition_03 | |
| recognition_04 |