API Reference

Build Status codecov Gitter chat

You can get started quickly with Violet by looking at the collection of samples that we have along with the easy click to deploy button that we have set up.

Another option is to build a voice script locally. Doing this is as simple as:

a) installing the dependencies via npm:

npm install violet --save

b) trying a simple intent:

var violet = require('violet').script();

  expecting: "Whats next on my todo",
  resolve: function(response) {
    var nextItem = todoSvc.getNextItem();
    response.say(`Next item on your list is ${nextItem}`);

c) and running the code.


A simple way to respond to a user request:

violet.respondTo(['Can you help me', 'What can I do'],
 (response) => {
   response.say(`I can help you with your current account balance, with
                  financial planning, budgeting, investing, or taking out a

If you want to accept data from a user, you will need to declare it with its type and then tell the script engine where to expect it:


violet.respondTo(['My name is [[name]]'],
 (response) => {
   response.say('I like the name [[name]]')

You can use phrase equivalents to tell the engine that two phrases are identical in all situations:

  ['My name is', 'I call myself'],

Conversational Goals

Sophisticated conversations are supported by Violet using goals. When a user indicates a need for a discussion on a particular topic, a script can just add the topic as a goal to be met. Goals could theoretically also be set by a script to proactively check-in with a user or to raise an item related to another goal.

The below simply adds a goal to be met by the system when the user asks for flight arrival information.

violet.respondTo('What time does the [[airline]] flight arrive', 'from [[city]]',
  (response) => {

violet.respondTo('What time does the flight arrive from [[city]]',
  (response) => {

The conversation engine tries to meet goals based on goal definitions provided in the script. Goals are one of two types. The first type of goal is when additional information is needed

  goal: 'flightArrivalTime',
  resolve: (response) => {
    if (!response.ensureGoalFilled('airline')
        || !response.ensureGoalFilled('city')
        || !response.ensureGoalFilled('flightDay') ) {
          return false; // dependent goals not met
    var airline = response.get('airline');
    var city = response.get('city');
    var flightDay = response.get('flightDay');
    flightArrivalTimeSvc.query(airline, city, flightDay, (arrivalTime)=>{
      response.say('Flight ' + airline + ' from ' + city + ' is expected to arrive ' + flightDay + ' at ' + arrivalTime);
    return true;
  goal: 'city',
  prompt: ['What city do you want the flight to be arriving from'],
  respondTo: [{
    expecting: '[[city]]',
    resolve: (response) => {
      response.set('city', response.get('city') );


There are a number of plugins that allow you to further extend the capabilities of Violet Skills


These plugins will allow you to easily store and load data from a data store.

The main plugin provided currently is the Salesforce integration plugin violetStoreSF. If you are using this integration, then you will need to set up the following environment variables (locally and on any deployed platform): V_SFDC_CLIENT_ID, V_SFDC_CLIENT_SECRET, V_SFDC_USERNAME and V_SFDC_PASSWORD.

To include the plugin in your code you would need to add this after the violet script:

var violetStoreSF = require('violet/lib/violetStoreSF.js')(violet);
violet.respondTo('I received a bill from [[company]] today for [[amount]]',
  (response) => {
        'user': response.get('userId'),
        'from': response.get('company'),
        'amount': response.get('amount')

To retried data from the database you need to use the load method. Caution Load returns a promise to the db results - if you need to use the values retrieved from it, you need to (a) either use a .then after it OR (b) you need to make you resolve method a generator and place a yield before the call to the load method

// example a:
  expecting: 'Who did I receive my bill from most recently?',
  resolve: (response) => {
    return response.load('bills', 'bills.user', response.get('userId') )
        response.say(`You received a bill from ${results[0].from} for ${results[0].amount}`);
// example b: (note the 'function *' and the 'yield' below)
  expecting: 'Who did I receive my bill from most recently?',
  resolve: function *(response) {
    var results = yield response.load('bills', 'bills.user', response.get('userId') )
    response.say(`You received a bill from ${results[0].from} for ${results[0].amount}`);

Timed delay

var violetTime = require('violet/lib/violetTime.js')(violet);

Possible spoken commands:

  • What is the current time
  • Advance 5 days, hours, or minutes
violetTime.repeat(48*60, ()=>{ violet.addGoal('checkIn'); });

Violet Client Integration

var violetClientTx = require('violet/lib/violetClientTx.js')(violet);

Allows setting voice and creating alerts (the latter needs testing)

Advanced Topics

Custom types

The voice engine can recognize better what the user is saying when it knows to expect one of a limited set of inputs. One helpful way to do this is to use create custom type and have it as an input parameter in your script.

In the below example - from violetTime.js - a custom type called timeUnit is declared.

  "time": "NUMBER",
  "timeUnit": {
    "type": "timeUnitType",
    "values": ["days", "hours", "minutes"]

After declaring a custom type, the values and the type name need to be provided to Amazon's Skill Configuration Site as a custom slot type.

Debugging Conversations

When developing conversational scripts - it helps to debug/test it in three phrases:

  1. Make sure the code compiles/runs by typing npm start. Fix any errors and keep re-starting the service until misplaced punctuations and declarations have been fixed.
  2. Test the script in the included tester view, by running the script and opening it in a browser, for example: http://localhost:8080/alexa/einstein You will likely want to submit IntentRequest's based on the Utterance's at the bottom of the page. Once you submit a request, verify that the response output SSML is per your needs. Additionally, it is helpful to walk through the script a few times to ensure that the application supports the different user scenarios.
  3. Once the script works locally, deploy it to the cloud and configure Alexa to talk to the underlying skill using Amazon's Skill Configuration site. At this stage you will likely benefit from testing by iterating rapidly with: invoking the voice-client, examining the conversational-app's logs, and tweaking the utterances in Amazon's Configuration. Testing a voice client is likely best done first through a PC based tool that provides additional debugging information like the Violet Client or a web testing tool like Echosim.io.


We appreciate any help, in particular we would like to see:

  • Sophisticated conversational applications built on top of this project. As you build it, let us know how it went. What worked well? What was challenging?

  • Tests: If you want to make sure that we improve the framework that we don't break a use case that you are depending on - make sure we have an automated test.

  • File issues: If something is not working as expected, please file an issue on the project.

Documentation generated by JSDoc 3.5.5 on Fri Dec 28 2018 09:52:24 GMT-0500 (EST)