Person Group Operations - Get Large Person Group

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

Retrieve the information of a Large Person Group, including its name, userData and recognitionModel. This API returns Large Person Group information only, use "Get Large Person Group Persons" instead to retrieve person information under the Large Person Group.

GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}
With optional parameters: 
GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}?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).
largePersonGroupId
 path True

string

ID of the container.

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

boolean

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

Responses

Name Type Description
200 OK

LargePersonGroup

A successful call returns the Large Person Group'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 LargePersonGroup

Sample request

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

Sample response

Status code:
200 
{
  "name": "your_large_person_group_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "largePersonGroupId": "your_large_person_group_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.
LargePersonGroup

The container of the uploaded person data, including face recognition feature, and up to 1,000,000 people.
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.

LargePersonGroup

The container of the uploaded person data, including face recognition feature, and up to 1,000,000 people.

Name Type Description
largePersonGroupId

string

ID of the container.
name

string

User defined name, maximum length is 128.
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.

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.