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
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Builder
  5. Dialog Task
  6. GenAI Node (BETA)

GenAI Node (BETA)

The GenAI Node lets you leverage the full potential of LLMs and Generative AI models to quickly build conversations that involve complex flows and also provide human-like experiences. You can define the entities you would like to collect and also the business rules that govern the collection of these entities. The XO Platform orchestrates the conversation using contextual intelligence, ensuring that the conversation is always grounded to your enterprise business rules. You can also provide exit rules for handing off the conversation to the virtual assistant or the human agents.

Watch a Short Video on GenAI Node (Previously AI-Assisted Dialog Node)

Why a GenAI Node?

There are two key scenarios when an GenAI node might be beneficial:

  1. NLP might not pick up co-referencing and entity correction during a conversation. For example, in a flight booking task, someone might ask to book two window seats, then change their mind and ask to modify one of the seat types from the window to the middle. In this scenario, the VA must correct the already collected entity (seat type) and perform entity co-referencing to modify from window to middle.
  2. Complex flows like the above increase dialog task complexity, requiring multiple paths and nodes. Even then, it is humanly impossible to predict all such scenarios. Scripting all these possibilities might also result in a sub-par end-user experience.

Leveraging OpenAI’s generative AI model mitigates these scenarios by eliminating the need to predict and configure such complex possibilities while still under the constraint of defined rules and exit scenarios. This can facilitate more natural conversations and improve end-user experience.

Node Behavior

Runtime

You can work with this node like with any other node within Dialog Tasks and can invoke it within multiple tasks. During runtime, the node behaves as follows:

  1. Entities Collection:
    1. On reaching the GenAI Node, the platform invokes the Generative AI models to understand the user input.
    2. The platform uses the entities and business rules defined as part of the node configurations to understand the user input and identify the required entity values.
    3. The responses required to prompt/inform the user are automatically generated based on the conversation context.
    4. The platform drives the conversation until all the defined entities are captured.
  2. Contextual Intents:
    1. Contextual intents (Dialog or FAQs) recognized from the user input continue to be honored as per the Interruption Settings defined in the bot definition.
    2. Post completion of the contextual intents, the flows can return back to the GenAI Node.
  3. Exit Conditions:
    1. The platform exits from the GenAI Node when any of the defined exit conditions are met.
    2. These conditions provide you the ability to define scenarios that need a different path in the conversation, for e.g., handing off to a human agent.
  4. The platform can also exit the GenAI Node when the user exceeds the maximum number of volleys (retries to capture the required entities).
  5. The platform stores the entity values in the context object, and this information can be used to define the transitions or any other part of the bot configuration.

Output

The output generated by this node is fully usable throughout the dialog flow, even once the node is no longer in use. Output is maintained in a structured .json within the Context Object, so you can access and use the output throughout the rest of your flow.

Challenge Mitigation

Large Language Models come with challenges, such as potentially unwanted behavior. This is why the GenAI Node is built with the necessary infrastructure to enable you to define VA behavior. The node considers existing entities and context and allows you to configure specific rules and exit scenarios that ensure the VA acts within the boundaries of your business.

Enable the Node

By default, the feature/node is disabled. To enable the feature, see Dynamic Conversations Features.

Add to a Task

To add the GenAI Node to a Dialog Task, follow these steps:

    1. Go to Build > Conversational Skills > Dialog Tasks and select the task that you are working with.
    2. You can add the GenAI Node just like any other node. You can find it in the main list of nodes, as it does not depend on the Bot Action node.

Configure

Component Properties

The settings made within this section affect this node across all instances in all dialog tasks.

General Settings

Under General Settings, provide a Name and Display Name for the node. The node Name cannot contain spaces.

Dialog Details

Under Dialog Details, configure the following:

Pre-Processor Script

This property helps execute a script as the first step when the GenAI Node is reached. Use the script to manipulate data and incorporate it into rules or exit scenarios as required. The Pre-processor Script has the same properties as the Script Node. Learn more.

Steps to Define and Configure Pre-processor Script

To run a pre-processor script before reaching the GenAI Node, you must define it with the following steps:

    1. Click the GenAI Node you want to configure.
    2. Click the Component Properties icon on the left menu.
    3. In the Dialog Details section, click Define Script in the Pre-processor Script section.

    1. In the Add Script window, add the script you want to execute, and click Save.

System Context

Include a brief description of the use case context; for example: Act like a flight booking agent.

Entities

Specify the entities to be collected by LLM during runtime. Click Add Entity, enter a Key for the Entity Type, then choose a Value from the drop-down list. Click the Bin icon next to an entity type to remove it.

You can add a maximum of 5 entities. Most entity types are supported. Here are the exceptions: custom, composite, list of items (enumerated and lookup), and attachment. See Entity Types for more information.

Rules

Add the business rules that the collected entities should respect. Click Add Rule, then enter a short and to-the-point sentence, such as:

  • The airport name should include the IATA Airport Code;
  • The passenger’s name should include the last name.

There is a 250-character limit to the Rules field, and you can add a maximum of 5 rules.

To remove a rule, click the Bin icon next to the rule.

Exit Scenarios

Specify the scenarios that should terminate entity collection and return to the dialog task. This means the node ends interaction with the generative AI model and returns to the dialog flow within the XO Platform.

Click Add Scenario, then enter short, clear, and to-the-point phrases that specifically tell the generative AI model when to exit and return to the dialog flow. For example, Exit when the user wants to book more than 5 tickets in a single booking and return “max limit reached”.

There is a 250-character limit to the Scenarios field, and you can add a maximum of 5 scenarios.

To remove a scenario, click the Bin next to the scenario.

Post-Processor Script

This property initiates the post-processor script after processing every user input as part of the GenAI Node. Use the script to manipulate the response captured in the context variables just before exiting the GenAI Node for both the success and exit scenarios. The Pre-processor Script has the same properties as the Script Node. Learn more.

Important Considerations

  1. If the GenAI Node requires multiple user inputs, the post-processor is executed for every user input received.
  2. The system evaluates the entity values collected from the user and stores the collected information in the context object for further processing.

Steps to Define and Configure Pre-processor Script

To define a Post-Processor script, in the Dialog Details section, follow the steps below:

    1. Click Define Script in the Pre-processor Script section.

  1. Add the script you want to execute in the Add Script window, and click Save.

Instance Properties

Configure the instance-specific fields for this node. These apply only for this instance and will not affect this adaptive dialog node when used in other tasks. You must configure Instance Properties for each task where this node is used.

User Input

Define how user input validation occurs for this node:

  • Mandatory: This entity is required and must be provided before proceeding.
  • Allowed Retries: Configure the maximum number of times a user is prompted for a valid input. You can choose between 5-25 retries in 5-retries increments. The default value is 10 retries.
  • Behavior on Exceeding Retries: Define what happens when the user exceeds the allowed retries. You can choose to either End the Dialog or Transition to a Node – in which case you can select the node to transition to.

User Input Correction

Decide whether to use autocorrect to mitigate potential user input errors:

  • Autocorrect user input: The input will be autocorrected for spelling and other common errors.
  • Do not autocorrect user input: The user input will be used without making any corrections.

Advanced Controls

Configure advanced controls for this node instance as follows:

Intent Detection

This applies only to String and Description entities: Select one of these options to determine the course of action if the VA encounters an entity as a part of the user utterance:

    • Accept input as entity value and discard the detected intent: The VA captures the user entry as a string or description and ignores the intent.
    • Prefer user input as intent and proceed with Hold & Resume settings: The user input is considered for intent detection, and the VA proceeds according to the Hold & Resume settings.
    • Ask the user how to proceed: Allow the user to specify if they meant intent or entity.

Interruptions Behavior

To define the interruption handling at this node. You can select from the below options:

    • Use the task level ‘Interruptions Behavior’ setting: The VA refers to the Interruptions Behavior settings set at the dialog task level.
    • Customize for this node: You can customize the Interruptions Behavior settings by selecting this option and configuring it. You can choose whether to allow interruptions or not, or to allow the end user to select the behavior. You can further customize Hold and Resume behavior. Read the Interruption Handling and Context Switching article for more information.

Custom Tags

Add Custom Meta Tags to the conversation flow to profile VA-user conversations and derive business-critical insights from usage and execution metrics. You can define tags to be attached to messages, users, and sessions. See Custom Meta Tags for details.

Voice Call Properties

Configure Voice Properties to streamline the user experience on voice channels. You can define prompts, grammar, and other call behavior parameters for the node. This node does not require Initial Prompts, Error Prompts, and grammar configuration.

See Voice Call Properties for more information on setting up this section of the GenAI Node.

Connections

Define the transition conditions from this node. These conditions are applicable only for this instance and will not affect this node being used in any other dialog. See Adding IF-Else Conditions to Node Connections for a detailed setup guide.

All the entity values collected are stored in context variables. For example, {{context.GenAI_Node.collect_passengers_info.entities.DepartureAirport}}. You can define transitions using the context variables.

This node captures entities in the following structure:

"context":{
"GenAI_Node":{
   "collect_passengers_info":{
        "entities":{
	"DepartureAirport":"Newyork"
	"ArrivalAirport":"California"
	"TravelDate":"09/03/2023"
	}
   },
   "collect_order_info":{
        "entities":{
        "pizza":"margartia"
        "size":"large"
        "crust":"thin"
        }
     }
  }
}

GenAI Node (BETA)

The GenAI Node lets you leverage the full potential of LLMs and Generative AI models to quickly build conversations that involve complex flows and also provide human-like experiences. You can define the entities you would like to collect and also the business rules that govern the collection of these entities. The XO Platform orchestrates the conversation using contextual intelligence, ensuring that the conversation is always grounded to your enterprise business rules. You can also provide exit rules for handing off the conversation to the virtual assistant or the human agents.

Watch a Short Video on GenAI Node (Previously AI-Assisted Dialog Node)

Why a GenAI Node?

There are two key scenarios when an GenAI node might be beneficial:

  1. NLP might not pick up co-referencing and entity correction during a conversation. For example, in a flight booking task, someone might ask to book two window seats, then change their mind and ask to modify one of the seat types from the window to the middle. In this scenario, the VA must correct the already collected entity (seat type) and perform entity co-referencing to modify from window to middle.
  2. Complex flows like the above increase dialog task complexity, requiring multiple paths and nodes. Even then, it is humanly impossible to predict all such scenarios. Scripting all these possibilities might also result in a sub-par end-user experience.

Leveraging OpenAI’s generative AI model mitigates these scenarios by eliminating the need to predict and configure such complex possibilities while still under the constraint of defined rules and exit scenarios. This can facilitate more natural conversations and improve end-user experience.

Node Behavior

Runtime

You can work with this node like with any other node within Dialog Tasks and can invoke it within multiple tasks. During runtime, the node behaves as follows:

  1. Entities Collection:
    1. On reaching the GenAI Node, the platform invokes the Generative AI models to understand the user input.
    2. The platform uses the entities and business rules defined as part of the node configurations to understand the user input and identify the required entity values.
    3. The responses required to prompt/inform the user are automatically generated based on the conversation context.
    4. The platform drives the conversation until all the defined entities are captured.
  2. Contextual Intents:
    1. Contextual intents (Dialog or FAQs) recognized from the user input continue to be honored as per the Interruption Settings defined in the bot definition.
    2. Post completion of the contextual intents, the flows can return back to the GenAI Node.
  3. Exit Conditions:
    1. The platform exits from the GenAI Node when any of the defined exit conditions are met.
    2. These conditions provide you the ability to define scenarios that need a different path in the conversation, for e.g., handing off to a human agent.
  4. The platform can also exit the GenAI Node when the user exceeds the maximum number of volleys (retries to capture the required entities).
  5. The platform stores the entity values in the context object, and this information can be used to define the transitions or any other part of the bot configuration.

Output

The output generated by this node is fully usable throughout the dialog flow, even once the node is no longer in use. Output is maintained in a structured .json within the Context Object, so you can access and use the output throughout the rest of your flow.

Challenge Mitigation

Large Language Models come with challenges, such as potentially unwanted behavior. This is why the GenAI Node is built with the necessary infrastructure to enable you to define VA behavior. The node considers existing entities and context and allows you to configure specific rules and exit scenarios that ensure the VA acts within the boundaries of your business.

Enable the Node

By default, the feature/node is disabled. To enable the feature, see Dynamic Conversations Features.

Add to a Task

To add the GenAI Node to a Dialog Task, follow these steps:

    1. Go to Build > Conversational Skills > Dialog Tasks and select the task that you are working with.
    2. You can add the GenAI Node just like any other node. You can find it in the main list of nodes, as it does not depend on the Bot Action node.

Configure

Component Properties

The settings made within this section affect this node across all instances in all dialog tasks.

General Settings

Under General Settings, provide a Name and Display Name for the node. The node Name cannot contain spaces.

Dialog Details

Under Dialog Details, configure the following:

Pre-Processor Script

This property helps execute a script as the first step when the GenAI Node is reached. Use the script to manipulate data and incorporate it into rules or exit scenarios as required. The Pre-processor Script has the same properties as the Script Node. Learn more.

Steps to Define and Configure Pre-processor Script

To run a pre-processor script before reaching the GenAI Node, you must define it with the following steps:

    1. Click the GenAI Node you want to configure.
    2. Click the Component Properties icon on the left menu.
    3. In the Dialog Details section, click Define Script in the Pre-processor Script section.

    1. In the Add Script window, add the script you want to execute, and click Save.

System Context

Include a brief description of the use case context; for example: Act like a flight booking agent.

Entities

Specify the entities to be collected by LLM during runtime. Click Add Entity, enter a Key for the Entity Type, then choose a Value from the drop-down list. Click the Bin icon next to an entity type to remove it.

You can add a maximum of 5 entities. Most entity types are supported. Here are the exceptions: custom, composite, list of items (enumerated and lookup), and attachment. See Entity Types for more information.

Rules

Add the business rules that the collected entities should respect. Click Add Rule, then enter a short and to-the-point sentence, such as:

  • The airport name should include the IATA Airport Code;
  • The passenger’s name should include the last name.

There is a 250-character limit to the Rules field, and you can add a maximum of 5 rules.

To remove a rule, click the Bin icon next to the rule.

Exit Scenarios

Specify the scenarios that should terminate entity collection and return to the dialog task. This means the node ends interaction with the generative AI model and returns to the dialog flow within the XO Platform.

Click Add Scenario, then enter short, clear, and to-the-point phrases that specifically tell the generative AI model when to exit and return to the dialog flow. For example, Exit when the user wants to book more than 5 tickets in a single booking and return “max limit reached”.

There is a 250-character limit to the Scenarios field, and you can add a maximum of 5 scenarios.

To remove a scenario, click the Bin next to the scenario.

Post-Processor Script

This property initiates the post-processor script after processing every user input as part of the GenAI Node. Use the script to manipulate the response captured in the context variables just before exiting the GenAI Node for both the success and exit scenarios. The Pre-processor Script has the same properties as the Script Node. Learn more.

Important Considerations

  1. If the GenAI Node requires multiple user inputs, the post-processor is executed for every user input received.
  2. The system evaluates the entity values collected from the user and stores the collected information in the context object for further processing.

Steps to Define and Configure Pre-processor Script

To define a Post-Processor script, in the Dialog Details section, follow the steps below:

    1. Click Define Script in the Pre-processor Script section.

  1. Add the script you want to execute in the Add Script window, and click Save.

Instance Properties

Configure the instance-specific fields for this node. These apply only for this instance and will not affect this adaptive dialog node when used in other tasks. You must configure Instance Properties for each task where this node is used.

User Input

Define how user input validation occurs for this node:

  • Mandatory: This entity is required and must be provided before proceeding.
  • Allowed Retries: Configure the maximum number of times a user is prompted for a valid input. You can choose between 5-25 retries in 5-retries increments. The default value is 10 retries.
  • Behavior on Exceeding Retries: Define what happens when the user exceeds the allowed retries. You can choose to either End the Dialog or Transition to a Node – in which case you can select the node to transition to.

User Input Correction

Decide whether to use autocorrect to mitigate potential user input errors:

  • Autocorrect user input: The input will be autocorrected for spelling and other common errors.
  • Do not autocorrect user input: The user input will be used without making any corrections.

Advanced Controls

Configure advanced controls for this node instance as follows:

Intent Detection

This applies only to String and Description entities: Select one of these options to determine the course of action if the VA encounters an entity as a part of the user utterance:

    • Accept input as entity value and discard the detected intent: The VA captures the user entry as a string or description and ignores the intent.
    • Prefer user input as intent and proceed with Hold & Resume settings: The user input is considered for intent detection, and the VA proceeds according to the Hold & Resume settings.
    • Ask the user how to proceed: Allow the user to specify if they meant intent or entity.

Interruptions Behavior

To define the interruption handling at this node. You can select from the below options:

    • Use the task level ‘Interruptions Behavior’ setting: The VA refers to the Interruptions Behavior settings set at the dialog task level.
    • Customize for this node: You can customize the Interruptions Behavior settings by selecting this option and configuring it. You can choose whether to allow interruptions or not, or to allow the end user to select the behavior. You can further customize Hold and Resume behavior. Read the Interruption Handling and Context Switching article for more information.

Custom Tags

Add Custom Meta Tags to the conversation flow to profile VA-user conversations and derive business-critical insights from usage and execution metrics. You can define tags to be attached to messages, users, and sessions. See Custom Meta Tags for details.

Voice Call Properties

Configure Voice Properties to streamline the user experience on voice channels. You can define prompts, grammar, and other call behavior parameters for the node. This node does not require Initial Prompts, Error Prompts, and grammar configuration.

See Voice Call Properties for more information on setting up this section of the GenAI Node.

Connections

Define the transition conditions from this node. These conditions are applicable only for this instance and will not affect this node being used in any other dialog. See Adding IF-Else Conditions to Node Connections for a detailed setup guide.

All the entity values collected are stored in context variables. For example, {{context.GenAI_Node.collect_passengers_info.entities.DepartureAirport}}. You can define transitions using the context variables.

This node captures entities in the following structure:

"context":{
"GenAI_Node":{
   "collect_passengers_info":{
        "entities":{
	"DepartureAirport":"Newyork"
	"ArrivalAirport":"California"
	"TravelDate":"09/03/2023"
	}
   },
   "collect_order_info":{
        "entities":{
        "pizza":"margartia"
        "size":"large"
        "crust":"thin"
        }
     }
  }
}
Menu