Skip to main content

CLEAR: Comprehensive LLM Error Analysis and Reporting

CLEAR is an open-source toolkit for LLM error analysis using an LLM-as-a-Judge approach.

Python 3.10+ License PyPI


What is CLEAR?

CLEAR provides systematic error analysis for LLM-based systems. It combines automated LLM-as-a-judge evaluation with interactive dashboards to help you:

  • Identify recurring error patterns across your dataset
  • Quantify issue frequencies and severity
  • Drill down into specific failure cases
  • Prioritize improvements based on data-driven insights

CLEAR operates in two phases:

  1. Analysis — Generates per-instance textual feedback, identifies system-level error categories, and quantifies their frequencies.
  2. Interactive Dashboard — Explore aggregate visualizations, apply dynamic filters, and drill down into individual failure examples.

Two Analysis Modes

LLM Analysis

Evaluate standard LLM outputs — generation quality, correctness, and recurring error patterns. Provide a CSV with prompts and responses, and CLEAR will score each instance, generate textual critiques, and surface system-level issues.

  • Input: CSV with model inputs and responses
  • Output: Per-record scores, evaluation text, aggregated issue categories
  • Dashboard: Streamlit-based interactive explorer

LLM Analysis Guide →

Agentic Analysis

Evaluate multi-agent system trajectories — step-by-step agent interactions and full trajectory analysis. Supports traces from LangGraph, CrewAI, and other frameworks via MLflow or Langfuse.

  • Input: Raw JSON traces or preprocessed trajectory CSVs (each trace captures one complete agent task execution)
  • Output: Per-step CLEAR analysis, trajectory-level scores, rubric evaluations
  • Dashboard: NiceGUI-based workflow visualization with path and temporal analysis

Agentic Workflows Guide →


Installation

Requires Python 3.10+

Option 1: pip

pip install clear-eval

Option 2: From source (for development)

git clone https://github.com/IBM/CLEAR.git
cd CLEAR
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e .

Verify the installation:

run-clear-eval-analysis --help

Quick Start

1. Set your provider credentials

CLEAR requires a supported LLM provider. Set the appropriate environment variables for your provider (e.g., OPENAI_API_KEY for OpenAI). Adjust --provider and --eval-model-name in the commands below to match your setup. See Provider Configuration for details.

2. LLM Analysis

This evaluates GSM8K math problem responses and surfaces recurring quality issues:

run-clear-eval-analysis --provider openai --eval-model-name gpt-4o

Results are saved to results/gsm8k/sample_output/. View them:

run-clear-eval-dashboard

Full LLM Analysis Guide → — input formats, CLI arguments, configuration, Python API, and external judges.

3. Agentic Analysis

These two modes are independent — this section does not require step 2.

Run CLEAR on sample agent traces (3 traces, each capturing one complete agent task execution, ~2 minutes):

run-clear-agentic-eval \
    --data-dir src/clear_eval/sample_data/agentic/research_agent_traces/mlflow \
    --results-dir my_smoke_test_results \
    --from-raw-traces true \
    --agent-framework langgraph \
    --observability-framework mlflow \
    --run-name smoke_test \
    --max-files 3 \
    --eval-model-name gpt-4o \
    --provider openai

View pre-computed results (all 20 traces) without re-running:

run-clear-agentic-dashboard
# Upload: src/clear_eval/sample_data/agentic/research_agent_results/mlflow/my_experiment/unified_ui_results.zip

Full Agentic Guide → — trace generation, configuration, output structure, and dashboard features.


Provider Configuration

CLEAR uses LiteLLM as its inference backend, supporting 100+ LLM providers (OpenAI, Anthropic, WatsonX, AWS Bedrock, Google Vertex AI, and more).

Parameters:

Parameter CLI Flag Description
provider --provider LiteLLM provider name (e.g., openai, anthropic, bedrock, vertex_ai)
eval_model_name --eval-model-name Model identifier (e.g., gpt-4o, claude-3-5-sonnet-20241022)
eval_model_params --eval-model-params Additional model parameters as JSON (e.g., {"temperature": 0})
endpoint_url --endpoint-url Custom endpoint URL for local/self-hosted models

Cloud provider example:

export OPENAI_API_KEY="..."
run-clear-eval-analysis --provider openai --eval-model-name gpt-4o

Local model example (vLLM, llama.cpp, Ollama, etc.):

run-clear-eval-analysis \
    --provider openai \
    --eval-model-name my-local-model \
    --endpoint-url http://localhost:8000/v1

No credentials are needed when using --endpoint-url with a local server.

Set the required environment variables for your provider according to LiteLLM's documentation.


Documentation

Guide Description
Agentic Workflows Guide Multi-agent evaluation — trace preprocessing, step-by-step and trajectory analysis, configuration reference
Agentic Dashboard Guide Dashboard features — workflow view, node analysis, trajectory explorer, path and temporal analysis
LLM Analysis Guide Full pipeline reference — input formats, CLI arguments, configuration, and external judges

Citation

If you use CLEAR in your research, please cite the relevant paper(s):

LLM Analysis (AAAI 2026):

@inproceedings{yehudai2026clear,
  title={CLEAR: Error analysis via llm-as-a-judge made easy},
  author={Yehudai, Asaf and Eden, Lilach and Perlitz, Yotam and Bar-Haim, Roy and Shmueli-Scheuer, Michal},
  booktitle={Proceedings of the AAAI Conference on Artificial Intelligence},
  volume={40},
  number={48},
  pages={41736--41738},
  year={2026}
}

Agentic Analysis (ACL 2026, to appear — preprint):

@article{yehudai2026agentic,
  title={Agentic CLEAR: Automating Multi-Level Evaluation of LLM Agents},
  author={Yehudai, Asaf and Eden, Lilach and Shmueli-Scheuer, Michal},
  journal={arXiv preprint arXiv:2605.22608},
  year={2026}
}

License

Apache 2.0 — see LICENSE for details.

Metadata

Release files for clear-eval 2.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for clear-eval 2.0.5
File Size Uploaded
clear_eval-2.0.5.tar.gz 2.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for clear-eval 2.0.5
File Interpreter ABI Platform
clear_eval-2.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 4.8 MB

Release files / clear_eval-2.0.5.tar.gz

Download URL clear_eval-2.0.5.tar.gz
Size 2.3 MB
Tags Source
SHA-256 checksum
How to use checksums
7e331637a34bb3fae98ec630f5a4db8a7d7a1605e82671304296943e7c4bbc22
BLAKE2b-256 checksum
How to use checksums
1726c61825a72d96687383ca4cfed49030c755096d0bd2ba64cfaf14067105fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.0

Release files / clear_eval-2.0.5-py3-none-any.whl

Download URL clear_eval-2.0.5-py3-none-any.whl
Size 2.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
8f94c980ece1eb79d427090588b14d2a442a02b1e7879c37dc3c2b611d4ff4a0
BLAKE2b-256 checksum
How to use checksums
f9d5da61ce5d750f87c32abbf148c4f276d4feb8775045f98e4b7e0e301703af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.0

Release history Release notifications | RSS feed

This release

2.0.5 This release

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page