AnalyzedDocument Class

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

Inheritance
builtins.object
AnalyzedDocument

Constructor

AnalyzedDocument(**kwargs)

Variables

doc_type
str

The type of document that was analyzed.

bounding_regions
list[BoundingRegion]

Bounding regions covering the document.

spans
list[DocumentSpan]

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

fields
dict[str, DocumentField]

A dictionary of named field values.

confidence
float

Confidence of correctly extracting the document.

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) -> azure.ai.formrecognizer._models.AnalyzedDocument

Parameters

data
dict
Required

A dictionary in the shape of AnalyzedDocument.

data
Required

Returns

AnalyzedDocument

Return type

to_dict

Returns a dict representation of AnalyzedDocument.

to_dict() -> dict

Returns

dict

Return type