ask_smapi_model.v1.skill.evaluations 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_smapi_model.v1.skill.evaluations.confirmation_status_type module¶

class ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType¶

Bases: enum.Enum

An enumeration indicating whether the user has explicitly confirmed or denied the entire intent. Possible values: "NONE", "CONFIRMED", "DENIED".

Allowed enum values: [NONE, CONFIRMED, DENIED]

CONFIRMED = 'CONFIRMED'¶

DENIED = 'DENIED'¶

NONE = 'NONE'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.dialog_act module¶

class ask_smapi_model.v1.skill.evaluations.dialog_act.DialogAct(object_type=None, target_slot=None)¶

Bases: object

A representation of question prompts to the user for multi-turn, which requires user to fill a slot value, or confirm a slot value, or confirm an intent.

Parameters:	object_type ((optional) ask_smapi_model.v1.skill.evaluations.dialog_act_type.DialogActType) – target_slot ((optional) str) – The name of the target slot that needs to be filled or confirmed for a dialogAct

attribute_map = {'object_type': 'type', 'target_slot': 'targetSlot'}¶

deserialized_types = {'object_type': 'ask_smapi_model.v1.skill.evaluations.dialog_act_type.DialogActType', 'target_slot': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.dialog_act_type module¶

class ask_smapi_model.v1.skill.evaluations.dialog_act_type.DialogActType¶

Bases: enum.Enum

Allowed enum values: [Dialog_ElicitSlot, Dialog_ConfirmSlot, Dialog_ConfirmIntent]

Dialog_ConfirmIntent = 'Dialog.ConfirmIntent'¶

Dialog_ConfirmSlot = 'Dialog.ConfirmSlot'¶

Dialog_ElicitSlot = 'Dialog.ElicitSlot'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.intent module¶

class ask_smapi_model.v1.skill.evaluations.intent.Intent(name=None, confirmation_status=None, slots=None)¶

Bases: object

Parameters:	name ((optional) str) – confirmation_status ((optional) ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType) – slots ((optional) dict(str, ask_smapi_model.v1.skill.evaluations.slot.Slot)) – A map of key-value pairs that further describes what the user meant based on a predefined intent schema. The map can be empty.

attribute_map = {'confirmation_status': 'confirmationStatus', 'name': 'name', 'slots': 'slots'}¶

deserialized_types = {'confirmation_status': 'ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType', 'name': 'str', 'slots': 'dict(str, ask_smapi_model.v1.skill.evaluations.slot.Slot)'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.multi_turn module¶

class ask_smapi_model.v1.skill.evaluations.multi_turn.MultiTurn(dialog_act=None, token=None, prompt=None)¶

Bases: object

Included when the selected intent has dialog defined and the dialog is not completed. To continue the dialog, provide the value of the token in the multiTurnToken field in the next request.

Parameters:	dialog_act ((optional) ask_smapi_model.v1.skill.evaluations.dialog_act.DialogAct) – token ((optional) str) – Opaque string which contains multi-turn related context. prompt ((optional) str) – A sample prompt defined in the dialog model for each DialogAct.

attribute_map = {'dialog_act': 'dialogAct', 'prompt': 'prompt', 'token': 'token'}¶

deserialized_types = {'dialog_act': 'ask_smapi_model.v1.skill.evaluations.dialog_act.DialogAct', 'prompt': 'str', 'token': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.profile_nlu_request module¶

class ask_smapi_model.v1.skill.evaluations.profile_nlu_request.ProfileNluRequest(utterance=None, multi_turn_token=None)¶

Bases: object

Parameters:	utterance ((optional) str) – Actual representation of user input to Alexa. multi_turn_token ((optional) str) – Opaque string which contains multi-turn related context.

attribute_map = {'multi_turn_token': 'multiTurnToken', 'utterance': 'utterance'}¶

deserialized_types = {'multi_turn_token': 'str', 'utterance': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.profile_nlu_response module¶

class ask_smapi_model.v1.skill.evaluations.profile_nlu_response.ProfileNluResponse(session_ended=None, selected_intent=None, considered_intents=None, multi_turn=None)¶

Bases: object

Parameters:

session_ended ((optional) bool) – Represents when an utterance results in the skill exiting. It would be true when NLU selects 1P ExitAppIntent or GoHomeIntent, and false otherwise.
selected_intent ((optional) ask_smapi_model.v1.skill.evaluations.profile_nlu_selected_intent.ProfileNluSelectedIntent) –
considered_intents ((optional) list[ask_smapi_model.v1.skill.evaluations.intent.Intent]) – All intents that Alexa considered for the utterance in the request, but did not select.
multi_turn ((optional) ask_smapi_model.v1.skill.evaluations.multi_turn.MultiTurn) –

attribute_map = {'considered_intents': 'consideredIntents', 'multi_turn': 'multiTurn', 'selected_intent': 'selectedIntent', 'session_ended': 'sessionEnded'}¶

deserialized_types = {'considered_intents': 'list[ask_smapi_model.v1.skill.evaluations.intent.Intent]', 'multi_turn': 'ask_smapi_model.v1.skill.evaluations.multi_turn.MultiTurn', 'selected_intent': 'ask_smapi_model.v1.skill.evaluations.profile_nlu_selected_intent.ProfileNluSelectedIntent', 'session_ended': 'bool'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.profile_nlu_selected_intent module¶

class ask_smapi_model.v1.skill.evaluations.profile_nlu_selected_intent.ProfileNluSelectedIntent(name=None, confirmation_status=None, slots=None)¶

Bases: ask_smapi_model.v1.skill.evaluations.intent.Intent

The intent that Alexa selected for the utterance in the request.

Parameters:	name ((optional) str) – confirmation_status ((optional) ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType) – slots ((optional) dict(str, ask_smapi_model.v1.skill.evaluations.slot.Slot)) – A map of key-value pairs that further describes what the user meant based on a predefined intent schema. The map can be empty.

attribute_map = {'confirmation_status': 'confirmationStatus', 'name': 'name', 'slots': 'slots'}¶

deserialized_types = {'confirmation_status': 'ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType', 'name': 'str', 'slots': 'dict(str, ask_smapi_model.v1.skill.evaluations.slot.Slot)'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_items module¶

class ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_items.ResolutionsPerAuthorityItems(authority=None, status=None, values=None)¶

Bases: object

Parameters:

authority ((optional) str) – The name of the authority for the slot values. For custom slot types, this authority label incorporates your skill ID and the slot type name.
status ((optional) ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status.ResolutionsPerAuthorityStatus) –
values ((optional) list[ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_value_items.ResolutionsPerAuthorityValueItems]) – An array of resolved values for the slot.

attribute_map = {'authority': 'authority', 'status': 'status', 'values': 'values'}¶

deserialized_types = {'authority': 'str', 'status': 'ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status.ResolutionsPerAuthorityStatus', 'values': 'list[ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_value_items.ResolutionsPerAuthorityValueItems]'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status module¶

class ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status.ResolutionsPerAuthorityStatus(code=None)¶

Bases: object

An object representing the status of entity resolution for the slot.

Parameters:	code ((optional) ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status_code.ResolutionsPerAuthorityStatusCode) –

attribute_map = {'code': 'code'}¶

deserialized_types = {'code': 'ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status_code.ResolutionsPerAuthorityStatusCode'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status_code module¶

class ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status_code.ResolutionsPerAuthorityStatusCode¶

Bases: enum.Enum

A code indicating the results of attempting to resolve the user utterance against the defined slot types. This can be one of the following: ER_SUCCESS_MATCH: The spoken value matched a value or synonym explicitly defined in your custom slot type. ER_SUCCESS_NO_MATCH: The spoken value did not match any values or synonyms explicitly defined in your custom slot type. ER_ERROR_TIMEOUT: An error occurred due to a timeout. ER_ERROR_EXCEPTION: An error occurred due to an exception during processing.

Allowed enum values: [ER_SUCCESS_MATCH, ER_SUCCESS_NO_MATCH, ER_ERROR_TIMEOUT, ER_ERROR_EXCEPTION]

ER_ERROR_EXCEPTION = 'ER_ERROR_EXCEPTION'¶

ER_ERROR_TIMEOUT = 'ER_ERROR_TIMEOUT'¶

ER_SUCCESS_MATCH = 'ER_SUCCESS_MATCH'¶

ER_SUCCESS_NO_MATCH = 'ER_SUCCESS_NO_MATCH'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_value_items module¶

class ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_value_items.ResolutionsPerAuthorityValueItems(name=None, id=None)¶

Bases: object

An object representing the resolved value for the slot, based on the user's utterance and the slot type definition.

Parameters:	name ((optional) str) – The string for the resolved slot value. id ((optional) str) – The unique ID defined for the resolved slot value. This is based on the IDs defined in the slot type definition.

attribute_map = {'id': 'id', 'name': 'name'}¶

deserialized_types = {'id': 'str', 'name': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.slot module¶

class ask_smapi_model.v1.skill.evaluations.slot.Slot(name=None, value=None, confirmation_status=None, resolutions=None)¶

Bases: object

Parameters:	name ((optional) str) – value ((optional) str) – confirmation_status ((optional) ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType) – resolutions ((optional) ask_smapi_model.v1.skill.evaluations.slot_resolutions.SlotResolutions) –

attribute_map = {'confirmation_status': 'confirmationStatus', 'name': 'name', 'resolutions': 'resolutions', 'value': 'value'}¶

deserialized_types = {'confirmation_status': 'ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType', 'name': 'str', 'resolutions': 'ask_smapi_model.v1.skill.evaluations.slot_resolutions.SlotResolutions', '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_smapi_model.v1.skill.evaluations.slot_resolutions module¶

class ask_smapi_model.v1.skill.evaluations.slot_resolutions.SlotResolutions(resolutions_per_authority=None)¶

Bases: object

A resolutions object representing the results of resolving the words captured from the user's utterance.

Parameters:	resolutions_per_authority ((optional) list[ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_items.ResolutionsPerAuthorityItems]) – An array of objects representing each possible authority for entity resolution. An authority represents the source for the data provided for the slot. For a custom slot type, the authority is the slot type you defined.

attribute_map = {'resolutions_per_authority': 'resolutionsPerAuthority'}¶

deserialized_types = {'resolutions_per_authority': 'list[ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_items.ResolutionsPerAuthorityItems]'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model