Router

Defined in: ai.matey.core/src/router.ts:60

Router manages multiple backend adapters with intelligent routing.

Implements

• Router

Constructors

Constructor

new Router(config): Router

Defined in: ai.matey.core/src/router.ts:83

Parameters

config

Partial<RouterConfig> = {}

Returns

Router

Properties

config

readonly config: RouterConfig

Defined in: ai.matey.core/src/router.ts:62

Router configuration.

Implementation of

Router.config

---

metadata

readonly metadata: AdapterMetadata

Defined in: ai.matey.core/src/router.ts:61

Adapter metadata for identification and capabilities.

Implementation of

Router.metadata

Methods

checkHealth()

Call Signature

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

Defined in: ai.matey.core/src/router.ts:790

Check health of all or specific backend.

Returns

Promise<Record<string, boolean>>

Implementation of

Router.checkHealth

Call Signature

checkHealth(name): Promise<boolean>

Defined in: ai.matey.core/src/router.ts:791

Check health of specific backend.

Parameters

name

string

Returns

Promise<boolean>

Implementation of

Router.checkHealth

---

clearBackendTranslationMapping()

clearBackendTranslationMapping(backendName?): Router

Defined in: ai.matey.core/src/router.ts:420

Clear backend-specific model translation mappings.

Parameters

backendName?

string

Optional backend name to clear. If not provided, clears all.

Returns

Router

This router for chaining

---

clearModelTranslationMapping()

clearModelTranslationMapping(): Router

Defined in: ai.matey.core/src/router.ts:409

Clear all model translation mappings.

Returns

Router

This router for chaining

---

clone()

clone(config): Router

Defined in: ai.matey.core/src/router.ts:975

Clone router with new configuration.

Parameters

config

Partial<RouterConfig>

Returns

Router

Implementation of

Router.clone

---

closeCircuitBreaker()

closeCircuitBreaker(name): void

Defined in: ai.matey.core/src/router.ts:860

Manually close circuit breaker for a backend.

Parameters

name

string

Returns

void

Implementation of

Router.closeCircuitBreaker

---

dispatchParallel()

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

Defined in: ai.matey.core/src/router.ts:658

Dispatch request to multiple backends in parallel.

Parameters

request

IRChatRequest

options

ParallelDispatchOptions = {}

signal?

AbortSignal

Returns

Promise<ParallelDispatchResult>

Implementation of

Router.dispatchParallel

---

dispose()

dispose(): void

Defined in: ai.matey.core/src/router.ts:994

Clean up resources.

Returns

void

Implementation of

Router.dispose

---

execute()

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

Defined in: ai.matey.core/src/router.ts:553

Execute request with automatic backend selection and fallback.

Parameters

request

IRChatRequest

signal?

AbortSignal

Returns

Promise<IRChatResponse>

Implementation of

Router.execute

---

executeStream()

executeStream(request, signal?): IRChatStream

Defined in: ai.matey.core/src/router.ts:608

Execute streaming request with automatic backend selection and fallback.

Parameters

request

IRChatRequest

signal?

AbortSignal

Returns

IRChatStream

Implementation of

Router.executeStream

---

fromIR()

fromIR(_request): unknown

Defined in: ai.matey.core/src/router.ts:135

Convert IR request to provider format. Not applicable for Router - use the specific backend adapter instead.

Parameters

_request

IRChatRequest

Returns

unknown

Implementation of

Router.fromIR

---

get()

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

Defined in: ai.matey.core/src/router.ts:219

Get a registered backend adapter.

Parameters

name

string

Returns

BackendAdapter<unknown, unknown> | undefined

Implementation of

Router.get

---

getBackendInfo()

Call Signature

getBackendInfo(): BackendInfo[]

Defined in: ai.matey.core/src/router.ts:240

Get information about all or specific backend.

Returns

BackendInfo[]

Implementation of

Router.getBackendInfo

Call Signature

getBackendInfo(name): BackendInfo | undefined

Defined in: ai.matey.core/src/router.ts:241

Get information about specific backend.

Parameters

name

string

Returns

BackendInfo | undefined

Implementation of

Router.getBackendInfo

---

getBackendStats()

getBackendStats(name): BackendStats | undefined

Defined in: ai.matey.core/src/router.ts:960

Get statistics for specific backend.

Parameters

name

string

Returns

BackendStats | undefined

Implementation of

Router.getBackendStats

---

getBackendTranslationMapping()

getBackendTranslationMapping(backendName): ModelMapping

Defined in: ai.matey.core/src/router.ts:391

Get backend-specific model translation mapping.

Parameters

backendName

string

Returns

ModelMapping

---

getFallbackChain()

getFallbackChain(): readonly string[]

Defined in: ai.matey.core/src/router.ts:284

Get current fallback chain.

Returns

readonly string[]

Implementation of

Router.getFallbackChain

---

getModelMapping()

getModelMapping(): ModelMapping

Defined in: ai.matey.core/src/router.ts:310

Get current model mapping.

Returns

ModelMapping

Implementation of

Router.getModelMapping

---

getModelPatterns()

getModelPatterns(): readonly ModelPatternMapping[]

Defined in: ai.matey.core/src/router.ts:456

Get current model patterns.

Returns

readonly ModelPatternMapping[]

Implementation of

Router.getModelPatterns

---

getModelTranslationMapping()

getModelTranslationMapping(): ModelMapping

Defined in: ai.matey.core/src/router.ts:341

Get current model translation mapping.

Returns

ModelMapping

---

getStats()

getStats(): RouterStats

Defined in: ai.matey.core/src/router.ts:917

Get router statistics.

Returns

RouterStats

Implementation of

Router.getStats

---

has()

has(name): boolean

Defined in: ai.matey.core/src/router.ts:226

Check if backend is registered.

Parameters

name

string

Returns

boolean

Implementation of

Router.has

---

isCircuitBreakerOpen()

isCircuitBreakerOpen(name): boolean

Defined in: ai.matey.core/src/router.ts:902

Check if circuit breaker is open for a backend.

Parameters

name

string

Backend name

Returns

boolean

true if circuit breaker is open, false otherwise

---

listBackends()

listBackends(): readonly string[]

Defined in: ai.matey.core/src/router.ts:233

List all registered backend names.

Returns

readonly string[]

Implementation of

Router.listBackends

---

openCircuitBreaker()

openCircuitBreaker(name, timeoutMs?): void

Defined in: ai.matey.core/src/router.ts:833

Manually open circuit breaker for a backend.

Parameters

name

string

timeoutMs?

number

Returns

void

Implementation of

Router.openCircuitBreaker

---

register()

register(name, adapter): Router

Defined in: ai.matey.core/src/router.ts:154

Register a backend adapter.

Parameters

name

string

adapter

BackendAdapter

Returns

Router

Implementation of

Router.register

---

resetCircuitBreaker()

resetCircuitBreaker(name?): void

Defined in: ai.matey.core/src/router.ts:879

Reset circuit breaker statistics.

Parameters

name?

string

Returns

void

Implementation of

Router.resetCircuitBreaker

---

resetStats()

resetStats(): void

Defined in: ai.matey.core/src/router.ts:938

Reset router statistics.

Returns

void

Implementation of

Router.resetStats

---

selectBackend()

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

Defined in: ai.matey.core/src/router.ts:467

Select backend for a request.

Parameters

request

IRChatRequest

preferredBackend?

string

Returns

Promise<string>

Implementation of

Router.selectBackend

---

setBackendTranslationMapping()

setBackendTranslationMapping(backendName, mapping): Router

Defined in: ai.matey.core/src/router.ts:361

Set backend-specific model translation mapping. This takes priority over global model translation mapping.

Parameters

backendName

string

mapping

ModelMapping

Returns

Router

Example

router.setBackendTranslationMapping('anthropic', {
  'gpt-4': 'claude-3-5-sonnet-20241022',
  'gpt-3.5-turbo': 'claude-3-5-haiku-20241022'
});

---

setFallbackChain()

setFallbackChain(chain): Router

Defined in: ai.matey.core/src/router.ts:265

Set fallback chain for sequential failover.

Parameters

chain

readonly string[]

Returns

Router

Implementation of

Router.setFallbackChain

---

setModelMapping()

setModelMapping(mapping): Router

Defined in: ai.matey.core/src/router.ts:291

Set model to backend mapping.

Parameters

mapping

ModelMapping

Returns

Router

Implementation of

Router.setModelMapping

---

setModelPatterns()

setModelPatterns(patterns): Router

Defined in: ai.matey.core/src/router.ts:437

Set model pattern mappings.

Parameters

patterns

readonly ModelPatternMapping[]

Returns

Router

Implementation of

Router.setModelPatterns

---

setModelTranslationMapping()

setModelTranslationMapping(mapping): Router

Defined in: ai.matey.core/src/router.ts:330

Set model name translation mapping (for fallback scenarios). Maps source model names to target model names.

Parameters

mapping

ModelMapping

Returns

Router

Example

router.setModelTranslationMapping({
  'gpt-4': 'claude-3-5-sonnet-20241022',
  'gpt-3.5-turbo': 'claude-3-5-haiku-20241022'
});

---

toIR()

toIR(_response, _originalRequest, _latencyMs): IRChatResponse

Defined in: ai.matey.core/src/router.ts:143

Convert provider response to IR format. Not applicable for Router - use the specific backend adapter instead.

Parameters

_response

unknown

_originalRequest

IRChatRequest

_latencyMs

number

Returns

IRChatResponse

Implementation of

Router.toIR

---

unregister()

unregister(name): Router

Defined in: ai.matey.core/src/router.ts:182

Unregister a backend adapter.

Parameters

name

string

Returns

Router

Implementation of

Router.unregister