TranslationText Class

  • Reference

Translation result.

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

Inheritance
azure.ai.translation.text._model_base.Model
TranslationText

Constructor

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

Variables

Name Description
to
str

A string representing the language code of the target language. Required.
text
str

A string giving the translated text. Required.
transliteration
TransliteratedText

An object giving the translated text in the script specified by the toScript parameter.
alignment
TranslatedTextAlignment

Alignment information.
sent_len
SentenceBoundaries

Sentence boundaries in the input and output texts.

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

alignment

Alignment information.

alignment: _models.TranslatedTextAlignment | None

sent_len

Sentence boundaries in the input and output texts.

sent_len: _models.SentenceBoundaries | None

text

A string giving the translated text. Required.

text: str

to

A string representing the language code of the target language. Required.

to: str

transliteration

An object giving the translated text in the script specified by the toScript parameter.

transliteration: _models.TransliteratedText | None