Package com.azure.ai.formrecognizer.training.models

Class CustomFormModel

java.lang.Object
com.azure.ai.formrecognizer.training.models.CustomFormModel
public final class CustomFormModel extends Object
The CustomFormModel

  • Constructor Details

    • CustomFormModel

      public CustomFormModel(String modelId, CustomFormModelStatus modelStatus, OffsetDateTime trainingStartedOn, OffsetDateTime trainingCompletedOn, List<CustomFormSubmodel> submodels, List<FormRecognizerError> modelError, List<TrainingDocumentInfo> trainingDocuments)
      Constructs a CustomFormModel object.
      Parameters:
      modelId - Model identifier.
      modelStatus - Status of the model.
      trainingStartedOn - Date and time (UTC) when the training of model was started.
      trainingCompletedOn - Date and time (UTC) when the model training was completed.
      submodels - List of sub model that are part of this model, each of which can recognize and extract fields from a different type of form.
      modelError - List of errors returned during the training operation.
      trainingDocuments - List of the documents used to train the model.

  • Method Details

    • getModelId

      public String getModelId()
      Get the Model identifier.
      Returns:
      the modelId value.

    • getModelStatus

      public CustomFormModelStatus getModelStatus()
      Get the status of the model.
      Returns:
      the modelStatus 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.

    • getModelError

      public List<FormRecognizerError> getModelError()
      Get the errors returned during the training operation.
      Returns:
      the unmodifiable list of model errors returned during the training operation.

    • getSubmodels

      public List<CustomFormSubmodel> getSubmodels()
      Get the list of sub model that are part of this model, each of which can recognize and extract fields from a different type of form.
      Returns:
      the unmodifiable list of submodels that are a part of this model.

    • getTrainingDocuments

      public List<TrainingDocumentInfo> getTrainingDocuments()
      Get the list of the documents used to train the model and any errors reported in each document.
      Returns:
      the unmodifiable list of documents used to train the model.

    • 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.