AxBaseAI

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L140

Extended by

Type Parameters

Type Parameter
`TModel`
`TEmbedModel`
`TChatRequest`
`TEmbedRequest`
`TChatResponse`
`TChatResponseDelta`
`TEmbedResponse`
`TModelKey`

Implements

AxAIService<TModel, TEmbedModel, TModelKey>

Constructors

Constructor

new AxBaseAI<TModel, TEmbedModel, TChatRequest, TEmbedRequest, TChatResponse, TChatResponseDelta, TEmbedResponse, TModelKey>(aiImpl: Readonly<AxAIServiceImpl<TModel, TEmbedModel, TChatRequest, TEmbedRequest, TChatResponse, TChatResponseDelta, TEmbedResponse>>, __namedParameters: Readonly<AxBaseAIArgs<TModel, TEmbedModel, TModelKey>>): AxBaseAI<TModel, TEmbedModel, TChatRequest, TEmbedRequest, TChatResponse, TChatResponseDelta, TEmbedResponse, TModelKey>;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L208

Parameters

Parameter	Type
`aiImpl`	`Readonly`<`AxAIServiceImpl`<`TModel`, `TEmbedModel`, `TChatRequest`, `TEmbedRequest`, `TChatResponse`, `TChatResponseDelta`, `TEmbedResponse`>>
`__namedParameters`	`Readonly`<`AxBaseAIArgs`<`TModel`, `TEmbedModel`, `TModelKey`>>

Returns

AxBaseAI<TModel, TEmbedModel, TChatRequest, TEmbedRequest, TChatResponse, TChatResponseDelta, TEmbedResponse, TModelKey>

Methods

chat()

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

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L870

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

AxAIService.chat

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L1380

Parameters

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

Returns

Promise<AxEmbedResponse>

Implementation of

AxAIService.embed

getFeatures()

getFeatures(model?: TModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L345

Parameters

Parameter	Type
`model?`	`TModel`

Returns

AxAIFeatures

Implementation of

AxAIService.getFeatures

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L270

Returns

string

Implementation of

AxAIService.getId

getLastUsedChatModel()

getLastUsedChatModel(): undefined | TModel;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L351

Returns

undefined | TModel

Implementation of

AxAIService.getLastUsedChatModel

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined | TEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L355

Returns

undefined | TEmbedModel

Implementation of

AxAIService.getLastUsedEmbedModel

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L359

Returns

undefined | AxModelConfig

Implementation of

AxAIService.getLastUsedModelConfig

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L310

Returns

AxLoggerFunction

Implementation of

AxAIService.getLogger

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L866

Returns

AxAIServiceMetrics

Implementation of

AxAIService.getMetrics

getModelList()

getModelList(): (
  | {
  description: string;
  embedModel?: undefined;
  key: TModelKey;
  model: string;
}
  | {
  description: string;
  embedModel: string;
  key: TModelKey;
  model?: undefined;
})[];

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L314

Returns

( | { description: string; embedModel?: undefined; key: TModelKey; model: string; } | { description: string; embedModel: string; key: TModelKey; model?: undefined; })[]

Implementation of

AxAIService.getModelList

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L341

Returns

string

Implementation of

AxAIService.getName

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L295

Returns

Readonly<AxAIServiceOptions>

Implementation of

AxAIService.getOptions

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L274

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

setHeaders()

setHeaders(headers: () => Promise<Record<string, string>>): void;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L278

Parameters

Parameter	Type
`headers`	() => `Promise`<`Record`<`string`, `string`>>

Returns

void

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L266

Parameters

Parameter	Type
`name`	`string`

Returns

void

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/base.ts#L282

Parameters

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

Returns

void

Implementation of

AxAIService.setOptions