com.azure.ai.formrecognizer.models

Class FormWord

java.lang.Object

com.azure.ai.formrecognizer.models.FormElement

com.azure.ai.formrecognizer.models.FormWord

public final class FormWord
extends FormElement

Represents a word recognized from the input document.

Constructor Summary

Constructors

Constructor and Description
FormWord(String text, FieldBoundingBox boundingBox, int pageNumber, float confidence) Constructs a FormWord object.

Method Summary

Modifier and Type	Method and Description
FieldBoundingBox	getBoundingBox() BoundingBox property of the element.
float	getConfidence() Gets the confidence property of the Form Word.
int	getPageNumber() Get the 1-based page number in the input document.
String	getText() The text content of the form element.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormWord

public FormWord(String text,
                FieldBoundingBox boundingBox,
                int pageNumber,
                float confidence)

Constructs a FormWord object.

Parameters:

text - the text content of recognized field.

boundingBox - the BoundingBox of recognized field.

pageNumber - the 1 based page number.

confidence - the confidence property of the Form Word.

Method Detail

getConfidence

public float getConfidence()

Gets the confidence property of the Form Word.

Returns:

the confidence property of the Form Word.

getBoundingBox

public FieldBoundingBox getBoundingBox()

BoundingBox property of the element.

Overrides:

getBoundingBox in class FormElement

Returns:

the bounding box of the element.

getText

public String getText()

The text content of the form element.

Overrides:

getText in class FormElement

Returns:

The text content of the form element.

getPageNumber

public int getPageNumber()

Get the 1-based page number in the input document.

Overrides:

getPageNumber in class FormElement

Returns:

the page number value.