AnalyzedDocument Class

An object describing the location and semantic content of a document.

Inheritance
builtins.object
AnalyzedDocument

Constructor

AnalyzedDocument(**kwargs: Any)

Methods

from_dict

Converts a dict in the shape of a AnalyzedDocument to the model itself.

to_dict

Returns a dict representation of AnalyzedDocument.

from_dict

Converts a dict in the shape of a AnalyzedDocument to the model itself.

from_dict(data: Dict) -> AnalyzedDocument

Parameters

Name Description
data
Required

A dictionary in the shape of AnalyzedDocument.

Returns

Type Description

AnalyzedDocument

to_dict

Returns a dict representation of AnalyzedDocument.

to_dict() -> Dict

Returns

Type Description

dict

Attributes

bounding_regions

Bounding regions covering the document.

bounding_regions: List[BoundingRegion] | None

confidence

Confidence of correctly extracting the document.

confidence: float

doc_type

The type of document that was analyzed.

doc_type: str

fields

A dictionary of named field values.

fields: Dict[str, DocumentField] | None

spans

The location of the document in the reading order concatenated content.

spans: List[DocumentSpan]