Face List Operations - Get Large Face List Face

Service:

Azure AI Services

API Version:

v1.1-preview.1

Retrieve persisted face in Large Face List by largeFaceListId and persistedFaceId.

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/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).
largeFaceListId	path	True	string	Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. Regex pattern: ^[a-z0-9-_]+$
persistedFaceId	path	True	string uuid	Face ID of the face.

Responses

Name	Type	Description
200 OK	LargeFaceListFace	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 LargeFaceList

Sample request

HTTP

GET {endpoint}/face/v1.1-preview.1/largefacelists/your_large_face_list_id/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.
LargeFaceListFace	Face resource for large face list.

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.

LargeFaceListFace

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