bitrouter 1.0.0-alpha.29

BitRouter: an LLM API router. CLI + assembly library.
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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
use std::collections::{BTreeMap, BTreeSet};

use serde::Serialize;

use crate::policy_lock::PolicyDefinition;
use crate::workflow_state::archive::CloudUsageRecord;
use crate::workflow_state::fixture::WorkflowTraceFixture;
use crate::workflow_state::predictive::{PredictiveRouteProjection, predict_next_step};
use crate::workflow_state::real_trace::{CapturedIngressTrace, TraceSanitizer};
use crate::workflow_state::replay::extract_fixture_ir;
use bitrouter_sdk::{BitrouterError, Result};

const PPM: u64 = 1_000_000;

/// Cost-only replay of one immutable policy over a settled baseline trace.
///
/// The factor is the candidate's effective cost divided by baseline cost and
/// may already include expected token, retry, and turn inflation. This is an
/// upper-bound prioritization tool: it never claims that replacing a request
/// leaves the remainder of the live trajectory unchanged.
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct PolicyCounterfactualReport {
    pub effective_cost_factor_ppm: u32,
    pub trace_count: usize,
    pub known_cost_request_count: usize,
    pub unknown_cost_request_count: usize,
    pub eligible_request_count: usize,
    pub baseline_cost_micro_usd: u64,
    pub eligible_cost_micro_usd: u64,
    pub cost_weighted_coverage_ppm: u32,
    pub projected_savings_micro_usd: u64,
    pub projected_savings_ppm: u32,
    pub complete_cost_evidence: bool,
    pub routes: Vec<CounterfactualRouteSummary>,
    pub uncovered_routes: Vec<CounterfactualRouteSummary>,
    pub ranked_requests: Vec<CounterfactualRequest>,
    pub ranked_uncovered_requests: Vec<CounterfactualRequest>,
    pub targets: Vec<CounterfactualTarget>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct CounterfactualRouteSummary {
    pub request_key: String,
    pub selected_tier: String,
    pub request_count: usize,
    pub baseline_cost_micro_usd: u64,
    pub cost_share_ppm: u32,
    pub projected_savings_micro_usd: u64,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct CounterfactualRequest {
    pub trace_id: String,
    pub request_id: String,
    pub request_key: String,
    pub selected_tier: String,
    pub baseline_cost_micro_usd: u64,
    pub projected_savings_micro_usd: u64,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct CounterfactualTarget {
    pub target_savings_ppm: u32,
    pub required_coverage_ppm: u32,
    pub attainable: bool,
    pub minimum_request_count: Option<usize>,
}

#[derive(Default)]
struct RouteAccumulator {
    request_count: usize,
    baseline_cost_micro_usd: u64,
    projected_savings_micro_usd: u64,
}

/// Replay `policy` over protocol-native baseline traces and exact request
/// settlement. Route eligibility is derived from the lock rather than from a
/// benchmark- or agent-specific label.
pub fn analyze_policy_counterfactual(
    traces: &[CapturedIngressTrace],
    usage: &[CloudUsageRecord],
    policy: &PolicyDefinition,
    effective_cost_factor_ppm: u32,
    target_savings_ppm: &[u32],
) -> Result<PolicyCounterfactualReport> {
    if effective_cost_factor_ppm > PPM as u32 {
        return Err(BitrouterError::bad_request(
            "counterfactual effective cost factor must be between 0 and 1000000 ppm",
        ));
    }
    if target_savings_ppm.iter().any(|target| *target > PPM as u32) {
        return Err(BitrouterError::bad_request(
            "counterfactual savings targets must be between 0 and 1000000 ppm",
        ));
    }
    let default_tier = policy.default_tier.as_deref().ok_or_else(|| {
        BitrouterError::bad_request("counterfactual policy requires a default_tier")
    })?;
    let usage_by_request = strict_usage_join(traces, usage)?;
    let mut baseline_cost_micro_usd = 0_u64;
    let mut eligible_cost_micro_usd = 0_u64;
    let mut projected_savings_micro_usd = 0_u64;
    let mut known_cost_request_count = 0_usize;
    let mut unknown_cost_request_count = 0_usize;
    let mut routes = BTreeMap::<(String, String), RouteAccumulator>::new();
    let mut uncovered_routes = BTreeMap::<(String, String), RouteAccumulator>::new();
    let mut ranked_requests = Vec::new();
    let mut ranked_uncovered_requests = Vec::new();

    for trace in traces {
        let fixture = WorkflowTraceFixture::from_value(
            trace.to_replay_fixture_json(&TraceSanitizer::default())?,
        )?;
        let ir = extract_fixture_ir(&fixture);
        let prediction = predict_next_step(&ir, &fixture.prompt);
        let projection = PredictiveRouteProjection::new(
            prediction.task_family,
            prediction.next_step_role,
            prediction.route_risk,
        );
        let primary_request_key = projection.key();
        let baseline_request_key = projection.unknown_baseline().key();
        let (selected_tier, request_key) = resolve_tier(
            policy,
            &primary_request_key,
            &baseline_request_key,
            !fixture.prompt.tools.is_empty(),
        )
        .ok_or_else(|| {
            BitrouterError::bad_request("counterfactual policy has no resolvable tier")
        })?;
        let Some(cost) = usage_by_request
            .get(trace.id.as_str())
            .and_then(|record| record.final_charge_micro_usd)
        else {
            unknown_cost_request_count = unknown_cost_request_count.saturating_add(1);
            continue;
        };
        known_cost_request_count = known_cost_request_count.saturating_add(1);
        baseline_cost_micro_usd = baseline_cost_micro_usd.saturating_add(cost);
        if selected_tier == default_tier {
            let route = uncovered_routes
                .entry((request_key.to_string(), selected_tier.to_string()))
                .or_default();
            route.request_count = route.request_count.saturating_add(1);
            route.baseline_cost_micro_usd = route.baseline_cost_micro_usd.saturating_add(cost);
            ranked_uncovered_requests.push(CounterfactualRequest {
                trace_id: trace.id.clone(),
                request_id: trace.id.clone(),
                request_key: request_key.to_string(),
                selected_tier: selected_tier.to_string(),
                baseline_cost_micro_usd: cost,
                projected_savings_micro_usd: 0,
            });
            continue;
        }
        let savings = scaled_savings(cost, effective_cost_factor_ppm);
        eligible_cost_micro_usd = eligible_cost_micro_usd.saturating_add(cost);
        projected_savings_micro_usd = projected_savings_micro_usd.saturating_add(savings);
        let route = routes
            .entry((request_key.to_string(), selected_tier.to_string()))
            .or_default();
        route.request_count = route.request_count.saturating_add(1);
        route.baseline_cost_micro_usd = route.baseline_cost_micro_usd.saturating_add(cost);
        route.projected_savings_micro_usd =
            route.projected_savings_micro_usd.saturating_add(savings);
        ranked_requests.push(CounterfactualRequest {
            trace_id: trace.id.clone(),
            request_id: trace.id.clone(),
            request_key: request_key.to_string(),
            selected_tier: selected_tier.to_string(),
            baseline_cost_micro_usd: cost,
            projected_savings_micro_usd: savings,
        });
    }

    ranked_requests.sort_by(|left, right| {
        right
            .baseline_cost_micro_usd
            .cmp(&left.baseline_cost_micro_usd)
            .then_with(|| left.request_id.cmp(&right.request_id))
    });
    ranked_uncovered_requests.sort_by(|left, right| {
        right
            .baseline_cost_micro_usd
            .cmp(&left.baseline_cost_micro_usd)
            .then_with(|| left.request_id.cmp(&right.request_id))
    });
    let complete_cost_evidence = unknown_cost_request_count == 0;
    let routes = route_summaries(routes, baseline_cost_micro_usd);
    let uncovered_routes = route_summaries(uncovered_routes, baseline_cost_micro_usd);
    let projected_savings_ppm = ratio_ppm(projected_savings_micro_usd, baseline_cost_micro_usd);
    let targets = target_savings_ppm
        .iter()
        .map(|target| {
            target_report(
                *target,
                effective_cost_factor_ppm,
                baseline_cost_micro_usd,
                projected_savings_ppm,
                complete_cost_evidence,
                &ranked_requests,
            )
        })
        .collect();

    Ok(PolicyCounterfactualReport {
        effective_cost_factor_ppm,
        trace_count: traces.len(),
        known_cost_request_count,
        unknown_cost_request_count,
        eligible_request_count: ranked_requests.len(),
        baseline_cost_micro_usd,
        eligible_cost_micro_usd,
        cost_weighted_coverage_ppm: ratio_ppm(eligible_cost_micro_usd, baseline_cost_micro_usd),
        projected_savings_micro_usd,
        projected_savings_ppm,
        complete_cost_evidence,
        routes,
        uncovered_routes,
        ranked_requests,
        ranked_uncovered_requests,
        targets,
    })
}

fn route_summaries(
    routes: BTreeMap<(String, String), RouteAccumulator>,
    baseline_cost_micro_usd: u64,
) -> Vec<CounterfactualRouteSummary> {
    routes
        .into_iter()
        .map(
            |((request_key, selected_tier), route)| CounterfactualRouteSummary {
                request_key,
                selected_tier,
                request_count: route.request_count,
                baseline_cost_micro_usd: route.baseline_cost_micro_usd,
                cost_share_ppm: ratio_ppm(route.baseline_cost_micro_usd, baseline_cost_micro_usd),
                projected_savings_micro_usd: route.projected_savings_micro_usd,
            },
        )
        .collect()
}

fn strict_usage_join<'a>(
    traces: &[CapturedIngressTrace],
    usage: &'a [CloudUsageRecord],
) -> Result<BTreeMap<&'a str, &'a CloudUsageRecord>> {
    let mut trace_ids = BTreeSet::new();
    for trace in traces {
        if trace.id.trim().is_empty() || !trace_ids.insert(trace.id.as_str()) {
            return Err(BitrouterError::bad_request(
                "counterfactual traces contain an empty or duplicate request id",
            ));
        }
    }
    let mut usage_by_request = BTreeMap::new();
    for record in usage {
        let Some(request_id) = record.request_id.as_deref() else {
            return Err(BitrouterError::bad_request(
                "counterfactual usage row has no request id",
            ));
        };
        if usage_by_request.insert(request_id, record).is_some() {
            return Err(BitrouterError::bad_request(format!(
                "counterfactual usage contains duplicate request id {request_id}"
            )));
        }
    }
    let usage_ids = usage_by_request.keys().copied().collect::<BTreeSet<_>>();
    if trace_ids != usage_ids {
        return Err(BitrouterError::bad_request(
            "counterfactual trace/usage request ids differ",
        ));
    }
    Ok(usage_by_request)
}

fn resolve_tier<'policy, 'key>(
    policy: &'policy PolicyDefinition,
    primary_request_key: &'key str,
    baseline_request_key: &'key str,
    carries_tools: bool,
) -> Option<(&'policy str, &'key str)> {
    let (raw, matched_request_key) = if let Some(tier) = policy.routes.get(primary_request_key) {
        (tier.as_str(), primary_request_key)
    } else if let Some(tier) = policy.routes.get(baseline_request_key) {
        (tier.as_str(), baseline_request_key)
    } else {
        (policy.default_tier.as_deref()?, primary_request_key)
    };
    if carries_tools
        && !policy.tool_safe_tiers.iter().any(|tier| tier == raw)
        && let Some(floor) = policy.tool_use_tier.as_deref()
    {
        return Some((floor, matched_request_key));
    }
    Some((raw, matched_request_key))
}

fn scaled_savings(cost: u64, effective_cost_factor_ppm: u32) -> u64 {
    let savings_factor = PPM.saturating_sub(u64::from(effective_cost_factor_ppm));
    mul_div_floor(cost, savings_factor, PPM)
}

fn ratio_ppm(numerator: u64, denominator: u64) -> u32 {
    if denominator == 0 {
        return 0;
    }
    let ratio = mul_div_floor(numerator, PPM, denominator);
    u32::try_from(ratio.min(PPM)).unwrap_or(PPM as u32)
}

fn target_report(
    target_savings_ppm: u32,
    effective_cost_factor_ppm: u32,
    baseline_cost_micro_usd: u64,
    projected_savings_ppm: u32,
    complete_cost_evidence: bool,
    ranked_requests: &[CounterfactualRequest],
) -> CounterfactualTarget {
    let savings_factor = PPM.saturating_sub(u64::from(effective_cost_factor_ppm));
    let required_coverage_ppm = if target_savings_ppm == 0 {
        0
    } else if savings_factor == 0 {
        u32::MAX
    } else {
        let required = mul_div_ceil(u64::from(target_savings_ppm), PPM, savings_factor);
        u32::try_from(required).unwrap_or(u32::MAX)
    };
    let target_cost = mul_div_ceil(baseline_cost_micro_usd, u64::from(target_savings_ppm), PPM);
    let mut accumulated = 0_u64;
    let mut minimum_request_count = None;
    if target_cost == 0 {
        minimum_request_count = Some(0);
    } else {
        for (index, request) in ranked_requests.iter().enumerate() {
            accumulated = accumulated.saturating_add(request.projected_savings_micro_usd);
            if accumulated >= target_cost {
                minimum_request_count = Some(index.saturating_add(1));
                break;
            }
        }
    }
    CounterfactualTarget {
        target_savings_ppm,
        required_coverage_ppm,
        attainable: complete_cost_evidence && projected_savings_ppm >= target_savings_ppm,
        minimum_request_count,
    }
}

fn mul_div_floor(value: u64, multiplier: u64, divisor: u64) -> u64 {
    if divisor == 0 {
        return u64::MAX;
    }
    let result = u128::from(value).saturating_mul(u128::from(multiplier)) / u128::from(divisor);
    u64::try_from(result).unwrap_or(u64::MAX)
}

fn mul_div_ceil(value: u64, multiplier: u64, divisor: u64) -> u64 {
    if divisor == 0 {
        return u64::MAX;
    }
    let numerator = u128::from(value).saturating_mul(u128::from(multiplier));
    let result =
        numerator.saturating_add(u128::from(divisor).saturating_sub(1)) / u128::from(divisor);
    u64::try_from(result).unwrap_or(u64::MAX)
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;

    use crate::metering::{ChargeStatus, ReconciliationStatus};
    use crate::policy_lock::PolicyDefinition;
    use crate::workflow_state::archive::CloudUsageRecord;
    use crate::workflow_state::ir::{HarnessId, ProtocolKind};
    use crate::workflow_state::real_trace::{CapturedIngressTrace, RealTraceOutcome};

    use super::analyze_policy_counterfactual;

    fn trace(id: &str, assistant_action: Option<&str>) -> CapturedIngressTrace {
        let mut messages = vec![
            serde_json::json!({
                "role": "system",
                "content": "You are an AI assistant tasked with solving command-line tasks in a Linux environment. Format your response as JSON with commands and task_complete."
            }),
            serde_json::json!({"role": "user", "content": "continue"}),
        ];
        if let Some(action) = assistant_action {
            messages.push(serde_json::json!({"role": "assistant", "content": action}));
            messages.push(serde_json::json!({"role": "user", "content": "command output"}));
        }
        CapturedIngressTrace {
            id: id.to_string(),
            captured_at: Some("2026-07-31T00:00:00Z".to_string()),
            harness: HarnessId::Terminus2,
            protocol: ProtocolKind::ChatCompletions,
            method: "POST".to_string(),
            path: "/v1/chat/completions".to_string(),
            headers: BTreeMap::new(),
            raw_body: serde_json::json!({
                "model": "@auto",
                "messages": messages
            }),
            outcome: RealTraceOutcome {
                http_status: 200,
                status: "completed".to_string(),
            },
        }
    }

    fn usage(id: &str, cost: u64) -> CloudUsageRecord {
        CloudUsageRecord {
            request_id: Some(id.to_string()),
            provider_id: "openai-codex".to_string(),
            model_id: "gpt-5.6-sol".to_string(),
            final_charge_micro_usd: Some(cost),
            charge_status: ChargeStatus::Computed,
            reconciliation_status: ReconciliationStatus::NotApplicable,
            ..CloudUsageRecord::default()
        }
    }

    fn policy() -> PolicyDefinition {
        PolicyDefinition {
            tiers: BTreeMap::from([
                ("economy".to_string(), "vendor:economy".into()),
                ("strong".to_string(), "vendor:strong".into()),
            ]),
            routes: BTreeMap::from([(
                "agent_route/v1|unknown|verify|normal".to_string(),
                "economy".to_string(),
            )]),
            default_tier: Some("strong".to_string()),
            tool_use_tier: Some("strong".to_string()),
            tool_safe_tiers: vec!["strong".to_string(), "economy".to_string()],
            ..PolicyDefinition::default()
        }
    }

    #[test]
    fn oracle_reports_cost_weighted_coverage_and_target_steps() {
        let traces = vec![
            trace("opening", None),
            trace(
                "edit",
                Some(r#"{"commands":[{"keystrokes":"sed -i s/a/b/ file"}],"task_complete":false}"#),
            ),
        ];
        let usage = vec![usage("opening", 1_000), usage("edit", 3_000)];

        let report = analyze_policy_counterfactual(&traces, &usage, &policy(), 250_000, &[500_000])
            .expect("counterfactual report");

        assert_eq!(report.baseline_cost_micro_usd, 4_000);
        assert_eq!(report.eligible_request_count, 1);
        assert_eq!(report.eligible_cost_micro_usd, 3_000);
        assert_eq!(report.cost_weighted_coverage_ppm, 750_000);
        assert_eq!(report.projected_savings_micro_usd, 2_250);
        assert_eq!(report.projected_savings_ppm, 562_500);
        assert_eq!(report.targets[0].required_coverage_ppm, 666_667);
        assert!(report.targets[0].attainable);
        assert_eq!(report.targets[0].minimum_request_count, Some(1));
        assert_eq!(report.ranked_requests[0].request_id, "edit");
        assert_eq!(report.ranked_requests[0].baseline_cost_micro_usd, 3_000);
        assert_eq!(report.uncovered_routes.len(), 1);
        assert_eq!(
            report.uncovered_routes[0].request_key,
            "agent_route/v1|unknown|unknown|normal"
        );
        assert_eq!(report.uncovered_routes[0].baseline_cost_micro_usd, 1_000);
        assert_eq!(report.ranked_uncovered_requests[0].request_id, "opening");
    }

    #[test]
    fn oracle_rejects_an_incomplete_trace_usage_join() {
        let error = analyze_policy_counterfactual(
            &[trace("opening", None)],
            &[],
            &policy(),
            250_000,
            &[300_000],
        )
        .expect_err("missing usage must fail closed");

        assert!(error.to_string().contains("trace/usage request ids differ"));
    }
}