Chatbot Testing and Tracing Framework

Welcome to the official documentation for the Chatbot Test Framework. This guide will walk you through every feature, from basic setup to advanced testing and tracing strategies.

Contents:

• 1. Introduction
  • What is the Chatbot Test Framework?
  • Why Use It?
  • Core Concepts
  • High-Level Workflow
• 2. Getting Started: A Quick Tour
  • Prerequisites
  • Installation
  • Step 1: Initialize Your Project
  • Step 2: Instrument a Simple Chatbot
  • Step 3: Configure Your Test
  • Step 4: Run Your First Test
  • Step 5: Check the Results
• 3. Comprehensive Guide to Tracing
  • The @trace Decorator
  • The Tracer and Recorder Relationship
  • Advanced Tracing: Injecting Custom Metadata
  • Recorders In-Depth
  • Tracing Integration Patterns
• 4. Comprehensive Guide to Testing
  • The Three-Phase Testing Approach
  • The Command-Line Interface (CLI) In-Depth
  • Configuration (test_config.yaml) In-Depth
  • Customizing Evaluations (prompts.py)
  • Understanding the Reports
• 5. Contributing & License