Package com.azure.ai.formrecognizer.models

Class DocumentEntity

java.lang.Object

com.azure.ai.formrecognizer.models.DocumentEntity

public final class DocumentEntity
extends Object

An object representing various categories of entities.

Constructor Summary

Constructors

Constructor	Description
DocumentEntity()

Method Summary

Modifier and Type	Method	Description
List<BoundingRegion>	getBoundingRegions()	Get the boundingRegions property: Bounding regions covering the entity.
String	getCategory()	Get the category property: Entity type.
float	getConfidence()	Get the confidence property: Confidence of correctly extracting the entity.
String	getContent()	Get the content property: Entity content.
List<DocumentSpan>	getSpans()	Get the spans property: Location of the entity in the reading order concatenated content.
String	getSubCategory()	Get the subCategory property: Entity sub type.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentEntity

public DocumentEntity()

Method Details

getCategory

public String getCategory()

Get the category property: Entity type.

Returns:

the category value.

getSubCategory

public String getSubCategory()

Get the subCategory property: Entity sub type.

Returns:

the subCategory value.

getContent

public String getContent()

Get the content property: Entity content.

Returns:

the content value.

getBoundingRegions

public List<BoundingRegion> getBoundingRegions()

Get the boundingRegions property: Bounding regions covering the entity.

Returns:

the boundingRegions value.

getSpans

public List<DocumentSpan> getSpans()

Get the spans property: Location of the entity in the reading order concatenated content.

Returns:

the spans value.

getConfidence

public float getConfidence()

Get the confidence property: Confidence of correctly extracting the entity.

Returns:

the confidence value.