Share via

DocumentBatch Class

Definition for the input batch translation request.

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

Constructor

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

Variables

Name Description
source
SourceInput

Source of the input documents. Required.
targets
list[TranslationTarget]

Location of the destination for the output. Required.
storage_type
str or StorageInputType

Storage type of the input documents source string. Known values are: "Folder" and "File".

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

source

Source of the input documents. Required.

source: _models.SourceInput

storage_type

"Folder" and "File".

storage_type: str | _models.StorageInputType | None

targets

Location of the destination for the output. Required.

targets: List[_models.TranslationTarget]