Sign in

v9

latestSwagger 2.02026-07-135252167.7 KB
ProjectApi

Queues project for training.

post/projects/{projectId}/train

Path parameters

projectIdstring uuid required

The project id.

Query parameters

trainingType'Regular' | 'Advanced'

The type of training to use to train the project (default: Regular).

reservedBudgetInHoursinteger

The number of hours reserved as budget for training (if applicable).

forceTrainboolean

Whether to force train even if dataset and configuration does not change (default: false).

notificationEmailAddressstring

The email address to send notification to when training finishes (default: null).

Request body

selectedTagsstring[]

List of tags selected for this training session, other tags in the project will be ignored.

Response

OK

idstring uuid

Gets the id of the iteration.

namestring required

Gets or sets the name of the iteration.

statusstring

Gets the current iteration status.

createdstring date-time

Gets the time this iteration was completed.

lastModifiedstring date-time

Gets the time this iteration was last modified.

trainedAtstring date-time nullable

Gets the time this iteration was last modified.

projectIdstring uuid

Gets the project id of the iteration.

exportableboolean

Whether the iteration can be exported to another format for download.

exportableTostring[]

A set of platforms this iteration can export to.

domainIdstring uuid nullable

Get or sets a guid of the domain the iteration has been trained on.

classificationType'Multiclass' | 'Multilabel' nullable

Gets the classification type of the project.

trainingType'Regular' | 'Advanced'

Gets the training type of the iteration.

reservedBudgetInHoursinteger

Gets the reserved advanced training budget for the iteration.

trainingTimeInMinutesinteger

Gets the training time for the iteration.

publishNamestring

Name of the published model.

originalPublishResourceIdstring

Resource Provider Id this iteration was originally published to.

trainingErrorDetailsstring

Training error details, when training fails. Value is null when training succeeds.