promptfoo--promptfoo/examples/config-python-test-cases/README.md

config-python-test-cases (Python Test Cases with Configuration)

You can run this example with:

npx promptfoo@latest init --example config-python-test-cases
cd config-python-test-cases

This example demonstrates how to use Python functions to generate test cases with configurable parameters using the new TestGeneratorConfig feature.

Overview

Previously, test generators could only be called without parameters:

tests:
  - file://test_cases.py:generate_simple_tests

Now you can pass configuration objects to customize the test generation:

tests:
  - path: file://test_cases.py:generate_simple_tests
    config:
      languages: [German, Italian]

Requirements

1. Python Dependencies:

   pip install pandas
   

2. Environment Variables:

   export OPENAI_API_KEY=your_api_key_here
   

Usage

Run the evaluation with:

promptfoo eval

Features Demonstrated

1. Backward Compatibility

The old format still works:

- file://test_cases.py:generate_simple_tests

2. Simple Configuration

Pass configuration to customize test generation:

- path: file://test_cases.py:generate_simple_tests
  config:
    languages: [German, Italian]

3. Row Limiting

Control how many test cases are generated:

- path: file://test_cases.py:generate_from_csv
  config:
    max_rows: 2

Implementation

The Python functions accept an optional config parameter:

from typing import Optional, Dict, Any

def generate_simple_tests(config: Optional[Dict[str, Any]] = None):
    languages = ["Spanish", "French"]  # defaults

    if config:
        languages = config.get("languages", languages)

    # Generate test cases using the configuration...

This enables:

• Backward compatibility: Existing generators work unchanged
• Flexible configuration: Pass any parameters as JSON
• Reusable functions: Same function, different configurations