Delen via

Person Directory Operations - Get Persons

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

Vermeld alle gegevens van alle personen in persoonsdirectory, inclusief personId, naam en userData.
Personen worden opgeslagen in alfabetische volgorde van personId die is gemaakt in person directory 'Create Person'.

    • 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}/persons
Met optionele parameters: 
GET {endpoint}/face/{apiVersion}/persons?start={start}&top={top}

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

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

Antwoorden

Name Type Description
200 OK

PersonDirectoryPerson[]

Een geslaagde aanroep retourneert een matrix met personen in de groep Dynamische personen.
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 Persons from PersonDirectory

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
200 
[
  {
    "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
    "name": "your_person_name",
    "userData": "your_user_data"
  }
]

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.
PersonDirectoryPerson

Persoonsresource voor persoonsmap

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.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.
message

string

Een leesbare weergave van de fout.

FaceErrorResponse

Een antwoord met foutdetails.

Name Type Description
error

FaceError

Het foutobject.

PersonDirectoryPerson

Persoonsresource voor persoonsmap

Name Type Description
name

string

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

string

Persoons-id van de persoon.
userData

string

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