llmtrim 0.3.1

Static, deterministic LLM prompt/payload compressor — cut input tokens 30-90% with zero extra model calls
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
//! Quality evaluation harness.
//!
//! The token gate proves savings; this proves the savings don't break the task.
//! Input and output quality are evaluated separately, and a lossy stage may
//! only ship once it passes here.
//!
//! - **Recall** (network-free): for lossy retrieval (Stage B), does the
//!   answer-bearing content survive compression? Sweeping `keep_ratio` and reading
//!   recall tells you the safe drop ratio — the gate for turning Stage B default-on.
//! - **Task success** (needs a model): does the model still answer correctly given
//!   the compressed request? The [`Model`] trait lets a live API (the proxy phase)
//!   or recorded answers plug in; the scaffold runs offline today.

use anyhow::{Context, Result};
use serde_json::{Value, json};

use crate::transport::Endpoint;
use llmtrim_core::compress_with_config;
use llmtrim_core::config::DenseConfig;
use llmtrim_core::ir::ProviderKind;
use llmtrim_core::provider::{self, Provider};

/// A case asserting that answer-bearing phrases survive compression.
pub struct RecallCase {
    pub name: String,
    pub request: String,
    pub provider: ProviderKind,
    /// Phrases the answer depends on; each must remain in the compressed request.
    pub must_keep: Vec<String>,
}

/// Fraction of `must_keep` phrases present in `haystack` (1.0 = all retained).
pub fn recall(must_keep: &[String], haystack: &str) -> f64 {
    if must_keep.is_empty() {
        return 1.0;
    }
    let hit = must_keep
        .iter()
        .filter(|p| haystack.contains(p.as_str()))
        .count();
    hit as f64 / must_keep.len() as f64
}

/// Recall + token measurement for one case.
#[derive(Debug, Clone)]
pub struct RecallResult {
    pub name: String,
    pub recall: f64,
    pub tokens_before: usize,
    pub tokens_after: usize,
}

impl RecallResult {
    pub fn savings_pct(&self) -> f64 {
        if self.tokens_before == 0 {
            0.0
        } else {
            (self.tokens_before as f64 - self.tokens_after as f64) / self.tokens_before as f64
                * 100.0
        }
    }
}

/// Compress each case with `config` and measure recall + token reduction.
pub fn run_recall(cases: &[RecallCase], config: &DenseConfig) -> Result<Vec<RecallResult>> {
    cases
        .iter()
        .map(|c| {
            let r = compress_with_config(&c.request, Some(c.provider), config)?;
            Ok(RecallResult {
                name: c.name.clone(),
                recall: recall(&c.must_keep, &r.request_json),
                tokens_before: r.input_tokens_before.0,
                tokens_after: r.input_tokens_after.0,
            })
        })
        .collect()
}

/// Mean recall across results (1.0 when empty).
pub fn mean_recall(results: &[RecallResult]) -> f64 {
    if results.is_empty() {
        return 1.0;
    }
    results.iter().map(|r| r.recall).sum::<f64>() / results.len() as f64
}

/// Load a held-out corpus from JSONL into recall cases — so existing benchmark
/// datasets (LongBench, ZeroSCROLLS, prompt-compression-benchmarker exports) drive
/// the quality gate with no bespoke framework. Each line may use `context`|`input`,
/// `question`|`query`, and `answers`|`answer`|`expected`.
pub fn load_corpus(jsonl: &str, provider: ProviderKind) -> Result<Vec<RecallCase>> {
    let mut cases = Vec::new();
    for (i, line) in jsonl.lines().enumerate() {
        let line = line.trim();
        if line.is_empty() {
            continue;
        }
        let v: Value = serde_json::from_str(line)
            .with_context(|| format!("corpus line {} is not valid JSON", i + 1))?;
        let context = field(&v, &["context", "input", "passage", "document"]).unwrap_or_default();
        let question = field(&v, &["question", "query", "prompt"]).unwrap_or_default();

        let mut messages = vec![json!({"role": "user", "content": context})];
        if !question.is_empty() {
            messages.push(json!({"role": "user", "content": question}));
        }
        cases.push(RecallCase {
            name: format!("case-{}", i + 1),
            request: json!({"model": "gpt-4o", "messages": messages}).to_string(),
            provider,
            must_keep: answers(&v),
        });
    }
    Ok(cases)
}

fn field(v: &Value, keys: &[&str]) -> Option<String> {
    keys.iter()
        .find_map(|k| v.get(*k).and_then(Value::as_str))
        .map(str::to_string)
}

fn answers(v: &Value) -> Vec<String> {
    if let Some(arr) = v.get("answers").and_then(Value::as_array) {
        return arr
            .iter()
            .filter_map(Value::as_str)
            .map(str::to_string)
            .collect();
    }
    field(v, &["answer", "expected"]).into_iter().collect()
}

/// Token usage reported by the provider for one response, including prompt-cache hits
/// (Stage A). `None` fields mean the provider didn't report that figure.
#[derive(Debug, Clone, Copy, Default)]
pub struct Usage {
    pub prompt_tokens: Option<u64>,
    pub completion_tokens: Option<u64>,
    /// Input tokens served from the prompt cache (the cheap `cache_read` rate).
    pub cached_tokens: Option<u64>,
}

/// Extract usage from a chat/messages response, tolerant to OpenAI
/// (`prompt_tokens_details.cached_tokens`) and Anthropic (`cache_read_input_tokens`)
/// shapes, both of which OpenRouter may surface.
pub fn parse_usage(response: &Value) -> Usage {
    let u = response.get("usage");
    let num = |k: &str| u.and_then(|u| u.get(k)).and_then(Value::as_u64);
    let cached = u
        .and_then(|u| u.pointer("/prompt_tokens_details/cached_tokens"))
        .and_then(Value::as_u64)
        .or_else(|| num("cache_read_input_tokens"))
        .or_else(|| num("cached_tokens"));
    Usage {
        prompt_tokens: num("prompt_tokens").or_else(|| num("input_tokens")),
        completion_tokens: num("completion_tokens").or_else(|| num("output_tokens")),
        cached_tokens: cached,
    }
}

/// An abstract LLM endpoint, so task-success evals can run against a live API
/// later or recorded answers now.
pub trait Model {
    fn answer(&self, request_json: &str) -> Result<String>;

    /// Also return provider token usage (prompt/completion/cached) alongside the answer.
    /// Default: the answer with empty usage — only live endpoints fill it in.
    fn answer_with_usage(&self, request_json: &str) -> Result<(String, Usage)> {
        Ok((self.answer(request_json)?, Usage::default()))
    }
}

/// A task-success case: the model's answer to the (compressed) request must
/// contain `expected`.
pub struct TaskCase {
    pub name: String,
    pub request: String,
    pub provider: ProviderKind,
    pub expected: String,
}

/// Compress each case, ask the model, and return the fraction whose answer
/// contains the expected phrase. Lights up once a real [`Model`] is wired (proxy
/// phase); runs offline today with a recorded/stub model.
pub fn run_task_success(
    cases: &[TaskCase],
    config: &DenseConfig,
    model: &dyn Model,
) -> Result<f64> {
    if cases.is_empty() {
        return Ok(1.0);
    }
    let mut ok = 0usize;
    for case in cases {
        let r = compress_with_config(&case.request, Some(case.provider), config)?;
        let answer = model.answer(&r.request_json)?;
        if answer.contains(case.expected.as_str()) {
            ok += 1;
        }
    }
    Ok(ok as f64 / cases.len() as f64)
}

/// A live LLM endpoint as a quality [`Model`]: sends the (compressed) request and
/// extracts the answer text. Lets task-success evals run against a real API once
/// keys are available (the proxy phase) — the harness is otherwise model-agnostic.
pub struct HttpModel {
    endpoint: Endpoint,
    provider: Box<dyn Provider>,
}

impl HttpModel {
    pub fn from_env(provider: ProviderKind) -> Result<Self> {
        Ok(Self {
            endpoint: Endpoint::from_env(provider)?,
            provider: provider::for_kind(provider),
        })
    }

    /// Build with explicit credentials (e.g. an OpenRouter base URL + key resolved
    /// from a `.env`), bypassing the fixed `OPENAI_*` env var names.
    pub fn new(provider: ProviderKind, base_url: String, api_key: String) -> Self {
        Self {
            endpoint: Endpoint {
                provider,
                base_url,
                api_key,
            },
            provider: provider::for_kind(provider),
        }
    }
}

impl Model for HttpModel {
    fn answer(&self, request_json: &str) -> Result<String> {
        // Pass None for bind_addr: bench runs are not daemon instances, so there is no
        // listen port to guard against loopback recursion.
        let proxy_url = crate::transport::upstream_proxy_url(None)?;
        let response = self.endpoint.send(request_json, proxy_url.as_deref())?;
        let value: serde_json::Value =
            serde_json::from_str(&response).context("response is not valid JSON")?;
        self.provider
            .answer_text(&value)
            .context("no answer text found in response")
    }
}

/// A live OpenRouter endpoint as a quality [`Model`], via the `async-openai` client's
/// bring-your-own-types path: it POSTs the **exact** (compressed) request body as raw
/// JSON and returns the raw response, so llmtrim's injected fields — provider
/// routing, `cache_control`, reordered messages — reach the API unchanged. A typed SDK
/// request builder would silently drop them and benchmark a different request.
///
/// Wraps a single-thread Tokio runtime so the otherwise-async client satisfies the sync
/// [`Model`] interface; this is the dev/bench transport and stays out of the no-async
/// compressor core.
#[cfg(feature = "live")]
pub struct OpenRouterModel {
    client: async_openai::Client<async_openai::config::OpenAIConfig>,
    runtime: tokio::runtime::Runtime,
    provider: Box<dyn Provider>,
}

#[cfg(feature = "live")]
impl OpenRouterModel {
    /// Build against OpenRouter's OpenAI-compatible endpoint with the given key.
    pub fn new(api_key: String, provider: ProviderKind) -> Result<Self> {
        let config = async_openai::config::OpenAIConfig::new()
            .with_api_base("https://openrouter.ai/api/v1")
            .with_api_key(api_key);
        // Never route through an HTTP(S)_PROXY: in a `setup`-wired shell that env points at
        // llmtrim's own interceptor, which would compress the ORIGINAL arm in flight and the
        // A/B would measure compressed-vs-compressed.
        let http_client = reqwest::Client::builder()
            .no_proxy()
            .build()
            .context("failed to build the OpenRouter HTTP client")?;
        let runtime = tokio::runtime::Builder::new_current_thread()
            .enable_all()
            .build()
            .context("failed to start Tokio runtime for the OpenRouter client")?;
        Ok(Self {
            client: async_openai::Client::with_config(config).with_http_client(http_client),
            runtime,
            provider: provider::for_kind(provider),
        })
    }
}

#[cfg(feature = "live")]
impl OpenRouterModel {
    /// Public raw send: POST the body, return the raw response Value (with `choices`,
    /// `tool_calls`, `usage`). The agent-loop benchmark needs the full response (tool calls),
    /// not just the extracted answer text that [`Model::answer`] returns.
    pub fn send_raw(&self, request_json: &str) -> Result<Value> {
        self.send(request_json)
    }

    /// POST the raw (compressed) body and return the raw response Value, retrying with
    /// exponential backoff on transient upstream errors (HTTP 429 / rate-limit / 5xx) —
    /// Groq free-tier routing rate-limits in bursts, so a short wait usually clears it.
    fn send(&self, request_json: &str) -> Result<Value> {
        let body: Value =
            serde_json::from_str(request_json).context("request is not valid JSON")?;
        let mut last = anyhow::anyhow!("no attempt made");
        const ATTEMPTS: u32 = 8;
        for attempt in 0..ATTEMPTS {
            // Light pre-call pace to stay under strict free-tier rate limits (Groq).
            std::thread::sleep(std::time::Duration::from_millis(350));
            match self
                .runtime
                .block_on(self.client.chat().create_byot::<Value, Value>(body.clone()))
            {
                Ok(v) => return Ok(v),
                Err(e) => {
                    let msg = e.to_string();
                    let transient = ["429", "rate", "temporarily", "502", "503", "overloaded"]
                        .iter()
                        .any(|p| msg.contains(p));
                    last = anyhow::anyhow!("OpenRouter request failed: {msg}");
                    if !transient || attempt == ATTEMPTS - 1 {
                        break;
                    }
                    // Exponential backoff capped at 20s: 0.8,1.6,3.2,6.4,12.8,20,20…
                    let backoff = (800u64 << attempt).min(20_000);
                    std::thread::sleep(std::time::Duration::from_millis(backoff));
                }
            }
        }
        Err(last)
    }
}

/// Answer text for the bench transport: the provider's extraction, falling back to the
/// reasoning channel when `content` is null/empty. Reasoning models (gpt-oss, R1) on
/// OpenRouter sometimes return the whole answer in `message.reasoning` (or DeepSeek's
/// `reasoning_content`) with empty content — flaky per-call, previously misclassified as
/// "compressed send broke the request". Bench-only: the proxy's rehydration must NOT
/// treat reasoning as answer text, so this stays out of `Provider::answer_text`.
#[cfg(feature = "live")]
fn answer_text_or_reasoning(
    provider: &dyn provider::Provider,
    response: &serde_json::Value,
) -> Option<String> {
    if let Some(t) = provider.answer_text(response)
        && !t.trim().is_empty()
    {
        return Some(t);
    }
    [
        "/choices/0/message/reasoning",
        "/choices/0/message/reasoning_content",
    ]
    .iter()
    .find_map(|p| response.pointer(p).and_then(serde_json::Value::as_str))
    .filter(|t| !t.trim().is_empty())
    .map(str::to_string)
}

#[cfg(feature = "live")]
impl Model for OpenRouterModel {
    fn answer(&self, request_json: &str) -> Result<String> {
        let response = self.send(request_json)?;
        answer_text_or_reasoning(self.provider.as_ref(), &response)
            .context("no answer text found in response")
    }

    fn answer_with_usage(&self, request_json: &str) -> Result<(String, Usage)> {
        let response = self.send(request_json)?;
        let text = answer_text_or_reasoning(self.provider.as_ref(), &response)
            .context("no answer text found in response")?;
        Ok((text, parse_usage(&response)))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn load_corpus_parses_common_schemas() {
        let jsonl = "{\"context\":\"The vault code is 7741.\",\"question\":\"code?\",\"answers\":[\"7741\"]}\n\
                     {\"input\":\"Paris is the capital.\",\"query\":\"capital?\",\"answer\":\"Paris\"}";
        let cases = load_corpus(jsonl, ProviderKind::OpenAi).unwrap();
        assert_eq!(cases.len(), 2);
        assert_eq!(cases[0].must_keep, vec!["7741"]);
        assert_eq!(cases[1].must_keep, vec!["Paris"]);
        let v: Value = serde_json::from_str(&cases[0].request).unwrap();
        assert_eq!(
            v["messages"].as_array().unwrap().len(),
            2,
            "context + question"
        );
    }

    #[test]
    fn recall_counts_surviving_phrases() {
        let keep = vec!["alpha".to_string(), "beta".to_string()];
        assert_eq!(recall(&keep, "x alpha y"), 0.5);
        assert_eq!(recall(&keep, "alpha beta"), 1.0);
        assert_eq!(recall(&[], "anything"), 1.0);
    }

    /// Stub model that echoes the request — proves the task-success plumbing offline
    /// (a real model plugs in unchanged via the `Model` trait).
    struct EchoModel;
    impl Model for EchoModel {
        fn answer(&self, request_json: &str) -> Result<String> {
            Ok(request_json.to_string())
        }
    }

    #[test]
    fn task_success_harness_runs_offline() {
        let cases = vec![TaskCase {
            name: "secret".to_string(),
            request: r#"{"model":"gpt-4o","messages":[{"role":"user","content":"the secret code is ALPHA7"}]}"#.to_string(),
            provider: ProviderKind::OpenAi,
            expected: "ALPHA7".to_string(),
        }];
        let rate = run_task_success(&cases, &DenseConfig::lossless(), &EchoModel).unwrap();
        assert_eq!(
            rate, 1.0,
            "echoed compressed request still contains the answer"
        );
    }

    #[test]
    fn provider_answer_text_extraction() {
        use llmtrim_core::provider::for_kind;
        use serde_json::json;
        let oa = for_kind(ProviderKind::OpenAi);
        assert_eq!(
            oa.answer_text(&json!({"choices":[{"message":{"content":"hi"}}]})),
            Some("hi".to_string())
        );
        assert_eq!(oa.answer_text(&json!({"nope": 1})), None);
        let an = for_kind(ProviderKind::Anthropic);
        assert_eq!(
            an.answer_text(
                &json!({"content":[{"type":"text","text":"a"},{"type":"text","text":"b"}]})
            ),
            Some("ab".to_string())
        );
    }
}