ask_smapi_model.v1.skill.history 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.history.confidence module¶
-
class
ask_smapi_model.v1.skill.history.confidence.
Confidence
(bin=None)¶ Bases:
object
The hypothesized confidence for this interaction.
Parameters: bin ((optional) ask_smapi_model.v1.skill.history.confidence_bin.ConfidenceBin) – -
attribute_map
= {'bin': 'bin'}¶
-
deserialized_types
= {'bin': 'ask_smapi_model.v1.skill.history.confidence_bin.ConfidenceBin'}¶
-
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.history.confidence_bin module¶
-
class
ask_smapi_model.v1.skill.history.confidence_bin.
ConfidenceBin
¶ Bases:
enum.Enum
Intent confidence bin for this utterance. * `HIGH`: Intent was recognized with high confidence. * `MEDIUM`: Intent was recognized with medium confidence. * `LOW`: Intent was recognized with low confidence. Note: Low confidence intents are not sent to the skill.
Allowed enum values: [HIGH, MEDIUM, LOW]
-
HIGH
= 'HIGH'¶
-
LOW
= 'LOW'¶
-
MEDIUM
= 'MEDIUM'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.history.dialog_act module¶
-
class
ask_smapi_model.v1.skill.history.dialog_act.
DialogAct
(name=None)¶ Bases:
object
The dialog act used in the interaction.
Parameters: name ((optional) ask_smapi_model.v1.skill.history.dialog_act_name.DialogActName) – -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'name': 'ask_smapi_model.v1.skill.history.dialog_act_name.DialogActName'}¶
-
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.history.dialog_act_name module¶
-
class
ask_smapi_model.v1.skill.history.dialog_act_name.
DialogActName
¶ Bases:
enum.Enum
Dialog act directive name. * `Dialog.ElicitSlot`: Alexa asked the user for the value of a specific slot. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#elicitslot) * `Dialog.ConfirmSlot`: Alexa confirmed the value of a specific slot before continuing with the dialog. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#confirmslot) * `Dialog.ConfirmIntent`: Alexa confirmed the all the information the user has provided for the intent before the skill took action. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#confirmintent)
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.history.intent module¶
-
class
ask_smapi_model.v1.skill.history.intent.
Intent
(name=None, confidence=None, slots=None)¶ Bases:
object
Provides the intent name, slots and confidence of the intent used in this interaction.
Parameters: - name ((optional) str) – The hypothesized intent for this utterance.
- confidence ((optional) ask_smapi_model.v1.skill.history.confidence.Confidence) –
- slots ((optional) dict(str, ask_smapi_model.v1.skill.history.slot.Slot)) – The hypothesized slot(s) for this interaction.
-
attribute_map
= {'confidence': 'confidence', 'name': 'name', 'slots': 'slots'}¶
-
deserialized_types
= {'confidence': 'ask_smapi_model.v1.skill.history.confidence.Confidence', 'name': 'str', 'slots': 'dict(str, ask_smapi_model.v1.skill.history.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.history.intent_confidence_bin module¶
-
class
ask_smapi_model.v1.skill.history.intent_confidence_bin.
IntentConfidenceBin
¶ Bases:
enum.Enum
A filter used to retrieve items where the intent confidence bin is equal to the given value. * `HIGH`: Intent was recognized with high confidence. * `MEDIUM`: Intent was recognized with medium confidence. * `LOW`: Intent was recognized with low confidence. Note: Low confidence intents are not sent to the skill.
Allowed enum values: [HIGH, MEDIUM, LOW]
-
HIGH
= 'HIGH'¶
-
LOW
= 'LOW'¶
-
MEDIUM
= 'MEDIUM'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.history.intent_request module¶
-
class
ask_smapi_model.v1.skill.history.intent_request.
IntentRequest
(dialog_act=None, intent=None, interaction_type=None, locale=None, publication_status=None, stage=None, utterance_text=None)¶ Bases:
object
Parameters: - dialog_act ((optional) ask_smapi_model.v1.skill.history.dialog_act.DialogAct) –
- intent ((optional) ask_smapi_model.v1.skill.history.intent.Intent) –
- interaction_type ((optional) ask_smapi_model.v1.skill.history.interaction_type.InteractionType) –
- locale ((optional) ask_smapi_model.v1.skill.history.intent_request_locales.IntentRequestLocales) –
- publication_status ((optional) ask_smapi_model.v1.skill.history.publication_status.PublicationStatus) –
- stage ((optional) ask_smapi_model.v1.stage_type.StageType) –
- utterance_text ((optional) str) – The transcribed user speech.
-
attribute_map
= {'dialog_act': 'dialogAct', 'intent': 'intent', 'interaction_type': 'interactionType', 'locale': 'locale', 'publication_status': 'publicationStatus', 'stage': 'stage', 'utterance_text': 'utteranceText'}¶
-
deserialized_types
= {'dialog_act': 'ask_smapi_model.v1.skill.history.dialog_act.DialogAct', 'intent': 'ask_smapi_model.v1.skill.history.intent.Intent', 'interaction_type': 'ask_smapi_model.v1.skill.history.interaction_type.InteractionType', 'locale': 'ask_smapi_model.v1.skill.history.intent_request_locales.IntentRequestLocales', 'publication_status': 'ask_smapi_model.v1.skill.history.publication_status.PublicationStatus', 'stage': 'ask_smapi_model.v1.stage_type.StageType', 'utterance_text': '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.history.intent_request_locales module¶
-
class
ask_smapi_model.v1.skill.history.intent_request_locales.
IntentRequestLocales
¶ Bases:
enum.Enum
Skill locale in which this interaction occurred.
Allowed enum values: [en_US, en_GB, en_IN, en_CA, en_AU, de_DE, ja_JP]
-
de_DE
= 'de-DE'¶
-
en_AU
= 'en-AU'¶
-
en_CA
= 'en-CA'¶
-
en_GB
= 'en-GB'¶
-
en_IN
= 'en-IN'¶
-
en_US
= 'en-US'¶
-
ja_JP
= 'ja-JP'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.history.intent_requests module¶
-
class
ask_smapi_model.v1.skill.history.intent_requests.
IntentRequests
(links=None, next_token=None, is_truncated=None, total_count=None, start_index=None, skill_id=None, items=None)¶ Bases:
object
Response to the GET Intent Request History API. It contains the collection of utterances for the skill, nextToken and other metadata related to the search query.
Parameters: - links ((optional) ask_smapi_model.v1.links.Links) –
- next_token ((optional) str) – This token can be used to load the next page of the result.
- is_truncated ((optional) bool) – This property is true when all the results matching the search request haven't been returned, false otherwise.
- total_count ((optional) float) – Total number of records that matched the given search query.
- start_index ((optional) float) – Position of the current page in the result set.
- skill_id ((optional) str) – The Skill Id.
- items ((optional) list[ask_smapi_model.v1.skill.history.intent_request.IntentRequest]) – List of intent requests for the skill
-
attribute_map
= {'is_truncated': 'isTruncated', 'items': 'items', 'links': '_links', 'next_token': 'nextToken', 'skill_id': 'skillId', 'start_index': 'startIndex', 'total_count': 'totalCount'}¶
-
deserialized_types
= {'is_truncated': 'bool', 'items': 'list[ask_smapi_model.v1.skill.history.intent_request.IntentRequest]', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'skill_id': 'str', 'start_index': 'float', 'total_count': 'float'}¶
-
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.history.interaction_type module¶
-
class
ask_smapi_model.v1.skill.history.interaction_type.
InteractionType
¶ Bases:
enum.Enum
Indicates if the utterance was executed as a "ONE_SHOT" interaction or "MODAL" interaction. * `ONE_SHOT`: The user invokes the skill and states their intent in a single phrase. * `MODAL`: The user first invokes the skill and then states their intent.
Allowed enum values: [ONE_SHOT, MODAL]
-
MODAL
= 'MODAL'¶
-
ONE_SHOT
= 'ONE_SHOT'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.history.locale_in_query module¶
-
class
ask_smapi_model.v1.skill.history.locale_in_query.
LocaleInQuery
¶ Bases:
enum.Enum
A filter used to retrieve items where the locale is equal to the given value.
Allowed enum values: [en_US, en_GB, en_IN, en_CA, en_AU, de_DE, ja_JP]
-
de_DE
= 'de-DE'¶
-
en_AU
= 'en-AU'¶
-
en_CA
= 'en-CA'¶
-
en_GB
= 'en-GB'¶
-
en_IN
= 'en-IN'¶
-
en_US
= 'en-US'¶
-
ja_JP
= 'ja-JP'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.history.publication_status module¶
-
class
ask_smapi_model.v1.skill.history.publication_status.
PublicationStatus
¶ Bases:
enum.Enum
The publication status of the skill when this interaction occurred
Allowed enum values: [Development, Certification]
-
Certification
= 'Certification'¶
-
Development
= 'Development'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.history.slot module¶
-
class
ask_smapi_model.v1.skill.history.slot.
Slot
(name=None)¶ Bases:
object
Parameters: name ((optional) str) – Name of the slot that was used in this interaction. -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'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.history.sort_field_for_intent_request_type module¶
-
class
ask_smapi_model.v1.skill.history.sort_field_for_intent_request_type.
SortFieldForIntentRequestType
¶ Bases:
enum.Enum
Allowed enum values: [recordCount, intent_name, intent_confidence_bin, stage, dialogAct_name, locale, utteranceText, publicationStatus, interactionType]
-
dialogAct_name
= 'dialogAct.name'¶
-
intent_confidence_bin
= 'intent.confidence.bin'¶
-
intent_name
= 'intent.name'¶
-
interactionType
= 'interactionType'¶
-
locale
= 'locale'¶
-
publicationStatus
= 'publicationStatus'¶
-
recordCount
= 'recordCount'¶
-
stage
= 'stage'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
utteranceText
= 'utteranceText'¶
-