Person Group - Train
Queue a person group training task, the training task may not be started immediately.
POST {Endpoint}/face/v1.0/persongroups/{personGroupId}/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). |
person
|
path | True |
string |
Id referencing a particular person group. Regex pattern: |
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 person group training
Sample Request
POST {Endpoint}/face/v1.0/persongroups/abc/train
Sample Response
Definitions
Name | Description |
---|---|
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 |