Create a Travel Virtual Assistant

After you have signed up with the Kore.ai XO Platform, the next step is to create a Virtual Assistant. Before you create it, we recommend you to go through the basics of building a VA by reading this article.

This present article takes you through the creation of a simple, travel related VA, that gives users the flight status arriving/departing from Los Angeles International Airport.

Assistant Capabilities

This assistant can perform the following tasks:

Ask the user if they want to know about the arrivals or departures.
Make a service call to an API to fetch the details of flights arriving and departing out of the airport.
Display the flight numbers based on the user preference of Arrival or Departure.
Request the user to select a flight number.
Display the status details of the selected flight.
Handle any errors.

Create the Assistant

To build your Virtual Assistant, follow the steps below:

Log in to your Kore.ai XO Platform account.
On the landing page, click New Bot on the top-right and select the Start from Scratch option.
On the Create New Bot window, enter the details:

Bot Name – Give a name to your assistant. For example: Travel Planning Assistant. If the name is already used, try something else.
Choose or upload an Icon to represent your assistant throughout the Platform.
Select Standard Bot as the Bot Type.
Select English from the Default Bot Language drop-down list.

Click Create.

Create a Dialog Task

After creating your assistant, you are directed to the Bot Summary page. The first step is to add an Intent Dialog. The Intent Dialog is the first step in the user-VA conversation flow.

To create such a Dialog Task, please follow the steps below:

On the Tasks widget, click + New Task and select Dialog Task.
On the Create Dialog page, enter the following details:

Intent Name – Enter the Intent name, this is the phrase that triggers the dialog. The intent name must be simple and not more than 3-4 words. For example, Check flight status.
Under More Options, you can add a description and other dialog-related details. Let us retain the default settings.

Click Proceed.
You may be prompted to Upgrade to Conversation Driven Dialog Builder, select to Upgrade. For instructions on the Legacy Dialog Builder, refer here
Once your task has been created, you will see the Dialog Builder Canvas, with the first node displayed – the Intent Node, which receives the name of the task and represents the main node within the Dialog Task. Learn more about working with the Dialog Builder.

Create a User Preference Entity Node

An Entity node is typically used to gather information from the user. Let us use it to capture the user preference of arrival or departure details.

Click the + icon next to the User Intent node.
Select Entity > + New Entity.
You can also drag and drop Entity from the node panel on the left.
Click the newly added Entity node to open the Entity window.
By default, the Component Properties tab is selected.
1. Under the General Settings section, enter the following details:
  1. Name: Preference
  2. Display Name: Preference
  3. Type: Select List of Items (enumerated) from the drop-down list. You can provide a list of values that the user can select. To add a list of values,
    1. Click the Settings icon next to the field.
    2. Select the Static List option.
    3. Under the Keys & Values To Use section, enter the Display Name as Arrival and Departure in separate rows. Value and Synonyms columns auto-populate, leave them as is.
    4. Define the percentage of Auto Correction to be applied to match the user’s input to a value in the list. Set to 0 if you do not want to apply auto correction at all.
    5. Click Save.
Go back to the Entity window.
Under the User Prompts section, enter the following text:

Hello {{context.session.UserContext.firstName}}! Welcome to *Los Angeles International Airport*. I can help you with flight Arrival/Departure information. Please select your preference.

Note: The context variable retrieves the user’s first name. Also, markdown is used for the airport name to appear in bold.

Under the Display List of Values section, select Yes, use channel-specific standard formatting for default messages and show the available list of values to the end-user option. This displays the list of values as a button template in supported channels.
Close the Entity window.

Create a Service Node

A Service Bot Action node allows you to make a backend API call. Here the service node is used to call an API to get flight information for flights From and To LAX airport. In this tutorial, a dummy API setup is used.

Click the + icon next to the Preference Entity node.
Select Bot Action > + New Bot Action.
Under the General Settings section, enter the following details:
1. Name: FlightDetails
2. Display Name: Flight Details
Click the + next to the Bot Action node to expand the Bot Action.
From within the Bot Action node click +
Select Service > + New service.
1. The service node is used to make a backend API call to get flight information for flights From and To LAX airport.
Click the Service node to open the Service window, by default, the Component Properties tab is selected.
Under the General Settings section, enter the following details:
1. Name: Fetchflightdetails
2. Display Name: Fetch Flight Details
3. Service Type: Custom Service
4. Type: Webservice
5. Sub Type: REST
6. Under the Request Definition section, Click DEFINE REQUEST.
7. On the Define Request page, enter the following details:
  1. Request Type – GET
  2. Request URL – http://5e85a56644467600161c6579.mockapi.io/FlightDetails
    This API does not require any Auth or Header Parameters.
  3. Click the Test Request tab.
    1. Click Test on the top-right.
    2. Wait for the test to complete and you get a Status Code 200.
    3. Click Save as Sample Response.
    4. Click Save.
8. Return to the dialog builder
Under the Connections section, set the Default Connection Rule to End of Bot Action.
Close the Service window.
Collapse the Bot Action node.

Create a Flight Selection Entity Node

This Entity node is to capture the Flight Number for which the user wants the status details.

Click the + icon next to the Flight Details Bot Action node.
Select Entity > New entity node +.
1. The Entity node is required to capture the flight number selected by the user.
On the Entity window, by default, the Component Properties tab is selected.
Under the General Settings section, enter the following details:
1. Name: SelectFlight
2. Display Name: Select Flight
3. Type: String (users can write a custom script to convert the API string output to a list of values in the following steps, this is the requirement of the dummy API used)

Under the User Prompts section, enter the following text:
Please provide the flight number.

Manage: Users can define a specific prompt for the Web SDK channel.
Click Manage. Read more about managing user prompts.
Click Add Prompt Message.
On the New Prompt Message window, select Web/Mobile client from the Channel drop-down list.
Under the Message section, click the JavaScript tab.

Enter the following JavaScript. The JavaScript extracts flight numbers matching user preference from the string output from API call and displays them in the Quick Reply format.

var data = context.Fetchflightdetails.response.body.details;
context.flights = [];
context.info;
var msg;
for (var i = 0; i < data.length; i++)
{
    if (context.entities.Preference == data[i].Type)
    {
        var details = {
            "Airlines" : data[i].Airlines,
            "FlightNo" : data[i].FlightNo,
            "Airport" : data[i].Airport,
            "AirportName" : data[i].AirportName,
            "Time" : data[i].Time
        };
        context.flights.push(details);
    }
}
var message = {
    "type" : "template",
    "payload" : {
       "template_type" : "quick_replies",
       "text" : "Here are the flights " + context.entities.Preference + " details for Los Angeles
International Airport today. Please select the flight number to see details",
       "quick_replies" : []    }
};
for (i=0; i < context.flights.length; i++)
{
   var replies = {
        "content_type":"text",
        "title" : context.flights[i].FlightNo,
        "payload" : context.flights[i].FlightNo
    };
message.payload.quick_replies.push(replies);
}
return JSON.stringify(message);

Click Save.
Go back to Dialog Builder and close the Entity window.

Create a Script Node

A Script node is used to write custom JavaScript in the Dialog task. Here, users can use the script to extract the selected flight details. Later, users can add more functionality to this script.

Click the + icon next to the Select Flight Entity node.
Select Bot Action > + New Bot Action.
Under the General Settings section, enter the following details:

Name: Flight Validation
Display Name: Flight Validation

Click the + next to the Bot Action node to expand the Bot Action.
From within the Bot Action node click +
Select Script > New script node +.
On the Script window, by default, the Component Properties tab is selected.
Under the General Settings section, enter the following details:

Name: ValidateFlight
Display Name: Validate Flight

Under the Script Definition section, click Define Script.

On the Add Script dialog box, copy the following JavaScript. This code extracts the details of the selected flight number and also mitigates potential task failures caused by users not selecting a preference and instead manually entering information that is not found within the Context. Learn more about the Context Object.

context.valid = false;
context.details;
var x = context.flights.length;
for (var l = 0; l < x; l++)
{
    if (context.entities.SelectFlight == context.flights[l].FlightNo)
    {
         context.valid = true;
         context.details = {
            "Airlines" : context.flights[l].Airlines,
            "FlightNo" : context.flights[l].FlightNo,
            "Airport" : context.flights[l].Airport,
            "AirportName" : context.flights[l].AirportName,
            "Time" :context.flights[l].Time
        };
        break;
    }
}
if (context.valid === false)
{
    delete context.entities.SelectFlight;
}

Click Save.
Under the Connections section, set the Default Connection Rule to End of Bot Action
Close the Script window.
Collapse the Bot Action node.

Create a Message Node to provide the Flight Status

A Message node is used to display a message from the VA to the user. Here, users can use the Message node to show appropriate flight details, based on user preference. This message node is triggered when the user enters a valid flight number.

Click the + icon next to the Validate Flight Script node.
Select Message > New message node +.
On the Message window, by default, the Component Properties tab is selected.
Under the General Settings section, enter the following details:
1. Name: FlightDetails
2. Display Name: Flight Details
Under the Bot Responses section, enter the following text:
Here are your flight details.
Click Enter to save.
Manage Prompts: Users can define a specific prompt for the Web SDK channel.
1. Click Manage.
2. On the Manage Bot Responses page, click ADD BOT RESPONSE.
3. Select Web/Mobile client from the Channel drop-down list.
4. Under the Message section, click the JavaScript tab.
5. Copy the following JavaScript. The JavaScript is written to display the flight details in the Table format.
6. Click Save.
Go back to the Message window.
On the Message window, click the Connections tab.
1. From the drop-down list, change the default connection from Not Connected to End of Dialog.
2. Click Save.
Close the Message window.

When you have finished configuring your Dialog Task, it should look something like the illustration below.

Create a Conditional Flow for an Error Message

The Conditional Flow is required when, for example, the user provides input that cannot be identified by the VA, rather than selecting from one of the options you have configured (i.e.: either Arrivals or Departures.) In such a case, you would want to have the VA respond to the user with an error message.

The following are the steps required in order to add the conditional flow from the Validate Flight Script node. A new connection from this Script node to a new Message node is established. This is to display an error message from the VA to the user and redirect to select the flight number again.

Create the Error Message

Hover over the connection between Flight Validation Bot Action node and Flight Details message node.
You can see the Add Node button, click the same.
Create a new Message node.
- Name: ErrorMessage
- Display Name: Error Message
- Click Enter to save.

Select Message > + New message node .
On the Message window, by default, the Component Properties tab is selected.
Under the General Settings section, enter the following details:
Under the Bot Responses section, enter the following text:
The Flight number you entered is incorrect. Let us start again.
Click the Connections tab.
From the drop-down list, change the default connection from Not Connected to SelectFlight.
Click Save.
Close the Error Message window.

Add IF Condition

As you can see in the demonstration above, the initial validation message remains disconnected after adding the error message. To fix this, you need to add a conditional connection so that the Flight Validation Bot Action Node connects to the Flight Details Message node to provide flight information; or to the Error Message, so the user is asked to provide valid input. The steps to take in order to achieve this are the following:

Click the Flight Validation Bot Action node.
On the Flight Validation Bot Action window, click the Connections tab.
- Select Context
- For If Condition, enter the text as valid.
- Select the operator as equals.
- Enter the value as true.
- If this condition is true, then the dialog goes to FlightDetails.
- Under the ELSE section,
- If this condition is false, then the dialog goes to ErrorMessage.
- Click Save.
- Close the Validate Flight Script window.

Click + ADD IF.
Under the IF section,

When completed, the task might look similar to the illustration below:

Add Events

Currently, the assistant is waiting for user input on the start. However, it can also guide the user at the start of the conversation. For this, you can add an Event Handler to initiate this task every time a new connection is established from the Web/Mobile SDK. Learn more about Event Handlers.

Close the Dialog Builder to go back to the Dialog Tasks page.
From the Left Navigation pane, and select Intelligence > Events.
From the events list, click Configure against the On Connect event.
On the On Connect window, by default, the Initiate Task option is selected; retain it.
From the drop-down list, select the Get Flight Status task.
Click Save.

Test the Assistant

To test the Dialog task, you can use the Talk to bot option at the bottom right. Since the onConnect event is configured, the dialog is automatically initiated. Alternately, you can always try the following utterance (intent name) Get me the flight status.

Follow the instructions:

Select Arrival/Departure
Enter an invalid flight number.
You can see the appropriate error message and be prompted to enter the flight number again.
Select a flight number.
You can see the flight details in a tabular format.

You have successfully created and tested your first Virtual Assistant.

On this Page