Person Group Operations - Get Person Group Person

Service:

Azure AI Services

API Version:

v1.2-preview.1

Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature(s).

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons/{personId}

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).
personGroupId	path	True	string	ID of the container. Regex pattern: ^[a-z0-9-_]+$
personId	path	True	string uuid	ID of the person.

Responses

Name	Type	Description
200 OK	PersonGroupPerson	A successful call returns the person'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 Person from PersonGroup

Sample request

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Sample response

Status code:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "name": "your_person_group_person_name",
  "userData": "your_user_data",
  "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.
PersonGroupPerson	The person in a specified person group. To add face to this person, please call "Add Large Person Group Person 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.

PersonGroupPerson

The person in a specified person group. To add face to this person, please call "Add Large Person Group Person Face".

Name	Type	Description
name	string	User defined name, maximum length is 128.
persistedFaceIds	string[]	Face ids of registered faces in the person.
personId	string	ID of the person.
userData	string	Optional user defined data. Length should not exceed 16K.