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. Bot Settings
  5. General Settings

General Settings

To modify the general settings of a bot:

  1. Select the Build tab from the top.
  2. Click Configuration > General Settings.
  3. Bot General Settings

General Bot Settings

Modify one or more of the settings described in the following table.

Field Description
Bot Name The name of the Bot. When a Bot is published, the Name cannot be changed. This field is required.
Description The description of the Bot. This field is required.
Icon The icon image for the Bot displayed in Bot Builder, Bots Marketplace, and the end-user interface as shown in the previous illustration. The image format must be .png and best results are obtained using a 200 x 200-pixel image. This field is required.
Target Audience
  • Select General Public if the bot is for public use for both managed and unmanaged users in your domain. Bot assignments are not required and when the Bots Admin deploys the bot, it is available for use by all domain users. Use this option to make a bot widely available for all user types.
  • Select Enterprise Users if the bot is for managed users only in a domain, for example, for your employees or paid customers. After the Bots Admin approves and deploys this bot, it is not available to any managed users unless explicitly assigned by the Bots Admin. Use this option when you want to control which managed users in your domain can access and set up this bot on their devices.

Once Target Audience is defined and saved, you cannot change them.

Default Bot Language This is uneditable and is set at the time of Bot creation.
Bot Id Non-editable, assigned by the platform. Can be copied for use in API calls etc..
Variable Namespaces You can categorize variables using Namespaces and map them to various components. The XO Platform will load the variables only from the mapped namespaces while executing specific components. Learn more.
Subdomain (Tenancy)

Click Yes to enable the use of tenancy. When the tenancy is defined, the end-user is prompted to enter a tenant name as part of the URL for the Bot, for example, kore, for the www.kore.someWebService.com tenant-specific URL. When enabled define the following properties:

  • Help Hint – The text displayed to the end-user to prompt the user to enter a tenant-specific URL for the Bot.
  • Base URL – The base URL for the Bot that the end-user must specify their company to complete the tenant-specific URL using the following syntax: https://{tenant}.someWebService.com where {tenant}, including the braces, represents the tenant name. 
Show link for task setup/execution
  • Select Yes to display a link to enable the choice for a user to input information used to execute a task in a user interface form or input the data directly into the message input field, for example, Enter the title for new Asana task. To make edits, click here. where here is a link to a form with fields.
  • When No is selected, the user can only input information for the task in the message input field. For example, Enter the title for new Asana task.
Error Message(s) Edit or add custom HTTP Status Codes and error messages for your Bot. For more information, see Customizing Error Messages.

To save the Bot settings, click Save. The < Bot Name > updated successfully message is displayed.

Customizing Error Messages

In Bot Builder, each Bot and task contains a set of predefined error messages along with actions for standard HTTP Status codes returned for an HTTP Request method. In most cases, the default response and action are sufficient for an end-user response, however, you may need to handle other HTTP Status codes not defined by default, or customize the error message itself, or change the default response by Kore.ai in the event of an error. This topic describes how to customize and create error messages for Kore.ai Bots and tasks. When you create a Bot or a task, you can add or customize error messages for HTTP Status codes in the Error Messages section of the Bot or task settings. General Settings for Error Messages

Custom Status Codes

There are approximately 25 HTTP Status codes defined by default for a Bot or task. To customize an HTTP Status code

  1. Open the Bot or task in Bot Builder
  2. Select Build tab from top menu
  3. From the left menu click Configurations -> General Settings
  4. Scroll down to locate the Error Messages section.
  5. Click the Edit Edit Icon icon for the code that you want to customize to open the Setup Error Message dialog. Setup Error Message
  6. In the Message Type field, select one of:
    • Custom – Displays a Custom Message field to define an error-specific message for the end-user.
    • Source – Displays the Error Paths field where you can define the JSON path from the JSON response payload for HTTP Status codes other than those in the 2XX range (success messages).
  7. In the Action field, specify the action to take when the number of consecutive errors defined in the Error Recurrence field is reached. Select one of:
    • Disable – The task is set to Inactive when the error occurs. The end-user can activate the task when needed.
    • Reschedule – Displays the Retry Interval field used to define the elapsed time in minutes after which to retry the task when the error occurs.
    • Disable Auth – When the error occurs, the authorization mechanism defined for the task is disabled. Any other task that uses the same authorization mechanism is also disabled.
    • Notify – Displays the error message in the end-user interface.

    Setup Error Message Actions

  8. In the Message field (available only for the default messages), enter the text message displayed to the end-user.
  9. In the Error Recurrence field, specify the number of consecutive error codes must be returned before the action is executed. By default, the Error Recurrence field is set to ” 1 “.
  10. Click Add to save and close the Setup Error Message dialog for your custom error message.

To create a new HTTP Status code, click Add Error Message, define the fields for your new code as described in the preceding section, and then click Add.

General Settings

To modify the general settings of a bot:

  1. Select the Build tab from the top.
  2. Click Configuration > General Settings.
  3. Bot General Settings

General Bot Settings

Modify one or more of the settings described in the following table.

Field Description
Bot Name The name of the Bot. When a Bot is published, the Name cannot be changed. This field is required.
Description The description of the Bot. This field is required.
Icon The icon image for the Bot displayed in Bot Builder, Bots Marketplace, and the end-user interface as shown in the previous illustration. The image format must be .png and best results are obtained using a 200 x 200-pixel image. This field is required.
Target Audience
  • Select General Public if the bot is for public use for both managed and unmanaged users in your domain. Bot assignments are not required and when the Bots Admin deploys the bot, it is available for use by all domain users. Use this option to make a bot widely available for all user types.
  • Select Enterprise Users if the bot is for managed users only in a domain, for example, for your employees or paid customers. After the Bots Admin approves and deploys this bot, it is not available to any managed users unless explicitly assigned by the Bots Admin. Use this option when you want to control which managed users in your domain can access and set up this bot on their devices.

Once Target Audience is defined and saved, you cannot change them.

Default Bot Language This is uneditable and is set at the time of Bot creation.
Bot Id Non-editable, assigned by the platform. Can be copied for use in API calls etc..
Variable Namespaces You can categorize variables using Namespaces and map them to various components. The XO Platform will load the variables only from the mapped namespaces while executing specific components. Learn more.
Subdomain (Tenancy)

Click Yes to enable the use of tenancy. When the tenancy is defined, the end-user is prompted to enter a tenant name as part of the URL for the Bot, for example, kore, for the www.kore.someWebService.com tenant-specific URL. When enabled define the following properties:

  • Help Hint – The text displayed to the end-user to prompt the user to enter a tenant-specific URL for the Bot.
  • Base URL – The base URL for the Bot that the end-user must specify their company to complete the tenant-specific URL using the following syntax: https://{tenant}.someWebService.com where {tenant}, including the braces, represents the tenant name. 
Show link for task setup/execution
  • Select Yes to display a link to enable the choice for a user to input information used to execute a task in a user interface form or input the data directly into the message input field, for example, Enter the title for new Asana task. To make edits, click here. where here is a link to a form with fields.
  • When No is selected, the user can only input information for the task in the message input field. For example, Enter the title for new Asana task.
Error Message(s) Edit or add custom HTTP Status Codes and error messages for your Bot. For more information, see Customizing Error Messages.

To save the Bot settings, click Save. The < Bot Name > updated successfully message is displayed.

Customizing Error Messages

In Bot Builder, each Bot and task contains a set of predefined error messages along with actions for standard HTTP Status codes returned for an HTTP Request method. In most cases, the default response and action are sufficient for an end-user response, however, you may need to handle other HTTP Status codes not defined by default, or customize the error message itself, or change the default response by Kore.ai in the event of an error. This topic describes how to customize and create error messages for Kore.ai Bots and tasks. When you create a Bot or a task, you can add or customize error messages for HTTP Status codes in the Error Messages section of the Bot or task settings. General Settings for Error Messages

Custom Status Codes

There are approximately 25 HTTP Status codes defined by default for a Bot or task. To customize an HTTP Status code

  1. Open the Bot or task in Bot Builder
  2. Select Build tab from top menu
  3. From the left menu click Configurations -> General Settings
  4. Scroll down to locate the Error Messages section.
  5. Click the Edit Edit Icon icon for the code that you want to customize to open the Setup Error Message dialog. Setup Error Message
  6. In the Message Type field, select one of:
    • Custom – Displays a Custom Message field to define an error-specific message for the end-user.
    • Source – Displays the Error Paths field where you can define the JSON path from the JSON response payload for HTTP Status codes other than those in the 2XX range (success messages).
  7. In the Action field, specify the action to take when the number of consecutive errors defined in the Error Recurrence field is reached. Select one of:
    • Disable – The task is set to Inactive when the error occurs. The end-user can activate the task when needed.
    • Reschedule – Displays the Retry Interval field used to define the elapsed time in minutes after which to retry the task when the error occurs.
    • Disable Auth – When the error occurs, the authorization mechanism defined for the task is disabled. Any other task that uses the same authorization mechanism is also disabled.
    • Notify – Displays the error message in the end-user interface.

    Setup Error Message Actions

  8. In the Message field (available only for the default messages), enter the text message displayed to the end-user.
  9. In the Error Recurrence field, specify the number of consecutive error codes must be returned before the action is executed. By default, the Error Recurrence field is set to ” 1 “.
  10. Click Add to save and close the Setup Error Message dialog for your custom error message.

To create a new HTTP Status code, click Add Error Message, define the fields for your new code as described in the preceding section, and then click Add.

Menu