DocumentIntelligenceError Class

The error object.

Constructor

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

Variables

Name	Description
code	str One of a server-defined set of error codes. Required.
message	str A human-readable representation of the error. Required.
target	str The target of the error.
details	list[DocumentIntelligenceError] An array of details about specific errors that led to this reported error.
innererror	DocumentIntelligenceInnerError An object containing more specific information than the current object about the error.

Methods

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

as_dict

Return a dict that can be turned into json 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

code

One of a server-defined set of error codes. Required.

code: str

details

An array of details about specific errors that led to this reported error.

details: List[_models.DocumentIntelligenceError] | None

innererror

An object containing more specific information than the current object about the error.

innererror: _models.DocumentIntelligenceInnerError | None

message

A human-readable representation of the error. Required.

message: str

target

The target of the error.

target: str | None