For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
WebsiteStatusSupportDashboard
DocumentationAPI ReferenceMCPSDKsCLI (new)What's New?
DocumentationAPI ReferenceMCPSDKsCLI (new)What's New?
  • Get started
    • Introduction
    • Phone calls
    • Web calls
    • Vapi Guides
    • Composer
    • CLI quickstart
  • Assistants
    • Quickstart
    • Tools
    • Custom keywords
    • Custom voices
    • Custom transcriber
    • Custom TTS
  • Observability
    • Boards
  • Squads
    • Quickstart
    • Overview
    • Handoff tool
    • Passing data between assistants
  • Best practices
    • Prompting guide
    • Debugging voice agents
    • Enterprise environments (DEV/UAT/PROD)
    • IVR navigation
      • Test suites
      • Chat testing
      • Voice testing
  • Phone numbers
    • Free Vapi number
    • Inbound SMS
    • Phone Number Hooks
  • Calls
    • Call end reasons
    • Troubleshoot call errors
  • Outbound Campaigns
    • Quickstart
    • Overview
  • Chat
    • Quickstart
    • Streaming
    • Non-streaming
    • OpenAI compatibility
    • Session management
    • Variable substitution
    • SMS chat
    • Web widget
    • Webhooks
  • Workflows
    • Quickstart
    • Overview
LogoLogo
WebsiteStatusSupportDashboard
On this page
  • Overview
  • How Chat Testing Works
  • Designing your tests
  • Benefits of Chat Testing
  • Creating Chat Tests
  • Best Practices for Chat Testing
Best practicesTesting

Chat Testing

Automated text-based testing for AI agents

Was this page helpful?
Edit this page
Previous

Voice Testing

Automated voice call testing for AI voice agents
Next
Built with

Overview

Chat Test Suites allow you to evaluate your AI agents through simulated text conversations. This is our recommended solution for testing as it is much faster than voice testing and lets you isolate testing the behavior of your agent.

How Chat Testing Works

  1. Simulation: Our AI tester engages with your agent in a text-based conversation.
  2. Scripted Interaction: The testing agent follows your predefined script to simulate specific customer scenarios.
  3. Transcript Capture: The conversation is captured as a transcript.
  4. Evaluation: A language model (LLM) assesses the transcript against your success criteria.

Designing your tests

Good test design is critical to evaluating your agent. You’ll want to consider testing:

  1. The tool calls of your agent. Set your script to schedule an appointment or call a transfer tool. At the evaluation step, your rubric will have context of the tool call history to evaluate success.
  2. Knowledge base integrations. Test different Q&A to make sure that your agent responds as expected.
  3. Legal / compliance issues. Ask the agent to answer things it’s not supposed to, and verify that it refuses to answer.
  4. Personality. Simulate an angry, frustrated or manipulative customer, and make sure your assistant handles the situation well.

Benefits of Chat Testing

  • Speed: Chat tests execute faster than voice tests, allowing for rapid iteration.
  • Cost-Effective: No TTS or STT models are used during chat testing.
  • Focused Assessment: Evaluate pure conversational ability without audio-related variables.
  • Higher Test Volume: Run more tests in less time to ensure comprehensive coverage.

Creating Chat Tests

You can create chat tests as part of a Test Suite:

  1. Navigate to the Test tab and select Test Suites.
  2. Create a new Test Suite or edit an existing one.
  3. When adding tests, select Chat as the test type.
  4. Define your script and success criteria as detailed in the Test Suites documentation.

Best Practices for Chat Testing

  • Use chat tests for rapid iteration during development.
  • Create variations of the same scenario to test different user inputs.
  • Test edge cases and potential misunderstandings.

For comprehensive instructions on creating and managing test suites that include chat tests, refer to the Test Suites documentation.