Router

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

Router manages multiple backend adapters with intelligent routing.

Extends

• BackendAdapter<unknown, unknown>

Properties

config

readonly config: RouterConfig

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

Router configuration.

---

metadata

readonly metadata: AdapterMetadata

Defined in: packages/ai.matey.types/src/adapters.ts:268

Adapter metadata for identification and capabilities.

Inherited from

BackendAdapter.metadata

Methods

checkHealth()

Call Signature

checkHealth(): Promise<Record<string, boolean>>

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

Check health of all backends.

Returns

Promise<Record<string, boolean>>

Call Signature

checkHealth(name): Promise<boolean>

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

Check health of specific backend.

Parameters

name

string

Returns

Promise<boolean>

---

clone()

clone(config): Router

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

Clone router with new configuration.

Parameters

config

Partial<RouterConfig>

Returns

Router

---

closeCircuitBreaker()

closeCircuitBreaker(name): void

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

Manually close circuit breaker for a backend.

Parameters

name

string

Returns

void

---

dispatchParallel()

dispatchParallel(request, options?, signal?): Promise<ParallelDispatchResult>

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

Dispatch request to multiple backends in parallel.

Parameters

request

IRChatRequest

options?

ParallelDispatchOptions

signal?

AbortSignal

Returns

Promise<ParallelDispatchResult>

---

dispose()

dispose(): void

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

Clean up resources.

Returns

void

---

estimateCost()?

optional estimateCost(request): Promise<number | null>

Defined in: packages/ai.matey.types/src/adapters.ts:342

Optional: Estimate cost for a request.

Parameters

request

IRChatRequest

IR request to estimate cost for

Returns

Promise<number | null>

Estimated cost in USD (or null if unavailable)

Inherited from

BackendAdapter.estimateCost

---

execute()

execute(request, signal?): Promise<IRChatResponse>

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

Execute request with automatic backend selection and fallback.

Parameters

request

IRChatRequest

signal?

AbortSignal

Returns

Promise<IRChatResponse>

Overrides

BackendAdapter.execute

---

executeStream()

executeStream(request, signal?): IRChatStream

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

Execute streaming request with automatic backend selection and fallback.

Parameters

request

IRChatRequest

signal?

AbortSignal

Returns

IRChatStream

Overrides

BackendAdapter.executeStream

---

fromIR()

fromIR(request): unknown

Defined in: packages/ai.matey.types/src/adapters.ts:283

Convert universal IR request to provider-specific format.

Useful for:

• Debugging: Inspect what will be sent to the provider
• Testing: Test conversion logic without making API calls
• Transparency: See provider-specific request structure

Parameters

request

IRChatRequest

Universal IR request

Returns

unknown

Provider-specific request object

Throws

If request is invalid for this provider

Throws

If conversion fails

Inherited from

BackendAdapter.fromIR

---

get()

get(name): BackendAdapter<unknown, unknown> | undefined

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

Get a registered backend adapter.

Parameters

name

string

Returns

BackendAdapter<unknown, unknown> | undefined

---

getBackendInfo()

Call Signature

getBackendInfo(): BackendInfo[]

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

Get information about all registered backends.

Returns

BackendInfo[]

Call Signature

getBackendInfo(name): BackendInfo | undefined

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

Get information about specific backend.

Parameters

name

string

Returns

BackendInfo | undefined

---

getBackendStats()

getBackendStats(name): BackendStats | undefined

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

Get statistics for specific backend.

Parameters

name

string

Returns

BackendStats | undefined

---

getFallbackChain()

getFallbackChain(): readonly string[]

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

Get current fallback chain.

Returns

readonly string[]

---

getModelMapping()

getModelMapping(): ModelMapping

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

Get current model mapping.

Returns

ModelMapping

---

getModelPatterns()

getModelPatterns(): readonly ModelPatternMapping[]

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

Get current model patterns.

Returns

readonly ModelPatternMapping[]

---

getStats()

getStats(): RouterStats

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

Get router statistics.

Returns

RouterStats

---

has()

has(name): boolean

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

Check if backend is registered.

Parameters

name

string

Returns

boolean

---

healthCheck()?

optional healthCheck(): Promise<boolean>

Defined in: packages/ai.matey.types/src/adapters.ts:334

Optional: Health check to verify backend is available.

Returns

Promise<boolean>

true if backend is healthy and available

Inherited from

BackendAdapter.healthCheck

---

listBackends()

listBackends(): readonly string[]

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

List all registered backend names.

Returns

readonly string[]

---

listModels()?

optional listModels(options?): Promise<ListModelsResult>

Defined in: packages/ai.matey.types/src/adapters.ts:357

Optional: List available models from this backend.

Behavior depends on provider:

• Providers with API endpoints (OpenAI, Groq): Fetch from API with caching
• Providers without endpoints (Anthropic): Return static list from config or defaults
• Can be overridden via config.models or config.modelsEndpoint

Parameters

options?

ListModelsOptions

Options for listing models (filtering, cache control)

Returns

Promise<ListModelsResult>

List of available models with metadata

Throws

If remote fetch fails

Throws

If network request fails

Inherited from

BackendAdapter.listModels

---

openCircuitBreaker()

openCircuitBreaker(name, timeoutMs?): void

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

Manually open circuit breaker for a backend.

Parameters

name

string

timeoutMs?

number

Returns

void

---

register()

register(name, adapter): Router

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

Register a backend adapter.

Parameters

name

string

adapter

BackendAdapter

Returns

Router

---

resetCircuitBreaker()

resetCircuitBreaker(name?): void

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

Reset circuit breaker statistics.

Parameters

name?

string

Returns

void

---

resetStats()

resetStats(): void

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

Reset router statistics.

Returns

void

---

selectBackend()

selectBackend(request, preferredBackend?): Promise<string>

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

Select backend for a request.

Parameters

request

IRChatRequest

preferredBackend?

string

Returns

Promise<string>

---

setFallbackChain()

setFallbackChain(chain): Router

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

Set fallback chain for sequential failover.

Parameters

chain

readonly string[]

Returns

Router

---

setModelMapping()

setModelMapping(mapping): Router

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

Set model to backend mapping.

Parameters

mapping

ModelMapping

Returns

Router

---

setModelPatterns()

setModelPatterns(patterns): Router

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

Set model pattern mappings.

Parameters

patterns

readonly ModelPatternMapping[]

Returns

Router

---

toIR()

toIR(response, originalRequest, latencyMs): IRChatResponse

Defined in: packages/ai.matey.types/src/adapters.ts:299

Convert provider-specific response to universal IR.

Useful for:

• Testing: Convert mock provider responses to IR
• Debugging: Parse provider responses manually
• Format conversion: Use backend as response converter

Parameters

response

unknown

Provider-specific response object

originalRequest

IRChatRequest

Original IR request (for context)

latencyMs

number

Request latency in milliseconds

Returns

IRChatResponse

Universal IR response

Throws

If conversion fails

Inherited from

BackendAdapter.toIR

---

unregister()

unregister(name): Router

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

Unregister a backend adapter.

Parameters

name

string

Returns

Router