Share via

DictionaryExampleItem Class

  • Reference

Dictionary Example element.

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

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

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

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