RouterConfig

Defined in: packages/ai.matey.types/src/router.ts:94

Router configuration options.

Properties

capabilityBasedRouting?

readonly optional capabilityBasedRouting: boolean

Defined in: packages/ai.matey.types/src/router.ts:155

Enable capability-based routing. When enabled, the router will select backends based on their model capabilities matching the request requirements.

Default

false

---

capabilityCacheDuration?

readonly optional capabilityCacheDuration: number

Defined in: packages/ai.matey.types/src/router.ts:178

Cache duration for model capability data in milliseconds.

Default

3600000 (1 hour)

---

circuitBreakerThreshold?

readonly optional circuitBreakerThreshold: number

Defined in: packages/ai.matey.types/src/router.ts:129

Number of consecutive failures before circuit breaker opens.

Default

5

---

circuitBreakerTimeout?

readonly optional circuitBreakerTimeout: number

Defined in: packages/ai.matey.types/src/router.ts:135

Time to wait before attempting to close circuit breaker (milliseconds).

Default

60000

---

customFallback?

readonly optional customFallback: CustomFallbackFunction

Defined in: packages/ai.matey.types/src/router.ts:188

Custom fallback function.

---

customRouter?

readonly optional customRouter: CustomRoutingFunction

Defined in: packages/ai.matey.types/src/router.ts:183

Custom routing function.

---

defaultBackend?

readonly optional defaultBackend: string

Defined in: packages/ai.matey.types/src/router.ts:110

Default backend to use if routing doesn’t select one.

---

enableCircuitBreaker?

readonly optional enableCircuitBreaker: boolean

Defined in: packages/ai.matey.types/src/router.ts:123

Enable circuit breaker pattern.

Default

false

---

fallbackStrategy?

readonly optional fallbackStrategy: FallbackStrategy

Defined in: packages/ai.matey.types/src/router.ts:105

Fallback strategy when primary backend fails.

Default

'sequential'

---

healthCheckInterval?

readonly optional healthCheckInterval: number

Defined in: packages/ai.matey.types/src/router.ts:117

Interval for health checking backends (milliseconds). Set to 0 to disable health checks.

Default

0

---

modelTranslation?

readonly optional modelTranslation: ModelTranslationConfig

Defined in: packages/ai.matey.types/src/router.ts:195

Model translation configuration for fallback scenarios. Controls how model names are translated when falling back to different backends.

Default

{ strategy: 'hybrid', warnOnDefault: true, strictMode: false }

---

optimization?

readonly optional optimization: "cost" | "speed" | "quality" | "balanced"

Defined in: packages/ai.matey.types/src/router.ts:162

Optimization strategy for capability-based routing. Determines how to weigh cost, speed, and quality when selecting models.

Default

'balanced'

---

optimizationWeights?

readonly optional optimizationWeights: object

Defined in: packages/ai.matey.types/src/router.ts:168

Custom optimization weights for capability-based routing. Must sum to 1.0. Overrides optimization preset.

cost

cost: number

quality

quality: number

speed

speed: number

---

routingStrategy?

readonly optional routingStrategy: RoutingStrategy

Defined in: packages/ai.matey.types/src/router.ts:99

Primary routing strategy.

Default

'explicit'

---

trackCost?

readonly optional trackCost: boolean

Defined in: packages/ai.matey.types/src/router.ts:147

Track cost per backend (requires backends to implement estimateCost).

Default

false

---

trackLatency?

readonly optional trackLatency: boolean

Defined in: packages/ai.matey.types/src/router.ts:141

Track latency statistics per backend.

Default

true