Large Person Group - List

Service:

Azure AI Services

API-versie:

1.0

Vermeld alle bestaande grote personengroepen largePersonGroupId, naam, userData en recognitionModel.

• Grote personengroepen worden opgeslagen in alfabetische volgorde van largePersonGroupId.
• Parameter 'start' (tekenreeks, optioneel) is een door de gebruiker verstrekte largePersonGroupId-waarde die geretourneerde vermeldingen grotere id's hebben door tekenreeksvergelijking. 'begin' ingesteld op leeg om aan te geven dat het resultaat van het eerste item wordt geretourneerd.
• De parameter 'top' (int, optioneel) geeft het aantal vermeldingen op dat moet worden geretourneerd. Een maximum van 1000 vermeldingen kan in één aanroep worden geretourneerd. Als u meer wilt ophalen, kunt u 'beginnen' opgeven met de id van de laatste geretourneerde vermelding van de huidige aanroep.
  Bijvoorbeeld: totaal 5 grote personengroepen: 'group1', ..., 'group5'.
  "start=&top=" retourneert alle vijf groepen.
  "start=&top=2" retourneert "group1", "group2".
  "start=group2&top=3" retourneert "group3", "group4", "group5".

GET {Endpoint}/face/v1.0/largepersongroups

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).
returnRecognitionModel	query		boolean	Een waarde die aangeeft of de bewerking 'recognitionModel' als antwoord moet retourneren.
start	query		string maxLength: 64	Vermeld grote personengroepen van de minst grotePersonGroupId groter dan de 'start'.
top	query		integer minimum: 1 maximum: 1000	Het aantal groepen grote personen dat moet worden vermeld.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Antwoorden

Name	Type	Description
200 OK	LargePersonGroup[]	Een geslaagde aanroep retourneert een matrix met groepen grote personen en hun informatie.
Other Status Codes	APIError	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

List large person groups example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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"
  }
]

Definities

Name	Description
APIError	Foutinformatie geretourneerd door de API
Error	Hoofdtekst van de fout.
LargePersonGroup	Groepsobject voor grote personen.
RecognitionModel	Naam van het herkenningsmodel. Het herkenningsmodel wordt gebruikt wanneer de gezichtsfuncties worden geëxtraheerd en gekoppeld aan gedetecteerde faceIds, (Large)FaceList of (Large)PersonGroup. Er kan een naam voor het herkenningsmodel worden opgegeven bij het uitvoeren van Face - Detecteren of (Groot)FaceList - Maken of (Groot)PersonGroup - Maken. De standaardwaarde is 'recognition_01', indien het meest recente model nodig is, geef expliciet het model op dat u nodig hebt.

APIError

Object

Foutinformatie geretourneerd door de API

Name	Type	Description
error	Error	Hoofdtekst van de fout.

Error

Object

Hoofdtekst van de fout.

Name	Type	Description
code	string
message	string

LargePersonGroup

Object

Groepsobject voor grote personen.

Name	Type	Default value	Description
largePersonGroupId	string maxLength: 64 pattern: ^[a-z0-9-_]+$		LargePersonGroupId van de doelgroepen voor grote personen
name	string minLength: 1 maxLength: 128		Door de gebruiker gedefinieerde naam, de maximale lengte is 128.
recognitionModel	RecognitionModel	recognition_01	Naam van het herkenningsmodel. Het herkenningsmodel wordt gebruikt wanneer de gezichtsfuncties worden geëxtraheerd en gekoppeld aan gedetecteerde faceIds, (Large)FaceList of (Large)PersonGroup. Er kan een naam voor het herkenningsmodel worden opgegeven bij het uitvoeren van Face - Detecteren of (Groot)FaceList - Maken of (Groot)PersonGroup - Maken. De standaardwaarde is 'recognition_01', indien het meest recente model nodig is, geef expliciet het model op dat u nodig hebt.
userData	string maxLength: 16384		Door de gebruiker opgegeven gegevens. De lengte mag niet groter zijn dan 16 kB.

RecognitionModel

Inventarisatie

Naam van het herkenningsmodel. Het herkenningsmodel wordt gebruikt wanneer de gezichtsfuncties worden geëxtraheerd en gekoppeld aan gedetecteerde faceIds, (Large)FaceList of (Large)PersonGroup. Er kan een naam voor het herkenningsmodel worden opgegeven bij het uitvoeren van Face - Detecteren of (Groot)FaceList - Maken of (Groot)PersonGroup - Maken. De standaardwaarde is 'recognition_01', indien het meest recente model nodig is, geef expliciet het model op dat u nodig hebt.

Waarde	Description
recognition_01
recognition_02
recognition_03
recognition_04