Share via

DetectedTextWord Class

  • Reference

A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word.

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

Constructor

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

Variables

Name Description
text
str

Text content of the word. Required.
bounding_polygon
list[ImagePoint]

A bounding polygon around the word. At the moment only quadrilaterals are supported (represented by 4 image points). Required.
confidence
float

The level of confidence that the word was detected. Confidence scores span the range of 0.0 to 1.0 (inclusive), with higher values indicating a higher confidence of detection. 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
bool

Whether to remove the readonly properties.

Returns

Type Description
dict

A dict JSON compatible object

clear 

clear() -> None

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

copy 

copy() -> Model

Keyword-Only Parameters

Name Description
exclude_readonly
bool

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
bool

Whether to remove the readonly properties.

items 

items() -> ItemsView[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

keys 

keys() -> KeysView[str]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

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
bool

Whether to remove the readonly properties.

popitem 

popitem() -> Tuple[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

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
bool

Whether to remove the readonly properties.

update 

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

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

values 

values() -> ValuesView[Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Attributes

bounding_polygon

A bounding polygon around the word. At the moment only quadrilaterals are supported (represented by 4 image points). Required.

bounding_polygon: List[_models.ImagePoint]

confidence

The level of confidence that the word was detected. Confidence scores span the range of 0.0 to 1.0 (inclusive), with higher values indicating a higher confidence of detection. Required.

confidence: float

text

Text content of the word. Required.

text: str