AnalyzeResult Class

Document analysis result.

Constructor

Python

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.

Python

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.

Python

to_dict() -> Dict

Returns

Type	Description
dict	dict

Attributes

api_version

API version used to produce this result.

Python

api_version: str

content

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

Python

content: str

documents

Extracted documents.

Python

documents: List[AnalyzedDocument] | None

key_value_pairs

Extracted key-value pairs.

Python

key_value_pairs: List[DocumentKeyValuePair] | None

languages

Detected languages in the document.

Python

languages: List[DocumentLanguage] | None

model_id

Model ID used to produce this result.

Python

model_id: str

pages

Analyzed pages.

Python

pages: List[DocumentPage]

paragraphs

Extracted paragraphs.

Python

paragraphs: List[DocumentParagraph] | None

styles

Extracted font styles.

Python

styles: List[DocumentStyle] | None

tables

Extracted tables.

Python

tables: List[DocumentTable] | None