Large Person Group - Train

Queue a large person group training task, the training task may not be started immediately.

POST {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}/train

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).

largePersonGroupId
path True
  • string

Id referencing a particular large person group.

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

Request Header

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

Responses

Name Type Description
202 Accepted

The training task was queued successfully.

Other Status Codes

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Queue large person group training

Sample Request

POST {Endpoint}/face/v1.0/largepersongroups/abc/train

Sample Response

Definitions

APIError

Error information returned by the API

Error

Error body.

APIError

Error information returned by the API

Name Type Description
error

Error body.

Error

Error body.

Name Type Description
code
  • string
message
  • string