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

Class CustomFormSubmodel

java.lang.Object

com.azure.ai.formrecognizer.training.models.CustomFormSubmodel

public final class CustomFormSubmodel
extends Object

The CustomFormSubmodel model.

Constructor Summary

Constructors

Constructor	Description
CustomFormSubmodel(Float accuracy, Map<String,CustomFormModelField> fields, String formType)	Constructs a CustomFormSubmodel object.

Method Summary

Modifier and Type	Method	Description
Float	getAccuracy()	Get the estimated extraction accuracy for this model.
Map<String,CustomFormModelField>	getFields()	A map of the fields recognized from the input document.
String	getFormType()	Gets the recognized form type for the model.
String	getModelId()	Get the unique identifier for the submodel.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomFormSubmodel

public CustomFormSubmodel(Float accuracy,
 Map<String,CustomFormModelField> fields,
 String formType)

Constructs a CustomFormSubmodel object.

Parameters:

accuracy - The estimated extraction accuracy for this model.

fields - The Map of fields used to train the model.

formType - The recognized form type.

Method Details

getAccuracy

public Float getAccuracy()

Get the estimated extraction accuracy for this model.

Returns:

the accuracy value.

getFormType

public String getFormType()

Gets the recognized form type for the model.

Returns:

the form type for the model.

getFields

public Map<String,CustomFormModelField> getFields()

A map of the fields recognized from the input document. For models trained with labels, this is the training-time label of the field. For models trained with forms only, a unique name is generated for each field.

Returns:

the unmodifiable map of recognized fields.

getModelId

public String getModelId()

Get the unique identifier for the submodel.

Returns:

the modelId value.