@ocelot-consulting/ocelot-voice-framework v1.1.90

Ocelot Voice Framework

Ocelot Voice Framework is designed to enable you to build context aware state machines as conversations for Alexa/Lex voice platforms.

Note: this framework requires the robot3 library for building state machines capable of handling the necessary conversation transitions.

Use (Alexa)

This framework is used alongside Amazon's ask-sdk-core. To get started, install this package to your alexa project. If you've never set up an Alexa project before, start here

The key differences between this framework and a normal Alexa application are:

• conversations have contextual information stored as json that can be used to influence the conversation. for example, you can keep track of how many unexpected responses you've received from a user and show longer helpful messages rather than the quick convenient responses for most users.

• session data storage can be managed by you. that means that if your session with alexa is interrupted, you can resume it by restarting the app, even if you're using a different device. if you don't want to use this feature, simply omit the fetchSession and saveSession functions from your state handler invocation.

• normal alexa apps add a new request handler and intent for each conversation option - the intent is used to navigate to the correct request handler. this framework uses it's own request handler behind the scenes for every request so you don't worry about writing them. intents are used for navigating between sub conversations rather than handlers.

• slots are Alexa's data types. you create your own in the interaction model and include a reference to each slot you want to use in your intent in the intent declaration. you can use Amazon's pre-built slot types (mentioned in docs), or build your own. slots are used in the same way with the framework, so Alexa's documentation for slots is relevant here too.

Documentation

generate (function)

generates your alexa application using your conversationSet and dialog options

conversationSet (array*) \ json for each of your subConversations where the app's logic lives. Each conversation will be an object with a handle function, and for root conversations an intent to match the associated intent in the interaction model. There are other options you can return, but intent and handle are the most important. A conversationSet with the two conversations greeting and randomFact would look like this

{
  greeting: {
    intent: 'GreetingIntent',
    handle: () => { ... },
  },
  randomFact: {
    intent: 'RandomFactIntent',
    handle: () => { ... },
  },
}

fetchSession (function) \ asynchronous function that's called to retrieve session data for a particular user - could be a get request to an api. If omitted, your application will use Alexa's default session storage. With this approach, you don\'t need to manage the data for your session state but users will lose the ability to resume conversations from previous sessions.

saveSession (function) \ asynchronous function that's called at the end of each interaction with the user to save the state the session is in between invocations. If omitted, your application will use Alexa's built in session storage. Note: If using fetchSession, you must also use saveSession and vice versa. If one is missing, the feedback loop won\'t be complete. In this case, we\'ll use Alexa's session storage and warn you in the console that your fetch/save will be ignored until the missing function is provided.

dialog (object) \ a master list of all your application's dialog options

Example

const {
 saveSessionToDynamoDb,
 getSessionFromDynamoDb,
} = require('../service/SessionAttributesService')
const { generate } = require('@ocelot-consulting/ocelot-voice-framework')

exports.handler = generate({
 conversationSet: {
  ...require('./subConversations/greeting'),
  ...require('./subConversations/randomFact'),
 },
  dialog: {
    ...require('./dialog/GreetingDialog'),
    ...require('./dialog/RandomFactDialog'),
  },
  fetchSession: getSessionFromDynamoDb,
  saveSession: saveSessionToDynamoDb,
})

handle (function)

The place for your subConversation's logic. In the handle function, each of your sub conversations have the following available parameters for you to use

conversationSet (object) \ contains all of your subConversations - this is the same object you passed to the generate function

conversationStack (array) \ array of all active subConversations in order or oldest to newest. when a subConversation triggers a new subConversation, the current subConversation is pushed into the conversationStack and replaced with the new subConversation

sessionAttributes (object) \ json that exposes all of the application's state. can be used as global state but warning; the conversation relies on some of the values. sessionAttributes.conversationAttributes is what you should use for global state in your conversation

intent (object) \ intent json from alexa with slot data

poppedConversation (boolean) \ indicates when the subConversation being processed has been popped from the stack. This happens when a subConversation is resolved

dialog (function) \ function that exposes your dialog options to speak to the user

currentSubConversation (object) \ the subConversation that the conversation engine is currently generating a response for - the most recent subConversation

subConversation (object) \ the subConversation that the conversation engine is processing during the loop. not to be confused with currentSubConversation

finalWords (boolean) \ indicates that there's nothing left to say and that the subConversation is over

From your handle function, you should return the following

stateMap (object*) \ The only truly required return for the handle function. stateMap is your robot3 state machine definition. It drives the logic for each transition from one interaction to another.

dialogMap (object) \ DialogMap maps the current state of your state machine to the appropriate speech to respond to the user. This is required for any state values that don't line up with the state name used in your stateMap. If no dialogMap key is available for the state, the framework will use <subConversationName>.<stateName> by default.

initialState (object) \ All the keys you want available in your subConversation's context. These values are available in all of your robot3 states and dialog speech options. Variables are initialized at the beginning of the conversation so if you want to start with a specific value, pass it; otherwise, initialize with an empty data type of your choice.

overrideResume (boolean) \ When you transition from one state to another mid conversation, coming back to the previous conversation will trigger the resume state for your conversation. For conversations that should be implicitly resumed whenever they're at the top of the stack, pass overrideResume: true to skip that step and go right back into your conversation without asking the user.

transitionStates (array) \ If your subConversation leads to another subConversation, pass the name of each available transition as a new string to the array. For example, if you have a reusable collectAddress subConversation that some of your other subConversations rely on, you'd pass transitionStates: [ 'collectAddress' ] to each of the subConversations that use it.

formatContext (function) \ sometimes, the information alexa collects isn't in a form that allows you to repeat it back to the user. for example, when scheduling appointments, collecting a date using amazon's AMAZON.DATE slot type leaves you with an ISO code. the formatContext function allows you to modify the data that gets written to the conversation's context

const makeAppointment = {
  handle: () => ({
    formatContext: ctx => ({
      ...ctx,
      date: formatDate(ctx.date),
    }),
  }),
}

All input values from the handle function can be modified and replaced in the return of the handle function, but do so at your own risk as it could cause bugs.

intent (string)

The name of the intent in your interaction model that corresponds to the subConversation. This is only to be used in root subConversations, not subConversations that are accessed and used by other subConversations.

canInterrupt (boolean)

For subConversations that are high priority, sometimes we want to interrupt the current subConversation and come back to it later. In this case, you pass canInterrupt: true back from the handle function. After the subConversation is concluded, the previous subConversation will be popped off the stack in a resume state to give the user an option to continue the previous conversation or end it.

Putting it all together

Example below is of a conversation designed to collect a user's first and last name

const {
  state,
  transition,
  guard,
  invoke,
  immediate,
} = require('robot3')
const { utils } = require('@ocelot-consulting/ocelot-voice-framework')

const stateMap = {
 fresh: state(transition('processIntent', 'askFirstName')),
 askFirstName: state(
  transition(
   'processIntent',
   'askLastName',
   // if the user didn't successfully fill the firstName slot,
   // don't move on to asking about last name
   guard((ctx, { intent }) => intent.slots.firstName !== ''),
   reduce((ctx, { intent }) => ({
    ...ctx,
    firstName: utils.getSlotValueId(intent.slots.firstName),
   }))
  ),
  // instead, re-ask about first name
  transition('processIntent', 'askFirstName')
 ),
 askLastName: state(
  transition(
   'processIntent',
   'askForConfirmation',
   guard((ctx, { intent }) => intent.slots.lastName !== ''),
   reduce((ctx, { intent }) => ({
    ...ctx,
    lastName: utils.getSlotValueId(intent.slots.lastName),
   }))
  ),
  transition('processIntent', 'askLastName')
 ),
  askForConfirmation: state(
    transition('processIntent', 'thankYou',
      guard((ctx, { intent }) => utils.getSlotValueId(intent.slots.confirmed) === 'yes',
    ),
    transition('processIntent', 'restart',
      guard((ctx, { intent }) => utils.getSlotValueId(intent.slots.confirmed) === 'no'),
    ),
    transition('processIntent', 'askForConfirmation')
  ),
  restart: immediate('askFirstName'),
 thankYou: state(),
}

const askName = {
  intent: 'AskNameIntent',
  handle: () => ({
    initialState: {
      firstName: '',
      lastName: '',
    },
    stateMap,
  }),
}

And the dialog options for this conversation (passed to the generate function as dialog)

const askName = {
 askFirstName: [
  `Hi. What is your first name?`,
  `Hello. What's your first name?``Hey there. What is your first name?`,
 ],
 askLastName: [
  `Thanks {{firstName}}.  What's your last name?`,
  `Got it, {{firstName}}.  Now what about your last name?`,
  `Great.  Can you give me your last name next, {{firstName}}?`,
 ],
  askForConfirmation: [
    `So your name is {{firstName}} {{lastName}}?`,
    `Got it.  I heard your name was {{firstName}} {{lastName}}.  Is that correct?`
  ],
  restart: [
    `Oops. Let's try again.`
  ],
 thankYou: [
  `Thanks for your response {{firstName}} {{lastName}}.`,
  `{{firstName}} {{lastName}} thank you for answering.`,
  `Okay, got it {{firstName}} {{lastName}}.`,
 ],
}

And finally, the json for the interaction model

{
  "interactionModel": {
    "languageModel": {
      "invocationName": "ask name skill",
      "intents": [
        {
          "name": "AskNameIntent",
          "samples": [
            "Ask my name",
            "Ask me my name",
            "Ask for my name"
          ],
          "slots": [
            {
              "name": "firstName",
              "type": "AMAZON.FirstName",
              "samples": [
                "{firstName}"
              ]
            },
            {
              "name": "lastName",
              "type": "AMAZON.LastName",
              "samples": [
                "{lastName}"
              ]
            },
            {
              "name": "confirmed",
              "type": "yesNoType",
              "samples": [
                "{confirmed}"
              ]
            },
          ]
        }
      ],
      "types": [
        {
          "name": "yesNoType",
          "values": [
            {
              "id": "no",
              "name": {
                "value": "no",
                "synonyms": [
                  "no thanks",
                  "nah",
                  "negative",
                  "incorrect",
                  "never",
                  "nope",
                  "false"
                ]
              }
            },
            {
              "id": "yes",
              "name": {
                "value": "yes",
                "synonyms": [
                  "sounds good",
                  "yup",
                  "yeah",
                  "affirmative",
                  "correct",
                  "always",
                  "ok",
                  "sure",
                  "true"
                ]
              }
            }
          ]
        },
      ],
    }
  },
  "dialog": {
    "intents": [
      {
        "name": "AskNameIntent",
        "confirmationRequired": false,
        "prompts": {},
        "slots": [
          {
            "name": "firstName",
            "type": "AMAZON.FirstName",
            "elicitationRequired": false,
            "confirmationRequired": false,
            "prompts": {}
          },
          {
            "name": "lastName",
            "type": "AMAZON.LastName",
            "elicitationRequired": false,
            "confirmationRequired": false,
            "prompts": {}
          },
          {
            "name": "confirmed",
            "type": "yesNoType",
            "elicitationRequired": false,
            "confirmationRequired": false,
            "prompts": {}
          }
        ]
      }
    ]
  }
}