Aracılığıyla paylaş


Face List Operations - Get Large Face List Faces

Belirtilen Büyük Yüz Tanıma Listesinde yüzlerin kalıcıFaceId ve userData bilgilerini listeleyin.
Yüzler, "Büyük Yüz Listesi Yüzü Ekle" içinde oluşturulan persistedFaceId 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}/largefacelists/{largeFaceListId}/persistedfaces
GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces?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).

largeFaceListId
path True

string

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

Geçerli karakter küçük harf veya basamaklı harf ya da '-' veya '_', maksimum uzunluk 64'dür.

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

LargeFaceListFace[]

Başarılı bir çağrı, kalıcı yüzler ve bilgilerini (persistedFaceId 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 Faces from LargeFaceList

Örnek isteği

GET {endpoint}/face/v1.2/largefacelists/your_large_face_list_id/persistedfaces?start=00000000-0000-0000-0000-000000000000&top=20

Örnek yanıt

[
  {
    "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
    "userData": "your_user_data"
  }
]

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.

LargeFaceListFace

Büyük yüz listesi için yüz kaynağı.

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.

LargeFaceListFace

Büyük yüz listesi için yüz kaynağı.

Name Tür Description
persistedFaceId

string (uuid)

Yüzün yüz kimliği.

userData

string

maxLength: 1024

Yüze eklenen kullanıcı tarafından sağlanan veriler. Uzunluk sınırı 1K'dır.