Delen via

Person Group Operations - Get Large Person Groups

  • Referentie
Service:
Azure AI Services
API-versie:
v1.2-preview.1

Vermeld alle bestaande Large Person Groups largePersonGroupId, name, userData en recognitionModel.
Large Person Groups worden opgeslagen in alfabetische volgorde van largePersonGroupId.

    • Parameter 'start' (tekenreeks, optioneel) geeft een id-waarde op waaruit geretourneerde vermeldingen grotere id's hebben op basis van tekenreeksvergelijking. Als u 'begin' instelt op een lege waarde, wordt aangegeven dat vermeldingen moeten worden geretourneerd vanaf het eerste item.
    • De parameter top (int, optioneel) bepaalt het maximum aantal vermeldingen dat moet worden geretourneerd, met een limiet van maximaal 1000 vermeldingen per aanroep. Als u meer items wilt ophalen dan deze limiet, geeft u 'begin' op met de personId van het laatste item dat is geretourneerd in de huidige aanroep.

Fooi

  • Er zijn bijvoorbeeld in totaal vijf items met hun id's: 'itemId1', ..., 'itemId5'.
    • "start=&top=" retourneert alle vijf items.
    • "start=&top=2" retourneert "itemId1", "itemId2".
    • "start=itemId2&top=3" retourneert "itemId3", "itemId4", "itemId5".
GET {endpoint}/face/{apiVersion}/largepersongroups
Met optionele parameters: 
GET {endpoint}/face/{apiVersion}/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI-parameters

Name In Vereist Type Description
apiVersion
 path True

string

API-versie
endpoint
 path True

string (uri)

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://{resource-name}.cognitiveservices.azure.com).
returnRecognitionModel
 query

boolean

Retourneer 'recognitionModel' of niet. De standaardwaarde is onwaar.
start
 query

string

Resources weergeven die groter zijn dan het begin. Het bevat niet meer dan 64 tekens. De standaardwaarde is leeg.
top
 query

integer (int32)

minimum: 1
maximum: 1000

Het aantal te vermelden items, variërend in [1, 1000]. De standaardwaarde is 1000.

Antwoorden

Name Type Description
200 OK

LargePersonGroup[]

Een geslaagde aanroep retourneert een matrix van Large Person Groups en hun gegevens (largePersonGroupId, name en userData).
Other Status Codes

FaceErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

De geheime sleutel voor uw Azure AI Face-abonnement.

Type: apiKey
In: header

AADToken

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://api.example.com/oauth2/authorize
Token-URL: https://api.example.com/oauth2/token

Bereiken

Name Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Get LargePersonGroups

Voorbeeldaanvraag

GET {endpoint}/face/v1.2-preview.1/largepersongroups?start=00000000-0000-0000-0000-000000000000&top=20&returnRecognitionModel=True

Voorbeeldrespons

Statuscode:
200 
[
  {
    "name": "your_large_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "largePersonGroupId": "your_large_person_group_id"
  }
]

Definities

Name Description
FaceError

Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

Een antwoord met foutdetails.
LargePersonGroup

De container van de geüploade persoonsgegevens, inclusief gezichtsherkenningsfunctie en maximaal 1.000.000 personen.
RecognitionModel

Het herkenningsmodel voor het gezicht.

FaceError

Object

Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.
message

string

Een leesbare weergave van de fout.

FaceErrorResponse

Object

Een antwoord met foutdetails.

Name Type Description
error

FaceError

Het foutobject.

LargePersonGroup

Object

De container van de geüploade persoonsgegevens, inclusief gezichtsherkenningsfunctie en maximaal 1.000.000 personen.

Name Type Description
largePersonGroupId

string

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

Id van de container.
name

string

minLength: 1
maxLength: 128

Door de gebruiker gedefinieerde naam, de maximale lengte is 128.
recognitionModel

RecognitionModel

Naam van het herkenningsmodel. Het herkenningsmodel wordt gebruikt wanneer de gezichtsfuncties worden geëxtraheerd en gekoppeld aan gedetecteerde faceIds.
userData

string

maxLength: 16384

Optionele door de gebruiker gedefinieerde gegevens. De lengte mag niet groter zijn dan 16.000.

RecognitionModel

Inventarisatie

Het herkenningsmodel voor het gezicht.

Waarde Description
recognition_01

Het standaardherkenningsmodel voor 'Detecteren'. Al deze faceIds die vóór 2019 maart zijn gemaakt, worden gekoppeld aan dit herkenningsmodel.
recognition_02

Het herkenningsmodel is uitgebracht in maart 2019.
recognition_03

Het herkenningsmodel is uitgebracht in 2020.
recognition_04

Het herkenningsmodel is uitgebracht in 2021 februari. Het is raadzaam om dit herkenningsmodel te gebruiken voor betere nauwkeurigheid van herkenning.