DictionaryLookupItem Class

  • Reference

Dictionary Lookup Element.

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

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

Constructor

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

Variables

Name Description
normalized_source
str

A string giving the normalized form of the source term. For example, if the request is "JOHN", the normalized form will be "john". The content of this field becomes the input to lookup examples. Required.
display_source
str

A string giving the source term in a form best suited for end-user display. For example, if the input is "JOHN", the display form will reflect the usual spelling of the name: "John". Required.
translations
list[DictionaryTranslation]

A list of translations for the source term. 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

display_source

A string giving the source term in a form best suited for end-user display. For example, if the input is "JOHN", the display form will reflect the usual spelling of the name: "John". Required.

display_source: str

normalized_source

A string giving the normalized form of the source term. For example, if the request is "JOHN", the normalized form will be "john". The content of this field becomes the input to lookup examples. Required.

normalized_source: str

translations

A list of translations for the source term. Required.

translations: List[_models.DictionaryTranslation]