com.azure.ai.formrecognizer.training.models

Class CustomFormModelInfo

java.lang.Object

com.azure.ai.formrecognizer.training.models.CustomFormModelInfo

public final class CustomFormModelInfo
extends Object

The CustomFormModelInfo model.

Constructor Summary

Constructors

Constructor and Description
CustomFormModelInfo(String modelId, CustomFormModelStatus status, OffsetDateTime trainingStartedOn, OffsetDateTime trainingCompletedOn) Constructs a CustomFormModelInfo object.

Method Summary

Modifier and Type	Method and Description
CustomFormModelProperties	getCustomModelProperties() Get model metadata properties.
String	getModelId() Get the model identifier.
String	getModelName() Get the user defined model display name.
CustomFormModelStatus	getStatus() Get the Status of the model.
OffsetDateTime	getTrainingCompletedOn() Get the date and time (UTC) when the model training was completed.
OffsetDateTime	getTrainingStartedOn() Get the date and time (UTC) when the training of the model was started.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFormModelInfo

public CustomFormModelInfo(String modelId,
                           CustomFormModelStatus status,
                           OffsetDateTime trainingStartedOn,
                           OffsetDateTime trainingCompletedOn)

Constructs a CustomFormModelInfo object.

Parameters:

modelId - The model identifier.

status - The status of the model.

trainingStartedOn - Date and time (UTC) when the training of the model was started.

trainingCompletedOn - Date and time (UTC) when the model training was completed.

Method Detail

getModelId

public String getModelId()

Get the model identifier.

Returns:

the modelId value.

getStatus

public CustomFormModelStatus getStatus()

Get the Status of the model.

Returns:

the status value.

getTrainingStartedOn

public OffsetDateTime getTrainingStartedOn()

Get the date and time (UTC) when the training of the model was started.

Returns:

the trainingStartedOn value.

getTrainingCompletedOn

public OffsetDateTime getTrainingCompletedOn()

Get the date and time (UTC) when the model training was completed.

Returns:

the trainingCompletedOn value.

getCustomModelProperties

public CustomFormModelProperties getCustomModelProperties()

Get model metadata properties.

Returns:

the custom model metadata properties.

getModelName

public String getModelName()

Get the user defined model display name.

Returns:

the modelName value.