Person Directory Operations - Get Person

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Hämta en persons namn och userData från Person Directory.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
endpoint	path	True	string (uri)	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).
personId	path	True	string (uuid)	Person-ID för personen.

Svar

Name	Typ	Description
200 OK	PersonDirectoryPerson	Ett lyckat samtal returnerar personens information.
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure AI Face-prenumeration.

Typ: apiKey
I: header

AADToken

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://api.example.com/oauth2/authorize
Token-webbadress: https://api.example.com/oauth2/token

Omfattningar

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

Exempel

Get Person from PeronDirectory

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
FaceError	Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ett svar som innehåller felinformation.
PersonDirectoryPerson	Personresurs för personkatalog

FaceError

Objekt

Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
message	string	En mänsklig läsbar representation av felet.

FaceErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.

PersonDirectoryPerson

Objekt

Personresurs för personkatalog

Name	Typ	Description
name	string minLength: 1 maxLength: 128	Användardefinierat namn, maximal längd är 128.
personId	string (uuid)	Person-ID för personen.
userData	string maxLength: 16384	Valfria användardefinierade data. Längden får inte överstiga 16 K.