Person Directory Operations - Get Dynamic Person Group

Service:

Azure AI Services

Version d'API:

v1.2-preview.1

Récupérez les informations d’un groupe de personnes dynamiques, y compris son nom et userData.
Cette API retourne uniquement les informations de groupe de personnes dynamiques, utilisez l’annuaire de personnes « Obtenir des personnes de groupe de personnes dynamiques » pour récupérer des informations de personne sous le groupe de personnes dynamiques.

GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
apiVersion	path	True	string	Version de l’API
dynamicPersonGroupId	path	True	string	ID du groupe de personnes dynamiques. Modèle d’expression régulière: ^[a-z0-9-_]+$
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).

Réponses

Nom	Type	Description
200 OK	DynamicPersonGroup	Un appel réussi retourne les informations du groupe de personnes dynamiques.
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 DynamicPersonGroup

Exemple de requête

HTTP

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

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.