AZazure

Retrieve the training status of a person group (completed or ongoing).

get/persongroups/{personGroupId}/training

Request

  • Base URL
    {Endpoint}/face/v1.0
  • URL
    {Endpoint}/face/v1.0/persongroups/{personGroupId}/training
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

personGroupIdstring required

Id referencing a particular person group.

Response

A successful call returns the person group's training status.

status'nonstarted' | 'running' | 'succeeded' | 'failed' required

Training status: notstarted, running, succeeded, failed. If the training process is waiting to perform, the status is notstarted. If the training is ongoing, the status is running. Status succeed means this person group or large person group is ready for Face - Identify, or this large face list is ready for Face - Find Similar. Status failed is often caused by no person or no persisted face exist in the person group or large person group, or no persisted face exist in the large face list.

createdDateTimestring date-time required

A combined UTC date and time string that describes the created time of the person group, large person group or large face list.

lastActionDateTimestring date-time

A combined UTC date and time string that describes the last modify time of the person group, large person group or large face list, could be null value when the group is not successfully trained.

lastSuccessfulTrainingDateTimestring date-time

A combined UTC date and time string that describes the last successful training time of the person group, large person group or large face list.

messagestring

Show failure message when training failed (omitted when training succeed).

Changes

No recorded changes to this operation across all 30 revisions of this API.