Skip to main content

OpenAgent Eval

The open-source evaluation framework for RAG systems and AI Agents.

PyPI Version Python Versions License Downloads Code Style PRs Welcome GitHub Stars Forks Contributors Issues

Local-first. Framework-agnostic. Developer-friendly.

Getting Started · Documentation · Contributing


Why OpenAgent Eval?

Evaluating RAG systems shouldn't require a PhD or a cloud account. OpenAgent Eval brings pytest-level simplicity to AI evaluation — run from your terminal, get actionable insights, and ship with confidence.

  • Local-first — No cloud services, dashboards, or authentication required
  • Framework-agnostic — Works with LangChain, LlamaIndex, or any custom RAG pipeline
  • 18+ metrics — Retrieval, generation, faithfulness, relevancy, performance, and cost
  • Plugin-based — Extend with custom metrics, providers, and report generators
  • Production-ready — Corpus auditing, failure diagnosis, and synthetic test data generation

Installation

pip install openagent-eval

For development:

git clone https://github.com/OpenAgentHQ/openagent-eval.git
cd openagent-eval
uv sync

Quick Start

1. Initialize Configuration

oaeval init --interactive

2. Validate Configuration

oaeval validate config.yaml

3. Run Evaluation

oaeval run config.yaml

4. View Results

oaeval report latest

Features

Feature Description
CLI + SDK Use via command line or import as a Python library
Beautiful Reports Terminal, Markdown, HTML, and JSON output formats
Failure Analysis Identify why evaluations fail, not just that they failed
Corpus Health Auditor Detect contradictions, staleness, and duplicates before evaluation
LLM-as-Judge Metrics NLI-based scoring for faithfulness and relevancy
Component Diagnosis Blame attribution — retrieval vs generation vs chunking
Synthetic Test Data Auto-generate test cases from your knowledge base

Evaluation Metrics

Retrieval Metrics
  • Context Precision & Recall
  • Precision@K & Recall@K
  • Hit Rate
  • Mean Reciprocal Rank (MRR)
  • Normalized Discounted Cumulative Gain (NDCG)
Generation Metrics
  • Faithfulness (NLI-based)
  • Answer Relevancy (NLI-based)
  • Hallucination Detection
  • Semantic Similarity
  • Exact Match & F1 Score
  • BLEU & ROUGE
  • BERTScore
  • LLM-as-Judge (custom criteria)
Performance & Cost
  • Latency tracking (embedding, retrieval, LLM stages)
  • Token counting (prompt, completion, total)
  • Cost estimation per provider

Supported Providers

LLM Providers: OpenAI · Anthropic · Google Gemini · Groq · OpenRouter · Ollama

Retriever Providers: Chroma · Qdrant · Pinecone · Weaviate · FAISS · pgvector · Elasticsearch · BM25


CLI Reference

Command Description
oaeval init Create configuration file (interactive wizard)
oaeval run <config> Run evaluation pipeline
oaeval report <id> View evaluation reports
oaeval compare <a> <b> Compare two experiments
oaeval list List previous evaluations
oaeval validate <config> Validate configuration
oaeval doctor Check environment and dependencies
oaeval audit --corpus <path> Audit corpus health
oaeval diagnose --report <id> Diagnose failures and attribute blame
oaeval synth --corpus <path> Generate synthetic test cases

SDK Usage

from openagent_eval.core import Engine
from openagent_eval.config import load_config

config = load_config("config.yaml")
engine = Engine(config)
report = await engine.run(dataset)

print(report.summary)

Project Structure

openagent-eval/
├── openagent_eval/
│   ├── cli/              # CLI commands (Typer)
│   ├── config/           # Configuration system (Pydantic)
│   ├── core/             # Core orchestration engine
│   ├── metrics/          # 18+ evaluation metrics
│   ├── providers/        # LLM & Retriever adapters
│   ├── corpus/           # Corpus Health Auditor
│   ├── diagnosis/        # Component Diagnosis
│   ├── synthesis/        # Synthetic Test Data
│   ├── reports/          # Report generators
│   └── plugins/          # Plugin system
├── tests/                # Test suite
├── docs/                 # Documentation
└── examples/             # Tutorials and examples

Contributing

We welcome contributions of all kinds. Whether you're fixing a bug, adding a feature, or improving documentation — we'd love your help.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.


Community


License

Licensed under the Apache License, Version 2.0. See LICENSE for details.


Built with care by the OpenAgent community.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openagent_eval-0.4.5.tar.gz (154.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openagent_eval-0.4.5-py3-none-any.whl (244.5 kB view details)

Uploaded Python 3

File details

Details for the file openagent_eval-0.4.5.tar.gz.

File metadata

  • Download URL: openagent_eval-0.4.5.tar.gz
  • Upload date:
  • Size: 154.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openagent_eval-0.4.5.tar.gz
Algorithm Hash digest
SHA256 57f67efed4170e26adee6dc148f1ec2b39bcf6c6497fda806cc9e3a50bafc933
MD5 f6379d2ff5d226a98cc24703ef91e049
BLAKE2b-256 ad6739316288bb8e60b6b23ccb72216496f03de3e6f05f4b6ae74ed626b70619

See more details on using hashes here.

Provenance

The following attestation bundles were made for openagent_eval-0.4.5.tar.gz:

Publisher: release.yml on OpenAgentHQ/openagent-eval

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openagent_eval-0.4.5-py3-none-any.whl.

File metadata

  • Download URL: openagent_eval-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 244.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openagent_eval-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 01c67ad776549822de8c2bda9c59b71c98b3b04e2a8cde2760805ef9bde6a265
MD5 fa5ab41518ca883ac17536c860ec650f
BLAKE2b-256 9542f69414bfa9f40b7c15a83390db64f23865979e0bcac28e83a0fc659f6613

See more details on using hashes here.

Provenance

The following attestation bundles were made for openagent_eval-0.4.5-py3-none-any.whl:

Publisher: release.yml on OpenAgentHQ/openagent-eval

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.4.10

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

This release

0.4.5 This release

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page