Person Directory Operations - Get Person Faces

  • Reference
Service:
Azure AI Services
API Version:
v1.2-preview.1

Retrieve a person's persistedFaceIds representing the registered person face feature(s).

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

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

ListFaceResult

A successful call returns an array of persistedFaceIds and and a person ID.
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 Faces from PersonDirectory Person

Sample request

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

Sample response

Status code:
200 
{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
  "persistedFaceIds": [
    "43897a75-8d6f-42cf-885e-74832febb055"
  ]
}

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

Response of list face of 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.

ListFaceResult

Response of list face of person.

Name Type Description
persistedFaceIds

string[]

Array of persisted face ids.
personId

string

Id of person.

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.