AxAIWebLLM

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/webllm/api.ts#L377

Extends

AxBaseAI<AxAIWebLLMModel, AxAIWebLLMEmbedModel, AxAIWebLLMChatRequest, AxAIWebLLMEmbedRequest, AxAIWebLLMChatResponse, AxAIWebLLMChatResponseDelta, AxAIWebLLMEmbedResponse, TModelKey>

Type Parameters

Type Parameter
`TModelKey`

Constructors

Constructor

new AxAIWebLLM<TModelKey>(__namedParameters: Readonly<Omit<AxAIWebLLMArgs<TModelKey>, "name">>): AxAIWebLLM<TModelKey>;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/webllm/api.ts#L387

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIWebLLMArgs`<`TModelKey`>, `"name"`>>

Returns

AxAIWebLLM<TModelKey>

Overrides

AxBaseAI.constructor

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>>

Inherited from

AxBaseAI.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>

Inherited from

AxBaseAI.embed

getFeatures()

getFeatures(model?: AxAIWebLLMModel): AxAIFeatures;

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

Parameters

Parameter	Type
`model?`	`AxAIWebLLMModel`

Returns

AxAIFeatures

Inherited from

AxBaseAI.getFeatures

getId()

getId(): string;

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

Returns

string

Inherited from

AxBaseAI.getId

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAIWebLLMModel;

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

Returns

undefined | AxAIWebLLMModel

Inherited from

AxBaseAI.getLastUsedChatModel

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined;

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

Returns

undefined

Inherited from

AxBaseAI.getLastUsedEmbedModel

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

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

Returns

undefined | AxModelConfig

Inherited from

AxBaseAI.getLastUsedModelConfig

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

AxLoggerFunction

Inherited from

AxBaseAI.getLogger

getMetrics()

getMetrics(): AxAIServiceMetrics;

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

Returns

AxAIServiceMetrics

Inherited from

AxBaseAI.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; })[]

Inherited from

AxBaseAI.getModelList

getName()

getName(): string;

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

Returns

string

Inherited from

AxBaseAI.getName

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

AxBaseAI.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

Inherited from

AxBaseAI.setAPIURL

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

Inherited from

AxBaseAI.setHeaders

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

Inherited from

AxBaseAI.setName

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

Inherited from

AxBaseAI.setOptions