AnalyzeBatchResult Class

Batch document analysis result.

Constructor

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

Variables

Name	Description
succeeded_count	int Number of documents that completed with status succeeded. Required.
failed_count	int Number of documents that completed with status failed. Required.
skipped_count	int Number of documents that completed with status skipped. Required.
details	list[AnalyzeBatchOperationDetail] Operation detail for each document in the batch.

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

details

Operation detail for each document in the batch.

details: List[_models.AnalyzeBatchOperationDetail] | None

failed_count

Number of documents that completed with status failed. Required.

failed_count: int

skipped_count

Number of documents that completed with status skipped. Required.

skipped_count: int

succeeded_count

Number of documents that completed with status succeeded. Required.

succeeded_count: int