Person Directory Operations - Get Person Face

Service:

Azure AI Services

API Version:

v1.2-preview.1

Retrieve person face information. The persisted person face is specified by its personId. recognitionModel, and persistedFaceId.

GET {endpoint}/face/{apiVersion}/persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces/{persistedFaceId}

URI Parameters

Name	In	Required	Type	Description
apiVersion	path	True	string	API Version
endpoint	path	True	string uri	Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).
persistedFaceId	path	True	string uuid	Face ID of the face.
personId	path	True	string uuid	Person ID of the person.
recognitionModel	path	True	RecognitionModel	The 'recognitionModel' associated with faces.

Responses

Name	Type	Description
200 OK	PersonDirectoryFace	A successful call returns target persisted face's information (persistedFaceId and userData).
Other Status Codes	FaceErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

The secret key for your Azure AI Face subscription.

Type: apiKey
In: header

AADToken

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Examples

Get Face from PersonDirectory Person

Sample request

HTTP

GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5/recognitionModels/recognition_01/persistedfaces/43897a75-8d6f-42cf-885e-74832febb055

Sample response

Status code:

200

{
  "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
  "userData": "your_user_data"
}

Definitions

Name	Description
FaceError	The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	A response containing error details.
PersonDirectoryFace	Face resource for person directory person.
RecognitionModel	The recognition model for the face.

FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.

Name	Type	Description
code	string	One of a server-defined set of error codes.
message	string	A human-readable representation of the error.

FaceErrorResponse

A response containing error details.

Name	Type	Description
error	FaceError	The error object.

PersonDirectoryFace

Face resource for person directory person.

Name	Type	Description
persistedFaceId	string	Face ID of the face.
userData	string	User-provided data attached to the face. The length limit is 1K.

RecognitionModel

The recognition model for the face.

Name	Type	Description
recognition_01	string	The default recognition model for "Detect". All those faceIds created before 2019 March are bonded with this recognition model.
recognition_02	string	Recognition model released in 2019 March.
recognition_03	string	Recognition model released in 2020 May.
recognition_04	string	Recognition model released in 2021 February. It's recommended to use this recognition model for better recognition accuracy.