Person Group Operations - Get Person Groups

Service:

Azure AI Services

Version d'API:

v1.2-preview.1

Répertorier personGroupId, name, userData et recognitionModel.
Les groupes de personnes sont stockés par ordre alphabétique de personGroupId.

• • Le paramètre « start » (chaîne, facultatif) spécifie une valeur d’ID à partir de laquelle les entrées retournées auront des ID plus volumineux en fonction de la comparaison de chaînes. La définition de « start » sur une valeur vide indique que les entrées doivent être retournées à partir du premier élément.
  • Le paramètre « top » (int, facultatif) détermine le nombre maximal d’entrées à retourner, avec une limite allant jusqu’à 1 000 entrées par appel. Pour récupérer des entrées supplémentaires au-delà de cette limite, spécifiez « start » avec l’id de personne de la dernière entrée retournée dans l’appel actuel.

Pourboire

• Par exemple, il existe au total 5 éléments avec leurs ID : « itemId1 », ..., « itemId5 ».
  • « start=&top= » retourne tous les 5 éléments.
  • « start=&top=2 » retourne « itemId1 », « itemId2 ».
  • « start=itemId2&top=3 » retourne « itemId3 », « itemId4 », « itemId5 ».

GET {endpoint}/face/{apiVersion}/persongroups

Avec des paramètres facultatifs:

GET {endpoint}/face/{apiVersion}/persongroups?start={start}&top={top}&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).
returnRecognitionModel	query		boolean	Retournez « recognitionModel » ou non. La valeur par défaut est false.
start	query		string	Répertorier les ressources supérieures au « start ». Il ne contient pas plus de 64 caractères. La valeur par défaut est vide.
top	query		integer int32	Nombre d’éléments à répertorier, compris dans [1, 1000]. La valeur par défaut est 1 000.

Réponses

Nom	Type	Description
200 OK	PersonGroup[]	Un appel réussi retourne un tableau de groupes de personnes et leurs informations (personGroupId, name et userData).
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 PersonGroups

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

[
  {
    "name": "your_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "personGroupId": "your_person_group_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.
PersonGroup	Conteneur des données de personne chargées, y compris la fonctionnalité de reconnaissance faciale, et jusqu’à 10 000 personnes. Pour gérer un problème d’identification des visages à grande échelle, envisagez d’utiliser un groupe de personnes volumineux.
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.

PersonGroup

Conteneur des données de personne chargées, y compris la fonctionnalité de reconnaissance faciale, et jusqu’à 10 000 personnes. Pour gérer un problème d’identification des visages à grande échelle, envisagez d’utiliser un groupe de personnes volumineux.

Nom	Type	Description
name	string	Nom défini par l’utilisateur, la longueur maximale est 128.
personGroupId	string	ID du conteneur.
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.

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.