AxBalancer

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L62

Balancer that rotates through services.

Type Parameters

Type Parameter	Default type
`TServices` extends readonly `AxAIService`<`any`, `any`, `any`>[]	readonly `AxAIService`[]
`TModelKey`	`ExtractAllModelKeys`<`TServices`>

Implements

AxAIService<unknown, unknown, TModelKey>

Constructors

Constructor

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L89

Parameters

Parameter	Type
`services`	`TServices`
`options?`	`AxBalancerOptions`<`TModelKey`>

Returns

AxBalancer<TServices, TModelKey>

Methods

chat()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L477

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`TModelKey`>>
`options?`	`Readonly`<`AxAIServiceOptions`>

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

AxAIService.chat

embed()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L629

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`TModelKey`>>
`options?`	`Readonly`<`AxAIServiceOptions`>

Returns

Promise<AxEmbedResponse>

Implementation of

AxAIService.embed

getEstimatedCost()

TypeScript

getEstimatedCost(modelUsage?: AxModelUsage): number;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L353

Parameters

Parameter	Type
`modelUsage?`	`AxModelUsage`

Returns

number

Implementation of

AxAIService.getEstimatedCost

getFeatures()

TypeScript

getFeatures(model?: string): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L209

Parameters

Parameter	Type
`model?`	`string`

Returns

AxAIFeatures

Implementation of

AxAIService.getFeatures

getId()

TypeScript

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L205

Returns

string

Implementation of

AxAIService.getId

getLastUsedChatModel()

TypeScript

getLastUsedChatModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L122

Returns

unknown

Implementation of

AxAIService.getLastUsedChatModel

getLastUsedEmbedModel()

TypeScript

getLastUsedEmbedModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L125

Returns

unknown

Implementation of

AxAIService.getLastUsedEmbedModel

getLastUsedModelConfig()

TypeScript

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L128

Returns

undefined | AxModelConfig

Implementation of

AxAIService.getLastUsedModelConfig

getLogger()

TypeScript

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L715

Returns

AxLoggerFunction

Implementation of

AxAIService.getLogger

getMetrics()

TypeScript

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L266

Returns

AxAIServiceMetrics

Implementation of

AxAIService.getMetrics

getModelList()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L166

Returns

| undefined | AxAIModelList<TModelKey>

Implementation of

AxAIService.getModelList

getName()

TypeScript

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L201

Returns

string

Implementation of

AxAIService.getName

getOptions()

TypeScript

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L711

Returns

Readonly<AxAIServiceOptions>

Implementation of

AxAIService.getOptions

setOptions()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L701

Parameters

Parameter	Type
`options`	`Readonly`<`AxAIServiceOptions`>

Returns

void

Implementation of

AxAIService.setOptions

speak()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L694

Parameters

Parameter	Type
`req`	`Readonly`<`AxSpeechRequest`<`TModelKey`>>
`options?`	`Readonly`<`AxAIServiceOptions`>

Returns

Promise<AxChatAudioOutput>

Implementation of

AxAIService.speak

transcribe()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L687

Parameters

Parameter	Type
`req`	`Readonly`<`AxTranscriptionRequest`<`TModelKey`>>
`options?`	`Readonly`<`AxAIServiceOptions`>

Returns

Promise<AxTranscriptionResponse>

Implementation of

AxAIService.transcribe

create()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L116

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

Type Parameters

Type Parameter
`TServices` extends readonly `AxAIService`<`any`, `any`, `any`>[]

Parameters

Parameter	Type
`services`	`TServices`
`options?`	`AxBalancerOptions`<`ExtractAllModelKeys`<`TServices`>>

Returns

AxBalancer<TServices, ExtractAllModelKeys<TServices>>

inputOrderComparator()

TypeScript

static inputOrderComparator(): number;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L135

Service comparator that respects the input order of services.

Returns

number

metricComparator()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/balance.ts#L156

Service comparator that sorts services by cost.

Type Parameters

Type Parameter	Default type
`TModelKey`	`string`

Parameters

Parameter	Type
`a`	`AxAIService`<`unknown`, `unknown`, `TModelKey`>
`b`	`AxAIService`<`unknown`, `unknown`, `TModelKey`>

Returns

number