Person Group Operations - Train Person Group

Service:

Azure AI Services

API Version:

v1.2-preview.1

Submit a Person Group training task. Training is a crucial step that only a trained Person Group can be used by "Identify From Person Group".
The training task is an asynchronous task. Training time depends on the number of person entries, and their faces in a Person Group. It could be several seconds to minutes. To check training status, please use "Get Person Group Training Status".

POST {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/train

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-_]+$

Responses

Name	Type	Description
202 Accepted		A successful call returns an empty response body. Headers operation-Location: string
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

Train PersonGroup

Sample request

HTTP

POST {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/train

Sample response

Status code:

202

operation-Location: https://contoso.com/operationstatus

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.

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.