Person Group Operations - Get Person Group Persons
Répertoriez toutes les informations de personnes dans le groupe de personnes spécifié, y compris personId, name, userData et persistedFaceIds des visages de personne inscrite.
Les personnes sont stockées dans l’ordre alphabétique de personId créé dans « Créer une personne de groupe de personnes ».
-
- 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/{personGroupId}/persons
GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons?start={start}&top={top}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
api
|
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). |
person
|
path | True |
string |
ID du conteneur. Modèle d’expression régulière: |
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 |
Un appel réussi retourne un tableau d’informations de personne appartenant au groupe de personnes. |
|
Other Status Codes |
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 Persons from PersonGroup
Exemple de requête
GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons?start=00000000-0000-0000-0000-000000000000&top=20
Exemple de réponse
[
{
"personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
"name": "your_person_group_person_name",
"userData": "your_user_data",
"persistedFaceIds": [
"43897a75-8d6f-42cf-885e-74832febb055"
]
}
]
Définitions
Nom | Description |
---|---|
Face |
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. |
Face |
Réponse contenant les détails de l’erreur. |
Person |
Personne dans un groupe de personnes spécifié. Pour ajouter un visage à cette personne, appelez « Ajouter un visage de personne grand groupe de personnes ». |
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 |
Objet d’erreur. |
PersonGroupPerson
Personne dans un groupe de personnes spécifié. Pour ajouter un visage à cette personne, appelez « Ajouter un visage de personne grand groupe de personnes ».
Nom | Type | Description |
---|---|---|
name |
string |
Nom défini par l’utilisateur, la longueur maximale est 128. |
persistedFaceIds |
string[] |
Ids de visages des visages inscrits dans la personne. |
personId |
string |
ID de la personne. |
userData |
string |
Données définies par l’utilisateur facultatives. La longueur ne doit pas dépasser 16 Ko. |