Metadata-Version: 2.4
Name: benchtrace
Version: 0.1.0
Summary: A trace-first evaluation framework for LLM agents
Project-URL: Homepage, https://github.com/theomthakur/benchtrace
Project-URL: Repository, https://github.com/theomthakur/benchtrace
Project-URL: Issues, https://github.com/theomthakur/benchtrace/issues
Project-URL: Changelog, https://github.com/theomthakur/benchtrace/blob/main/CHANGELOG.md
Author: Om Thakur
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2026 agentbench contributors
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: agents,benchmarking,evaluation,llm
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: httpx==0.28.1
Requires-Dist: jsonschema==4.25.0
Requires-Dist: pydantic==2.11.7
Requires-Dist: pyyaml==6.0.2
Requires-Dist: scipy==1.16.1
Requires-Dist: typing-extensions==4.16.0
Provides-Extra: dev
Requires-Dist: build==1.3.0; extra == 'dev'
Requires-Dist: mypy==1.17.1; extra == 'dev'
Requires-Dist: numpy==2.5.2; extra == 'dev'
Requires-Dist: pytest-asyncio==1.1.0; extra == 'dev'
Requires-Dist: pytest==8.4.1; extra == 'dev'
Requires-Dist: ruff==0.12.7; extra == 'dev'
Requires-Dist: types-jsonschema==4.25.0.20250809; extra == 'dev'
Requires-Dist: types-pyyaml==6.0.12.20250516; extra == 'dev'
Description-Content-Type: text/markdown

# benchtrace

[![CI](https://github.com/theomthakur/benchtrace/actions/workflows/ci.yml/badge.svg)](https://github.com/theomthakur/benchtrace/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/benchtrace)](https://pypi.org/project/benchtrace/)
[![Python](https://img.shields.io/pypi/pyversions/benchtrace)](https://pypi.org/project/benchtrace/)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)

**Trace-first evaluation for LLM agents.** One runtime-validated JSONL schema is written by the
runner and read by everything else: grading, statistics, cost analysis, retrieval evaluation,
model comparison and HTML reporting.

```bash
pip install benchtrace
```

```bash
export OPENAI_API_KEY="..." ANTHROPIC_API_KEY="..."

benchtrace run tasks/ --models gpt-5,claude-opus-5 --repeats 1
benchtrace cost runs/latest         # what it cost, per model and per successful result
benchtrace retrieval runs/latest    # precision@k, recall@k, citation faithfulness
benchtrace report runs/latest       # one self-contained HTML file
benchtrace compare runs/a runs/b    # exact McNemar, paired by case
```

## Statistics you can defend

Pass-rate intervals use the **Wilson score interval**, with exact **Clopper-Pearson** available
via `method="clopper-pearson"`. A percentile bootstrap is deliberately not used: for Bernoulli
data its distribution is exactly `Binomial(n, p̂)`, so it collapses to a point whenever every case
passes or every case fails. `5/5` would report a 95% interval of 100% to 100%, and all-pass is an
ordinary benchmark outcome. See Brown, Cai and DasGupta (2001).

Paired *differences* between two models are still bootstrapped, which is correct there, because a
mean of per-case differences is not a boundary-constrained proportion.

Two models are paired by task, case and repeat, then compared with an exact two-sided McNemar
test rather than independent means. Mismatched case sets are rejected. Every number carries `n`,
and when the paired-difference interval includes zero the CLI says there is no winner instead of
picking one.

---

`benchtrace` is a typed, trace-first Python library and CLI for evaluating single-turn LLM calls and multi-step tool-using agents. The runner writes one runtime-validated JSONL schema; grading, statistics, cost analysis, retrieval evaluation, comparisons, and HTML reporting read that same schema.

## Why the trace is the architecture

`src/benchtrace/trace.py` is the only run-result contract. `TraceRecord` is versioned, immutable, rejects unknown fields, and captures the rendered request, final response, every provider call, usage, latency, cost, retrieved context, citations, trajectory steps, grader outputs, failure mode, and metadata. JSONL readers report invalid records as `path:line: error`.

A run directory contains `traces.jsonl`. There is no database and no service. You can stream, archive, diff, or process it with the library:

```python
from benchtrace.trace import load_traces
from benchtrace.stats import summarize_pass_rates

traces = load_traces("runs/latest")
for (model, task), estimate in summarize_pass_rates(traces).items():
    print(model, task, estimate.value, estimate.lower, estimate.upper, estimate.n)
```

## Tasks are YAML, not classes

Tasks contain a prompt template, cases, expected behavior, tools, a step budget, and graders. Loader errors identify the offending file and line. This is a minimal task:

```yaml
schema_version: "1.0"
id: weather
prompt_template: "Use weather for {city}."
step_budget: 3
tools:
  - name: weather
    description: Look up current conditions.
    parameters: {type: object, properties: {city: {type: string}}, required: [city]}
graders:
  - type: tool_call
cases:
  - id: paris
    input:
      city: Paris
      tool_results:
        weather: [{arguments: {city: Paris}, result: {condition: sunny}}]
    expected:
      tool_calls: [{name: weather, arguments: {city: Paris}}]
```

`tool_results` makes committed suites runnable without application code. Library users can instead pass async implementations through `ToolRegistry`. The committed `tasks/` suite has 30 cases across weather, arithmetic, and inventory tools.

## Providers

All adapters implement one async `Provider` interface. The built-in REST adapters avoid mandatory vendor SDKs:

| Model prefix | Adapter | Environment variable |
|---|---|---|
| `gpt-*` (default) | OpenAI | `OPENAI_API_KEY` |
| `claude-*`, `anthropic/` | Anthropic | `ANTHROPIC_API_KEY` |
| `gemini-*`, `google/` | Google | `GOOGLE_API_KEY` |
| `together/` | OpenAI-compatible | `TOGETHER_API_KEY` |
| `groq/` | OpenAI-compatible | `GROQ_API_KEY` |
| `openrouter/` | OpenAI-compatible | `OPENROUTER_API_KEY` |

Providers enforce configurable concurrency, retry transient failures with exponential backoff and jitter, and honor rate-limit reset headers. Seeds are passed only by adapters that support them. Tests use `httpx.MockTransport` and never make network requests.

## Agent loop and failure modes

The runner performs observe/plan/act transitions until the model returns a final answer or reaches its step budget. Every action and observation is retained. Repeating the same action when observed state has not changed is `thrash`; exhausting the step budget is `budget_exhausted`. Both are distinct from `wrong_answer`, `tool_error`, `provider_error`, and `grader_error`. One failed case is persisted and never aborts other cases.

Runs are resumable. Existing `(task, case, model, repeat)` keys are skipped unless `--force` is supplied. The default output is timestamped under `runs/`, and `runs/latest` points to it.

## Graders

Every grader returns a score in `[0, 1]` and a reason:

- exact match, with case and whitespace controls;
- regular expression, with explicit flags;
- numeric absolute and relative tolerance;
- JSON Schema Draft 2020-12;
- ordered tool-call name and argument correctness;
- rubric-based LLM judge.

The LLM judge has its own provider and model selection. It refuses to judge the same model under test unless `force_same_model: true` is present in task data. Judge usage and cost are retained as ordinary `ModelCall` entries.

## Statistics and comparisons

Pass-rate intervals default to the **Wilson score interval**, with exact **Clopper-Pearson** available via `method="clopper-pearson"`. A percentile bootstrap is deliberately not used: for Bernoulli data its distribution is exactly `Binomial(n, p_hat)`, so it collapses to a single point whenever every case passes or every case fails. `5/5` would report a 95% interval of 100% to 100%, and all-pass is an ordinary benchmark outcome. See Brown, Cai and DasGupta (2001), *Interval Estimation for a Binomial Proportion*.

Paired **differences** between two models are still bootstrapped, which is appropriate there, since the per-case difference is not a boundary-constrained proportion.

Two models are paired by task, case, and repeat and compared with an exact two-sided McNemar test, not independent means. Mismatched case sets are rejected. Output includes `n`; if the paired-difference confidence interval includes zero, the CLI explicitly reports no winner.

```bash
benchtrace compare runs/a runs/b
```

## Cost, retrieval, and reports

Pricing is loaded from versioned package data (`src/benchtrace/data/pricing-v1.json`), never embedded in clients. `benchtrace cost` reprices every call and reports provider, model, and task totals. Cost per successful result is printed first. Unknown model prices are reported rather than silently estimated.

Retrieval metrics operate only on runner traces. `relevant_context_ids` supports precision@k, recall@k, and MRR. Citation faithfulness requires a recorded semantic support verdict; missing context or an unassessed claim is conservatively unsupported rather than guessed from token overlap.

`benchtrace report` writes one escaped, self-contained `report.html` with embedded CSS, no server, build step, JavaScript dependency, or CDN. It includes pass-rate intervals, model cost and latency, and an expandable browser containing every failed trajectory.

## CLI reference

```text
benchtrace run TASKS --models MODEL[,MODEL] [--repeats N] [--concurrency N] [--seed N] [--force]
benchtrace cost RUN_DIR [--pricing-version v1]
benchtrace retrieval RUN_DIR [--k 5]
benchtrace report RUN_DIR [--output report.html]
benchtrace compare RUN_A RUN_B [--model-a MODEL] [--model-b MODEL]
```

## Development

Python 3.11+ is supported. Dependencies are pinned for reproducible CI.

```bash
python -m pip install -e '.[dev]'
ruff check .
mypy --strict src/benchtrace
pytest
python -m build
```

Provider calls in tests are mocked and no API key is required. Please extend `TraceRecord` when a feature needs new recorded data; do not introduce a parallel result loader.

## Pricing and releases

Pricing snapshots are data with an effective date. They are not a promise of current vendor pricing; update and version the table when providers change rates. See [CHANGELOG.md](CHANGELOG.md) for release history.

Licensed under the Apache License 2.0. See [LICENSE](LICENSE).
