The interaction model resource has the same structure as if you create an interaction model in the developer console using the skill builder. You can create and modify the interaction model resource with ASK CLI commands or with Interaction Model API Operations.
Rules for conducting a multi-turn dialog with the user
no
prompts
array
Cues to the user on behalf of the skill for eliciting data or providing feedback
no
languageModel
Field
Type
Description
Required?
invocationName
string
Invocation name of the skill
yes
intents
array
Intents and their slots
yes
types
array
Custom slot types
no
languageModel_intents
Field
Type
Description
Required?
name
string
Name of the intent
yes
slots
array
List of slots within the intent
no
samples
array
Sample utterances for the intent
no
slots
Field
Type
Description
Required?
name
string
Name of the slot
yes
type
string
Type of the slot
yes
samples
array
Sample utterances for the slot
no
types
Field
Type
Description
Required?
name
string
Name of the custom slot type
yes
values
array
List of representative values for the slot.
no
valueSupplier
object
Definition of slot value supplier(s).
no
Type_ValueCatalog
Field
Type
Description
Required?
type
string
Type of the value supplier. CatalogValueSupplier is the only supported option.
yes
CatalogValueSupplier
Field
Type
Description
Required?
valueCatalog
object
The catalog reference definition.
yes
valueCatalog
Field
Type
Description
Required?
catalogId
string
The identifier of the catalog.
yes
version
string
The version of the catalog.
yes
value
Field
Type
Description
Required?
id
string
Identifier for a value of a custom slot type
yes
name
object
Describes a value of a custom slot type
yes
values_name
Field
Type
Description
Required?
value
string
A value for a custom slot type
yes
values_synonyms
Field
Type
Description
Required?
value
string
A value for a custom slot type
yes
synonyms
array
List of potential synonyms for a value of a custom slot type
no
dialog
Field
Type
Description
Required?
intents
array
List of intents that have dialog rules associated with them.
yes
delegationStrategy
string
Specifies whether dialogs in this skill should be automatically delegated to Alexa. This can be ALWAYS (auto-delegation is on for the overall skill) or SKILL_RESPONSE (auto-delegation is off for the overall skill). You can override this setting at the intent level.
dialog_intents
Field
Type
Description
Required?
name
string
Name of the intent that has dialog rules
yes
delegationStrategy
string
Specifies whether the dialog for this intent should be automatically delegated to Alexa. This can be ALWAYS (auto-delegation is on for this intent) or SKILL_RESPONSE (auto-delegation is off for the intent). When this property is not present, the intent uses the skill-level delegationStrategy.
slots
array
List of slots in this intent that have dialog rules
no
confirmationRequired
boolean
Describes whether confirmation of the intent is required
no
prompts
Map
Collection of prompts for this intent
no
dialog_intent_prompt_type
Field
Type
Description
Required?
confirmation
string
Enum value in the dialog_intents map to reference the confirmation prompt id
no
dialog_slots
Field
Type
Description
Required?
name
string
Name of the slot in the dialog intent
yes
type
string
Type of the slot in the dialog intent
yes
elicitationRequired
boolean
Describes whether elicitation of the slot is required
no
confirmationRequired
boolean
Describes whether confirmation of the slot is required
no
prompts
Map
Collection of prompts for this slot
no
validations
array
List of validation rules for this slot
no
dialog_slot_validations
Field
Type
Description
Required?
type
string
Enum value to reference the type of validation rule. See Validation rules
yes
prompt
string
ID to reference the set of prompts for this validation rule
yes
The validation object includes additional properties specific to the available validations. See Validation rules.
dialog_slot_prompt_type
Field
Type
Description
Required?
elicitation
string
Enum value in the dialog_slots map to reference the elicitation prompt id
no
confirmation
string
Enum value in the dialog_slots map to reference the confirmation prompt id