Share via

Face List Operations - Get Face List

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

Retrieve a Face List's faceListId, name, userData, recognitionModel and faces in the Face List.

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}
With optional parameters: 
GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

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).
faceListId
 path True

string

Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.

Regex pattern: ^[a-z0-9-_]+$
returnRecognitionModel
 query

boolean

Return 'recognitionModel' or not. The default value is false.

Responses

Name Type Description
200 OK

FaceList

A successful call returns the Face List's information.
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 FaceList

Sample request

GET {endpoint}/face/v1.2-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

Sample response

Status code:
200 
{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "faceListId": "your_face_list_id"
}

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

Face list is a list of faces, up to 1,000 faces.
FaceListFace

Face resource for face list.
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.

FaceList

Face list is a list of faces, up to 1,000 faces.

Name Type Description
faceListId

string

Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.
name

string

User defined name, maximum length is 128.
persistedFaces

FaceListFace[]

Face ids of registered faces in the face list.
recognitionModel

RecognitionModel

Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds.
userData

string

Optional user defined data. Length should not exceed 16K.

FaceListFace

Face resource for face list.

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.