mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-05 23:02:10 +03:00
* chore(release): open v3.8.22 development cycle * refactor(dashboard): extract ProviderDetailPageClient — #3501 Phase 0 (#3633) #3501 Phase 0: extract ProviderDetailPageClient + smoke test. Co-authored-by: oyi77 <oyi77@users.noreply.github.com> * refactor(dashboard): extract auth-import modals — #3501 Phase 1a (#3634) #3501 Phase 1a: extract 3 auth-import modal clusters. Co-authored-by: oyi77 <oyi77@users.noreply.github.com> * fix(db): reclassify localDb unexported modules as intentionally-internal (#3499) (#3635) Closes #3499 — reclassify localDb unexported modules as intentionally-internal (audit + honest gate framing). * refactor(db): move call_logs aggregations into callLogStats db module (#3500) (#3636) #3500 slice 1: call_logs aggregations → src/lib/db/callLogStats.ts (Rule #5). Byte-identical queries; TDD 6/6. * refactor(dashboard): extract EditCompatibleNodeModal — #3501 Phase 1b (#3638) #3501 Phase 1b: extract EditCompatibleNodeModal (cycle-safe via leaf constants module). Co-authored-by: oyi77 <oyi77@users.noreply.github.com> * refactor(db): move community_servers SQL into gamification db module (#3500 slice 3) (#3639) #3500 slice 3: community_servers SQL → gamification db module. * refactor(db): move usage_history SQL into usageAnalytics module (#3500 slice 2) (#3644) #3500 slice 2: usage_history/daily_usage_summary SQL → usageAnalytics db module. * refactor(db): move skills UPDATE + db-backups SQL into db modules (#3500 slice 5) (#3647) #3500 slice 5: skills UPDATE (allowlist) + db-backups SQL → db modules. * refactor(db): move usage_logs/semantic_cache/proxy_logs SQL into db modules (#3500 slice 4) (#3648) #3500 slice 4: usage_logs/semantic_cache/proxy_logs SQL → db modules. All internal routes done (2 external by-design remain). * chore(db-gate): reclassify external-DB reads, fully close #3500 (#3649) Closes #3500: reclassify external-DB reads; all internal raw-SQL migrated to db/ modules. * refactor(dashboard): extract pure helpers to providerPageHelpers — #3501 Phase 2 (#3653) #3501 Phase 2: extract pure helpers to providerPageHelpers (leaf, cycle-safe). Co-authored-by: oyi77 <oyi77@users.noreply.github.com> * refactor(dashboard): extract remaining shared helpers to providerPageHelpers — #3501 Phase 2b (#3658) #3501 Phase 2b: extract remaining shared helpers to providerPageHelpers (leaf, cycle-safe). Heavy modals unblocked. Co-authored-by: oyi77 <oyi77@users.noreply.github.com> * fix(reasoning): replay reasoning_content on plain DeepSeek turns (#1682) (#3632) Integrated into release/v3.8.22 * fix(kiro): route enterprise IAM Identity Center accounts to their regional endpoint (#3631) Integrated into release/v3.8.22 * refactor: small code cleanup (#3523) Integrated into release/v3.8.22 * fix(combo): skip same-provider targets on 408/500/502/503/504/524 errors (#3637) Integrated into release/v3.8.22 — circuit-breaker guard added in review (#1731v2) * feat(providers): add MiMoCode free-tier provider with bootstrap JWT auth (#3659) Integrated into release/v3.8.22 — page.tsx conflict resolved + NoAuthAccountCard re-applied to ProviderDetailPageClient in review. MiMoCode endpoint validated live. * Log Responses WebSocket calls in history (#3616) Integrated into release/v3.8.22 — Codex Responses WebSocket call history logging. * Add Claude Code routing preference for unprefixed Claude models (#3540) Integrated into release/v3.8.22 — page.tsx conflict resolved (re-applied toggle to ProviderDetailPageClient) + disable-test updated for catalog drift in review. * docs(changelog): credit #3632/#3631/#3637/#3659/#3540/#3616/#3523 (v3.8.22 targeted review round) * fix(mimocode): add required authHeader:"none" to registry entry (#3659 follow-up) The mimocode RegistryEntry omitted the required authHeader field, which broke typecheck:core (TS2741). Match the no-auth convention (authType:"none" + authHeader:"none") used by veoaifree-web and other free providers. Follow-up to #3659 (@pizzav-xyz). * fix(responses): detect stream readiness for tool-call-only and object-less chunks (#3612) (#3661) Closes #3612 * fix(mitm): remove duplicated 'Command failed:' error prefix (#3641) (#3662) Closes #3641 * fix(cli): honor HERMES_HOME for Hermes Agent config path (#3628) (#3663) Closes #3628 * fix(api): fetch live OpenCode model catalog for no-auth model picker (#3611) (#3664) Closes #3611 * fix(api): flag provider topology error state by current status, not stale history (#3619) (#3666) Closes #3619 * fix(electron): launch peer-stamping server-ws.mjs entrypoint to avoid 403 LOCAL_ONLY (#3386) (#3665) Closes #3386 * fix(dashboard): restore home topology live in-flight pulse (#3507) (#3667) Closes #3507 * fix(oauth): name Kiro/AWS auto-imported accounts and dedupe by profileArn (#3615) (#3671) Closes #3615 * fix(resilience): clear stale transient connection cooldowns on startup (#3625) (#3672) Closes #3625 * fix(i18n): use logical CSS direction utilities for sidebar and key overlays (RTL #3541) (#3670) Closes #3541 * fix(dashboard): honor auto-hide and switch to visible filter on passthrough Test-all (#3610) (#3669) Closes #3610 * refactor(dashboard): extract AddApiKeyModal + EditConnectionModal — #3501 Phase 1c (#3674) #3501 Phase 1c: extract AddApiKeyModal, EditConnectionModal, WebSessionCredentialGuide into components/; god-component 10,166->8,092 LOC. Reconciles the v3.8.22 file-size drift for this file. Co-authored-by: oyi77 <oyi77@users.noreply.github.com> * docs(changelog): reconcile v3.8.22 — credit #3621/#3622 + MiMoCode follow-up roll-up * refactor(dashboard): extract ConnectionRow + ModelCompatPopover + SiliconFlowEndpointModal — #3501 Phase 1d (#3676) #3501 Phase 1d: god-component 8,092->6,838 LOC. Co-authored-by: oyi77 <oyi77@users.noreply.github.com> * feat(obsidian): add WebDAV config route + encrypt creds at rest (#3485 part 1) (#3677) Part 1 of #3485. Adds /api/settings/obsidian/webdav (GET/POST/DELETE) wiring the ready obsidianSync lib, encrypts webdav password + obsidian token at rest, removes the duplicate UI block, drops the KNOWN_MISSING entry. WebDAV file server is part 2. * feat(obsidian): add /api/v1/webdav file server for Obsidian vault sync (#3485 part 2) (#3678) Part 2 of #3485. WebDAV server (PROPFIND/GET/PUT/DELETE/MKCOL/MOVE/OPTIONS) handled in the custom server layer (standalone-server-ws.mjs) since the App Router cannot export WebDAV methods. Basic-Auth (constant-time), path-traversal hardened, password decrypt ported from encryption.ts (parity-tested), DATA_DIR resolution parity-tested against dataPaths.ts. End-to-end Obsidian-over-Tailscale validation is a live VPS step (Rule #18). * fix(combo): stop premature context compaction — real auto-combo windows + per-target compression limit (#3680) Integrated into release/v3.8.22 * feat(dashboard): deactivate/activate accounts from the quota overview (#3675) Integrated into release/v3.8.22 * fix(dashboard): close review gaps in bulk provider connection actions (#3271 follow-up) (#3673) Integrated into release/v3.8.22 — page.tsx conflict (god-component split #3501) resolved by re-applying the bulk-action deltas to ProviderDetailPageClient.tsx * refactor(dashboard): extract useModelCompatState hook + model sections — #3501 Phase 1e (#3683) #3501 Phase 1e: extract useModelCompatState hook (unblocks the model sections) + ModelRow/PassthroughModelsSection/PassthroughModelRow/CustomModelsSection/CompatibleModelsSection. god-component 6,838->4,921 LOC. Co-authored-by: oyi77 <oyi77@users.noreply.github.com> * refactor(dashboard): extract useProviderConnections/Settings/Models hooks — #3501 Phase 1f (#3684) #3501 Phase 1f: god-component 4,948->4,062 LOC. Connection state+handlers, settings, and model metadata moved into hooks/. Co-authored-by: oyi77 <oyi77@users.noreply.github.com> * chore(release): v3.8.22 CHANGELOG + env-doc sync - Set release date in CHANGELOG [3.8.22] to 2026-06-11 - Add HERMES_HOME to .env.example (from #3628/#3663) - Add HERMES_HOME + OMNIROUTE_PREFER_CLAUDE_CODE_FOR_UNPREFIXED_CLAUDE_MODELS to ENVIRONMENT.md (#3628/#3540) * docs(changelog): credit #3673 + #3675 — leninejunior bulk-actions + quota-toggle --------- Co-authored-by: oyi77 <oyi77@users.noreply.github.com> Co-authored-by: Abhishek Divekar <adivekar@utexas.edu> Co-authored-by: NOXX - Commiter <artur1992123@mail.ru> Co-authored-by: Nicolas Lorin <androw95220@gmail.com> Co-authored-by: Hernan Javier Ardila Sanchez <hjasgr@gmail.com> Co-authored-by: PizzaV <103120356+pizzav-xyz@users.noreply.github.com> Co-authored-by: kkkayye <98376609+kkkayye@users.noreply.github.com> Co-authored-by: Witroch4 <witalo_rocha@hotmail.com> Co-authored-by: Lenine Júnior <lenine@engrene.com.br>
505 lines
23 KiB
Markdown
505 lines
23 KiB
Markdown
---
|
||
title: "OmniRoute Auto-Combo Engine"
|
||
version: 3.8.2
|
||
lastUpdated: 2026-05-13
|
||
---
|
||
|
||
# OmniRoute Auto-Combo Engine
|
||
|
||
> **For Users**: Looking for a quick start? See the [Auto-Combo User Guide](../getting-started/AUTO-COMBO-GUIDE.md) for simple explanations and examples.
|
||
|
||
> Self-managing model chains with adaptive scoring + zero-config auto-routing
|
||
|
||
## Zero-Config Auto-Routing (`auto/` prefix)
|
||
|
||
> **NEW:** No combo creation required. Use `auto/` prefix directly in any client.
|
||
|
||
### Quick Examples
|
||
|
||
| Model ID | Variant | Behavior |
|
||
| -------------- | ------- | ------------------------------------------------------------------------ |
|
||
| `auto` | default | All connected providers, LKGP strategy, balanced weights |
|
||
| `auto/coding` | coding | Quality-first weights, suitable for code generation |
|
||
| `auto/fast` | fast | Low-latency weighted selection |
|
||
| `auto/cheap` | cheap | Cost-optimized routing (lowest cost first) |
|
||
| `auto/offline` | offline | Favors providers with highest quota availability |
|
||
| `auto/smart` | smart | Quality-first + higher exploration rate (10%) for better model discovery |
|
||
| `auto/lkgp` | lkgp | Explicit LKGP (same as default `auto`) |
|
||
|
||
**How to use:**
|
||
|
||
```bash
|
||
# Any IDE or CLI tool that supports OpenAI format
|
||
Base URL: http://localhost:20128/v1
|
||
API Key: <your-endpoint-key>
|
||
|
||
# In your code/config, set model to:
|
||
model: "auto" # balanced default
|
||
model: "auto/coding" # best for coding tasks
|
||
model: "auto/fast" # fastest available
|
||
model: "auto/cheap" # cheapest per token
|
||
```
|
||
|
||
**What happens:**
|
||
|
||
1. OmniRoute detects `auto/` prefix in `src/sse/handlers/chat.ts`
|
||
2. Queries all **active provider connections** from the database
|
||
3. Filters to those with valid credentials (API key or OAuth token)
|
||
4. Determines the model per connection (`connection.defaultModel` or provider's first model)
|
||
5. Builds a **virtual combo** in-memory (not stored in DB)
|
||
6. Routes using the selected variant's weight profile + LKGP strategy
|
||
|
||
**Key properties:**
|
||
|
||
- ✅ **Always-on:** No toggle, no combo creation, no configuration needed
|
||
- ✅ **Dynamic:** Reflects current connected providers automatically
|
||
- ✅ **Session stickiness:** LKGP ensures last successful provider is prioritized
|
||
- ✅ **Multi-account aware:** Each provider connection becomes a separate candidate
|
||
- ✅ **No DB writes:** Virtual combo exists only for the request, zero persistence overhead
|
||
|
||
**Behind the scenes:**
|
||
|
||
```txt
|
||
Request: { model: "auto/coding" }
|
||
↓
|
||
src/sse/handlers/chat.ts detects prefix
|
||
↓
|
||
createVirtualAutoCombo('coding') → candidatePool from active connections
|
||
↓
|
||
handleComboChat (same engine as persisted combos)
|
||
↓
|
||
Auto-scoring selects best provider/model per request
|
||
```
|
||
|
||
**Implementation files:**
|
||
|
||
| File | Purpose |
|
||
| --------------------------------------------------------- | ----------------------------------------- |
|
||
| `open-sse/services/autoCombo/autoPrefix.ts` | Prefix parser (`parseAutoPrefix`) |
|
||
| `open-sse/services/autoCombo/virtualFactory.ts` | Creates virtual `AutoComboConfig` objects |
|
||
| `open-sse/services/autoCombo/providerRegistryAccessor.ts` | Test hook for mocking provider registry |
|
||
| `src/sse/handlers/chat.ts` | Integration: auto prefix short-circuit |
|
||
| `src/shared/constants/providers.ts` | `SYSTEM_PROVIDERS.auto` system entry |
|
||
|
||
## How It Works (Persisted Auto-Combos)
|
||
|
||
The Auto-Combo Engine dynamically selects the best provider/model for each request using a **9-factor scoring function** (defined in `open-sse/services/autoCombo/scoring.ts` → `DEFAULT_WEIGHTS`). All weights sum to **1.0**.
|
||
|
||

|
||
|
||
> Source: [diagrams/auto-combo-9factor.mmd](../diagrams/auto-combo-9factor.mmd)
|
||
|
||
| Factor | Default Weight | Description |
|
||
| :----------------- | :------------- | :------------------------------------------------------------------------------------------------- |
|
||
| `health` | 0.22 | Health score from circuit breaker (CLOSED=1.0, HALF_OPEN=0.5, OPEN=0.0) |
|
||
| `quota` | 0.17 | Remaining quota / rate-limit headroom [0..1] |
|
||
| `costInv` | 0.17 | Inverse **blended** cost (60% input + 40% output token price, normalized) — cheaper = higher score |
|
||
| `latencyInv` | 0.13 | Inverse p95 latency normalized to pool — faster = higher score |
|
||
| `taskFit` | 0.08 | Task-type fitness (coding, review, planning, analysis, debugging, docs) |
|
||
| `specificityMatch` | 0.08 | Match between request specificity (manifest hint) and model tier |
|
||
| `stability` | 0.05 | Variance-based stability (low latency stdDev / error rate) |
|
||
| `tierPriority` | 0.05 | Account-tier priority — Ultra=1.0, Pro=0.67, Standard=0.33, Free=0.0 |
|
||
| `tierAffinity` | 0.05 | Affinity between the candidate's tier and the manifest-recommended tier |
|
||
|
||
**Sum:** `0.22 + 0.17 + 0.17 + 0.13 + 0.08 + 0.08 + 0.05 + 0.05 + 0.05 = 1.0` (validated by `validateWeights()`).
|
||
|
||
## Mode Packs
|
||
|
||
Four pre-defined weight profiles in `open-sse/services/autoCombo/modePacks.ts`. Each pack overrides the default weights to bias selection toward a specific goal. Below are the **full weight tables per pack** (each row sums to 1.0).
|
||
|
||
| Factor | ship-fast | cost-saver | quality-first | offline-friendly |
|
||
| :----------- | :-------- | :--------- | :------------ | :--------------- |
|
||
| quota | 0.14 | 0.14 | 0.10 | **0.37** |
|
||
| health | 0.28 | 0.19 | 0.18 | 0.28 |
|
||
| costInv | 0.05 | **0.37** | 0.05 | 0.10 |
|
||
| latencyInv | **0.32** | 0.05 | 0.05 | 0.05 |
|
||
| taskFit | 0.10 | 0.10 | **0.37** | 0.00 |
|
||
| stability | 0.00 | 0.05 | 0.15 | 0.10 |
|
||
| tierPriority | 0.05 | 0.05 | 0.05 | 0.05 |
|
||
|
||
Notes:
|
||
|
||
- `tierAffinity` and `specificityMatch` are not set in mode packs — `calculateScore()` treats them as `?? 0` when absent.
|
||
- Each pack's emphasis at a glance:
|
||
- **ship-fast** → latencyInv 0.32 + health 0.28 (low-latency, healthy connections)
|
||
- **cost-saver** → costInv 0.37 (cheapest tokens win)
|
||
- **quality-first** → taskFit 0.37 + stability 0.15 (best model for the task, consistent)
|
||
- **offline-friendly** → quota 0.37 + health 0.28 (max headroom regardless of speed/cost)
|
||
|
||
## All Routing Strategies
|
||
|
||
OmniRoute's combo engine supports **14 routing strategies** (declared in `src/shared/constants/routingStrategies.ts` → `ROUTING_STRATEGY_VALUES`). The Auto Combo engine itself is exposed under the `auto` strategy; the others are available for persisted combos.
|
||
|
||
| Strategy | Description |
|
||
| :------------------ | :----------------------------------------------------------------- |
|
||
| `priority` | First-target ordered list with explicit priority |
|
||
| `weighted` | Weighted random by per-target weight |
|
||
| `round-robin` | Cycle through targets in order |
|
||
| `context-relay` | Hand off context across targets (long conversations) |
|
||
| `fill-first` | Fill each target's quota before moving to next |
|
||
| `p2c` | Power-of-2-choices random load balancing |
|
||
| `random` | Uniform random selection |
|
||
| `least-used` | Pick target with lowest current load |
|
||
| `cost-optimized` | Minimize $ per request given catalog pricing |
|
||
| `reset-aware` ⭐ | Prioritize by quota reset time — short reset windows ranked higher |
|
||
| `strict-random` | Random without deduplication of repeats |
|
||
| `auto` | Use Auto Combo scoring (9-factor) — **recommended** |
|
||
| `lkgp` | Last-Known-Good Path (sticky route to last successful target) |
|
||
| `context-optimized` | Pick target with best fit for current context size |
|
||
|
||
⭐ = New in v3.8.0
|
||
|
||
## Virtual Auto-Combo Factory
|
||
|
||
The Auto Combo engine doesn't require pre-defined combos. Instead, `open-sse/services/autoCombo/virtualFactory.ts` builds candidates on-the-fly:
|
||
|
||
1. Pulls `getProviderConnections({ isActive: true })` (all enabled connections)
|
||
2. Filters to those with valid credentials (API key or non-expired OAuth token via `hasUsableOAuthToken()`)
|
||
3. Cross-references with `getProviderRegistry()` for model availability + pricing
|
||
4. For each tuple `(provider, model, connection)`, builds a `VirtualAutoComboCandidate`
|
||
5. Picks `connection.defaultModel` (or the registry's first model) as the dispatch target
|
||
6. Scores each candidate using the 9-factor `scorePool()` and the variant's weight pack
|
||
7. Returns the resulting in-memory `AutoComboConfig` for `handleComboChat()` — never persisted to DB
|
||
|
||
This means **adding a new provider with `auto/*` enabled automatically expands the candidate pool** — no manual combo editing needed. The virtual combo is rebuilt per request, so newly-added or newly-healthy connections are picked up immediately.
|
||
|
||
## Self-Healing
|
||
|
||
- **Temporary exclusion**: Score < 0.2 → excluded for 5 min (progressive backoff, max 30 min)
|
||
- **Circuit breaker awareness**: OPEN → auto-excluded; HALF_OPEN → probe requests
|
||
- **Incident mode**: >50% OPEN → disable exploration, maximize stability
|
||
- **Cooldown recovery**: After exclusion, first request is a "probe" with reduced timeout
|
||
|
||
## Bandit Exploration
|
||
|
||
5% of requests (configurable) are routed to random providers for exploration. Disabled in incident mode.
|
||
|
||
## API
|
||
|
||
There is **no dedicated `POST /api/combos/auto` endpoint** — Auto-Combo is consumed in two ways:
|
||
|
||
1. **Zero-config (recommended):** Send any chat completion request with `model: "auto"` or `model: "auto/<variant>"`. The virtual factory builds the combo per request — no persistence, no API calls needed.
|
||
|
||
2. **Persisted combo with `strategy: "auto"`:** Create a regular combo via `POST /api/combos` and set `strategy: "auto"` plus `config.auto.weights` / `config.auto.candidatePool`. The same scoring engine is used; the combo is stored in `combos` and reusable by ID.
|
||
|
||
For discovery, `GET /api/combos/auto` lists every variant with its resolved candidate pool plus `context_length` / `max_output_tokens` — the MAX across the candidate pool's windows. Clients (e.g. the opencode plugin) must advertise these values instead of `0`: a zero context disables opencode's auto-compaction entirely, letting sessions grow until the gateway's history purge destroys context. MAX is safe to advertise because the auto-combo context pre-filter routes oversized requests to large-window candidates.
|
||
|
||
```bash
|
||
# Zero-config usage (no combo creation)
|
||
curl -X POST http://localhost:20128/v1/chat/completions \
|
||
-H "Authorization: Bearer <key>" \
|
||
-H "Content-Type: application/json" \
|
||
-d '{"model":"auto/coding","messages":[{"role":"user","content":"Hello"}]}'
|
||
|
||
# Persisted auto combo via the regular combos endpoint
|
||
curl -X POST http://localhost:20128/api/combos \
|
||
-H "Content-Type: application/json" \
|
||
-d '{"id":"my-auto","name":"Auto Coder","strategy":"auto","config":{"auto":{"candidatePool":["anthropic","google","openai"],"weights":{"quota":0.15,"health":0.3,"costInv":0.05,"latencyInv":0.35,"taskFit":0.1,"stability":0,"tierPriority":0.05}}}}'
|
||
```
|
||
|
||
### Auto router strategies
|
||
|
||
Persisted `strategy: "auto"` combos can set `config.routerStrategy` (or legacy
|
||
`config.auto.routerStrategy`) to one of:
|
||
|
||
- `rules` — default weighted scoring
|
||
- `cost` / `eco` — cheapest healthy provider
|
||
- `latency` / `fast` — lowest p95 latency with reliability penalty
|
||
- `sla-aware` / `sla` — prefer candidates that satisfy p95 latency, error-rate, and optional
|
||
cost SLOs
|
||
- `lkgp` — last known good provider first
|
||
|
||
### Router strategies in detail
|
||
|
||
The auto-combo engine exposes 5 pluggable **RouterStrategy** implementations that
|
||
you can swap via `config.routerStrategy` (or the legacy `config.auto.routerStrategy`).
|
||
Each strategy picks one provider from the candidate pool, given a `RoutingContext`
|
||
(task type, tool/vision hints, token estimate, optional SLA policy, optional
|
||
last-known-good provider).
|
||
|
||
#### 1. `rules` (default) — 6-factor weighted scoring
|
||
|
||
Wraps the existing scoring engine. Filters out `OPEN` circuit-breaker
|
||
candidates, then runs `scorePool()` with the current task type and `getTaskFitness()`,
|
||
picking the top-scoring provider.
|
||
|
||
```ts
|
||
class RulesStrategyImpl implements RouterStrategy {
|
||
readonly name = "rules";
|
||
readonly description =
|
||
"6-factor weighted scoring: quota, health, cost, latency, taskFit, stability";
|
||
|
||
select(pool, context) {
|
||
const eligible = pool.filter((c) => c.circuitBreakerState !== "OPEN");
|
||
const ranked = scorePool(eligible.length > 0 ? eligible : pool, context.taskType, undefined, getTaskFitness);
|
||
return { provider: ranked[0].provider, /* ... */ };
|
||
}
|
||
}
|
||
```
|
||
|
||
**When to use**: Default. Use when you want a balanced trade-off across all signals.
|
||
|
||
**Alias**: `rules` (no alias)
|
||
|
||
---
|
||
|
||
#### 2. `cost` / `eco` — cheapest healthy provider
|
||
|
||
Sorts the candidate pool by `costPer1MTokens` (ascending) and picks the cheapest.
|
||
Filters out `OPEN` candidates first.
|
||
|
||
```ts
|
||
class CostStrategyImpl implements RouterStrategy {
|
||
readonly name = "cost";
|
||
readonly description = "Always selects cheapest available provider";
|
||
|
||
select(pool, context) {
|
||
const healthy = pool.filter((c) => c.circuitBreakerState !== "OPEN");
|
||
const sorted = [...healthy].sort((a, b) => a.costPer1MTokens - b.costPer1MTokens);
|
||
return { provider: sorted[0].provider, /* ... */ };
|
||
}
|
||
}
|
||
```
|
||
|
||
**When to use**: Cost-sensitive workloads, batch processing, or background jobs.
|
||
|
||
**Aliases**: `cost`, `eco`
|
||
|
||
---
|
||
|
||
#### 3. `latency` / `fast` — lowest p95 latency with reliability penalty
|
||
|
||
Sorts by `p95LatencyMs + (errorRate * 1000)`. The error-rate penalty ensures
|
||
unreliable providers are ranked lower even if their nominal latency is low.
|
||
|
||
```ts
|
||
class LatencyStrategyImpl implements RouterStrategy {
|
||
readonly name = "latency";
|
||
readonly description = "Prioritizes lowest p95 latency with reliability weighting";
|
||
|
||
select(pool, context) {
|
||
const healthy = pool.filter((c) => c.circuitBreakerState !== "OPEN");
|
||
const sorted = [...healthy].sort((a, b) =>
|
||
(a.p95LatencyMs + a.errorRate * 1000) - (b.p95LatencyMs + b.errorRate * 1000)
|
||
);
|
||
return { provider: sorted[0].provider, /* ... */ };
|
||
}
|
||
}
|
||
```
|
||
|
||
**When to use**: Latency-sensitive workloads like real-time chat, autocomplete, or
|
||
interactive coding assistants.
|
||
|
||
**Aliases**: `latency`, `fast`
|
||
|
||
---
|
||
|
||
#### 4. `sla-aware` / `sla` — latency/error/cost SLO compliance
|
||
|
||
Scores each candidate by how well it satisfies the configured SLO policy:
|
||
|
||
| Factor | Weight | Formula |
|
||
|--------|--------|---------|
|
||
| Latency score | 35% | `threshold / max(value, ε)` |
|
||
| Error score | 35% | `threshold / max(value, ε)` |
|
||
| Health score | 15% | `1.0` (CLOSED) / `0.5` (HALF_OPEN) / `0.0` (OPEN) |
|
||
| Cost score | 10% | `threshold / max(value, ε)` or inverse normalized |
|
||
| Stability score | 5% | inverse normalized latency stddev |
|
||
|
||
When `hardConstraints: true`, candidates are sorted primarily by **violation score**
|
||
(how far they exceed any SLO), then by composite score. Otherwise it's just
|
||
the composite score.
|
||
|
||
```ts
|
||
class SLAStrategyImpl implements RouterStrategy {
|
||
readonly name = "sla-aware";
|
||
readonly description = "Selects the provider most likely to satisfy latency, error-rate, and cost SLOs";
|
||
|
||
select(pool, context) {
|
||
// ... scores each candidate against policy: { targetP95Ms, maxErrorRate, maxCostPer1MTokens, hardConstraints }
|
||
}
|
||
}
|
||
```
|
||
|
||
**SLA fields** (set on the combo config):
|
||
|
||
```json
|
||
{
|
||
"strategy": "auto",
|
||
"config": {
|
||
"routerStrategy": "sla-aware",
|
||
"slaTargetP95Ms": 1500,
|
||
"slaMaxErrorRate": 0.05,
|
||
"slaMaxCostPer1MTokens": 5,
|
||
"slaHardConstraints": true
|
||
}
|
||
}
|
||
```
|
||
|
||
**When to use**: Production workloads with strict latency, error-rate, or cost budgets.
|
||
|
||
**Aliases**: `sla-aware`, `sla`
|
||
|
||
---
|
||
|
||
#### 5. `lkgp` — last known good provider first
|
||
|
||
Tries the **last known good provider** (if set) first, then falls back to the
|
||
`rules` strategy. Useful for session stickiness — the same provider handles
|
||
follow-up requests in a conversation.
|
||
|
||
```ts
|
||
class LKGPStrategyImpl implements RouterStrategy {
|
||
readonly name = "lkgp";
|
||
readonly description = "Tries last known good provider first, then falls back to rules";
|
||
|
||
select(pool, context) {
|
||
if (context.lkgpEnabled === false) {
|
||
return getStrategy("rules").select(pool, context);
|
||
}
|
||
|
||
if (context.lastKnownGoodProvider) {
|
||
const candidates = pool.filter(
|
||
(c) => c.provider === context.lastKnownGoodProvider && c.circuitBreakerState !== "OPEN"
|
||
);
|
||
if (candidates.length > 0) {
|
||
return { provider: candidates[0].provider, /* ... */ };
|
||
}
|
||
}
|
||
|
||
// Fallback to rules strategy
|
||
return getStrategy("rules").select(pool, context);
|
||
}
|
||
}
|
||
```
|
||
|
||
**When to use**: Multi-turn conversations where you want the same provider to handle
|
||
follow-up requests (e.g., for caching, context continuity, or pricing consistency).
|
||
|
||
**Alias**: `lkgp` (no alias)
|
||
|
||
---
|
||
|
||
### Custom router strategies
|
||
|
||
You can register your own `RouterStrategy` implementation via the public API:
|
||
|
||
```ts
|
||
import { registerStrategy, type RouterStrategy } from "@omniroute/open-sse/services/autoCombo/routerStrategy";
|
||
|
||
class MyCustomStrategy implements RouterStrategy {
|
||
readonly name = "my-custom";
|
||
readonly description = "My custom routing strategy";
|
||
|
||
select(pool, context) {
|
||
// Your routing logic here
|
||
return {
|
||
provider: pool[0].provider,
|
||
model: pool[0].model,
|
||
strategy: this.name,
|
||
reason: "MyCustomStrategy: ...",
|
||
candidatesConsidered: pool.length,
|
||
finalScore: 1.0,
|
||
};
|
||
}
|
||
}
|
||
|
||
registerStrategy("my-custom", new MyCustomStrategy());
|
||
```
|
||
|
||
Then use it:
|
||
|
||
```json
|
||
{
|
||
"strategy": "auto",
|
||
"config": {
|
||
"routerStrategy": "my-custom"
|
||
}
|
||
}
|
||
```
|
||
|
||
---
|
||
|
||
### Router strategy selection guide
|
||
|
||
| Use case | Strategy | Reason |
|
||
|---------|----------|--------|
|
||
| Balanced workload | `rules` | Default — considers all factors |
|
||
| Minimize cost | `cost` | Always picks cheapest |
|
||
| Minimize latency | `latency` | Picks fastest reliable provider |
|
||
| Strict SLOs | `sla-aware` | Filters by p95/error/cost thresholds |
|
||
| Multi-turn chat | `lkgp` | Session stickiness |
|
||
|
||
SLA-aware fields:
|
||
|
||
```json
|
||
{
|
||
"strategy": "auto",
|
||
"config": {
|
||
"routerStrategy": "sla-aware",
|
||
"slaTargetP95Ms": 1500,
|
||
"slaMaxErrorRate": 0.05,
|
||
"slaMaxCostPer1MTokens": 5,
|
||
"slaHardConstraints": true
|
||
}
|
||
}
|
||
```
|
||
|
||
## Task Fitness
|
||
|
||
30+ models scored across 6 task types (`coding`, `review`, `planning`, `analysis`, `debugging`, `documentation`). Supports wildcard patterns (e.g., `*-coder` → high coding score).
|
||
|
||
## Auto Variants Recap
|
||
|
||
Including the bare `auto` (default) plus the 6 `AutoVariant` values declared in `autoPrefix.ts`, there are **7 invokable model IDs**:
|
||
|
||
`auto`, `auto/coding`, `auto/fast`, `auto/cheap`, `auto/offline`, `auto/smart`, `auto/lkgp`
|
||
|
||
(`AutoVariant` itself enumerates 6 values; the 7th option is "no variant" — bare `auto` — handled by `parseAutoPrefix()` as `variant: undefined`.)
|
||
|
||
## How tiers fit Auto-Combo
|
||
|
||
The 9-factor scoring function (`open-sse/services/autoCombo/scoring.ts`) treats tier
|
||
membership as one signal via the `tierPriority` weight. Default weights (from `DEFAULT_WEIGHTS`):
|
||
|
||
| Factor | Default weight | Notes |
|
||
| ------------------------ | -------------- | -------------------------------------------------------------- |
|
||
| Tier priority | 0.05 | Tier 1 premium → higher score |
|
||
| Latency (p50 inverse) | 0.35 | Fastest wins |
|
||
| Cost ($/1M inverse) | 0.20 | Cheapest **blended** price wins (60% input + 40% output ratio) |
|
||
| Recent health/error rate | 0.15 | Unhealthy deprioritized |
|
||
| Quota remaining | 0.10 | Near-exhausted deprioritized |
|
||
| Context window match | 0.08 | Penalizes short windows |
|
||
| Task fitness | 0.10 | Coding → coding-specialist models |
|
||
| Stability | 0.00 | Disabled by default |
|
||
|
||
Tier alone does **not** force Tier 1 first — if Tier 1 latency is bad or
|
||
cost-vs-quality is suboptimal, Tier 2 wins. To force tier ordering, use combo
|
||
strategy `priority` and arrange providers by tier.
|
||
|
||
To strongly favor Tier 1 (subscription), increase `tierPriority` weight:
|
||
|
||
```json
|
||
{
|
||
"strategy": "auto",
|
||
"config": { "auto": { "weights": { "tierPriority": 0.3, "costInv": 0.05 } } }
|
||
}
|
||
```
|
||
|
||
See `docs/marketing/TIERS.md` for tier definitions and provider classification.
|
||
|
||
## Files
|
||
|
||
| File | Purpose |
|
||
| :-------------------------------------------------------- | :------------------------------------------------------------------------- |
|
||
| `open-sse/services/autoCombo/scoring.ts` | 9-factor scoring function, `DEFAULT_WEIGHTS`, pool norm |
|
||
| `open-sse/services/autoCombo/taskFitness.ts` | Model × task fitness lookup |
|
||
| `open-sse/services/autoCombo/engine.ts` | Selection logic, bandit, budget cap |
|
||
| `open-sse/services/autoCombo/selfHealing.ts` | Exclusion, probes, incident mode |
|
||
| `open-sse/services/autoCombo/modePacks.ts` | 4 weight profiles (ship-fast, cost-saver, quality-first, offline-friendly) |
|
||
| `open-sse/services/autoCombo/autoPrefix.ts` | `auto/` prefix parser + 6 variants |
|
||
| `open-sse/services/autoCombo/virtualFactory.ts` | Builds in-memory `AutoComboConfig` from live connections |
|
||
| `open-sse/services/autoCombo/providerRegistryAccessor.ts` | Test hook for mocking provider registry |
|
||
| `src/shared/constants/routingStrategies.ts` | `ROUTING_STRATEGY_VALUES` (14 strategies) |
|
||
| `src/sse/handlers/chat.ts` | Integration: auto-prefix short-circuit |
|