TranslatedTextAlignment Class
Alignment information object.
All required parameters must be populated in order to send to server.
- Inheritance
-
azure.ai.translation.text._model_base.ModelTranslatedTextAlignment
Constructor
TranslatedTextAlignment(*args: Any, **kwargs: Any)
Variables
Name | Description |
---|---|
proj
|
Maps input text to translated text. The alignment information is only provided when the request parameter includeAlignment is true. Alignment is returned as a string value of the following format: [[SourceTextStartIndex]:[SourceTextEndIndex]–[TgtTextStartIndex]:[TgtTextEndIndex]]. The colon separates start and end index, the dash separates the languages, and space separates the words. One word may align with zero, one, or multiple words in the other language, and the aligned words may be non-contiguous. When no alignment information is available, the alignment element will be empty. 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
|
Whether to remove the readonly properties. |
Returns
Type | Description |
---|---|
A dict JSON compatible object |
clear
clear() -> None
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
Whether to remove the readonly properties. |
copy
copy() -> Model
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
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
|
Whether to remove the readonly properties. |
items
items() -> ItemsView[str, Any]
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
Whether to remove the readonly properties. |
keys
keys() -> KeysView[str]
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
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
|
Whether to remove the readonly properties. |
popitem
popitem() -> Tuple[str, Any]
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
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
|
Whether to remove the readonly properties. |
update
update(*args: Any, **kwargs: Any) -> None
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
Whether to remove the readonly properties. |
values
values() -> ValuesView[Any]
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
Whether to remove the readonly properties. |
Attributes
proj
Maps input text to translated text. The alignment information is only provided when the request parameter includeAlignment is true. Alignment is returned as a string value of the following format: [[SourceTextStartIndex]:[SourceTextEndIndex]–[TgtTextStartIndex]:[TgtTextEndIndex]]. The colon separates start and end index, the dash separates the languages, and space separates the words. One word may align with zero, one, or multiple words in the other language, and the aligned words may be non-contiguous. When no alignment information is available, the alignment element will be empty. Required.
proj: str
Azure SDK for Python