Share via

DictionaryExample Class

  • Reference

Dictionary Example.

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

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

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

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