Share via

SourceInput Class

Source of the input documents.

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

Constructor

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

Variables

Name Description
source_url
str

Location of the folder / container or single file with your documents. Required.
filter
DocumentFilter

Document filter.
language
str

Language code If none is specified, we will perform auto detect on the document.
storage_source
str or TranslationStorageSource

Storage Source. "AzureBlob"

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

filter

Document filter.

filter: _models.DocumentFilter | None

language

Language code If none is specified, we will perform auto detect on the document.

language: str | None

source_url

Location of the folder / container or single file with your documents. Required.

source_url: str

storage_source

Storage Source. "AzureBlob"

storage_source: str | _models.TranslationStorageSource | None