Share via

TranslatedTextItem Class

  • Reference

Element containing the translated text.

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

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

Constructor

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

Variables

Name Description
detected_language
DetectedLanguage

The detectedLanguage property is only present in the result object when language auto-detection is requested.
translations
list[Translation]

An array of translation results. The size of the array matches the number of target languages specified through the to query parameter. Required.
source_text
SourceText

Input text in the default script of the source language. sourceText property is present only when the input is expressed in a script that's not the usual script for the language. For example, if the input were Arabic written in Latin script, then sourceText.text would be the same Arabic text converted into Arab script.

Methods

clear
copy
get
items
keys
pop
popitem
setdefault
update
values

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

detected_language

The detectedLanguage property is only present in the result object when language auto-detection is requested.

detected_language: _models.DetectedLanguage | None

source_text

Input text in the default script of the source language. sourceText property is present only when the input is expressed in a script that's not the usual script for the language. For example, if the input were Arabic written in Latin script, then sourceText.text would be the same Arabic text converted into Arab script.

source_text: _models.SourceText | None

translations

An array of translation results. The size of the array matches the number of target languages specified through the to query parameter. Required.

translations: List[_models.Translation]