Skip to content

AxAI

Class: AxAI

Implements

Constructors

new AxAI()

new AxAI(options): AxAI

Parameters

options: Readonly<AxAIArgs>

Returns

AxAI

Defined in

src/ax/ai/wrap.ts:86

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Parameters

req: Readonly<AxChatRequest>

options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

AxAIService.chat

Defined in

src/ax/ai/wrap.ts:153


embed()

embed(req, options?): Promise<AxEmbedResponse>

Parameters

req: Readonly<AxEmbedRequest>

options?: Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Implementation of

AxAIService.embed

Defined in

src/ax/ai/wrap.ts:160


getEmbedModelInfo()

getEmbedModelInfo(): undefined | Readonly<AxModelInfoWithProvider>

Returns

undefined | Readonly<AxModelInfoWithProvider>

Implementation of

AxAIService.getEmbedModelInfo

Defined in

src/ax/ai/wrap.ts:137


getFeatures()

getFeatures(model?): object

Parameters

model?: string

Returns

object

functions

functions: boolean

streaming

streaming: boolean

Implementation of

AxAIService.getFeatures

Defined in

src/ax/ai/wrap.ts:145


getModelConfig()

getModelConfig(): Readonly<AxModelConfig>

Returns

Readonly<AxModelConfig>

Implementation of

AxAIService.getModelConfig

Defined in

src/ax/ai/wrap.ts:141


getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Returns

Readonly<AxModelInfoWithProvider>

Implementation of

AxAIService.getModelInfo

Defined in

src/ax/ai/wrap.ts:133


getModelMap()

getModelMap(): undefined | AxAIModelMap

Returns

undefined | AxAIModelMap

Implementation of

AxAIService.getModelMap

Defined in

src/ax/ai/wrap.ts:149


getName()

getName(): string

Returns

string

Implementation of

AxAIService.getName

Defined in

src/ax/ai/wrap.ts:129


setOptions()

setOptions(options): void

Parameters

options: Readonly<AxAIServiceOptions>

Returns

void

Implementation of

AxAIService.setOptions

Defined in

src/ax/ai/wrap.ts:167