GET /persongroups/{personGroupId}/training

Changed on

To check Person Group training status completed or still ongoing. Person Group training is an asynchronous operation triggered by "Train Person Group" API.

Request

  • Base URL
    {endpoint}/face/{apiVersion}
  • Auth
    • API key in header Ocp-Apim-Subscription-Key
    • or OAuth 2
      Authorization codehttps://api.example.com/oauth2/authorize
      Token URLhttps://api.example.com/oauth2/token
      Scopeshttps://cognitiveservices.azure.com/.default

Path parameters

personGroupIdstring required

ID of the container.

Response

A successful call returns the Person Group's training status.

status'notStarted' | 'running' | 'succeeded' | 'failed' required

The status of long running operation.

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 required

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 required

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

    • info

      api operation id PersonGroup_GetTrainingStatus removed and replaced with PersonGroupOperations_GetPersonGroupTrainingStatus