AxAIService

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L621

Type Parameters

Type Parameter	Default type
`TModel`	`unknown`
`TEmbedModel`	`unknown`
`TModelKey`	`string`

Methods

chat()

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

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L637

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L641

Parameters

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

Returns

Promise<AxEmbedResponse>

getFeatures()

getFeatures(model?: TModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L628

Parameters

Parameter	Type
`model?`	`TModel`

Returns

AxAIFeatures

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L626

Returns

string

getLastUsedChatModel()

getLastUsedChatModel(): undefined | TModel;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L633

Returns

undefined | TModel

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined | TEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L634

Returns

undefined | TEmbedModel

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L635

Returns

undefined | AxModelConfig

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L631

Returns

AxLoggerFunction

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L630

Returns

AxAIServiceMetrics

getModelList()

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

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L629

Returns

| undefined | AxAIModelList<TModelKey>

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L627

Returns

string

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L647

Returns

Readonly<AxAIServiceOptions>

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/types.ts#L646

Parameters

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

Returns

void