Partager via


Face List Operations - Get Face List

Récupérez le faceListId, le nom, userData, recognitionModel et les visages d’une liste de visages d’une liste de visages.

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}
GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

Paramètres URI

Nom Dans Obligatoire Type Description
apiVersion
path True

string

Version de l’API

endpoint
path True

string

uri

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://{nom-ressource}.cognitiveservices.azure.com).

faceListId
path True

string

Le caractère valide est la lettre en minuscules ou en chiffres ou '-' ou '_', la longueur maximale est 64.

Modèle d’expression régulière: ^[a-z0-9-_]+$

returnRecognitionModel
query

boolean

Retournez « recognitionModel » ou non. La valeur par défaut est false.

Réponses

Nom Type Description
200 OK

FaceList

Un appel réussi retourne les informations de La liste des visages.

Other Status Codes

FaceErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Clé secrète de votre abonnement Azure AI Face.

Type: apiKey
Dans: header

AADToken

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://api.example.com/oauth2/authorize
URL du jeton: https://api.example.com/oauth2/token

Étendues

Nom Description
https://cognitiveservices.azure.com/.default

Exemples

Get FaceList

Exemple de requête

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

Exemple de réponse

{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "faceListId": "your_face_list_id"
}

Définitions

Nom Description
FaceError

Objet d’erreur. Pour plus d’informations sur les codes d’erreur et les messages retournés par le service Visage, reportez-vous au lien suivant : https://aka.ms/face-error-codes-and-messages.

FaceErrorResponse

Réponse contenant les détails de l’erreur.

FaceList

La liste des visages est une liste de visages, jusqu’à 1 000 visages.

FaceListFace

Ressource Visage pour la liste des visages.

RecognitionModel

Modèle de reconnaissance pour le visage.

FaceError

Objet d’erreur. Pour plus d’informations sur les codes d’erreur et les messages retournés par le service Visage, reportez-vous au lien suivant : https://aka.ms/face-error-codes-and-messages.

Nom Type Description
code

string

Un ensemble de codes d’erreur définis par le serveur.

message

string

Représentation lisible par l’homme de l’erreur.

FaceErrorResponse

Réponse contenant les détails de l’erreur.

Nom Type Description
error

FaceError

Objet d’erreur.

FaceList

La liste des visages est une liste de visages, jusqu’à 1 000 visages.

Nom Type Description
faceListId

string

Le caractère valide est la lettre en minuscules ou en chiffres ou '-' ou '_', la longueur maximale est 64.

name

string

Nom défini par l’utilisateur, la longueur maximale est 128.

persistedFaces

FaceListFace[]

Ids de visages des visages inscrits dans la liste des visages.

recognitionModel

RecognitionModel

Nom du modèle de reconnaissance. Le modèle de reconnaissance est utilisé lorsque les fonctionnalités du visage sont extraites et associées à des visages détectés.

userData

string

Données définies par l’utilisateur facultatives. La longueur ne doit pas dépasser 16 Ko.

FaceListFace

Ressource Visage pour la liste des visages.

Nom Type Description
persistedFaceId

string

ID de visage du visage.

userData

string

Données fournies par l’utilisateur attachées au visage. La limite de longueur est de 1 Ko.

RecognitionModel

Modèle de reconnaissance pour le visage.

Nom Type Description
recognition_01

string

Modèle de reconnaissance par défaut pour « Détecter ». Tous ces faceIds créés avant mars 2019 sont liés à ce modèle de reconnaissance.

recognition_02

string

Modèle de reconnaissance publié en mars 2019.

recognition_03

string

Modèle de reconnaissance publié en mai 2020.

recognition_04

string

Modèle de reconnaissance publié en février 2021. Il est recommandé d’utiliser ce modèle de reconnaissance pour une meilleure précision de reconnaissance.