alexa-vui-generator
v2.1.0
Published
Generates the language model file describing the intents and types of an Alexa Skill
Downloads
16
Readme
Generator for Alexa Voice Interface definitions
Installation
npm install alexa-vui-generator
Usage
const generator = require('alexa-vui-generator');
generator.createLanguageModel(options, locale);
options
is an object which configures the generation of the language model
processors
is an array of functions that manipulate the provided VUI model.invocation
is a string that denotes the invocation name of the skillpretty
defines if the output should be pretty printed. By default it is minified.skipOutput
can be set totrue
to skip writing the output file
locale
is the locale that is generated and denotes the file name. (models/{locale}.json). It is forwarded to the processor functions as the second argument.
outputDir
is the folder to write the VUI (defaults to './models')
Using intents.yaml
You can use the provided function readIntentsFromYAML
as a function in processors
that reads the intents from a file called intents.yaml
and adds the Amazon default intents.
Furthermore it expands the provided texts to allow variations in the language. See example for usage.
intents.yaml
MySuperIntent:
texts:
- (Play|Start|Open) the {channel} (channel|)
slots:
channel: ChannelName
This resolves to the following intent definition:
{
"name": "MySuperIntent",
"samples": [
"play the {channel} channel",
"start the {channel} channel",
"open the {channel} channel",
"play the {channel}",
"start the {channel}",
"open the {channel}"
],
"slots": [
{
"name": "channel",
"type": "ChannelName",
"samples": []
}
]
}
To support different locales you can provide an object as texts with the locales as keys instead of a string array.
intents.yaml
MySuperIntent:
texts:
'en-US':
- (Play|Start|Open) the {channel} (channel|)
'de-DE':
- (Spiele|Starte|Öffne) den {channel} (channel|Kanal|)
slots:
channel: ChannelName
To use dialog support you can specify the slot in an expanded way:
intents.yaml
CalculateIntent:
texts:
- ja (bitte|)
- ausrechnen
slots:
age:
type: AMAZON.NUMBER
elicitationRequired: true
confirmationRequired: false
prompt: Wie alt bist du?
texts:
- Ich bin {age} (Jahre alt|)
- '{age}'
Using types.yaml
You can use the provided function readTypesFromYAML
as a function in processors
that reads the slot types from a file called types.yaml
.
types.yaml
ChannelName:
rock:
- rock
- rock music
This resolves to the following intent definition:
{
"name": "ChannelName",
"values": [
{
"id": "rock",
"name": {
"value": "rock",
"synonyms": [
"rock",
"rock music"
]
}
}
]
}
To support different locales you can provide an object as values with the locales as keys instead of a string array.
types.yaml
ChannelName:
rock:
'en-US':
- rock
- rock music
'de-DE':
- rock
- rock musik
Other generator functions used as processors
createAudioPlayerIntents
- Creates the intents needed when using the AudioPlayer functionality.
createDisplayIntents
- Creates the intents needed when using the Display functionality.