Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MultiValueListControlInteractionModelProps

Props associated with the interaction model.

Hierarchy

  • MultiValueListControlInteractionModelProps

Properties

Optional actions

Action slot-values associated to the control's capabilities.

Default:

{
   set: ['builtin_set', 'builtin_select'],
   change: ['builtin_set']
}

Action slot-values associate utterances to a control. For example, if the user says "change the time", it is parsed as a GeneralControlIntent with slot values action = change and target = time. Only controls that are registered with the change action should offer to handle this intent.

Usage:

  • This allows users to refer to an action using more domain-appropriate words. For example, a user might like to say 'show two items' rather that 'set item count to two'. To achieve this, include the slot-value-id 'show' in the list associated with the 'set' capability and ensure the interaction-model includes an action slot value with id=show and appropriate synonyms.
  • The 'builtin_*' IDs are associated with default interaction model data (which can be extended as desired). Any other IDs will require a full definition of the allowed synonyms in the interaction model.

Optional slotValueConflictExtensions

slotValueConflictExtensions: undefined | object

Additional properties to resolve utterance conflicts caused by the configured slot type.

Purpose:

  • use these props in situations where the configured slotType has values/synonyms that cause utterance conflicts. Most commonly, this arises when the list control is managing a slotType with values such as 'yes' and 'no' that conflict with Amazon.YesIntent & Amazon.NoIntent.

Optional targets

targets: string[]

Target-slot values associated with this Control.

Targets associate utterances to a control. For example, if the user says "change the time", it is parsed as a GeneralControlIntent with slot values action = change and target = time. Only controls that are registered with the time target should offer to handle this intent.

Default: ['builtin_it']

Usage:

  • If this prop is defined, it replaces the default; it is not additive the defaults. To add an additional target to the defaults, copy the defaults and amend.
  • A control can be associated with many target-slot-values, eg ['date', 'startDate', 'eventStartDate', 'vacationStart']
  • It is a good idea to associate with general targets (e.g. date) and also with specific targets (e.g. vacationStart) so that the user can say either general or specific things. e.g. 'change the date to Tuesday', or 'I want my vacation to start on Tuesday'.
  • The association does not have to be exclusive, and general target slot values will often be associated with many controls. In situations where there is ambiguity about what the user is referring to, the parent controls must resolve the confusion.
  • The 'builtin_*' IDs are associated with default interaction model data (which can be extended as desired). Any other IDs will require a full definition of the allowed synonyms in the interaction model.

Control behavior:

  • A control will not handle an input that mentions a target that is not registered by this prop.