ryanctlin / skill-sample-nodejs-petmatch

This Alexa Skill Kit sample shows how to build a skill using Dialog Management and Entity Resolution.

Conversation and Memory

Pet Match

Overview

In this workshop you will create a skill called Pet Match that matches the user with a pet. When launched, this Alexa Skill will prompt the user for the information it needs to determine a match. Once all of the required information is collected, it will send the data to an external web service which processes the data and returns the match.

Through this workshop, you'll learn how to use advanced Alexa Skills Kit features to create and configure an Alexa Skill and AWS Lambda. The features you'll learn to use are Dialog Management and Entity Resolution. These features leverage Alexa's Automatic Speech Recognition (ASR), Natural Language Understanding (NLU), and Machine Learning (ML), which makes your life easier because you don't have to write code. You only need to provide training data to the Alexa engines via your interaction model. The skill builder makes it easy to do so.

Pre-requistes

In order to start working on this workshop you will need:

• AWS Account
• Amazon Developer Account

Get Started

The workshop is composed of three parts:

• Part 1: Build and Customize Pet match
• Part 2: Entity Resolution
• Part 3: Memory

Each part contains a set of tasks that act as check points, and extra credit that will present a challenge that will further enhance your learning.

Note You may use Pet Match as a starting point to build your own skill that needs to collect information form the user and have processed via a web service. You can customize the slots to match the data you need and change the hostname to the web service you need to call.

If this is your first time here, you're new to Alexa Skills Development, you're interested in the "extra credit", or you're looking for more detailed instructions, click the Get Started button below:

Be sure to take a look at the Additional Resources at the bottom of this page!

About

Note: The rest of this readme assumes you have your developer environment ready to go and that you have some familiarity with CLI (Command Line Interface) Tools, AWS, and the ASK Developer Portal. If not, click here for a more detailed walkthrough.

Usage

Alexa, ask pet match find a pet.
	>> Welcome to pet match. I can help you find the best dog for you. What are two things you are looking for in a dog?

Alexa, open pet match

Repository Contents

• /.ask - ASK CLI (Command Line Interface) Configuration
• /lambda/custom - Back-End Logic for the Alexa Skill hosted on AWS Lambda
• /models - Voice User Interface and Language Specific Interaction Models
• /instructions - Step-by-Step Instructions for Getting Started
• skill.json - Skill Manifest

Setup w/ ASK CLI

Pre-requisites

• Node.js (> v4.3)
• Register for an AWS Account
• Register for an Amazon Developer Account
• Install and Setup ASK CLI

Installation

1. Clone the repository.

   $ git clone https://github.com/alexa/skill-sample-nodejs-petmatch/

2. Initiatialize the ASK CLI by Navigating into the repository and running npm command: ask init. Follow the prompts.

   $ cd skill-sample-nodejs-petmatch
   $ ask init

3. Install npm dependencies by navigating into the /lambda directory and running the npm command: npm install

   $ cd lambda/custom
   $ npm install

Deployment

ASK CLI will create the skill and the lambda function for you. The Lambda function will be created in us-east-1 (Northern Virginia) by default.

1. Deploy the skill and the lambda function in one step by running the following command:

   $ ask deploy

Testing

1. To test, you need to login to Alexa Developer Console, and enable the "Test" switch on your skill from the "Test" Tab.

2. Simulate verbal interaction with your skill through the command line using the following example:

    $ ask simulate -l en-US -t "alexa, start pet match"
   
    ✓ Simulation created for simulation id: 4a7a9ed8-94b2-40c0-b3bd-fb63d9887fa7
   ◡ Waiting for simulation response{
     "status": "SUCCESSFUL",
     ...

3. Once the "Test" switch is enabled, your skill can be tested on devices associated with the developer account as well. Speak to Alexa from any enabled device, from your browser at echosim.io, or through your Amazon Mobile App and say :

   Alexa, start pet match
   

Customization

1. ./skill.json

   Change the skill name, example phrase, icons, testing instructions etc ...

   Remember that many information is locale-specific and must be changed for each locale (en-GB and en-US)

   See the Skill Manifest Documentation for more information.

2. ./lambda/custom/index.js

   Modify messages, and facts from the source code to customize the skill.

3. ./models/*.json

   Change the model definition to replace the invocation name and the sample phrase for each intent. Repeat the operation for each locale you are planning to support.

Additional Resources

Community

• Amazon Developer Forums - Join the conversation!
• Hackster.io - See what others are building with Alexa.

Tutorials & Guides

• Voice Design Guide - A great resource for learning conversational and voice user interface design.
• CodeAcademy: Learn Alexa - Learn how to build an Alexa Skill from within your browser with this beginner friendly tutorial on CodeAcademy!

###Documentation

• Official Alexa Skills Kit Node.js SDK - The Official Node.js SDK Documentation
• Official Alexa Skills Kit Documentation - Official Alexa Skills Kit Documentation