Share via

DictionaryExample Class

  • Reference

Dictionary Example.

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

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

Constructor

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

Variables

Name Description
source_prefix
str

The string to concatenate before the value of sourceTerm to form a complete example. Do not add a space character, since it is already there when it should be. This value may be an empty string. Required.
source_term
str

A string equal to the actual term looked up. The string is added with sourcePrefix and sourceSuffix to form the complete example. Its value is separated so it can be marked in a user interface, e.g., by bolding it. Required.
source_suffix
str

The string to concatenate after the value of sourceTerm to form a complete example. Do not add a space character, since it is already there when it should be. This value may be an empty string. Required.
target_prefix
str

A string similar to sourcePrefix but for the target. Required.
target_term
str

A string similar to sourceTerm but for the target. Required.
target_suffix
str

A string similar to sourceSuffix but for the target. 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

source_prefix

The string to concatenate before the value of sourceTerm to form a complete example. Do not add a space character, since it is already there when it should be. This value may be an empty string. Required.

source_prefix: str

source_suffix

The string to concatenate after the value of sourceTerm to form a complete example. Do not add a space character, since it is already there when it should be. This value may be an empty string. Required.

source_suffix: str

source_term

A string equal to the actual term looked up. The string is added with sourcePrefix and sourceSuffix to form the complete example. Its value is separated so it can be marked in a user interface, e.g., by bolding it. Required.

source_term: str

target_prefix

A string similar to sourcePrefix but for the target. Required.

target_prefix: str

target_suffix

A string similar to sourceSuffix but for the target. Required.

target_suffix: str

target_term

A string similar to sourceTerm but for the target. Required.

target_term: str