AxBalancer

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L108

Provider balancer with ordered failover by default and opt-in adaptive routing for chat requests.

Type Parameters

Implements

• AxAIService<unknown, unknown, TModelKey>

Constructors

Constructor

new AxBalancer<TServices, TModelKey>(services: TServices, options?: AxBalancerOptions<TModelKey>): AxBalancer<TServices, TModelKey>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L136

Parameters

Returns

AxBalancer<TServices, TModelKey>

Methods

chat()

chat(req: Readonly<AxChatRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L1031

Parameters

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

AxAIService.chat

embed()

embed(req: Readonly<AxEmbedRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<AxEmbedResponse>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L1144

Parameters

Returns

Promise<AxEmbedResponse>

Implementation of

AxAIService.embed

getEstimatedCost()

getEstimatedCost(modelUsage?: AxModelUsage): number;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L456

Parameters

Returns

number

Implementation of

AxAIService.getEstimatedCost

getFeatures()

getFeatures(model?: string): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L263

Parameters

Returns

AxAIFeatures

Implementation of

AxAIService.getFeatures

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L259

Returns

string

Implementation of

AxAIService.getId

getLastUsedChatModel()

getLastUsedChatModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L176

Returns

unknown

Implementation of

AxAIService.getLastUsedChatModel

getLastUsedEmbedModel()

getLastUsedEmbedModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L179

Returns

unknown

Implementation of

AxAIService.getLastUsedEmbedModel

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L182

Returns

undefined | AxModelConfig

Implementation of

AxAIService.getLastUsedModelConfig

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L1230

Returns

AxLoggerFunction

Implementation of

AxAIService.getLogger

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L369

Returns

AxAIServiceMetrics

Implementation of

AxAIService.getMetrics

getModelList()

getModelList(): 
  | undefined
| AxAIModelList<TModelKey>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L220

Returns

| undefined | AxAIModelList<TModelKey>

Implementation of

AxAIService.getModelList

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L255

Returns

string

Implementation of

AxAIService.getName

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L1226

Returns

Readonly<AxAIServiceOptions>

Implementation of

AxAIService.getOptions

openChatSession()

openChatSession(req: Readonly<AxChatRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<AxChatSession>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L1017

Parameters

Returns

Promise<AxChatSession>

Implementation of

AxAIService.openChatSession

resolveChatService()

resolveChatService(req: Readonly<AxChatRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<{
  model?: string;
  service: Readonly<AxAIService<unknown, unknown, any>>;
}>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L1001

Resolve a provider before a controlled/tool run; the returned service is pinned.

Parameters

Returns

Promise<{ model?: string; service: Readonly<AxAIService<unknown, unknown, any>>; }>

Implementation of

AxAIService.resolveChatService

setOptions()

setOptions(options: Readonly<AxAIServiceOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L1216

Parameters

Returns

void

Implementation of

AxAIService.setOptions

speak()

speak(req: Readonly<AxSpeechRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<AxChatAudioOutput>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L1209

Parameters

Returns

Promise<AxChatAudioOutput>

Implementation of

AxAIService.speak

transcribe()

transcribe(req: Readonly<AxTranscriptionRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<AxTranscriptionResponse>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L1202

Parameters

Returns

Promise<AxTranscriptionResponse>

Implementation of

AxAIService.transcribe

validateChatRequest()

validateChatRequest(req: Readonly<AxChatRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L526

Check request compatibility without network calls, credentials, or state changes.

Parameters

Returns

void

Implementation of

AxAIService.validateChatRequest

create()

static create<TServices>(services: TServices, options?: AxBalancerOptions<ExtractAllModelKeys<TServices>>): AxBalancer<TServices, ExtractAllModelKeys<TServices>>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L170

Static factory method for type-safe balancer creation with automatic model key inference.

Type Parameters

Parameters

Returns

AxBalancer<TServices, ExtractAllModelKeys<TServices>>

inputOrderComparator()

static inputOrderComparator(): number;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L189

Service comparator that respects the input order of services.

Returns

number

metricComparator()

static metricComparator<TModelKey>(a: AxAIService<unknown, unknown, TModelKey>, b: AxAIService<unknown, unknown, TModelKey>): number;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/balance.ts#L210

Service comparator that sorts services by cost.

Type Parameters

Parameters

Returns

number