Person Directory Operations - Get Dynamic Person Groups

Service:

Azure AI Services

Version d'API:

v1.2-preview.1

Répertoriez tous les groupes de personnes dynamiques existants par dynamicPersonGroupId, ainsi que le nom et userData.
Les groupes de personnes dynamiques sont stockés par ordre alphabétique de dynamicPersonGroupId.

• • 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}/dynamicpersongroups

Avec des paramètres facultatifs:

GET {endpoint}/face/{apiVersion}/dynamicpersongroups?start={start}&top={top}

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).
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	DynamicPersonGroup[]	Un appel réussi retourne un tableau de groupes de personnes dynamiques et leurs informations (dynamicPersonGroupId, nom 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 DynamicPersonGroups

Exemple de requête

HTTP

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

Exemple de réponse

Code d’état:

200

[
  {
    "dynamicPersonGroupId": "your_dynamic_person_group_id",
    "name": "your_dynamic_person_group_name",
    "userData": "your_user_data"
  }
]

Définitions

Nom	Description
DynamicPersonGroup	Conteneur qui fait référence à Person Directory « Create Person ».
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.

DynamicPersonGroup

Conteneur qui fait référence à Person Directory « Create Person ».

Nom	Type	Description
dynamicPersonGroupId	string	ID du groupe de personnes dynamiques.
name	string	Nom défini par l’utilisateur, la longueur maximale est 128.
userData	string	Données définies par l’utilisateur facultatives. La longueur ne doit pas dépasser 16 Ko.

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.