ReadResult Class

The results of a Read (OCR) operation.

Inheritance
azure.ai.vision.imageanalysis._model_base.Model
ReadResult

Constructor

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

Variables

Name Description
blocks

A list of text blocks in the image. At the moment only one block is returned, containing all the text detected in the image. Required.

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

Whether to remove the readonly properties.

Returns

Type Description

A dict JSON compatible object

clear

clear() -> None

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

copy

copy() -> Model

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

get

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

Parameters

Name Description
key
Required
default
Default value: None

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

items

items() -> ItemsView[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

keys

keys() -> KeysView[str]

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

pop

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

Parameters

Name Description
key
Required
default

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

popitem

popitem() -> Tuple[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

setdefault

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

Parameters

Name Description
key
Required
default

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

update

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

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

values

values() -> ValuesView[Any]

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

Attributes

blocks

A list of text blocks in the image. At the moment only one block is returned, containing all the text detected in the image. Required.

blocks: List[_models.DetectedTextBlock]