AnalyzeBatchOperationDetail Class

Operation detail for a document in a batch analysis.

Constructor

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

Variables

Name	Description
status	str or DocumentIntelligenceOperationStatus Analyze status. succeeded, failed, or skipped. Required. Known values are: "notStarted", "running", "failed", "succeeded", "canceled", and "skipped".
source_url	str URL of the source document. Required.
result_url	str URL of the analyze result JSON.
error	DocumentIntelligenceError Encountered 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

error

Encountered error.

error: _models.DocumentIntelligenceError | None

result_url

URL of the analyze result JSON.

result_url: str | None

source_url

URL of the source document. Required.

source_url: str

status

"notStarted", "running", "failed", "succeeded", "canceled", and "skipped".

status: str | _models.DocumentIntelligenceOperationStatus