Person Group Operations - Get Large Person Group Person Face

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

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

GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/persons/{personId}/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).
largePersonGroupId
 path True

string

ID of the container.

Regex pattern: ^[a-z0-9-_]+$
persistedFaceId
 path True

string

uuid

Face ID of the face.
personId
 path True

string

uuid

ID of the person.

Responses

Name Type Description
200 OK

LargePersonGroupPersonFace

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 LargePersonGroup Person

Sample request

GET {endpoint}/face/v1.2-preview.1/largepersongroups/your_large_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1/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.
LargePersonGroupPersonFace

Face resource for large person group person.

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.

LargePersonGroupPersonFace

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