LLMQuant / LLMQuant/quant-mind

feat(flows): surface token-usage and cost for runs and batch_run

Open
#127 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: configs area: flows area: mind type: feature
Dominant language
Python
Stars
3k
Forks
484
PR merge metrics
No merged PRs in 30d

Description

## ✨ Feature Summary

Surface token usage (and optionally cost) for each QuantMind LLM run, and aggregate it across a `batch_run`, so callers can see what a build / extract / retrieve consumed. Nothing exposes this today.

## 🎯 Motivation

QuantMind discards the `RunResult.context_wrapper.usage` that the Agents SDK already computes: the flow and retrieval callables return domain objects (`PaperStructureTree`, `list[RetrievalEvidence]`, ...) and drop the usage. The `max_*_tokens` cfg fields are generation / input bounds, not accounting, and `BaseFlowCfg.max_total_input_tokens` / `max_total_cost_usd` are declared but unenforced. This is most painful with `batch_run`, which fans out many papers with zero cost visibility. Getting a real number today requires manually patching `Runner.run` to read `context_wrapper.usage`.

## 📋 Detailed Description

Aggregate `context_wrapper.usage` (input / output / total tokens and request count) per run and across a batch, and make it available to callers without forcing them to hook the SDK. Keep model pricing out of the library (report tokens; let callers apply per-model prices) or accept an optional price table. Optionally enforce the existing `max_total_input_tokens` / `max_total_cost_usd` guardrails from the same accounting.

## 🔧 Proposed Implementation

A small usage-accounting run-hook (or a returned usage summary) layered on the existing `flows/_runner` observability seam, accumulating SDK usage per run and per batch.

### API Design

```python
tree = await PaperFlow(cfg).build(input)
usage # UsageSummary(requests, input_tokens, output_tokens, total_tokens) via a run-hook / accessor

batch = await batch_run(flow.build, inputs)
batch.usage # aggregated UsageSummary across the fan-out
```

## 🎨 User Experience

A caller reads `input_tokens` / `output_tokens` / `requests` after any run and after a batch, and optionally sets `max_total_input_tokens` / `max_total_cost_usd` to fail closed when a budget is exceeded.

## 📊 Use Cases

1. **Cost visibility for batch ingestion**: a `batch_run` over N papers reports aggregate tokens so an operator can estimate spend.
2. **Budget guardrails**: enforce `max_total_input_tokens` / `max_total_cost_usd` per run or per batch.
3. **Model comparison**: compare token / turn counts across models (an agentic retrieve converging in 3 turns vs 10) to pick a cheaper default.

## 🔗 Related Issues

- Relates to #125

## Implementation Considerations

Pricing changes over time and varies by provider, so the library should avoid hard-coding prices. Usage is already produced by the SDK, so this is aggregation and surfacing, not new model plumbing.

### Breaking Changes

- [ ] This feature would introduce breaking changes
- [x] This feature is backward compatible

### Dependencies

- [ ] Requires new dependencies
- [x] Uses existing dependencies only

---

**Checklist**

- [x] I have searched existing issues to avoid duplicates
- [x] I have provided a clear and detailed description
- [x] I have explained the motivation and use cases
- [x] I have considered the implementation approach
- [x] I have thought about potential breaking changes

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing flows/_runner observability seam and the Runner.run path where context_wrapper.usage is available. Trace how flow callables and batch_run return their results, then define how usage is surfaced per run and aggregated across a batch. Done means callers can read input, output, total tokens, and request counts after both kinds of operation, with any guardrail behavior covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.