Delen via


Person Directory Operations - Get Person

Haal de naam en userData van een persoon op uit person directory.

GET {endpoint}/face/{apiVersion}/persons/{personId}

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

personId
path True

string

uuid

Persoons-id van de persoon.

Antwoorden

Name Type Description
200 OK

PersonDirectoryPerson

Een geslaagde oproep retourneert de gegevens van de persoon.

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 Person from PeronDirectory

Voorbeeldaanvraag

GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5

Voorbeeldrespons

{
  "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.