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. Docs
  2. Virtual Assistants
  3. Test your Bot
  4. Create a Test Suite

Create a Test Suite

A Test Suite contains a collection of test cases grouped to simulate a specific conversation between the user and the bot and used anytime for test execution. You can know the execution status and determine and analyze the results in a test suite.

In Conversation testing, you can create the test suites in the following two different ways:

Record Conversation to Create a Test Suite

The option to record the test suite captures the metadata in the background which helps to test the flow sequence, transitions, and track the test coverage. The following step-by-step process explains how to record a conversation as a test suite, and validate and create the test cases.

Record Test Suite

  1. On the Conversation Testing page, click New Test Suite.
  2. Click the Record option to start recording the new test.
  3. In the displayed pop-up, click Proceed to record the test with the On-Connect event or click the Skip On-Connect button.
  4. Note: “On-Connect” is the message you receive as soon as you open the chat window, even before you enter any message. The option is displayed for VAs with an On-Connect message. If you skip it, the On-connect message does not get added as a test case. If you click Proceed, then the On-connect message is created as a separate test case.

     

  5. The Chat window is displayed. The chat transcript is recorded and the recording status is displayed at the top. You can click Stop to stop the recording.
Note: If there is an error while recording due to any limitation set on the platform, it is displayed on the page.

 

Generated User Response Suggestions

If you have enabled LLM and Generative AI for your Virtual Assistant, you will see User Response suggestions while recording a Conversation Test Case. 

This feature provides a regression tool that creates a conversation test suite for each intent (new and old) to evaluate the impact of a change on the conversation execution. It helps check if the task or intent is robust enough to handle random user utterances. 

It also helps you predict and simulate the end user’s behavior and check if the VA can execute all the defined flows by generating user responses and presenting any digressions from the specified intent.

Click any suggestion to send it to your VA and test the response. 

You can refresh the suggestions list or minimize the suggestions panel. You can also talk to your VA by typing in your responses.

Validate Test Suite

The conversation is recorded and all the metadata at each test case is captured. Once the recording is completed, the Platform provides you an option to validate the test suite as follows:

  1. Upon successful completion of recording, click Validate Test Suite.
  2. The ongoing validation is displayed. You may click Cancel if you want to cancel the step or click Continue in Background to continue the validation as a background task.
  3. If you click Continue in Background, you can see the status in the top right corner of the landing page by clicking the Draft icon.
  4. Note: You can draft up to five validations on the platform. The red indicator denotes that there are pending validations. Clicking the blue arrow takes you to the Validate Test Suite page.

    If a Draft contains five validations, you cannot create a new test suite. You need to approve or discard at least one validation from the list to create a new test suite.

  5. Once the validation is complete, the platform displays the Recorded and Validated Chat transcripts in the Validate Test Suite pop-up with the following details for each VA response:
    Metadata – Details like Intent and Node Name, Transitions, etc.
    Assertions – Default assertions (Flow and Text) added based on the VA response.
  6. The following options are displayed on the Validate Test Suite pop-up:
    Approve – When you approve the validation, the platform triggers the Test Suite creation step.
    Discard – When you discard the validation, the data is deleted from the system.
Note: A test suite cannot contain more than 500 test cases, and a test input cannot have more than 8000 characters.

Capture Test Suite Metadata

Using Conversation Testing, you can test the sequence of nodes executed by the VA for user input(s) and capture the following metadata at the time of test suite creation to verify if the VA is executing the conversation flows as expected:

  • Intent ID, Intent Name
  • Node ID, Node Name
  • Transition flow

The metadata are captured in both Record and Upload scenarios for all the VA responses of all the test suites. The details to be captured vary based on the intent type of the VA response. For more information on the details captured here, see Test Editor.

Create Test Suite

  1. Upon approval, a Create Test Suite pop-up is displayed in which you can enter the following details:
  • Test Suite Name
  • Description
  • Tags
    1. You can either click Create to create the test suite or discard this step.
    2. On clicking Create, the new test suite is created. You can click the Run Test Suite button to execute the test suite.
    3. The dialog Before you execute the test Suite is displayed. Select the version of your VA to be executed. If any authorization profiles are available, they are displayed here.
    4. Click Continue to continue the execution. The test cases execution progress is displayed on the top right corner of the page.

    5. If the test cases are passed, the Result is displayed as Passed, as shown in the screenshot below.

    Upload File to Create a Test Suite

    Using this option, you can create test suites by uploading chat transcripts in a pre-defined JSON file. This alternative way of creating test suites is quick and scalable, as compared to recording the flow every time. The following step-by-step process explains how to upload a JSON file, validate and create the test suites.

    Upload a JSON File

    1. Click New Test Suite.
    2. Click the Upload option to upload a chat transcript in JSON format.
    3. You can drag and drop a predefined JSON file in the Upload pop-up or select the file in the local directory using the browse option.
    Note: Only JSON files can be uploaded. The maximum file size allowed for upload is 2MB. You can also download a sample JSON file by clicking the Download JSON Sample button.

    If there is an error during upload due to any limitation set on the platform, an error is displayed as follows.

    If an uploaded JSON file exceeds the configured size limit of 2 MB, an error is displayed as shown below.

    Validate Test Suite

    The platform processes the uploaded file to simulate the conversation flow and capture all the metadata at each test case. When validating the test suite, there is an option to go back to Conversation testing while the test suite is being validated in the background.

    The steps to validate test suites are the same as in Record Test suite Flow. See Validate Test Suite for more information. To understand more about testing the sequence of nodes and capturing metadata, see Capture Test Suite Metadata under Validate Test Suite.

    Create Test Suite

    The steps to create a test suite are the same as in Record Test suite Flow. See Create Test Suite to know more.

    Previous
    Conversation Testing Overview


    Next
    Test Editor

Create a Test Suite

A Test Suite contains a collection of test cases grouped to simulate a specific conversation between the user and the bot and used anytime for test execution. You can know the execution status and determine and analyze the results in a test suite.

In Conversation testing, you can create the test suites in the following two different ways:

Record Conversation to Create a Test Suite

The option to record the test suite captures the metadata in the background which helps to test the flow sequence, transitions, and track the test coverage. The following step-by-step process explains how to record a conversation as a test suite, and validate and create the test cases.

Record Test Suite

  1. On the Conversation Testing page, click New Test Suite.
  2. Click the Record option to start recording the new test.
  3. In the displayed pop-up, click Proceed to record the test with the On-Connect event or click the Skip On-Connect button.
  4. Note: “On-Connect” is the message you receive as soon as you open the chat window, even before you enter any message. The option is displayed for VAs with an On-Connect message. If you skip it, the On-connect message does not get added as a test case. If you click Proceed, then the On-connect message is created as a separate test case.

     

  5. The Chat window is displayed. The chat transcript is recorded and the recording status is displayed at the top. You can click Stop to stop the recording.
Note: If there is an error while recording due to any limitation set on the platform, it is displayed on the page.

 

Generated User Response Suggestions

If you have enabled LLM and Generative AI for your Virtual Assistant, you will see User Response suggestions while recording a Conversation Test Case. 

This feature provides a regression tool that creates a conversation test suite for each intent (new and old) to evaluate the impact of a change on the conversation execution. It helps check if the task or intent is robust enough to handle random user utterances. 

It also helps you predict and simulate the end user’s behavior and check if the VA can execute all the defined flows by generating user responses and presenting any digressions from the specified intent.

Click any suggestion to send it to your VA and test the response. 

You can refresh the suggestions list or minimize the suggestions panel. You can also talk to your VA by typing in your responses.

Validate Test Suite

The conversation is recorded and all the metadata at each test case is captured. Once the recording is completed, the Platform provides you an option to validate the test suite as follows:

  1. Upon successful completion of recording, click Validate Test Suite.
  2. The ongoing validation is displayed. You may click Cancel if you want to cancel the step or click Continue in Background to continue the validation as a background task.
  3. If you click Continue in Background, you can see the status in the top right corner of the landing page by clicking the Draft icon.
  4. Note: You can draft up to five validations on the platform. The red indicator denotes that there are pending validations. Clicking the blue arrow takes you to the Validate Test Suite page.

    If a Draft contains five validations, you cannot create a new test suite. You need to approve or discard at least one validation from the list to create a new test suite.

  5. Once the validation is complete, the platform displays the Recorded and Validated Chat transcripts in the Validate Test Suite pop-up with the following details for each VA response:
    Metadata – Details like Intent and Node Name, Transitions, etc.
    Assertions – Default assertions (Flow and Text) added based on the VA response.
  6. The following options are displayed on the Validate Test Suite pop-up:
    Approve – When you approve the validation, the platform triggers the Test Suite creation step.
    Discard – When you discard the validation, the data is deleted from the system.
Note: A test suite cannot contain more than 500 test cases, and a test input cannot have more than 8000 characters.

Capture Test Suite Metadata

Using Conversation Testing, you can test the sequence of nodes executed by the VA for user input(s) and capture the following metadata at the time of test suite creation to verify if the VA is executing the conversation flows as expected:

  • Intent ID, Intent Name
  • Node ID, Node Name
  • Transition flow

The metadata are captured in both Record and Upload scenarios for all the VA responses of all the test suites. The details to be captured vary based on the intent type of the VA response. For more information on the details captured here, see Test Editor.

Create Test Suite

  1. Upon approval, a Create Test Suite pop-up is displayed in which you can enter the following details:
  • Test Suite Name
  • Description
  • Tags
    1. You can either click Create to create the test suite or discard this step.
    2. On clicking Create, the new test suite is created. You can click the Run Test Suite button to execute the test suite.
    3. The dialog Before you execute the test Suite is displayed. Select the version of your VA to be executed. If any authorization profiles are available, they are displayed here.
    4. Click Continue to continue the execution. The test cases execution progress is displayed on the top right corner of the page.

    5. If the test cases are passed, the Result is displayed as Passed, as shown in the screenshot below.

    Upload File to Create a Test Suite

    Using this option, you can create test suites by uploading chat transcripts in a pre-defined JSON file. This alternative way of creating test suites is quick and scalable, as compared to recording the flow every time. The following step-by-step process explains how to upload a JSON file, validate and create the test suites.

    Upload a JSON File

    1. Click New Test Suite.
    2. Click the Upload option to upload a chat transcript in JSON format.
    3. You can drag and drop a predefined JSON file in the Upload pop-up or select the file in the local directory using the browse option.
    Note: Only JSON files can be uploaded. The maximum file size allowed for upload is 2MB. You can also download a sample JSON file by clicking the Download JSON Sample button.

    If there is an error during upload due to any limitation set on the platform, an error is displayed as follows.

    If an uploaded JSON file exceeds the configured size limit of 2 MB, an error is displayed as shown below.

    Validate Test Suite

    The platform processes the uploaded file to simulate the conversation flow and capture all the metadata at each test case. When validating the test suite, there is an option to go back to Conversation testing while the test suite is being validated in the background.

    The steps to validate test suites are the same as in Record Test suite Flow. See Validate Test Suite for more information. To understand more about testing the sequence of nodes and capturing metadata, see Capture Test Suite Metadata under Validate Test Suite.

    Create Test Suite

    The steps to create a test suite are the same as in Record Test suite Flow. See Create Test Suite to know more.

    Previous
    Conversation Testing Overview


    Next
    Test Editor

메뉴