Share via

TranslationGlossary Class

Glossary / translation memory for the request.

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

Constructor

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

Variables

Name Description
glossary_url
str

Location of the glossary. We will use the file extension to extract the formatting if the format parameter is not supplied.

If the translation language pair is not present in the glossary, it will not be applied. Required.
file_format
str

Format. Required.
format_version
str

Optional Version. If not specified, default is used.
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

file_format

Format. Required.

file_format: str

format_version

Optional Version. If not specified, default is used.

format_version: str | None

glossary_url

Location of the glossary. We will use the file extension to extract the formatting if the format parameter is not supplied.

If the translation language pair is not present in the glossary, it will not be applied. Required.

glossary_url: str

storage_source

Storage Source. "AzureBlob"

storage_source: str | _models.TranslationStorageSource | None