Share via

AnalyzeResult Class

Document analysis result.

Constructor

AnalyzeResult(*args: Any, **kwargs: Any)

Variables

Name Description
api_version
str

API version used to produce this result. Required.
model_id
str

Document model ID used to produce this result. Required.
string_index_type
str or StringIndexType

Method used to compute string offset and length. Required. Known values are: "textElements", "unicodeCodePoint", and "utf16CodeUnit".
content_format
str or ContentFormat

Format of the analyze result top-level content. Known values are: "text" and "markdown".
content
str

Concatenate string representation of all textual and visual elements in reading order. Required.
pages
list[DocumentPage]

Analyzed pages. Required.
paragraphs
list[DocumentParagraph]

Extracted paragraphs.
tables
list[DocumentTable]

Extracted tables.
figures
list[DocumentFigure]

Extracted figures.
sections
list[DocumentSection]

Extracted sections.
key_value_pairs
list[DocumentKeyValuePair]

Extracted key-value pairs.
styles
list[DocumentStyle]

Extracted font styles.
languages
list[DocumentLanguage]

Detected languages.
documents
list[Document]

Extracted documents.
warnings
list[Warning]

List of warnings encountered.

Methods

as_dict

Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear 

clear() -> None

copy 

copy() -> Model

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

keys 

keys() -> KeysView[str]

pop 

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem 

popitem() -> Tuple[str, Any]

setdefault 

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Attributes

api_version

API version used to produce this result. Required.

api_version: str

content

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

content: str

content_format

"text" and "markdown".

content_format: str | _models.ContentFormat | None

documents

Extracted documents.

documents: List[_models.Document] | None

figures

Extracted figures.

figures: List[_models.DocumentFigure] | None

key_value_pairs

Extracted key-value pairs.

key_value_pairs: List[_models.DocumentKeyValuePair] | None

languages

Detected languages.

languages: List[_models.DocumentLanguage] | None

model_id

Document model ID used to produce this result. Required.

model_id: str

pages

Analyzed pages. Required.

pages: List[_models.DocumentPage]

paragraphs

Extracted paragraphs.

paragraphs: List[_models.DocumentParagraph] | None

sections

Extracted sections.

sections: List[_models.DocumentSection] | None

string_index_type

"textElements", "unicodeCodePoint", and "utf16CodeUnit".

string_index_type: str | _models.StringIndexType

styles

Extracted font styles.

styles: List[_models.DocumentStyle] | None

tables

Extracted tables.

tables: List[_models.DocumentTable] | None

warnings

List of warnings encountered.

warnings: List[_models.Warning] | None