Address already in use error
If the following error OSError: [Errno 48] Address already in use occurs,
Search for the following processes and kill them.
ps aux | grep start.py
ps aux | grep classifier.py
ps aux | grep dialog_manager.py
kill -9 <pid>
Quick Start
Introduction
This chapter provides a quick understanding into how to run a Cuneiform application. For this purpose, we will use the ChessHelper sample.
ChessHelper is a sample conversational application which provides us with basic information about chess in natural language. This sample identifies our intentions from what we type and provide us with information relevant to what we requested.
Prerequisites
Before you begin, Cuneiform is supported for systems fulfilling the following requirements.
Software
- Python 3.6+
- pip3 for Python 3.x
- Node.js 6.11+
Operating Systems (64-bit)
- Ubuntu 16.04 or later
- macOS 10.13.3 (High Sierra) or later
Installation
Step One
Clone the cuneiform project repository from GitHub.
git clone https://github.com/Savidude/cuneiform.git
Step Two
Navigate to the bin directory in the project and run the install.sh script.
cd cuneiform/bin
./install.sh
Step Three
Run Cuneiform.
./start.sh
Running ChessHelper
Access the Cuneiform development environment by navigating to http://<HTTP_HOST>:<HTTP_PORT>
http://localhost:5000
Zip the ChessHelper sample project
- Navigate to cuneiform/resources/deployment/samples
- Compress the ChessHelper directory into a .zip file.
Open ChessHelper
- Select "Upload Existing App" in the Cuneiform Development Environment.
- Select the .zip file we just created and click "Upload Application".
Overview of the Cuneiform Development Environment
On opening the application, you are presented with the following interface.
More information on making your way through the Cuneiform development environment can be found in the tutorials. In this chapter, we will give you a brief introduction to the different components of the environment.
On the left is the list of intents in the project. An intent represents an action that fulfills a user's request provided in natural language. For example, WelcomeIntent highlights the set of actions that is executed when the user greets the system. Details on how to initiate this intent can be viewed by clicking the icon in the navigation view on the top right side of the environment.
Shown above is the set of details on how the WelcomeIntent could be initiated. This can be done with simple greetings like "Hello". Let's see what would happen when we greet our ChessHelper.
- Navigate to the development environment by going to the previous page on your browser.
- Click on the icon in the navigation menu on the top right to open the Try it Emulator.
- Type "Hello" in the text box at the bottom and hit enter.
When we greet ChessHelper by saying "Hello", it responds with "Welcome to ChessHelper. You can ask...". The program for this response can be seen by either clicking on the Code tab at the top.
WelcomeIntent {
node main {
priority : 5;
preconditions {
}
action {
var response = new Response;
response.responseSet = [
"Welcome to ChessHelper. You can ask how to set up the game, about an individual piece, what the rules are, how to win, or for a chess tip. Which will it be?"
];
response.userAction = "info";
response.send;
ExitIntent;
}
}
}
The program code for WelcomeIntent is shown above. The other intents are written similar to WelcomeIntent. However,if we check the intent properties of PieceIntent, there is a slot value called "Piece", which is represented by { Piece }.
When the edit button () is clicked, more details of the Piece slot can be seen.
The slot contains values such as "king", "queen", etc. Additionally, some slot values may also contain synonyms. For example, a person may refer to "rook" as "tower", or "castle".
The user may provide the name of the piece along with an utterance, similar to "Tell me about {Piece}", where the piece's name, or a synonym is to be used in place of {Piece}. An example for this can be seen in the emulator shown below, where we ask ChessHelper to tell us about the knight. However, instead of saying "knight", we use "horse".
Explore the rest of the intents, their properties, and source code and check how ChessHelper behaves when different types of inputs are given in the Try it Emulator. Try using different inputs, which are similar, but not provided in the sample utterances, and check if the program behaves as expected.
ChessHelper is a simple application designed to demonstrate basic conversational capabilities of Cuneiform. To learn more about Cuneiform, and its wide array of functionalities, explore more samples, or read our documentation.