AnalyzeBatchDocumentsRequest Class

Batch document analysis parameters.

All required parameters must be populated in order to send to server.

Constructor

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

Variables

Name	Description
azure_blob_source	AzureBlobContentSource Azure Blob Storage location containing the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
azure_blob_file_list_source	AzureBlobFileListContentSource Azure Blob Storage file list specifying the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
result_container_url	str Azure Blob Storage container URL where analyze result files will be stored. Required.
result_prefix	str Blob name prefix of result files.
overwrite_existing	bool Overwrite existing analyze result files?.

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

azure_blob_file_list_source

Azure Blob Storage file list specifying the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.

azure_blob_file_list_source: _models.AzureBlobFileListContentSource | None

azure_blob_source

Azure Blob Storage location containing the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.

azure_blob_source: _models.AzureBlobContentSource | None

overwrite_existing

Overwrite existing analyze result files?.

overwrite_existing: bool | None

result_container_url

Azure Blob Storage container URL where analyze result files will be stored. Required.

result_container_url: str

result_prefix

Blob name prefix of result files.

result_prefix: str | None