DocumentError Class

DocumentError is an error object which represents an error on the individual document.

Inheritance

azure.ai.textanalytics._dict_mixin.DictMixin

DocumentError

Constructor

DocumentError(**kwargs: Any)

Methods

get
has_key
items
keys
update
values

get

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

Parameters

Name	Description
key Required
default	default value: None

has_key

has_key(k: str) -> bool

Parameters

Name	Description
k Required

items

items() -> Iterable[Tuple[str, Any]]

keys

keys() -> Iterable[str]

update

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

values

values() -> Iterable[Any]

Attributes

error

The document error.

error: TextAnalyticsError

id

Unique, non-empty document identifier that matches the document id that was passed in with the request. If not specified in the request, an id is assigned for the document.

id: str

is_error

Boolean check for error item when iterating over list of results. Always True for an instance of a DocumentError.

is_error: Literal[True] = True

kind

Error kind - "DocumentError".

kind: Literal['DocumentError'] = 'DocumentError'