GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Help & Learning Resources
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Nodes & Connections
Overview
Node Types
Intent Node
Dialog Node
Entity Node
Entity Rules
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections Setup
Context Object
Sub-Intent Scoping
User Prompts
Voice Call Properties
Dialog Task Management
Event Handlers
Supported Entity Types
Supported Company Names
Supported Colors
Knowledge Graph
Introduction
Knowledge Extraction
Build Knowledge Graph
Create Node Structure
Build the Graph
Add FAQs
Add FAQs from an Existing Source
Run a Task
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update Knowledge Graph
Introduction
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Analysis
Knowledge Graph Import and Export
Prepare Data for Import
From a CSV File
From a JSON File
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Default Standard Responses
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Health and Monitoring
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
NLP Insights
Conversations History
Conversation Flows
Analytics Dashboard Filters
Usage Metrics
Containment Metrics
Smart Bots
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Plan & Usage
Overview
Usage Plans
Support Plans
Invoices
Authorization
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data as Service
Data Table
Table Views
App Definitions
Sharing Data Tables or Views
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Configure Agent Transfer
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
APIs & SDKs
API Reference
API Introduction
API List
API Collection
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Using the BotKit SDK
BotKit SDK Tutorial - Blue Prism
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. How Tos
  5. Travel Planing Assistant
  6. Travel VA: Configuring Digital Forms

Travel VA: Configuring Digital Forms

In this How-To, we will explore a scenario in a Travel Planning assistant, through which a user can book a flight. We will see how Digital Forms can be used to gather all the required information from the user, then make the booking based on that information.

For details on what Digital Forms are and how they are implemented in the Kore.ai XO Platform, refer here.

Problem Statement

Consider a Travel Planning Assistant helping a user book a flight. There are several information categories that the VA should collect from the user in order to complete this task. Rather than asking the user for each piece of information one by one, the VA can ask the user just once to complete a form that collects all the necessary data. Once the form is successfully submitted, the VA can pull the data and process the booking.

Prerequisites

To go through these configurations, you need to know at least the basics of the following XO Platform features:

Configurations

When a user makes a booking, the following needs to happen within your assistant

  1. A Digital Form needs to be displayed in order to gather input from the user;
  2. A Dialog Task needs to:
    1. trigger the above Digital Form; and
    2. capture the user-entered booking information.

Digital Form Configuration

Moving forward, we will be creating a form that gathers some of the necessary information in order to allow the user to book a flight:

  • Trip Type – Roundtrip or One Way.
  • Departure Airport (From);
  • Arrival Airport (To);
  • Departure Date;
  • Return Date  
  • Fare – default selection set to Premium Economy;
  • Pro Tip – showcases a promotional offer for Premium Economy seats and only displays when the selected Fare is Economy.
  • Passenger First Name and Last Name.

 

Form Creation

  1. From the Kore.ai XO Platform, open the Travel Planning assistant.
  2. Select the Build tab from the top menu.
  3. From the left navigation menu, select Digital Skills > Digital Forms.
  4. Click New Form and enter the following:
    1. Name – name to the form, say BookingForm
    2. Display Name for the form, say Booking Form
    3. Description of the form.
  5. Save & Proceed to the next step.

The Form Editor

The Form Editor opens with components on the left, and a blank form. You can drag and drop components to the form as per your requirement. By default, a Submit button is added to the form. This would trigger the submit event which would capture the user input and save in the context object. As soon as you drag and drop a component, its property settings panel will be displayed. There are several settings available for each component and you can set them up according to your own requirements. Some of these settings include: making a field mandatory, adding tooltips, securing field data, and more. This article takes you through the basic ones.

  1. Start by adding a selection field for the Trip Type. Drag and drop a Toggle component onto the form and set the following values:
    1. Display Name, say Trip Type.
    2. Name used for internal reference, say TripType.
    3. Description of the field.
    4. Placeholder value to be displayed in the field when blank, say, Please select whether you are booking a roundtrip.
    5. Value used to display functionality when the toggle is either on or off. When the toggle is enabled, set the value to Roundtrip. For the disabled state of the toggle, set the value to One Way.

  2. Drag and Drop a Dropdown component onto the form, for the From field.
    1. Display Name, say From.
    2. Name used for internal reference, say From.
    3. Description of the field.
    4. Placeholder value to be displayed in the field when blank, say, Select the trip type.
    5. Scroll and locate Data Settings, then click Add Values to enter the values. You can add a list of airports from which flights are departing.

  3. Repeat Step 2 to add the To field, for the arrival airport. 
  4. Drag and drop a Date field onto the form, to add the Departure Date
    1. Display Name, say Departure Date.
    2. Name used for internal reference, say DepartureDate.
    3. Description of the field.
    4. Placeholder value to be displayed in the field when blank, say, Please select the departure date.

  5. Add a second Date field, for the Return Date and repeat Step 4. 
  6. Drag and drop a Radio Button component onto the form for the Fare field, and set it up as follows:
    1. Display Name, say Fare.
    2. Name used for internal reference, say Fare.
    3. Description of the field.
    4. Placeholder value to be displayed in the field when blank, say, Please select the Fare Category.
    5. Scroll and locate Data Settings, then click Add Values to enter the values – Economy, Premium Economy and First Class. You can mark one value, e.g. Premium Economy, as default. This would be selected by default at the time of execution.

  7. Add a Pro Tip component. This field will only be visible if the user selects Economy as the Fare.
    1. Display Name, say Pro Tip
    2. Name used for internal reference, say Protip.
    3. Description of the field, say Book a Premium Economy seat and get a free hot meal onboard.
    4. Placeholder value to be displayed in the field when blank. 
    5. Scroll down to Visibility Settings and click Add Visibility Rule. 
    6. Now, set the rule by building the following logical expression:

      Fare Equal to Value Economy.

      This rule ensures that the Pro Tip will only be visible when the user selects the Economy option under the Fare field.

  8. Drag and drop a Text Field component onto the form, to add the Passenger First Name field.
    1. Display Name, say Passenger First Name.
    2. Name used for internal reference, say PassengerFirstName.
    3. Description of the field.
    4. Placeholder value to be displayed in the field when blank, say, Enter the name of the account holder.

  9. Repeat Step 7 to add the Passenger Last Name field. 
  10. Use any additional fields that are required for your process. For example, a Select Flight field, as a Radio Button, further fields for flight documents, (as e.g.: Text, Text Area, etc.) onboard meal options (as e.g.: Checkboxes or Radio Buttons), etc.

Your form is ready.

You can toggle between Desktop View and Mobile View to see how it looks on each device type. 

Use the Test button to see a preview. Below is a demo of the user experience with the form we have built:

Dialog Task Configuration

We will be creating a dialog task and adding a form node to trigger the Digital Form created in the above step and use a service node to make a service call to complete the booking process. Please see Using the Dialog Builder for details on working with Dialog Tasks. 

Create a Dialog Task

  1. Select the Build tab from the top menu
  2. From the left navigation menu, select Conversational Skills > Dialog Tasks.
  3. Click Create Dialog to create a new Task
    1. Enter the Intent Name, say, Book a Flight
    2. Create & Proceed to open the dialog builder page.

Add a Digital Form Node

  1. Click the + next to the intent node and select the Digital Form node.
  2. From the dropdown list select the Booking Form we created earlier.
  3. You will be prompted to select the Form Experience. Kore.ai XO Platform allows you to gather user input both from the form and through conversation based on the channel.
  4. For this use case, let us select Only Form UI experience.
  5. A Form Node would be added, you can customize the form name, etc.
  6. We are changing the Name to BookingForm and Display Name to Booking Form.

Add a Message Node

Next, we will see how to capture the values returned by the Form Node using a Script and a Message node..

  1. Add a Message Node to the form node.
  2. Set the Name to FormMessage and Display Name to Form Message.
  3. Click Manage under Bot Responses to open the message editor.
  4. Select the JavaScript tab and enter the following code. This is a simple script that captures some of the data from within the context object, as submitted by the user into the Form, and displays it accordingly.
    var message;
      message = 'You have booked a '+context.forms.BookingForm.TripType+' flight in the name of '+context.forms. BookingForm.PassengerLastName;
      message = message + ' and opted for '+ context.forms. BookingForm.Fare;
    print(message);
  5. Your dialog task is ready to use a digital form.

Test the Assistant

Talk to the bot to trigger the above dialog. The form will be displayed, enter the values and click Submit, the message will be displayed.

You can use the context object as shown above in Script or Service nodes for further processing of the booking.

See here for how to add this data into data tables.

Menu