GET /largefacelists/{largeFaceListId}/training

Changed on

To check the Large Face List training status completed or still ongoing. Large Face List training is an asynchronous operation triggered by "Train Large Face List".

Training time depends on the number of face entries in a Large Face List. It could be in seconds, or up to half an hour for 1,000,000 faces.

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

largeFaceListIdstring required

Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.

Response

A successful call returns the Large Face List'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 LargeFaceList_GetTrainingStatus removed and replaced with FaceListOperations_GetLargeFaceListTrainingStatus