Partager via

Large Person Group - List

Service:
Azure AI Services
Version d'API:
1.0

Répertorie tous les grands groupes de personnes volumineux, nom, userData et recognitionModel.

  • Les groupes de personnes volumineux sont stockés par ordre alphabétique de largePersonGroupId.
  • Le paramètre « start » (chaîne, facultatif) est une valeur largePersonGroupId fournie par l’utilisateur qui a retourné des ID plus importants par comparaison de chaînes. « start » défini sur vide pour indiquer le retour à partir du premier élément.
  • Le paramètre « top » (int, facultatif) spécifie le nombre d’entrées à retourner. Un maximum de 1 000 entrées peut être retourné dans un appel. Pour plus d’informations, vous pouvez spécifier « démarrer » avec l’ID de la dernière entrée retournée de l’appel actuel.
    Par exemple, 5 grands groupes de personnes : « group1 », ... , « group5 ».
    « start=&top= » retourne tous les 5 groupes.
    « start=&top=2 » retourne « group1 », « group2 ».
    « start=group2&top=3 » retourne « group3 », « group4 », « group5 ».
GET {Endpoint}/face/v1.0/largepersongroups
Avec des paramètres facultatifs: 
GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

Paramètres URI

Nom Dans Obligatoire Type Description
Endpoint
 path True

string

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com).
returnRecognitionModel
 query

boolean

Valeur indiquant si l’opération doit retourner « recognitionModel » en réponse.
start
 query

string

maxLength: 64

Répertorier les groupes de personnes volumineux du moins grandPersonGroupId supérieur au « start ».
top
 query

integer

minimum: 1
maximum: 1000

Nombre de groupes de personnes volumineux à répertorier.

En-tête de la demande

Nom Obligatoire Type Description
Ocp-Apim-Subscription-Key True

string

Réponses

Nom Type Description
200 OK

LargePersonGroup[]

Un appel réussi retourne un tableau de groupes de personnes volumineux et leurs informations.
Other Status Codes

APIError

Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

List large person groups example

Exemple de requête

GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

Exemple de réponse

Code d’état:
200 
[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

Définitions

Nom Description
APIError

Informations d’erreur retournées par l’API
Error

Corps de l’erreur.
LargePersonGroup

Objet de groupe de personnes volumineux.
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 aux faceIds détectés, (Large)FaceList ou (Large)PersonGroup. Un nom de modèle de reconnaissance peut être fourni lors de l’exécution de Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. La valeur par défaut est « recognition_01 », si le dernier modèle est nécessaire, spécifiez explicitement le modèle dont vous avez besoin.

APIError

Object

Informations d’erreur retournées par l’API

Nom Type Description
error

Error

Corps de l’erreur.

Error

Object

Corps de l’erreur.

Nom Type Description
code

string

message

string

LargePersonGroup

Object

Objet de groupe de personnes volumineux.

Nom Type Valeur par défaut Description
largePersonGroupId

string

maxLength: 64
pattern: ^[a-z0-9-_]+$

LargePersonGroupId des groupes de personnes volumineux cibles
name

string

minLength: 1
maxLength: 128

Nom défini par l’utilisateur, la longueur maximale est 128.
recognitionModel

RecognitionModel

recognition_01

Nom du modèle de reconnaissance. Le modèle de reconnaissance est utilisé lorsque les fonctionnalités du visage sont extraites et associées aux faceIds détectés, (Large)FaceList ou (Large)PersonGroup. Un nom de modèle de reconnaissance peut être fourni lors de l’exécution de Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. La valeur par défaut est « recognition_01 », si le dernier modèle est nécessaire, spécifiez explicitement le modèle dont vous avez besoin.
userData

string

maxLength: 16384

Données spécifiées par l’utilisateur. La longueur ne doit pas dépasser 16 Ko.

RecognitionModel

Énumération

Nom du modèle de reconnaissance. Le modèle de reconnaissance est utilisé lorsque les fonctionnalités du visage sont extraites et associées aux faceIds détectés, (Large)FaceList ou (Large)PersonGroup. Un nom de modèle de reconnaissance peut être fourni lors de l’exécution de Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. La valeur par défaut est « recognition_01 », si le dernier modèle est nécessaire, spécifiez explicitement le modèle dont vous avez besoin.

Valeur Description
recognition_01
recognition_02
recognition_03
recognition_04