Person Directory Operations - Update Dynamic Person Group With Person Changes

Service:

Azure AI Services

Version d'API:

v1.2-preview.1

Mettez à jour le nom ou userData d’un groupe de personnes dynamiques existant et gérez ses membres en ajoutant ou supprimant des personnes.
Les propriétés restent inchangées si elles ne sont pas dans le corps de la demande.

PATCH {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).

Corps de la demande

Nom	Type	Description
addPersonIds	string[]	Tableau de personIds créés par l’annuaire de personnes « Créer une personne » à ajouter.
name	string	Nom défini par l’utilisateur, la longueur maximale est 128.
removePersonIds	string[]	Tableau de personIds créés par l’annuaire de personnes « Créer une personne » à supprimer.
userData	string	Données définies par l’utilisateur facultatives. La longueur ne doit pas dépasser 16 Ko.

Réponses

Nom	Type	Description
202 Accepted		Un appel réussi retourne un corps de réponse vide. Le service a accepté la demande et commencera à traiter bientôt. Le client peut interroger l’état et le résultat de l’opération à l’aide de l’URL spécifiée dans l’en-tête de réponse « Operation-Location ». L’URL expire dans 48 heures. L’URL fournit l’état du moment où l’annuaire de personnes « Obtenir des références de groupe de personnes dynamiques » retourne les modifications apportées dans cette demande. En-têtes operation-Location: string
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

Update DynamicPersonGroup

Exemple de requête

HTTP

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

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ],
  "removePersonIds": [
    "67f7e96d-823a-4318-9bf6-e9a2a2608899"
  ]
}

Exemple de réponse

Code d’état:

202

operation-Location: https://contoso.com/operationstatus

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.

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.