GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
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
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
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
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
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
SDK Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On (SSO)
Two-Factor Authentication (2FA)
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Builder
  5. Dialog Task
  6. Message (Bot Response) Nodes

Message (Bot Response) Nodes

The Message Node is used to deliver a message to the user. Message nodes commonly follow an API, web service call, or webhook event to define their results as a formatted response.
You can format bot responses as below:

  • Plain text: Type a message in plain text. You can use stored context values with {{variable brackets}}. For example: 'Hello {{context.session.UserContext.firstName}}. How can I help you?'
  • Javascript: Compose JavaScript responses either:
    • For dynamically constructing messages using context and session variables.
    • for displaying templates or widgets as supported by various channels.
      For example, you can compose a JavaScript message for Facebook Channel to present a Carousel template.
    • Optionally, you can generate links to view the information in an HTML report format using templates and share the URL with the bot message.

For example, the Book Flights sample dialog uses the following message nodes:

  • WeatherReport: This shows the weather details returned by the WeatherApi Service node, formatted using the LocationScript node.
  • FinalFlightinfo: This shows the flight itineraries that the Flights info service node returns.
  • Thanks: After showing the final flight details, prompts the user if they have any other requests.

To understand customized JavaScript responses and channel-specific templates, refer to Customize JavaScript Responses in User Prompts articles.

Set-Up

Setting up a Message node in a dialog task involves the following steps:

Add Node

  1. Open the dialog task to add the Message node.
  2. Add a message node in the designated place. For steps in adding nodes, read the Using the Dialog Builder article.
  3. The Message window is displayed with the Component Properties tab selected by default.

Configure Node

Component Properties

Note: The configurations you set up or edit in this section reflect in all other dialog tasks that use this node.
  1. On the Component Properties tab, under the General Settings section, enter a Name and Display Name for the message node.
  2. Under the Bot Responses section, compose and format the bot response either as plain text or as a JavaScript message. A default message is set by the platform, you can customize it.
  3.  Enter channel-specific messages for bot responses using the Manage link. For more information, read the Using the Prompt Editor article.
  4. To add more bot responses, click Add Bot Response and repeat the above steps.
  5. Use the Rephrase Responses to rewrite VA replies using AI based on conversation,context and user emotions. For Message nodes, this feature helps rephrase the responses entered under Bot Responses. To see this feature in your node’s Component Properties, enable the OpenAI or Azure-OpenAI integration and the Dynamic Prompt and Message Rephrasing feature under LLM and Generative AI.

    Note: By default, this feature is disabled  for each node. Turn on the toggle to enable Rephrase Responses. 

    You can configure the number of previous user inputs to determine how many previous user messages should be sent to OpenAI as context based on which to rephrase the response sent through the node. You can choose between 0 and 5, where 0 means that no previous input is considered, while 5 means that the previous 5 responses are sent as context.

Generate Message as Report Link (Optional)

The Message node allows you to generate links to view the information in an HTML report format using templates. The URL link is added to the bot message. When you add a link to a bot response, the users can select the link and get more details, such as a table of values for Closed Sales Opportunities in the SalesForce Bot.
To generate a report link, follow these steps:

  1. On the Component Properties tab, under the Report URL section, click Generate Report Link.

    This image shows  the new dialog builder, you will find this feature in legacy builder at the same location i.e. Message node -> Component Properties.
  2. On the Generate Report dialog box, enter the following values:
    • Link Title – The link text displayed in the bot channel. For example, View Shopping Cart.
    • Header – The title of the report. For example, These are the items in your Shopping Cart.
    • Details – End-user help information displayed directly below the header, describing the content of the report. For example, Review your Shopping Cart, and then click Continue when you are ready to place your order.
    • Data Path – Path for the data, usually the response from the web service. For example, context.ShoppingCartService.response.body
    • Template – Select one of the following format templates to display the data from the task response. For each type, define the Column Name, Key Mapping, Data Type, and template-specific options.
      • Table – Uses a table format with defined columns. Each mapping for the Table template is set to Is Sortable, Display as an image, and Display it as a link. For more information, refer to the Defining a Table Report article and Report Link community post.
      • Fixed Column Table – Uses a table format with one or more columns fixed. Each mapping for the Fixed Column Table template is set to Is Sortable, Column in fixed, Display as an image, and Display it as a link. For more information, refer to the Defining a Fixed-Column Table Report article.
      • Card Layout – Uses a contact card format. Each mapping for the Card Layout template is set to Is Sortable, Display as an image, and Display it as a link. For more information, refer to the Defining a Card Layout Report article.
      • Weather Info – Define a date for a weather service response payload. Each mapping for the Weather Info template is set to Is Sortable, Display as an image, and Display it as a link. For more information, refer to Defining a Weather Info Report article.
      • Card Layout with Group By – Shows a list of items grouped by a specific field. For more information, refer to the Define a Card Layout with Group By Report article.
  3. Click Save.

Variable Namespace

  • In the Variable Namespaces section, associate the variable namespaces to execute this node and its transitions. This option is visible only when the Variable Namespace is enabled for the bot. You can go with the task level settings or customize it for this node. For more information, refer to Managing Namespace.

Instance Properties

  1. On the Message window, click the Instance Properties tab.
  2. Under the Interruptions Behavior section, you can configure the interruptions behavior for this node.
    Note: The settings in the Instance Properties tab are specific to the current task and do not reflect in other dialog tasks that use this node.

    • Use the task level ‘Interruptions Behavior’ setting: The bot refers to the Interruptions Behavior settings set at the dialog task level.
    • Customize for this node option: You can customize the Interruptions Behavior settings for this node by selecting this option and configuring the same. For more information, refer to the Interruption Handling and Context Switching article.
  3. Under the Custom Tags section, add tags to build custom profiles of your bot conversations. Click here for more.

IVR Properties

Use the IVR properties tab on the Message Node to define the initial prompts, timeout prompts, no match prompts, and error prompts with customization for the retries behavior, input mode, grammar settings for Global and Node level use cases, prompts, and call behavior parameters for this node to use in IVR Channel. These settings are defined at the Message Node level. For more information, read the Voice Call Properties article.

Note: The Message Node supports all voice call properties for the IVR, Audio Codes, Twilio Voice, and Voice Gateway channels provided the On User Input Transition setting is enabled for the node

.

Connections Properties

From the node’s Connections tab, you can determine the node in the dialog task to execute next. You can write the conditional statements based on the values of any Entity or Context Objects in the dialog task, or you can use intents for transitions.
To setup Component Transitions, follow these steps:

  1. On the Message window, click the Connections tab.
  2. On the Connections tab, under the Connection Rules section, you can select nodes from the Default drop-down list.
  3. To configure a conditional flow, click Add IF.
  4. Configure the conditional expression based on one of the following criteria:
    • Entity: Compare an entity node in the dialog with a specific value using one of these operators:
      • exists
      • equals to
      • greater than equals to 
      • less than equals to 
      • not equal to 
      • greater than 
      • less than
    • Select the entity, operator using the respective drop-down lists, and type the number in the Value box. For example, PassengerCount (entity) greater than (operator) 5 (specified value)..
    • Context: Compare a context object in the dialog with a specific value using one of these operators.
        • exists
        • equals to
        • greater than equals to 
        • less than equals to 
        • not equal to 
        • greater than
        • less than

      For example, Context.entity.PassengerCount (Context object) greater than (operator) 5 (specified value).

    • Intent: Select an intent that matches the next user utterance.
  5. In the Then go to drop-down list, select the next node to execute in the dialog flow if the conditional expression succeeds. For example, if the PassengerCount (entity) is greater than (operator) 5 (specified value), Then go to Offers (sub-dialog).
  6. In the Else drop-down list, select the node to execute if the condition fails.
Note: If you want to write multiple If conditions, click Add Else If below the last If conditional expression.

Message (Bot Response) Nodes

The Message Node is used to deliver a message to the user. Message nodes commonly follow an API, web service call, or webhook event to define their results as a formatted response.
You can format bot responses as below:

  • Plain text: Type a message in plain text. You can use stored context values with {{variable brackets}}. For example: 'Hello {{context.session.UserContext.firstName}}. How can I help you?'
  • Javascript: Compose JavaScript responses either:
    • For dynamically constructing messages using context and session variables.
    • for displaying templates or widgets as supported by various channels.
      For example, you can compose a JavaScript message for Facebook Channel to present a Carousel template.
    • Optionally, you can generate links to view the information in an HTML report format using templates and share the URL with the bot message.

For example, the Book Flights sample dialog uses the following message nodes:

  • WeatherReport: This shows the weather details returned by the WeatherApi Service node, formatted using the LocationScript node.
  • FinalFlightinfo: This shows the flight itineraries that the Flights info service node returns.
  • Thanks: After showing the final flight details, prompts the user if they have any other requests.

To understand customized JavaScript responses and channel-specific templates, refer to Customize JavaScript Responses in User Prompts articles.

Set-Up

Setting up a Message node in a dialog task involves the following steps:

Add Node

  1. Open the dialog task to add the Message node.
  2. Add a message node in the designated place. For steps in adding nodes, read the Using the Dialog Builder article.
  3. The Message window is displayed with the Component Properties tab selected by default.

Configure Node

Component Properties

Note: The configurations you set up or edit in this section reflect in all other dialog tasks that use this node.
  1. On the Component Properties tab, under the General Settings section, enter a Name and Display Name for the message node.
  2. Under the Bot Responses section, compose and format the bot response either as plain text or as a JavaScript message. A default message is set by the platform, you can customize it.
  3.  Enter channel-specific messages for bot responses using the Manage link. For more information, read the Using the Prompt Editor article.
  4. To add more bot responses, click Add Bot Response and repeat the above steps.
  5. Use the Rephrase Responses to rewrite VA replies using AI based on conversation,context and user emotions. For Message nodes, this feature helps rephrase the responses entered under Bot Responses. To see this feature in your node’s Component Properties, enable the OpenAI or Azure-OpenAI integration and the Dynamic Prompt and Message Rephrasing feature under LLM and Generative AI.

    Note: By default, this feature is disabled  for each node. Turn on the toggle to enable Rephrase Responses. 

    You can configure the number of previous user inputs to determine how many previous user messages should be sent to OpenAI as context based on which to rephrase the response sent through the node. You can choose between 0 and 5, where 0 means that no previous input is considered, while 5 means that the previous 5 responses are sent as context.

Generate Message as Report Link (Optional)

The Message node allows you to generate links to view the information in an HTML report format using templates. The URL link is added to the bot message. When you add a link to a bot response, the users can select the link and get more details, such as a table of values for Closed Sales Opportunities in the SalesForce Bot.
To generate a report link, follow these steps:

  1. On the Component Properties tab, under the Report URL section, click Generate Report Link.

    This image shows  the new dialog builder, you will find this feature in legacy builder at the same location i.e. Message node -> Component Properties.
  2. On the Generate Report dialog box, enter the following values:
    • Link Title – The link text displayed in the bot channel. For example, View Shopping Cart.
    • Header – The title of the report. For example, These are the items in your Shopping Cart.
    • Details – End-user help information displayed directly below the header, describing the content of the report. For example, Review your Shopping Cart, and then click Continue when you are ready to place your order.
    • Data Path – Path for the data, usually the response from the web service. For example, context.ShoppingCartService.response.body
    • Template – Select one of the following format templates to display the data from the task response. For each type, define the Column Name, Key Mapping, Data Type, and template-specific options.
      • Table – Uses a table format with defined columns. Each mapping for the Table template is set to Is Sortable, Display as an image, and Display it as a link. For more information, refer to the Defining a Table Report article and Report Link community post.
      • Fixed Column Table – Uses a table format with one or more columns fixed. Each mapping for the Fixed Column Table template is set to Is Sortable, Column in fixed, Display as an image, and Display it as a link. For more information, refer to the Defining a Fixed-Column Table Report article.
      • Card Layout – Uses a contact card format. Each mapping for the Card Layout template is set to Is Sortable, Display as an image, and Display it as a link. For more information, refer to the Defining a Card Layout Report article.
      • Weather Info – Define a date for a weather service response payload. Each mapping for the Weather Info template is set to Is Sortable, Display as an image, and Display it as a link. For more information, refer to Defining a Weather Info Report article.
      • Card Layout with Group By – Shows a list of items grouped by a specific field. For more information, refer to the Define a Card Layout with Group By Report article.
  3. Click Save.

Variable Namespace

  • In the Variable Namespaces section, associate the variable namespaces to execute this node and its transitions. This option is visible only when the Variable Namespace is enabled for the bot. You can go with the task level settings or customize it for this node. For more information, refer to Managing Namespace.

Instance Properties

  1. On the Message window, click the Instance Properties tab.
  2. Under the Interruptions Behavior section, you can configure the interruptions behavior for this node.
    Note: The settings in the Instance Properties tab are specific to the current task and do not reflect in other dialog tasks that use this node.

    • Use the task level ‘Interruptions Behavior’ setting: The bot refers to the Interruptions Behavior settings set at the dialog task level.
    • Customize for this node option: You can customize the Interruptions Behavior settings for this node by selecting this option and configuring the same. For more information, refer to the Interruption Handling and Context Switching article.
  3. Under the Custom Tags section, add tags to build custom profiles of your bot conversations. Click here for more.

IVR Properties

Use the IVR properties tab on the Message Node to define the initial prompts, timeout prompts, no match prompts, and error prompts with customization for the retries behavior, input mode, grammar settings for Global and Node level use cases, prompts, and call behavior parameters for this node to use in IVR Channel. These settings are defined at the Message Node level. For more information, read the Voice Call Properties article.

Note: The Message Node supports all voice call properties for the IVR, Audio Codes, Twilio Voice, and Voice Gateway channels provided the On User Input Transition setting is enabled for the node

.

Connections Properties

From the node’s Connections tab, you can determine the node in the dialog task to execute next. You can write the conditional statements based on the values of any Entity or Context Objects in the dialog task, or you can use intents for transitions.
To setup Component Transitions, follow these steps:

  1. On the Message window, click the Connections tab.
  2. On the Connections tab, under the Connection Rules section, you can select nodes from the Default drop-down list.
  3. To configure a conditional flow, click Add IF.
  4. Configure the conditional expression based on one of the following criteria:
    • Entity: Compare an entity node in the dialog with a specific value using one of these operators:
      • exists
      • equals to
      • greater than equals to 
      • less than equals to 
      • not equal to 
      • greater than 
      • less than
    • Select the entity, operator using the respective drop-down lists, and type the number in the Value box. For example, PassengerCount (entity) greater than (operator) 5 (specified value)..
    • Context: Compare a context object in the dialog with a specific value using one of these operators.
        • exists
        • equals to
        • greater than equals to 
        • less than equals to 
        • not equal to 
        • greater than
        • less than

      For example, Context.entity.PassengerCount (Context object) greater than (operator) 5 (specified value).

    • Intent: Select an intent that matches the next user utterance.
  5. In the Then go to drop-down list, select the next node to execute in the dialog flow if the conditional expression succeeds. For example, if the PassengerCount (entity) is greater than (operator) 5 (specified value), Then go to Offers (sub-dialog).
  6. In the Else drop-down list, select the node to execute if the condition fails.
Note: If you want to write multiple If conditions, click Add Else If below the last If conditional expression.
Menu