BuildDocumentModelRequest Class

Request body to build a new custom document model.

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

Constructor

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

Variables

Name	Description
model_id	str Unique document model name. Required.
description	str Document model description.
build_mode	str or DocumentBuildMode Custom document model build mode. Required. Known values are: "template" and "neural".
azure_blob_source	AzureBlobContentSource Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
azure_blob_file_list_source	AzureBlobFileListContentSource Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
tags	dict[str, str] List of key-value tag attributes associated with the document model.
max_training_hours	float Max number of V100-equivalent GPU hours to use for model training. Default=0.5.
allow_overwrite	bool Allow overwriting an existing model with the same name.

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.

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 Required	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 Required

popitem

popitem() -> Tuple[str, Any]

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default Required

update

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

values

values() -> ValuesView[Any]

Attributes

allow_overwrite

Allow overwriting an existing model with the same name.

allow_overwrite: bool | None

azure_blob_file_list_source

Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.

azure_blob_file_list_source: _models.AzureBlobFileListContentSource | None

azure_blob_source

Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.

azure_blob_source: _models.AzureBlobContentSource | None

build_mode

"template" and "neural".

build_mode: str | _models.DocumentBuildMode

description

Document model description.

description: str | None

max_training_hours

Max number of V100-equivalent GPU hours to use for model training. Default=0.5.

max_training_hours: float | None

model_id

Unique document model name. Required.

model_id: str

tags

List of key-value tag attributes associated with the document model.

tags: Dict[str, str] | None