FormField Class

Package:

com.azure.ai.formrecognizer.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.11

• java.lang.Object
• • com.azure.ai.formrecognizer.models.FormField

public final class FormField

Represents a field recognized in an input document.

Constructor Summary

Constructor	Description
FormField(String name, FieldData labelData, FieldData valueData, FieldValue value, float confidence)	Constructs a FormField object.

Method Summary

Modifier and Type	Method and Description
float	getConfidence() Get the estimated confidence value of the recognized field.
FieldData	getLabelData() Get the text, bounding box, and field elements for the field label.
String	getName() Get the name of the field in the provided document.
FieldValue	getValue() Get the value of the recognized field.
FieldData	getValueData() Get the text, bounding box, and field elements for the field value.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FormField

public FormField(String name, FieldData labelData, FieldData valueData, FieldValue value, float confidence)

Constructs a FormField object.

Parameters:

name - The name the field or label.

labelData - The text, bounding box, and field elements for the field label.

valueData - The text, bounding box, and field elements for the field value.

value - The value of the recognized field.

confidence - The confidence of the recognized field.

Method Details

getConfidence

public float getConfidence()

Get the estimated confidence value of the recognized field.

Returns:

the confidence value.

getLabelData

public FieldData getLabelData()

Get the text, bounding box, and field elements for the field label.

Returns:

the text, bounding box, and field elements for the field value.

getName

public String getName()

Get the name of the field in the provided document.

Returns:

the name of field or label.

getValue

public FieldValue getValue()

Get the value of the recognized field.

Returns:

Value of the recognized field.

getValueData

public FieldData getValueData()

Get the text, bounding box, and field elements for the field value.

Returns:

the text, bounding box, and field elements for the field value.