AnalyzeResult Class

Document analysis result.

Inheritance

builtins.object

AnalyzeResult

Constructor

AnalyzeResult(**kwargs: Any)

Methods

from_dict	Converts a dict in the shape of a AnalyzeResult to the model itself.
to_dict	Returns a dict representation of AnalyzeResult.

from_dict

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

from_dict(data: Dict) -> AnalyzeResult

Parameters

Name	Description
data Required	dict A dictionary in the shape of AnalyzeResult.

Returns

Type	Description
AnalyzeResult	AnalyzeResult

to_dict

Returns a dict representation of AnalyzeResult.

to_dict() -> Dict

Returns

Type	Description
dict	dict

Attributes

api_version

API version used to produce this result.

api_version: str

content

Concatenate string representation of all textual and visual elements in reading order.

content: str

documents

Extracted documents.

documents: List[AnalyzedDocument] | None

key_value_pairs

Extracted key-value pairs.

key_value_pairs: List[DocumentKeyValuePair] | None

languages

Detected languages in the document.

languages: List[DocumentLanguage] | None

model_id

Model ID used to produce this result.

model_id: str

pages

Analyzed pages.

pages: List[DocumentPage]

paragraphs

Extracted paragraphs.

paragraphs: List[DocumentParagraph] | None

styles

Extracted font styles.

styles: List[DocumentStyle] | None

tables

Extracted tables.

tables: List[DocumentTable] | None