Train class

Class representing a Train.

Constructors

Train(LUISAuthoringClientContext)

Create a Train.

Methods

getStatus(string, string, RequestOptionsBase)

Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. "appID" specifies the LUIS app ID. "versionId" specifies the version number of the LUIS app. For example, "0.1".

getStatus(string, string, RequestOptionsBase, ServiceCallback<ModelTrainingInfo[]>)
getStatus(string, string, ServiceCallback<ModelTrainingInfo[]>)
trainVersion(string, string, RequestOptionsBase)

Sends a training request for a version of a specified LUIS app. This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status. Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date. To verify training success, get the training status at least once after training is complete.

trainVersion(string, string, RequestOptionsBase, ServiceCallback<EnqueueTrainingResponse>)
trainVersion(string, string, ServiceCallback<EnqueueTrainingResponse>)

Constructor Details

Train(LUISAuthoringClientContext)

Create a Train.

new Train(client: LUISAuthoringClientContext)

Parameters

client
LUISAuthoringClientContext

Reference to the service client.

Method Details

getStatus(string, string, RequestOptionsBase)

Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. "appID" specifies the LUIS app ID. "versionId" specifies the version number of the LUIS app. For example, "0.1".

function getStatus(appId: string, versionId: string, options?: RequestOptionsBase): Promise<TrainGetStatusResponse>

Parameters

appId

string

The application ID.

versionId

string

The version ID.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.TrainGetStatusResponse>

getStatus(string, string, RequestOptionsBase, ServiceCallback<ModelTrainingInfo[]>)

function getStatus(appId: string, versionId: string, options: RequestOptionsBase, callback: ServiceCallback<ModelTrainingInfo[]>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<ModelTrainingInfo[]>

The callback

getStatus(string, string, ServiceCallback<ModelTrainingInfo[]>)

function getStatus(appId: string, versionId: string, callback: ServiceCallback<ModelTrainingInfo[]>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

callback

ServiceCallback<ModelTrainingInfo[]>

The callback

trainVersion(string, string, RequestOptionsBase)

Sends a training request for a version of a specified LUIS app. This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status. Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date. To verify training success, get the training status at least once after training is complete.

function trainVersion(appId: string, versionId: string, options?: RequestOptionsBase): Promise<TrainTrainVersionResponse>

Parameters

appId

string

The application ID.

versionId

string

The version ID.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.TrainTrainVersionResponse>

trainVersion(string, string, RequestOptionsBase, ServiceCallback<EnqueueTrainingResponse>)

function trainVersion(appId: string, versionId: string, options: RequestOptionsBase, callback: ServiceCallback<EnqueueTrainingResponse>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<EnqueueTrainingResponse>

The callback

trainVersion(string, string, ServiceCallback<EnqueueTrainingResponse>)

function trainVersion(appId: string, versionId: string, callback: ServiceCallback<EnqueueTrainingResponse>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

callback

ServiceCallback<EnqueueTrainingResponse>

The callback