Person Group Person - Get Face

Service:

Azure AI Services

API Version:

1.0-preview

Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId).

GET {Endpoint}/face/v1.0-preview/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
persistedFaceId	path	True	string (uuid)	Id referencing a particular persistedFaceId of an existing face.
personGroupId	path	True	string maxLength: 64 pattern: ^[a-z0-9-_]+$	Id referencing a particular person group.
personId	path	True	string (uuid)	Id referencing a particular person.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

Responses

Name	Type	Description
200 OK	PersistedFace	A successful call returns target persisted face's information (persistedFaceId and userData).
Other Status Codes	APIError	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Get persisted face example

Sample request

HTTP

GET {Endpoint}/face/v1.0-preview/persongroups/abc/persons/B8D802CF-DD8F-4E61-B15C-9E6C5844CCBA/persistedfaces/015839fb-fbd9-4f79-ace9-7675fc2f1dd9

Sample response

Status code:

200

{
  "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
  "userData": "User-provided data attached to the person face."
}

Definitions

Name	Description
APIError	Error information returned by the API
Error	Error body.
PersistedFace	PersonFace object.

APIError

Object

Error information returned by the API

Name	Type	Description
error	Error	Error body.

Error

Object

Error body.

Name	Type	Description
code	string
message	string

PersistedFace

Object

PersonFace object.

Name	Type	Description
persistedFaceId	string (uuid)	The persistedFaceId of the target face, which is persisted and will not expire. Different from faceId created by Face - Detect and will expire in at the time specified by faceIdTimeToLive after the detection call.
userData	string maxLength: 1024	User-provided data attached to the face. The size limit is 1KB.