ask_sdk_model.canfulfill 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.canfulfill.can_fulfill_intent module

class ask_sdk_model.canfulfill.can_fulfill_intent.CanFulfillIntent(can_fulfill=None, slots=None)

Bases: object

CanFulfillIntent represents the response to canFulfillIntentRequest includes the details about whether the skill can understand and fulfill the intent request with detected slots.

Parameters:
attribute_map = {'can_fulfill': 'canFulfill', 'slots': 'slots'}
deserialized_types = {'can_fulfill': 'ask_sdk_model.canfulfill.can_fulfill_intent_values.CanFulfillIntentValues', 'slots': 'dict(str, ask_sdk_model.canfulfill.can_fulfill_slot.CanFulfillSlot)'}
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.canfulfill.can_fulfill_intent_request module

class ask_sdk_model.canfulfill.can_fulfill_intent_request.CanFulfillIntentRequest(request_id=None, timestamp=None, locale=None, dialog_state=None, intent=None)

Bases: ask_sdk_model.request.Request

An object that represents a request made to skill to query whether the skill can understand and fulfill the intent request with detected slots, before actually asking the skill to take action. Skill should be aware this is not to actually take action, skill should handle this request without causing side-effect, skill should not modify some state outside its scope or has an observable interaction with its calling functions or the outside world besides returning a value, such as playing sound,turning on/off lights, committing a transaction or a charge.

Parameters:
  • request_id ((optional) str) – Represents the unique identifier for the specific request.
  • timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
  • locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
  • dialog_state ((optional) ask_sdk_model.dialog_state.DialogState) –
  • intent ((optional) ask_sdk_model.intent.Intent) –
attribute_map = {'dialog_state': 'dialogState', 'intent': 'intent', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'dialog_state': 'ask_sdk_model.dialog_state.DialogState', 'intent': 'ask_sdk_model.intent.Intent', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}
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.canfulfill.can_fulfill_intent_values module

class ask_sdk_model.canfulfill.can_fulfill_intent_values.CanFulfillIntentValues

Bases: enum.Enum

Overall if skill can understand and fulfill the intent with detected slots. Respond YES when skill understands all slots, can fulfill all slots, and can fulfill the request in its entirety. Respond NO when skill either cannot understand the intent, cannot understand all the slots, or cannot fulfill all the slots. Respond MAYBE when skill can understand the intent, can partially or fully understand the slots, and can partially or fully fulfill the slots. The only cases where should respond MAYBE is when skill partially understand the request and can potentially complete the request if skill get more data, either through callbacks or through a multi-turn conversation with the user.

Allowed enum values: [YES, NO, MAYBE]

MAYBE = 'MAYBE'
NO = 'NO'
YES = 'YES'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.canfulfill.can_fulfill_slot module

class ask_sdk_model.canfulfill.can_fulfill_slot.CanFulfillSlot(can_understand=None, can_fulfill=None)

Bases: object

This represents skill's capability to understand and fulfill each detected slot.

Parameters:
attribute_map = {'can_fulfill': 'canFulfill', 'can_understand': 'canUnderstand'}
deserialized_types = {'can_fulfill': 'ask_sdk_model.canfulfill.can_fulfill_slot_values.CanFulfillSlotValues', 'can_understand': 'ask_sdk_model.canfulfill.can_understand_slot_values.CanUnderstandSlotValues'}
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.canfulfill.can_fulfill_slot_values module

class ask_sdk_model.canfulfill.can_fulfill_slot_values.CanFulfillSlotValues

Bases: enum.Enum

This field indicates whether skill can fulfill relevant action for the slot, that has been partially or fully understood. The definition of fulfilling the slot is dependent on skill and skill is required to have logic in place to determine whether a slot value can be fulfilled in the context of skill or not. Return YES if Skill can certainly fulfill the relevant action for this slot value. Return NO if skill cannot fulfill the relevant action for this slot value. For specific recommendations to set the value refer to the developer docs for more details.

Allowed enum values: [YES, NO]

NO = 'NO'
YES = 'YES'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.canfulfill.can_understand_slot_values module

class ask_sdk_model.canfulfill.can_understand_slot_values.CanUnderstandSlotValues

Bases: enum.Enum

This field indicates whether skill has understood the slot value. In most typical cases, skills will do some form of entity resolution by looking up a catalog or list to determine whether they recognize the slot or not. Return YES if skill have a perfect match or high confidence match (for eg. synonyms) with catalog or list maintained by skill. Return NO if skill cannot understand or recognize the slot value. Return MAYBE if skill have partial confidence or partial match. This will be true when the slot value doesn’t exist as is, in the catalog, but a variation or a fuzzy match may exist. For specific recommendations to set the value refer to the developer docs for more details.

Allowed enum values: [YES, NO, MAYBE]

MAYBE = 'MAYBE'
NO = 'NO'
YES = 'YES'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model