Package com.azure.ai.formrecognizer.documentanalysis.models

Class TypedDocumentField<T>

java.lang.Object

com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField<T>

Type Parameters:

T - the type of value.

Direct Known Subclasses:

DocumentField

public class TypedDocumentField<T>
extends Object

Strongly typed version of DocumentField

Constructor Summary

Constructors

Constructor	Description
TypedDocumentField()

Method Summary

Modifier and Type	Method	Description
List<BoundingRegion>	getBoundingRegions()	Get the bounding regions covering the field.
Float	getConfidence()	Get the confidence of correctly extracting the field.
String	getContent()	Get the field content.
List<DocumentSpan>	getSpans()	Get the location of the field in the reading order concatenated content.
DocumentFieldType	getType()	Get the data type of the field value.
T	getValue()	Get value of the field.

Methods inherited from class java.lang.Object

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

Constructor Details

TypedDocumentField

public TypedDocumentField()

Method Details

getValue

public T getValue()

Get value of the field.

Returns:

the value of the field

getType

public DocumentFieldType getType()

Get the data type of the field value.

Returns:

the type value.

getContent

public String getContent()

Get the field content.

Returns:

the content value.

getBoundingRegions

public List<BoundingRegion> getBoundingRegions()

Get the bounding regions covering the field.

Returns:

the boundingRegions value.

getSpans

public List<DocumentSpan> getSpans()

Get the location of the field in the reading order concatenated content.

Returns:

the spans value.

getConfidence

public Float getConfidence()

Get the confidence of correctly extracting the field.

Returns:

the confidence value.