com.azure.ai.formrecognizer.training.models

Class TrainingOptions

java.lang.Object

com.azure.ai.formrecognizer.training.models.TrainingOptions

public final class TrainingOptions
extends Object

Options that may be passed when using training APIs on Form Training client.

Constructor Summary

Constructors

Constructor and Description
TrainingOptions()

Method Summary

Modifier and Type	Method and Description
String	getModelName() Get the optional model name defined by the user.
Duration	getPollInterval() Get the duration between each poll for the operation status.
TrainingFileFilter	getTrainingFileFilter() Get the filter to apply to the documents in the source path for training.
TrainingOptions	setModelName(String modelName) Set the optional model name defined by the user.
TrainingOptions	setPollInterval(Duration pollInterval) Set the duration between each poll for the operation status.
TrainingOptions	setTrainingFileFilter(TrainingFileFilter trainingFileFilter) Set the filter to apply to the documents in the source path for training.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrainingOptions

public TrainingOptions()

Method Detail

getTrainingFileFilter

public TrainingFileFilter getTrainingFileFilter()

Get the filter to apply to the documents in the source path for training.

Returns:

the filter to apply to the documents in the source path for training.

setTrainingFileFilter

public TrainingOptions setTrainingFileFilter(TrainingFileFilter trainingFileFilter)

Set the filter to apply to the documents in the source path for training.

Parameters:

trainingFileFilter - the filter to apply to the documents in the source path for training.

Returns:

the updated TrainingOptions value.

getPollInterval

public Duration getPollInterval()

Get the duration between each poll for the operation status. If none is specified, a default of 5 seconds is used.

Returns:

the pollInterval value.

setPollInterval

public TrainingOptions setPollInterval(Duration pollInterval)

Set the duration between each poll for the operation status. If none is specified, a default of 5 seconds is used.

Parameters:

pollInterval - the duration to specify between each poll for the operation status.

Returns:

the updated TrainingOptions value.

getModelName

public String getModelName()

Get the optional model name defined by the user.

Returns:

the modelName.

setModelName

public TrainingOptions setModelName(String modelName)

Set the optional model name defined by the user.

Parameters:

modelName - the user defined model name to set.

Returns:

the updated TrainingOptions value.