Face List Operations - Get Face List

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

Yüz Listesi'nin faceListId, name, userData, recognitionModel ve yüzlerini Yüz Listesinden alın.

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

string

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

Normal ifade deseni: ^[a-z0-9-_]+$
returnRecognitionModel
 query

boolean

'recognitionModel' döndür veya döndürme. Varsayılan değer false'tur.

Yanıtlar

Name Tür Description
200 OK

FaceList

Başarılı bir çağrı Yüz Listesi'nin bilgilerini 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 FaceList

Örnek isteği

GET {endpoint}/face/v1.2-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

Örnek yanıt

Durum kodu:
200 
{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "faceListId": "your_face_list_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.
FaceList

Yüz listesi, en fazla 1.000 yüz içeren bir yüz listesidir.
FaceListFace

Yüz listesi için yüz kaynağı.
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.

FaceList

Yüz listesi, en fazla 1.000 yüz içeren bir yüz listesidir.

Name Tür Description
faceListId

string

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

string

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

FaceListFace[]

Yüz listesindeki kayıtlı yüzlerin yüz kimlikleri.
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.

FaceListFace

Yüz listesi için yüz kaynağı.

Name Tür Description
persistedFaceId

string

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

string

Yüze eklenen kullanıcı tarafından sağlanan veriler. Uzunluk sınırı 1K'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.