Share via

DictionaryExampleItem Class

  • Reference

Dictionary Example element.

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

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

Constructor

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

Variables

Name Description
normalized_source
str

A string giving the normalized form of the source term. Generally, this should be identical to the value of the Text field at the matching list index in the body of the request. Required.
normalized_target
str

A string giving the normalized form of the target term. Generally, this should be identical to the value of the Translation field at the matching list index in the body of the request. Required.
examples
list[DictionaryExample]

A list of examples for the (source term, target term) pair. 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

examples

A list of examples for the (source term, target term) pair. Required.

examples: List[_models.DictionaryExample]

normalized_source

A string giving the normalized form of the source term. Generally, this should be identical to the value of the Text field at the matching list index in the body of the request. Required.

normalized_source: str

normalized_target

A string giving the normalized form of the target term. Generally, this should be identical to the value of the Translation field at the matching list index in the body of the request. Required.

normalized_target: str