Share via

TransliterableScript Class

  • Reference

Script definition with list of script into which given script can be translitered.

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

Inheritance
azure.ai.translation.text.models._models.LanguageScript
TransliterableScript

Constructor

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

Variables

Name Description
code
str

Code identifying the script. Required.
name
str

Display name of the script in the locale requested via Accept-Language header. Required.
native_name
str

Display name of the language in the locale native for the language. Required.
dir
str or LanguageDirectionality

Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages. Required. Known values are: "ltr" and "rtl".
to_scripts
list[LanguageScript]

List of scripts available to convert text to. Required.

Methods

as_dict

Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify 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

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

copy 

copy() -> Model

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

items 

items() -> ItemsView[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

keys 

keys() -> KeysView[str]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

pop 

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

Parameters

Name Description
key
Required
default

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

popitem 

popitem() -> Tuple[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

setdefault 

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

Parameters

Name Description
key
Required
default

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

update 

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

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

values 

values() -> ValuesView[Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Attributes

code

Code identifying the script. Required.

code: str

dir

Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages. Required. Known values are: "ltr" and "rtl".

dir: str | '_models.LanguageDirectionality'

name

Display name of the script in the locale requested via Accept-Language header. Required.

name: str

native_name

Display name of the language in the locale native for the language. Required.

native_name: str

to_scripts

List of scripts available to convert text to. Required.

to_scripts: List[_models.LanguageScript]