ask_sdk_model.er.dynamic package

Submodules

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_sdk_model.er.dynamic.entity module

class ask_sdk_model.er.dynamic.entity.Entity(id=None, name=None)

Bases: object

Represents an entity that the skill wants to store. An entity has an optional Id and the value and the synonyms for the entity

Parameters:
attribute_map = {'id': 'id', 'name': 'name'}
deserialized_types = {'id': 'str', 'name': 'ask_sdk_model.er.dynamic.entity_value_and_synonyms.EntityValueAndSynonyms'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.er.dynamic.entity_list_item module

class ask_sdk_model.er.dynamic.entity_list_item.EntityListItem(name=None, values=None)

Bases: object

Represents an array of entities of a particular type.

Parameters:
  • name ((optional) str) – The entity type. Must match the slot type as defined in the interaction model.
  • values ((optional) list[ask_sdk_model.er.dynamic.entity.Entity]) – A list of dynamic entities which are of the same type
attribute_map = {'name': 'name', 'values': 'values'}
deserialized_types = {'name': 'str', 'values': 'list[ask_sdk_model.er.dynamic.entity.Entity]'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.er.dynamic.entity_value_and_synonyms module

class ask_sdk_model.er.dynamic.entity_value_and_synonyms.EntityValueAndSynonyms(value=None, synonyms=None)

Bases: object

A container object with value and synomyms for the entity

Parameters:
  • value ((optional) str) – The entity value
  • synonyms ((optional) list[str]) – An array of synonyms for the entity
attribute_map = {'synonyms': 'synonyms', 'value': 'value'}
deserialized_types = {'synonyms': 'list[str]', 'value': 'str'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.er.dynamic.update_behavior module

class ask_sdk_model.er.dynamic.update_behavior.UpdateBehavior

Bases: enum.Enum

Replace the existing dynamic entities or clear them from the catalog

Allowed enum values: [REPLACE, CLEAR]

CLEAR = 'CLEAR'
REPLACE = 'REPLACE'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model