Ax Framework

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`unknown`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`AxAIAnthropicModel` \| `AxAIAnthropicVertexModel`, `unknown`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`AxAIAnthropicModel` \| `AxAIAnthropicVertexModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/azure-openai/api.ts#L38

> AxAIAzureOpenAI

Extends

AxAIOpenAIBase<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Constructors

new AxAIAzureOpenAI()

new AxAIAzureOpenAI(__namedParameters): AxAIAzureOpenAI

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/azure-openai/api.ts#L42

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIAzureOpenAIArgs`, `"name"` \| `"modelInfo"`>>

Returns

AxAIAzureOpenAI

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`AxAIOpenAIModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`AxAIOpenAIModel`, `AxAIOpenAIEmbedModel`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`AxAIOpenAIEmbedModel`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`AxAIOpenAIModel`, `AxAIOpenAIEmbedModel`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`AxAIOpenAIModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

> AxAICohere

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L289

Extends

AxBaseAI<AxAICohereModel, AxAICohereEmbedModel, AxAICohereChatRequest, AxAICohereEmbedRequest, AxAICohereChatResponse, AxAICohereChatResponseDelta, AxAICohereEmbedResponse>

Constructors

new AxAICohere()

new AxAICohere(__namedParameters): AxAICohere

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L298

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAICohereArgs`, `"name"`>>

Returns

AxAICohere

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`AxAICohereModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`AxAICohereModel`, `AxAICohereEmbedModel`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`AxAICohereEmbedModel`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`AxAICohereModel`, `AxAICohereEmbedModel`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`AxAICohereModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

> AxAIDeepSeek

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/deepseek/api.ts#L31

Extends

AxAIOpenAIBase<AxAIDeepSeekModel, undefined>

Constructors

new AxAIDeepSeek()

new AxAIDeepSeek(__namedParameters): AxAIDeepSeek

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/deepseek/api.ts#L32

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIDeepSeekArgs`, `"name"`>>

Returns

AxAIDeepSeek

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`AxAIDeepSeekModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`AxAIDeepSeekModel`, `undefined`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`undefined`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`AxAIDeepSeekModel`, `undefined`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`AxAIDeepSeekModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L494

> AxAIGoogleGemini

AxAIGoogleGemini: AI Service

Extends

AxBaseAI<AxAIGoogleGeminiModel, AxAIGoogleGeminiEmbedModel, AxAIGoogleGeminiChatRequest, AxAIGoogleGeminiBatchEmbedRequest | AxAIGoogleVertexBatchEmbedRequest, AxAIGoogleGeminiChatResponse, AxAIGoogleGeminiChatResponseDelta, AxAIGoogleGeminiBatchEmbedResponse | AxAIGoogleVertexBatchEmbedResponse>

Constructors

new AxAIGoogleGemini()

new AxAIGoogleGemini(__namedParameters): AxAIGoogleGemini

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L503

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIGoogleGeminiArgs`, `"name"`>>

Returns

AxAIGoogleGemini

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`AxAIGoogleGeminiModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`AxAIGoogleGeminiModel`, `AxAIGoogleGeminiEmbedModel`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`AxAIGoogleGeminiEmbedModel`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`AxAIGoogleGeminiModel`, `AxAIGoogleGeminiEmbedModel`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`AxAIGoogleGeminiModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

> AxAIGroq

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/groq/api.ts#L22

Extends

AxAIOpenAIBase<AxAIGroqModel, undefined>

Constructors

new AxAIGroq()

new AxAIGroq(__namedParameters): AxAIGroq

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/groq/api.ts#L23

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIGroqArgs`, `"name"`>>

Returns

AxAIGroq

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`AxAIGroqModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`AxAIGroqModel`, `undefined`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`undefined`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`AxAIGroqModel`, `undefined`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`AxAIGroqModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/groq/api.ts#L55

Parameters

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

Returns

void

Overrides

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L158

> AxAIHuggingFace

Extends

AxBaseAI<AxAIHuggingFaceModel, unknown, AxAIHuggingFaceRequest, unknown, AxAIHuggingFaceResponse, unknown, unknown>

Constructors

new AxAIHuggingFace()

new AxAIHuggingFace(__namedParameters): AxAIHuggingFace

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L167

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIHuggingFaceArgs`, `"name"`>>

Returns

AxAIHuggingFace

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`MetaLlama270BChatHF`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`MetaLlama270BChatHF`, `unknown`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`unknown`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`MetaLlama270BChatHF`, `unknown`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`MetaLlama270BChatHF`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

> AxAIMistral

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/api.ts#L34

Extends

AxAIOpenAIBase<AxAIMistralModel, AxAIMistralEmbedModels>

Constructors

new AxAIMistral()

new AxAIMistral(__namedParameters): AxAIMistral

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/api.ts#L38

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIMistralArgs`, `"name"`>>

Returns

AxAIMistral

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`AxAIMistralModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`AxAIMistralModel`, `MistralEmbed`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`MistralEmbed`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`AxAIMistralModel`, `MistralEmbed`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`AxAIMistralModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

> AxAIOllama

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/ollama/api.ts#L33

OllamaAI: AI Service

Extends

AxAIOpenAIBase<string, string>

Constructors

new AxAIOllama()

new AxAIOllama(__namedParameters): AxAIOllama

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/ollama/api.ts#L34

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIOllamaArgs`, `"name"`>>

Returns

AxAIOllama

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`string`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`string`, `string`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`string`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`string`, `string`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`string`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

> AxAIOpenAI

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L479

Extends

AxAIOpenAIBase<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Constructors

new AxAIOpenAI()

new AxAIOpenAI(__namedParameters): AxAIOpenAI

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L483

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIOpenAIArgs`<`"openai"`, `AxAIOpenAIModel`, `AxAIOpenAIEmbedModel`>, `"name"` \| `"modelInfo"`>>

Returns

AxAIOpenAI

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`AxAIOpenAIModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`AxAIOpenAIModel`, `AxAIOpenAIEmbedModel`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`AxAIOpenAIEmbedModel`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`AxAIOpenAIModel`, `AxAIOpenAIEmbedModel`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`AxAIOpenAIModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

> AxAIOpenAIBase

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L429

Extends

AxBaseAI<TModel, TEmbedModel, AxAIOpenAIChatRequest<TModel>, AxAIOpenAIEmbedRequest<TEmbedModel>, AxAIOpenAIChatResponse, AxAIOpenAIChatResponseDelta, AxAIOpenAIEmbedResponse>

Extended by

Type Parameters

Type Parameter
`TModel`
`TEmbedModel`

Constructors

new AxAIOpenAIBase()

new AxAIOpenAIBase<TModel, TEmbedModel>(__namedParameters): AxAIOpenAIBase<TModel, TEmbedModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L438

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIOpenAIBaseArgs`<`TModel`, `TEmbedModel`>, `"name"`>>

Returns

AxAIOpenAIBase<TModel, TEmbedModel>

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`TModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`TModel`, `TEmbedModel`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`TEmbedModel`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`TModel`, `TEmbedModel`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`TModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

> AxAIReka

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L266

Extends

AxBaseAI<AxAIRekaModel, undefined, AxAIRekaChatRequest, unknown, AxAIRekaChatResponse, AxAIRekaChatResponseDelta, unknown>

Constructors

new AxAIReka()

new AxAIReka(__namedParameters): AxAIReka

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L275

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIRekaArgs`, `"name"`>>

Returns

AxAIReka

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`AxAIRekaModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`AxAIRekaModel`, `undefined`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`undefined`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`AxAIRekaModel`, `undefined`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`AxAIRekaModel`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

AxAIServiceAuthenticationError

> AxAIServiceAuthenticationError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L192

Extends

AxAIServiceError

Constructors

new AxAIServiceAuthenticationError()

new AxAIServiceAuthenticationError(url, requestBody?, context?): AxAIServiceAuthenticationError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L193

Parameters

Parameter	Type
`url`	`string`
`requestBody`?	`unknown`
`context`?	`Record`<`string`, `unknown`>

Returns

Overrides

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

context

readonly context: Record<string, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L77

Inherited from

errorId

readonly errorId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L76

Inherited from

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

requestBody?

readonly optional requestBody: unknown

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L82

Inherited from

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

timestamp

readonly timestamp: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L75

Inherited from

url

readonly url: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L81

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Methods

toString()

toString(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L94

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

> AxAIServiceError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L74

Extends

Error

Extended by

Constructors

new AxAIServiceError()

new AxAIServiceError(message, url, requestBody?, context?): AxAIServiceError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L79

Parameters

Parameter	Type
`message`	`string`
`url`	`string`
`requestBody`?	`unknown`
`context`?	`Record`<`string`, `unknown`>

Returns

AxAIServiceError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

context

readonly context: Record<string, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L77

errorId

readonly errorId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L76

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

requestBody?

readonly optional requestBody: unknown

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L82

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

timestamp

readonly timestamp: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L75

url

readonly url: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L81

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

Error.prepareStackTrace

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Error.stackTraceLimit

Methods

toString()

toString(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L94

Returns a string representation of an object.

Returns

string

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

Error.captureStackTrace

> AxAIServiceNetworkError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L133

Extends

AxAIServiceError

Constructors

new AxAIServiceNetworkError()

new AxAIServiceNetworkError(originalError, url, requestBody?, context?): AxAIServiceNetworkError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L134

Parameters

Parameter	Type
`originalError`	`Error`
`url`	`string`
`requestBody`?	`unknown`
`context`?	`Record`<`string`, `unknown`>

Returns

AxAIServiceNetworkError

Overrides

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

context

readonly context: Record<string, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L77

Inherited from

errorId

readonly errorId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L76

Inherited from

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

originalError

readonly originalError: Error

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L135

requestBody?

readonly optional requestBody: unknown

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L82

Inherited from

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

timestamp

readonly timestamp: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L75

Inherited from

url

readonly url: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L81

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Methods

toString()

toString(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L94

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

AxAIServiceResponseError

> AxAIServiceResponseError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L150

Extends

AxAIServiceError

Constructors

new AxAIServiceResponseError()

new AxAIServiceResponseError(message, url, requestBody?, context?): AxAIServiceResponseError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L151

Parameters

Parameter	Type
`message`	`string`
`url`	`string`
`requestBody`?	`unknown`
`context`?	`Record`<`string`, `unknown`>

Returns

Overrides

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

context

readonly context: Record<string, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L77

Inherited from

errorId

readonly errorId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L76

Inherited from

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

requestBody?

readonly optional requestBody: unknown

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L82

Inherited from

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

timestamp

readonly timestamp: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L75

Inherited from

url

readonly url: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L81

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Methods

toString()

toString(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L94

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

> AxAIServiceStatusError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L116

Extends

AxAIServiceError

Constructors

new AxAIServiceStatusError()

new AxAIServiceStatusError(status, statusText, url, requestBody?, context?): AxAIServiceStatusError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L117

Parameters

Parameter	Type
`status`	`number`
`statusText`	`string`
`url`	`string`
`requestBody`?	`unknown`
`context`?	`Record`<`string`, `unknown`>

Returns

AxAIServiceStatusError

Overrides

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

context

readonly context: Record<string, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L77

Inherited from

errorId

readonly errorId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L76

Inherited from

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

requestBody?

readonly optional requestBody: unknown

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L82

Inherited from

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

status

readonly status: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L118

statusText

readonly statusText: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L119

timestamp

readonly timestamp: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L75

Inherited from

url

readonly url: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L81

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Methods

toString()

toString(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L94

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

AxAIServiceStreamTerminatedError

> AxAIServiceStreamTerminatedError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L162

Extends

AxAIServiceError

Constructors

new AxAIServiceStreamTerminatedError()

new AxAIServiceStreamTerminatedError(url, requestBody?, lastChunk?, context?): AxAIServiceStreamTerminatedError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L163

Parameters

Parameter	Type
`url`	`string`
`requestBody`?	`unknown`
`lastChunk`?	`unknown`
`context`?	`Record`<`string`, `unknown`>

Returns

Overrides

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

context

readonly context: Record<string, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L77

Inherited from

errorId

readonly errorId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L76

Inherited from

lastChunk?

readonly optional lastChunk: unknown

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L166

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

requestBody?

readonly optional requestBody: unknown

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L82

Inherited from

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

timestamp

readonly timestamp: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L75

Inherited from

url

readonly url: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L81

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Methods

toString()

toString(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L94

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

> AxAITogether

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/together/api.ts#L18

Extends

AxAIOpenAIBase<string, unknown>

Constructors

new AxAITogether()

new AxAITogether(__namedParameters): AxAITogether

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/together/api.ts#L19

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAITogetherArgs`, `"name"`>>

Returns

AxAITogether

Overrides

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`string`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`string`, `unknown`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`unknown`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`string`, `unknown`>>

Returns

Promise<AxEmbedResponse>

Inherited from

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Inherited from

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`string`

Returns

Inherited from

getId()

getId(): string

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

Returns

string

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string

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

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

Inherited from

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Inherited from

AxAIServiceTimeoutError

> AxAIServiceTimeoutError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L177

Extends

AxAIServiceError

Constructors

new AxAIServiceTimeoutError()

new AxAIServiceTimeoutError(url, timeoutMs, requestBody?, context?): AxAIServiceTimeoutError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L178

Parameters

Parameter	Type
`url`	`string`
`timeoutMs`	`number`
`requestBody`?	`unknown`
`context`?	`Record`<`string`, `unknown`>

Returns

Overrides

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

context

readonly context: Record<string, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L77

Inherited from

errorId

readonly errorId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L76

Inherited from

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

requestBody?

readonly optional requestBody: unknown

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L82

Inherited from

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

timestamp

readonly timestamp: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L75

Inherited from

url

readonly url: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L81

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Methods

toString()

toString(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L94

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

AxAgentic.getFeatures

> AxAgent

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L135

An AI agent that can process inputs using an AI service and coordinate with child agents. Supports features like smart model routing and automatic input field passing to child agents.

Type Parameters

Type Parameter	Default type
`IN` extends `AxGenIn`	-
`OUT` extends `AxGenOut`	`AxGenOut`

Implements

AxAgentic

Constructors

new AxAgent()

new AxAgent<IN, OUT>(__namedParameters, options?): AxAgent<IN, OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L150

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `agents`: `AxAgentic`[]; `ai`: `Readonly`<`AxAIService`<`unknown`, `unknown`>>; `definition`: `string`; `description`: `string`; `functions`: `AxInputFunctionType`; `name`: `string`; `signature`: `string` \| `AxSignature`; }>
`options`?	`Readonly`<`AxAgentOptions`>

Returns

AxAgent<IN, OUT>

Methods

forward()

forward(parentAi, values, options?): Promise<OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L350

Parameters

Parameter	Type
`parentAi`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`IN`
`options`?	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT>

getFeatures()

getFeatures(): AxAgentFeatures

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L298

Returns

AxAgentFeatures

Implementation of

getFunction()

getFunction(): AxFunction

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L248

Returns

AxAgentic.getFunction

Implementation of

getTraces()

getTraces(): AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L232

Returns

AxAgentic.setExamples

Implementation of

AxAgentic.getTraces

getUsage()

getUsage(): AxTokenUsage & object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L240

Returns

AxTokenUsage & object[]

Implementation of

AxAgentic.getUsage

resetUsage()

resetUsage(): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L244

Returns

void

Implementation of

AxAgentic.resetUsage

setDefinition()

setDefinition(definition): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L392

Parameters

Parameter	Type
`definition`	`string`

Returns

void

setDemos()

setDemos(demos): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L236

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`[]

Returns

void

Implementation of

AxAgentic.setDemos

setDescription()

setDescription(description): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L383

Updates the agent’s description. This updates both the stored description and the function’s description.

Parameters

Parameter	Type	Description
`description`	`string`	New description for the agent (must be at least 20 characters)

Returns

void

Throws

Error if description is too short

setExamples()

setExamples(examples): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L220

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`>

Returns

void

Implementation of

setId()

setId(id): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L224

Parameters

Parameter	Type
`id`	`string`

Returns

void

Implementation of

AxAgentic.setId

setParentId()

setParentId(parentId): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L228

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Implementation of

AxAgentic.setParentId

streamingForward()

streamingForward(parentAi, values, options?): AxGenStreamingOut<OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L363

Parameters

Parameter	Type
`parentAi`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`IN`
`options`?	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AxGenStreamingOut<OUT>

> AxApacheTika

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/tika.ts#L12

Constructors

new AxApacheTika()

new AxApacheTika(args?): AxApacheTika

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/tika.ts#L16

Parameters

Parameter	Type
`args`?	`Readonly`<`AxApacheTikaArgs`>

Returns

AxApacheTika

Methods

convert()

convert(files, options?): Promise<string[]>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/tika.ts#L54

Parameters

Parameter	Type
`files`	`Readonly`<`string`[] \| `Blob`[]>
`options`?	`Readonly`<{ `batchSize`: `number`; `format`: `"text"` \| `"html"`; }>

Returns

Promise<string[]>

> AxAssertionError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L16

Extends

Error

Constructors

new AxAssertionError()

new AxAssertionError(__namedParameters): AxAssertionError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L17

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `message`: `string`; }>

Returns

AxAssertionError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Error.stackTraceLimit

Methods

getFixingInstructions()

getFixingInstructions(): object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L26

Returns

object[]

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

Error.captureStackTrace

> AxBalancer

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L40

Balancer that rotates through services.

Implements

AxAIService<unknown, unknown>

Constructors

new AxBalancer()

new AxBalancer(services, options?): AxBalancer

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L53

Parameters

Parameter	Type
`services`	readonly `AxAIService`<`unknown`, `unknown`>[]
`options`?	`AxBalancerOptions`

Returns

AxBalancer

Methods

chat()

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

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L194

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L254

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`>
`options`?	`Readonly`<`AxAIServiceActionOptions`>

Returns

Promise<AxEmbedResponse>

Implementation of

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L110

Returns

Readonly<{ embedModel: string; model: string; }>

Implementation of

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`string`

Returns

Implementation of

getId()

getId(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L136

Returns

string

Implementation of

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L144

Returns

Implementation of

getModelList()

getModelList(): undefined | AxAIModelList

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L106

Returns

undefined | AxAIModelList

Implementation of

getName()

getName(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L132

Returns

string

Implementation of

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L284

Returns

Readonly<AxAIServiceOptions>

Implementation of

setOptions()

setOptions(options): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L280

Parameters

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

Returns

void

Implementation of

inputOrderComparator()

static inputOrderComparator(): number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L78

Service comparator that respects the input order of services.

Returns

number

metricComparator()

static metricComparator(a, b): number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/balance.ts#L99

Service comparator that sorts services by cost.

Parameters

Parameter	Type
`a`	`AxAIService`
`b`	`AxAIService`

Returns

number

> AxBaseAI

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

Extended by

Type Parameters

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

Implements

AxAIService<TModel, TEmbedModel>

Constructors

new AxBaseAI()

new AxBaseAI<TModel, TEmbedModel, TChatRequest, TEmbedRequest, TChatResponse, TChatResponseDelta, TEmbedResponse>(aiImpl, __namedParameters): AxBaseAI<TModel, TEmbedModel, TChatRequest, TEmbedRequest, TChatResponse, TChatResponseDelta, TEmbedResponse>

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

Parameters

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

Returns

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

Methods

chat()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`TModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`TModel`, `TEmbedModel`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

embed()

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

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`TEmbedModel`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`TModel`, `TEmbedModel`>>

Returns

Promise<AxEmbedResponse>

Implementation of

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

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

Returns

Readonly<{ embedModel: string; model: string; }>

Implementation of

getFeatures()

getFeatures(model?): AxAIFeatures

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

Parameters

Parameter	Type
`model`?	`TModel`

Returns

Implementation of

getId()

getId(): string

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

Returns

string

Implementation of

getMetrics()

getMetrics(): AxAIServiceMetrics

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

Returns

Implementation of

getModelList()

getModelList(): undefined | AxAIModelList

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

Returns

undefined | AxAIModelList

Implementation of

getName()

getName(): string

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

Returns

string

Implementation of

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

Implementation of

setAPIURL()

setAPIURL(apiURL): void

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

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

setHeaders()

setHeaders(headers): void

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

Parameters

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

Returns

void

setName()

setName(name): void

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

Parameters

Parameter	Type
`name`	`string`

Returns

void

setOptions()

setOptions(options): void

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

Parameters

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

Returns

void

Implementation of

AxGen.addFieldProcessor

> AxBootstrapFewShot

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L57

Type Parameters

Type Parameter	Default type
`IN` extends `AxGenIn`	`AxGenIn`
`OUT` extends `AxGenOut`	`AxGenOut`

Constructors

new AxBootstrapFewShot()

new AxBootstrapFewShot<IN, OUT>(__namedParameters): AxBootstrapFewShot<IN, OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L82

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`AxOptimizerArgs`<`IN`, `OUT`>>

Returns

AxBootstrapFewShot<IN, OUT>

Methods

compile()

compile(metricFn, options?): Promise<{ demos: AxProgramDemos[]; stats: AxOptimizationStats; }>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L249

Parameters

Parameter	Type
`metricFn`	`AxMetricFn`
`options`?	`Readonly`<`undefined` \| { `batchSize`: `number`; `costMonitoring`: `boolean`; `debugMode`: `boolean`; `earlyStoppingPatience`: `number`; `maxDemos`: `number`; `maxExamples`: `number`; `maxRounds`: `number`; `maxTokensPerGeneration`: `number`; `teacherAI`: `AxAIService`<`unknown`, `unknown`>; `verboseMode`: `boolean`; }>

Returns

Promise<{ demos: AxProgramDemos[]; stats: AxOptimizationStats; }>

getStats()

getStats(): AxOptimizationStats

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L286

Returns

AxOptimizationStats

> AxChainOfThought

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/cot.ts#L5

Extends

AxGen<IN, OUT & object>

Extended by

AxRAG

Type Parameters

Type Parameter	Default type
`IN` extends `AxGenIn`	`AxGenIn`
`OUT` extends `AxGenOut`	`AxGenOut`

Constructors

new AxChainOfThought()

new AxChainOfThought<IN, OUT>(signature, options?): AxChainOfThought<IN, OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/cot.ts#L9

Parameters

Parameter	Type
`signature`	`Readonly`<`string` \| `AxSignature`>
`options`?	`Readonly`<`AxGenOptions`>

Returns

AxChainOfThought<IN, OUT>

Overrides

AxGen.constructor

Methods

_forward1()

_forward1(ai, values, options): AsyncGenerator<{ delta: Partial<OUT & object>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L628

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`IN`
`options`	`Readonly`<`AxProgramForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<OUT & object>; version: number; }, void, unknown>

Inherited from

AxGen._forward1

addAssert()

addAssert(fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L133

Parameters

Parameter	Type
`fn`	(`values`) => `undefined` \| `boolean` \| `Promise`<`undefined` \| `boolean`>
`message`?	`string`

Returns

void

Inherited from

AxGen.addAssert

addFieldProcessor()

addFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L180

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

Inherited from

addStreamingAssert()

addStreamingAssert(fieldName, fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L137

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	(`content`, `done`?) => `undefined` \| `boolean`
`message`?	`string`

Returns

void

Inherited from

AxGen.addStreamingAssert

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L173

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

Inherited from

AxGen.addStreamingFieldProcessor

forward()

forward(ai, values, options?): Promise<OUT & object>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L676

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`IN`
`options`?	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT & object>

Inherited from

AxGen.forward

getSignature()

getSignature(): AxSignature

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L135

Returns

Inherited from

AxGen.getSignature

getTraces()

getTraces(): AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L223

Returns

AxGen.streamingForward

Inherited from

AxGen.getTraces

getUsage()

getUsage(): AxTokenUsage & object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L237

Returns

AxTokenUsage & object[]

Inherited from

AxGen.getUsage

register()

register(prog): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L139

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable` & `AxUsable`>

Returns

void

Inherited from

AxGen.register

resetUsage()

resetUsage(): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L247

Returns

void

Inherited from

AxGen.resetUsage

setDemos()

setDemos(demos): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L254

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`[]

Returns

void

Inherited from

AxGen.setDemos

setExamples()

setExamples(examples): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L182

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`>

Returns

void

Inherited from

AxGen.setExamples

setId()

setId(id): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L169

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxGen.setId

setParentId()

setParentId(parentId): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L176

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxGen.setParentId

streamingForward()

streamingForward(ai, values, options?): AsyncGenerator<{ delta: Partial<OUT & object>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L700

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`IN`
`options`?	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<OUT & object>; version: number; }, void, unknown>

Inherited from

> AxDB

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/wrap.ts#L19

Implements

AxDBService

Constructors

new AxDB()

new AxDB(args): AxDB

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/wrap.ts#L21

Parameters

Parameter	Type
`args`	`Readonly`<`AxDBArgs`>

Returns

AxDB

Methods

batchUpsert()

batchUpsert(batchReq, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/wrap.ts#L46

Parameters

Parameter	Type
`batchReq`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Implementation of

AxDBService.batchUpsert

query()

query(req): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/wrap.ts#L53

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>

Returns

Promise<AxDBQueryResponse>

Implementation of

AxDBService.query

upsert()

upsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/wrap.ts#L39

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Implementation of

AxDBService.upsert

> AxDBBase

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L22

Extended by

Implements

AxDBService

Constructors

new AxDBBase()

new AxDBBase(__namedParameters): AxDBBase

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L44

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`AxDBBaseArgs` & `object`>

Returns

AxDBBase

Properties

_batchUpsert()?

optional _batchUpsert: (batchReq, update?, options?) => Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L33

Parameters

Parameter	Type
`batchReq`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

_query()?

optional _query: (req, options?) => Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L39

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBQueryResponse>

_upsert()?

optional _upsert: (req, update?, options?) => Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L27

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Methods

batchUpsert()

batchUpsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L88

Parameters

Parameter	Type
`req`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Implementation of

AxDBService.batchUpsert

query()

query(req): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L128

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>

Returns

Promise<AxDBQueryResponse>

Implementation of

AxDBService.query

upsert()

upsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L54

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Implementation of

AxDBService.upsert

> AxDBCloudflare

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L44

Cloudflare: DB Service

Extends

AxDBBase

Constructors

new AxDBCloudflare()

new AxDBCloudflare(__namedParameters): AxDBCloudflare

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L48

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxDBCloudflareArgs`, `"name"`>>

Returns

AxDBCloudflare

Overrides

AxDBBase._batchUpsert

Properties

_batchUpsert()?

optional _batchUpsert: (batchReq, update?, options?) => Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L33

Parameters

Parameter	Type
`batchReq`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Inherited from

_query()?

optional _query: (req, options?) => Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L39

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBQueryResponse>

Inherited from

AxDBBase._query

Methods

_upsert()

_upsert(req, _update?, options?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L62

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`_update`?	`boolean`
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Overrides

AxDBBase._upsert

batchUpsert()

batchUpsert(batchReq, update?, options?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L98

Parameters

Parameter	Type
`batchReq`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Overrides

query()

query(req, options?): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L147

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBQueryResponse>

Overrides

upsert()

upsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L54

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Inherited from

> AxDBManager

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L33

Constructors

new AxDBManager()

new AxDBManager(__namedParameters): AxDBManager

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L40

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`AxDBManagerArgs`>

Returns

AxDBManager

Methods

insert()

insert(text, options?): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L53

Parameters

Parameter	Type
`text`	`Readonly`<`string` \| `string`[]>
`options`?	`Readonly`<{ `batchSize`: `number`; `maxWordsPerChunk`: `number`; `minWordsPerChunk`: `number`; }>

Returns

Promise<void>

query()

query(query, __namedParameters): Promise<AxDBMatch[][]>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L109

Parameters

Parameter	Type
`query`	`Readonly`<`string` \| `number` \| `string`[] \| `number`[]>
`__namedParameters`	`undefined` \| `Readonly`<{ `topPercent`: `number`; }>

Returns

Promise<AxDBMatch[][]>

> AxDBMemory

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L20

MemoryDB: DB Service

Extends

AxDBBase

Constructors

new AxDBMemory()

new AxDBMemory(__namedParameters): AxDBMemory

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L23

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxDBMemoryArgs`, `"name"`>>

Returns

AxDBMemory

Overrides

Methods

_batchUpsert()

_batchUpsert(batchReq, update?, _options?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L50

Parameters

Parameter	Type
`batchReq`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`
`_options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Overrides

AxDBBase._batchUpsert

_query()

_query(req, _options?): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L65

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>
`_options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBQueryResponse>

Overrides

AxDBBase._query

_upsert()

_upsert(req, _update?, _options?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L28

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`_update`?	`boolean`
`_options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Overrides

AxDBBase._upsert

batchUpsert()

batchUpsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L88

Parameters

Parameter	Type
`req`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Inherited from

clearDB()

clearDB(): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L100

Returns

void

getDB()

getDB(): AxDBState

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L92

Returns

AxDBState

query()

query(req): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L128

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>

Returns

Promise<AxDBQueryResponse>

Inherited from

setDB()

setDB(state): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L96

Parameters

Parameter	Type
`state`	`AxDBState`

Returns

void

upsert()

upsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L54

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Inherited from

> AxDBPinecone

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L58

Pinecone: DB Service

Extends

AxDBBase

Constructors

new AxDBPinecone()

new AxDBPinecone(__namedParameters): AxDBPinecone

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L62

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxDBPineconeArgs`, `"name"`>>

Returns

AxDBPinecone

Overrides

Properties

_query()?

optional _query: (req, options?) => Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L39

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBQueryResponse>

Inherited from

AxDBBase._query

Methods

_batchUpsert()

_batchUpsert(batchReq, _update?, options?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L85

Parameters

Parameter	Type
`batchReq`	readonly `AxDBUpsertRequest`[]
`_update`?	`boolean`
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Overrides

AxDBBase._batchUpsert

_upsert()

_upsert(req, update?, options?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L76

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Overrides

AxDBBase._upsert

batchUpsert()

batchUpsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L88

Parameters

Parameter	Type
`req`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Inherited from

query()

query(req, options?): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L111

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBQueryResponse>

Overrides

upsert()

upsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L54

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Inherited from

> AxDBWeaviate

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L39

Weaviate: DB Service

Extends

AxDBBase

Constructors

new AxDBWeaviate()

new AxDBWeaviate(__namedParameters): AxDBWeaviate

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L43

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxDBWeaviateArgs`, `"name"`>>

Returns

AxDBWeaviate

Overrides

Methods

_batchUpsert()

_batchUpsert(batchReq, update?, options?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L93

Parameters

Parameter	Type
`batchReq`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Overrides

AxDBBase._batchUpsert

_query()

_query(req, options?): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L138

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBQueryResponse>

Overrides

AxDBBase._query

_upsert()

_upsert(req, update?, options?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L57

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`
`options`?	`Readonly`<`AxDBBaseOpOptions`>

Returns

Promise<AxDBUpsertResponse>

Overrides

AxDBBase._upsert

batchUpsert()

batchUpsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L88

Parameters

Parameter	Type
`req`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Inherited from

query()

query(req): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L128

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>

Returns

Promise<AxDBQueryResponse>

Inherited from

upsert()

upsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L54

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

Inherited from

AxGen.addFieldProcessor

> AxDefaultQueryRewriter

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/rewriter.ts#L8

Extends

AxGen<AxRewriteIn, AxRewriteOut>

Constructors

new AxDefaultQueryRewriter()

new AxDefaultQueryRewriter(options?): AxDefaultQueryRewriter

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/rewriter.ts#L9

Parameters

Parameter	Type
`options`?	`Readonly`<`AxGenOptions`>

Returns

AxDefaultQueryRewriter

Overrides

AxGen.constructor

Methods

_forward1()

_forward1(ai, values, options): AsyncGenerator<{ delta: Partial<AxRewriteOut>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L628

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`AxRewriteIn`
`options`	`Readonly`<`AxProgramForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<AxRewriteOut>; version: number; }, void, unknown>

Inherited from

AxGen._forward1

addAssert()

addAssert(fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L133

Parameters

Parameter	Type
`fn`	(`values`) => `undefined` \| `boolean` \| `Promise`<`undefined` \| `boolean`>
`message`?	`string`

Returns

void

Inherited from

AxGen.addAssert

addFieldProcessor()

addFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L180

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

Inherited from

addStreamingAssert()

addStreamingAssert(fieldName, fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L137

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	(`content`, `done`?) => `undefined` \| `boolean`
`message`?	`string`

Returns

void

Inherited from

AxGen.addStreamingAssert

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L173

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

Inherited from

AxGen.addStreamingFieldProcessor

forward()

forward(ai, values, options?): Promise<AxRewriteOut>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L676

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`AxRewriteIn`
`options`?	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<AxRewriteOut>

Inherited from

AxGen.forward

getSignature()

getSignature(): AxSignature

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L135

Returns

Inherited from

AxGen.getSignature

getTraces()

getTraces(): AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L223

Returns

AxGen.streamingForward

Inherited from

AxGen.getTraces

getUsage()

getUsage(): AxTokenUsage & object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L237

Returns

AxTokenUsage & object[]

Inherited from

AxGen.getUsage

register()

register(prog): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L139

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable` & `AxUsable`>

Returns

void

Inherited from

AxGen.register

resetUsage()

resetUsage(): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L247

Returns

void

Inherited from

AxGen.resetUsage

setDemos()

setDemos(demos): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L254

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`[]

Returns

void

Inherited from

AxGen.setDemos

setExamples()

setExamples(examples): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L182

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`>

Returns

void

Inherited from

AxGen.setExamples

setId()

setId(id): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L169

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxGen.setId

setParentId()

setParentId(parentId): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L176

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxGen.setParentId

streamingForward()

streamingForward(ai, values, options?): AsyncGenerator<{ delta: Partial<AxRewriteOut>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L700

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`AxRewriteIn`
`options`?	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<AxRewriteOut>; version: number; }, void, unknown>

Inherited from

> AxDefaultResultReranker

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/reranker.ts#L8

Extends

AxGen<AxRerankerIn, AxRerankerOut>

Constructors

new AxDefaultResultReranker()

new AxDefaultResultReranker(options?): AxDefaultResultReranker

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/reranker.ts#L12

Parameters

Parameter	Type
`options`?	`Readonly`<`AxGenOptions`>

Returns

AxDefaultResultReranker

Overrides

AxGen.constructor

Methods

_forward1()

_forward1(ai, values, options): AsyncGenerator<{ delta: Partial<AxRerankerOut>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L628

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`AxRerankerIn`
`options`	`Readonly`<`AxProgramForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<AxRerankerOut>; version: number; }, void, unknown>

Inherited from

AxGen._forward1

addAssert()

addAssert(fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L133

Parameters

Parameter	Type
`fn`	(`values`) => `undefined` \| `boolean` \| `Promise`<`undefined` \| `boolean`>
`message`?	`string`

Returns

void

Inherited from

AxGen.addAssert

addFieldProcessor()

addFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L180

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

Inherited from

AxGen.addFieldProcessor

addStreamingAssert()

addStreamingAssert(fieldName, fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L137

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	(`content`, `done`?) => `undefined` \| `boolean`
`message`?	`string`

Returns

void

Inherited from

AxGen.addStreamingAssert

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L173

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

Inherited from

AxGen.addStreamingFieldProcessor

forward()

forward(ai, input, options?): Promise<AxRerankerOut>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/reranker.ts#L19

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`input`	`Readonly`<`AxRerankerIn`>
`options`?	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<AxRerankerOut>

Overrides

AxGen.forward

getSignature()

getSignature(): AxSignature

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L135

Returns

Inherited from

AxGen.getSignature

getTraces()

getTraces(): AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L223

Returns

AxGen.streamingForward

Inherited from

AxGen.getTraces

getUsage()

getUsage(): AxTokenUsage & object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L237

Returns

AxTokenUsage & object[]

Inherited from

AxGen.getUsage

register()

register(prog): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L139

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable` & `AxUsable`>

Returns

void

Inherited from

AxGen.register

resetUsage()

resetUsage(): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L247

Returns

void

Inherited from

AxGen.resetUsage

setDemos()

setDemos(demos): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L254

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`[]

Returns

void

Inherited from

AxGen.setDemos

setExamples()

setExamples(examples): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L182

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`>

Returns

void

Inherited from

AxGen.setExamples

setId()

setId(id): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L169

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxGen.setId

setParentId()

setParentId(parentId): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L176

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxGen.setParentId

streamingForward()

streamingForward(ai, values, options?): AsyncGenerator<{ delta: Partial<AxRerankerOut>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L700

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`AxRerankerIn`
`options`?	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<AxRerankerOut>; version: number; }, void, unknown>

Inherited from

> AxDockerSession

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L56

Constructors

new AxDockerSession()

new AxDockerSession(apiUrl): AxDockerSession

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L60

Parameters

Parameter	Type	Default value
`apiUrl`	`string`	`'http://localhost:2375'`

Returns

AxDockerSession

Methods

connectToContainer()

connectToContainer(containerId): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L186

Parameters

Parameter	Type
`containerId`	`string`

Returns

Promise<void>

createContainer()

createContainer(__namedParameters): Promise<{ Id: string; }>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L80

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `doNotPullImage`: `boolean`; `imageName`: `string`; `tag`: `string`; `volumes`: `object`[]; }>

Returns

Promise<{ Id: string; }>

executeCommand()

executeCommand(command): Promise<string>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L274

Parameters

Parameter	Type
`command`	`string`

Returns

Promise<string>

findOrCreateContainer()

findOrCreateContainer(__namedParameters): Promise<{ Id: string; isNew: boolean; }>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L128

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `doNotPullImage`: `boolean`; `imageName`: `string`; `tag`: `string`; `volumes`: `object`[]; }>

Returns

Promise<{ Id: string; isNew: boolean; }>

getContainerLogs()

getContainerLogs(): Promise<string>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L263

Returns

Promise<string>

listContainers()

listContainers(all): Promise<AxDockerContainer[]>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L256

Parameters

Parameter	Type	Default value
`all`	`boolean`	`false`

Returns

Promise<AxDockerContainer[]>

pullImage()

pullImage(imageName): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L64

Parameters

Parameter	Type
`imageName`	`string`

Returns

Promise<void>

startContainer()

startContainer(): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L169

Returns

Promise<void>

stopContainers()

stopContainers(__namedParameters): Promise<object[]>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L198

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `remove`: `boolean`; `tag`: `string`; `timeout`: `number`; }>

Returns

Promise<object[]>

toFunction()

toFunction(): AxFunction

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L373

Returns

> AxEmbeddingAdapter

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/embed.ts#L7

Constructors

new AxEmbeddingAdapter()

new AxEmbeddingAdapter(__namedParameters): AxEmbeddingAdapter

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/embed.ts#L19

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `ai`: `AxAIService`; `func`: (`args`, `extra`?) => `Promise`<`unknown`>; `info`: `Readonly`<{ `argumentDescription`: `string`; `description`: `string`; `name`: `string`; }>; }>

Returns

AxEmbeddingAdapter

Methods

toFunction()

toFunction(): AxFunction

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/embed.ts#L57

Returns

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

> AxFunctionError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/functions.ts#L15

Extends

Error

Constructors

new AxFunctionError()

new AxFunctionError(fields): AxFunctionError

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/functions.ts#L16

Parameters

Parameter	Type
`fields`	`object`[]

Returns

AxFunctionError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

Error.prepareStackTrace

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Error.stackTraceLimit

Methods

getFields()

getFields(): object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/functions.ts#L26

Returns

object[]

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

Error.captureStackTrace

> AxFunctionProcessor

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/functions.ts#L73

Constructors

new AxFunctionProcessor()

new AxFunctionProcessor(funcList): AxFunctionProcessor

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/functions.ts#L76

Parameters

Parameter	Type
`funcList`	readonly `AxFunction`[]

Returns

AxFunctionProcessor

Methods

execute()

execute(func, options?): Promise<string>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/functions.ts#L116

Parameters

Parameter	Type
`func`	`Readonly`<`AxChatResponseFunctionCall`>
`options`?	`Readonly`<`AxAIServiceActionOptions`>

Returns

Promise<string>

> AxGen

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L100

Extends

AxProgramWithSignature<IN, OUT>

Extended by

Type Parameters

Type Parameter	Default type
`IN` extends `AxGenIn`	`AxGenIn`
`OUT` extends `AxGenerateResult`<`AxGenOut`>	`AxGenerateResult`<`AxGenOut`>

Constructors

new AxGen()

new AxGen<IN, OUT>(signature, options?): AxGen<IN, OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L113

Parameters

Parameter	Type
`signature`	`Readonly`<`string` \| `AxSignature`>
`options`?	`Readonly`<`AxGenOptions`>

Returns

AxGen<IN, OUT>

Overrides

AxProgramWithSignature.constructor

Methods

_forward1()

_forward1(ai, values, options): AsyncGenerator<{ delta: Partial<OUT>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L628

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`IN`
`options`	`Readonly`<`AxProgramForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<OUT>; version: number; }, void, unknown>

addAssert()

addAssert(fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L133

Parameters

Parameter	Type
`fn`	(`values`) => `undefined` \| `boolean` \| `Promise`<`undefined` \| `boolean`>
`message`?	`string`

Returns

void

addFieldProcessor()

addFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L180

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

addStreamingAssert()

addStreamingAssert(fieldName, fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L137

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	(`content`, `done`?) => `undefined` \| `boolean`
`message`?	`string`

Returns

void

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L173

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

forward()

forward(ai, values, options?): Promise<OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L676

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`IN`
`options`?	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT>

Overrides

AxProgramWithSignature.forward

getSignature()

getSignature(): AxSignature

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L135

Returns

AxProgramWithSignature.getSignature

Inherited from

getTraces()

getTraces(): AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L223

Returns

AxProgramWithSignature.getTraces

Inherited from

getUsage()

getUsage(): AxTokenUsage & object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L237

Returns

AxTokenUsage & object[]

Inherited from

AxProgramWithSignature.getUsage

register()

register(prog): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L139

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable` & `AxUsable`>

Returns

void

Inherited from

AxProgramWithSignature.register

resetUsage()

resetUsage(): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L247

Returns

void

Inherited from

AxProgramWithSignature.resetUsage

setDemos()

setDemos(demos): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L254

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`[]

Returns

void

Inherited from

AxProgramWithSignature.setDemos

setExamples()

setExamples(examples): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L182

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`>

Returns

void

Inherited from

AxProgramWithSignature.setExamples

setId()

setId(id): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L169

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxProgramWithSignature.setId

setParentId()

setParentId(parentId): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L176

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxProgramWithSignature.setParentId

streamingForward()

streamingForward(ai, values, options?): AsyncGenerator<{ delta: Partial<OUT>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L700

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	`IN`
`options`?	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<OUT>; version: number; }, void, unknown>

Overrides

AxProgramWithSignature.streamingForward

> AxHFDataLoader

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/loader.ts#L5

Constructors

new AxHFDataLoader()

new AxHFDataLoader(__namedParameters): AxHFDataLoader

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/loader.ts#L14

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `config`: `string`; `dataset`: `string`; `options`: `Readonly`<{ `length`: `number`; `offset`: `number`; }>; `split`: `string`; }>

Returns

AxHFDataLoader

Methods

getData()

getData(): AxDataRow[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/loader.ts#L67

Returns

AxDataRow[]

getRows()

getRows<T>(__namedParameters): Promise<T[]>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/loader.ts#L71

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `count`: `number`; `fields`: readonly `string`[]; `renameMap`: `Record`<`string`, `string`>; }>

Returns

Promise<T[]>

loadData()

loadData(): Promise<AxDataRow[]>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/loader.ts#L51

Returns

Promise<AxDataRow[]>

setData()

setData(rows): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/loader.ts#L63

Parameters

Parameter	Type
`rows`	`AxDataRow`[]

Returns

void

> AxJSInterpreter

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/code.ts#L29

Constructors

new AxJSInterpreter()

new AxJSInterpreter(__namedParameters): AxJSInterpreter

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/code.ts#L32

Parameters

Parameter	Type
`__namedParameters`	`undefined` \| `Readonly`<{ `permissions`: readonly `AxJSInterpreterPermission`[]; }>

Returns

AxJSInterpreter

Methods

toFunction()

toFunction(): AxFunction

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/code.ts#L67

Returns

AxMCPTransport.connect

> AxInstanceRegistry

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/registry.ts#L1

Type Parameters

Type Parameter
`T`

Constructors

new AxInstanceRegistry()

new AxInstanceRegistry<T>(): AxInstanceRegistry<T>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/registry.ts#L4

Returns

AxInstanceRegistry<T>

Methods

[iterator]()

[iterator](): Generator<T, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/registry.ts#L12

Returns

Generator<T, void, unknown>

register()

register(instance): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/registry.ts#L8

Parameters

Parameter	Type
`instance`	`T`

Returns

void

> AxMCPClient

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/client.ts#L59

Constructors

new AxMCPClient()

new AxMCPClient(transport, options): AxMCPClient

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/client.ts#L69

Parameters

Parameter	Type
`transport`	`AxMCPTransport`
`options`	`Readonly`<`AxMCPClientOptions`>

Returns

AxMCPClient

Methods

cancelRequest()

cancelRequest(id): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/client.ts#L193

Parameters

Parameter	Type
`id`	`string`

Returns

void

init()

init(): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/client.ts#L74

Returns

Promise<void>

ping()

ping(timeout): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/client.ts#L168

Parameters

Parameter	Type	Default value
`timeout`	`number`	`3000`

Returns

Promise<void>

toFunction()

toFunction(): AxFunction[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/client.ts#L189

Returns

AxFunction[]

> AxMCPHTTPTransport

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/httpTransport.ts#L8

Implements

AxMCPTransport

Constructors

new AxMCPHTTPTransport()

new AxMCPHTTPTransport(sseUrl): AxMCPHTTPTransport

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/httpTransport.ts#L13

Parameters

Parameter	Type
`sseUrl`	`string`

Returns

AxMCPHTTPTransport

Methods

connect()

connect(): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/httpTransport.ts#L17

Connects to the transport if needed This method is optional and only required for transports that need connection setup

Returns

Promise<void>

Implementation of

send()

send(message): Promise<JSONRPCResponse<unknown>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/httpTransport.ts#L41

Sends a JSON-RPC request or notification and returns the response

Parameters

Parameter	Type	Description
`message`	`JSONRPCNotification` \| `JSONRPCRequest`<`unknown`>	The JSON-RPC request or notification to send

Returns

Promise<JSONRPCResponse<unknown>>

A Promise that resolves to the JSON-RPC response

Implementation of

AxMCPTransport.send

sendNotification()

sendNotification(message): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/httpTransport.ts#L63

Sends a JSON-RPC notification

Parameters

Parameter	Type	Description
`message`	`Readonly`<`JSONRPCNotification`>	The JSON-RPC notification to send

Returns

Promise<void>

Implementation of

AxMCPTransport.sendNotification

> AxMemory

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L180

Implements

AxAIMemory

Constructors

new AxMemory()

new AxMemory(limit, options?): AxMemory

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L184

Parameters

Parameter	Type	Default value
`limit`	`number`	`defaultLimit`
`options`?	{ `debug`: `boolean`; `debugHideSystemPrompt`: `boolean`; }	`undefined`
`options.debug`?	`boolean`	`undefined`
`options.debugHideSystemPrompt`?	`boolean`	`undefined`

Returns

AxMemory

Methods

add()

add(value, sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L206

Parameters

Parameter Type

value { cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; } | ({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[]

sessionId? string

Returns

void

Implementation of

AxAIMemory.add

addResult()

addResult(result, sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L213

Parameters

Parameter	Type
`result`	`Readonly`<`AxChatResponseResult`>
`sessionId`?	`string`

Returns

void

Implementation of

AxAIMemory.addResult

addTag()

addTag(name, sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L224

Parameters

Parameter	Type
`name`	`string`
`sessionId`?	`string`

Returns

void

Implementation of

AxAIMemory.addTag

getLast()

getLast(sessionId?): undefined | { chat: { cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; }; tags: string[]; }

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L236

Parameters

Parameter	Type
`sessionId`?	`string`

Returns

undefined | { chat: { cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; }; tags: string[]; }

Implementation of

AxAIMemory.getLast

history()

history(sessionId?): ({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L232

Parameters

Parameter	Type
`sessionId`?	`string`

Returns

({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[]

Implementation of

AxAIMemory.history

reset()

reset(sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L240

Parameters

Parameter	Type
`sessionId`?	`string`

Returns

void

Implementation of

AxAIMemory.reset

rewindToTag()

rewindToTag(name, sessionId?): ({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L228

Parameters

Parameter	Type
`name`	`string`
`sessionId`?	`string`

Returns

Implementation of

AxAIMemory.rewindToTag

updateResult()

updateResult(result, sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/memory.ts#L217

Parameters

Parameter	Type
`result`	`Readonly`<`AxChatResponseResult`>
`sessionId`?	`string`

Returns

void

Implementation of

AxAIMemory.updateResult

> AxMCPStdioTransport

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/stdioTransport.ts#L17

Implements

AxMCPTransport

Constructors

new AxMCPStdioTransport()

new AxMCPStdioTransport(config): AxMCPStdioTransport

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/stdioTransport.ts#L25

Parameters

Parameter	Type
`config`	`Readonly`<`StdioTransportConfig`>

Returns

AxMCPStdioTransport

Methods

connect()

connect(): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/stdioTransport.ts#L57

Connects to the transport if needed This method is optional and only required for transports that need connection setup

Returns

Promise<void>

Implementation of

AxMCPTransport.connect

send()

send(message): Promise<JSONRPCResponse<unknown>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/stdioTransport.ts#L40

Sends a JSON-RPC request or notification and returns the response

Parameters

Parameter	Type	Description
`message`	`Readonly`<`JSONRPCRequest`<`unknown`>>	The JSON-RPC request or notification to send

Returns

Promise<JSONRPCResponse<unknown>>

A Promise that resolves to the JSON-RPC response

Implementation of

AxMCPTransport.send

sendNotification()

sendNotification(message): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/stdioTransport.ts#L51

Sends a JSON-RPC notification

Parameters

Parameter	Type	Description
`message`	`Readonly`<`JSONRPCNotification`>	The JSON-RPC notification to send

Returns

Promise<void>

Implementation of

AxMCPTransport.sendNotification

> AxMiPRO

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L43

Type Parameters

Type Parameter	Default type
`IN` extends `AxGenIn`	`AxGenIn`
`OUT` extends `AxGenOut`	`AxGenOut`

Constructors

new AxMiPRO()

new AxMiPRO<IN, OUT>(__namedParameters): AxMiPRO<IN, OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L69

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`AxOptimizerArgs`<`IN`, `OUT`>> & `object`

Returns

AxMiPRO<IN, OUT>

Methods

compile()

compile(metricFn, options?): Promise<Readonly<AxProgram<IN, OUT>>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L794

The main compile method to run MIPROv2 optimization

Parameters

Parameter	Type	Description
`metricFn`	`AxMetricFn`	Evaluation metric function
`options`?	`Readonly`<{ `auto`: `"medium"` \| `"light"` \| `"heavy"`; `teacher`: `Readonly`<`AxProgram`<`IN`, `OUT`>>; `valset`: readonly `AxExample`[]; }>	Optional configuration options

Returns

Promise<Readonly<AxProgram<IN, OUT>>>

The optimized program

configureAuto()

configureAuto(level): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L120

Configures the optimizer for light, medium, or heavy optimization

Parameters

Parameter	Type	Description
`level`	`"medium"` \| `"light"` \| `"heavy"`	The optimization level: “light”, “medium”, or “heavy”

Returns

void

> AxMultiServiceRouter

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L23

Implements

AxAIService<string, string>

Constructors

new AxMultiServiceRouter()

new AxMultiServiceRouter(services): AxMultiServiceRouter

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L39

Constructs a new multi-service router. It validates that each service provides a unique set of model keys, then builds a lookup (map) for routing the chat/embed requests.

Parameters

Parameter	Type
`services`	(`AxAIService`<`unknown`, `unknown`> \| `AxAIServiceListItem`)[]

Returns

AxMultiServiceRouter

Methods

chat()

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

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L93

Delegates the chat call to the service matching the provided model key.

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`string`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`string`, `string`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L117

Delegates the embed call to the service matching the provided embed model key.

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`string`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`string`, `string`>>

Returns

Promise<AxEmbedResponse>

Implementation of

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L169

Returns

Readonly<{ embedModel: string; model: string; }>

Implementation of

getFeatures()

getFeatures(model?): object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L179

If a model key is provided, delegate to the corresponding service’s features. Otherwise, returns a default feature set.

Parameters

Parameter	Type
`model`?	`string`

Returns

object

functionCot?

optional functionCot: boolean

functions

functions: boolean

streaming

streaming: boolean

Implementation of

getId()

getId(): string

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

Returns a composite ID built from the IDs of the underlying services.

Returns

string

Implementation of

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L198

Returns aggregated metrics from the underlying service. Uses the metrics from the last service that was used, or falls back to the first service if none has been used.

Returns

Implementation of

getModelList()

getModelList(): AxAIModelList

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L159

Aggregates all available models across the underlying services.

Returns

AxAIModelList

Implementation of

getName()

getName(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L152

Returns the name of this router.

Returns

string

Implementation of

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L219

Returns the options from the last used service, or falls back to the first service if none has been used.

Returns

Readonly<AxAIServiceOptions>

Implementation of

setOptions()

setOptions(options): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/multiservice.ts#L209

Sets options on all underlying services.

Parameters

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

Returns

void

Implementation of

> AxMockAIService

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L46

Implements

AxAIService

Constructors

new AxMockAIService()

new AxMockAIService(config): AxMockAIService

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L58

Parameters

Parameter	Type
`config`	`AxMockAIServiceConfig`

Returns

AxMockAIService

Methods

chat()

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

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L93

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`unknown`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`unknown`, `unknown`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L131

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`>
`_options`?	`Readonly`<`AxAIServiceActionOptions`>

Returns

Promise<AxEmbedResponse>

Implementation of

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L82

Returns

Readonly<{ embedModel: string; model: string; }>

Implementation of

getFeatures()

getFeatures(_model?): object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L71

Parameters

Parameter	Type
`_model`?	`string`

Returns

object

functions

functions: boolean

streaming

streaming: boolean

Implementation of

getId()

getId(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L66

Returns

string

Implementation of

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L89

Returns

Implementation of

getModelList()

getModelList(): undefined | AxAIModelList

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L78

Returns

undefined | AxAIModelList

Implementation of

getName()

getName(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L62

Returns

string

Implementation of

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L166

Returns

Readonly<AxAIServiceOptions>

Implementation of

setOptions()

setOptions(options): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mock/api.ts#L162

Parameters

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

Returns

void

Implementation of

> AxProgramWithSignature

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L107

Extended by

AxGen

Type Parameters

Type Parameter
`IN` extends `AxGenIn`
`OUT` extends `AxGenOut`

Implements

Constructors

new AxProgramWithSignature()

new AxProgramWithSignature<IN, OUT>(signature, options?): AxProgramWithSignature<IN, OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L121

Parameters

Parameter	Type
`signature`	`Readonly`<`string` \| `AxSignature`>
`options`?	`Readonly`<`AxProgramWithSignatureOptions`>

Returns

AxProgramWithSignature<IN, OUT>

Methods

forward()

forward(_ai, _values, _options?): Promise<OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L146

Parameters

Parameter	Type
`_ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`_values`	`IN`
`_options`?	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT>

getSignature()

getSignature(): AxSignature

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L135

Returns

getTraces()

getTraces(): AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L223

Returns

AxTunable.setExamples

Implementation of

AxTunable.getTraces

getUsage()

getUsage(): AxTokenUsage & object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L237

Returns

AxTokenUsage & object[]

Implementation of

AxUsable.getUsage

register()

register(prog): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L139

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable` & `AxUsable`>

Returns

void

resetUsage()

resetUsage(): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L247

Returns

void

Implementation of

AxUsable.resetUsage

setDemos()

setDemos(demos): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L254

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`[]

Returns

void

Implementation of

AxTunable.setDemos

setExamples()

setExamples(examples): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L182

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`>

Returns

void

Implementation of

setId()

setId(id): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L169

Parameters

Parameter	Type
`id`	`string`

Returns

void

Implementation of

AxTunable.setId

setParentId()

setParentId(parentId): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L176

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Implementation of

AxTunable.setParentId

streamingForward()

streamingForward(_ai, _values, _options?): AxGenStreamingOut<OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L158

Parameters

Parameter	Type
`_ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`_values`	`IN`
`_options`?	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AxGenStreamingOut<OUT>

> AxPromptTemplate

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/prompt.ts#L35

Constructors

new AxPromptTemplate()

new AxPromptTemplate(sig, functions?, fieldTemplates?): AxPromptTemplate

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/prompt.ts#L40

Parameters

Parameter	Type
`sig`	`Readonly`<`AxSignature`>
`functions`?	readonly (`AxFunction` \| { `toFunction`: () => `AxFunction` \| `AxFunction`[]; })[]
`fieldTemplates`?	`Record`<`string`, `AxFieldTemplateFn`>

Returns

AxPromptTemplate

Methods

render()

render<T>(values, __namedParameters): ({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/prompt.ts#L93

Type Parameters

Type Parameter
`T` extends `Record`<`string`, `AxFieldValue`>

Parameters

Parameter	Type
`values`	`T`
`__namedParameters`	`Readonly`<{ `demos`: `Record`<`string`, `AxFieldValue`>[]; `examples`: `Record`<`string`, `AxFieldValue`>[]; `skipSystemPrompt`: `boolean`; }>

Returns

renderExtraFields()

renderExtraFields(extraFields): ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/prompt.ts#L158

Parameters

Parameter	Type
`extraFields`	readonly `AxIField`[]

Returns

({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]

> AxRAG

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/rag.ts#L12

Extends

AxChainOfThought<{ context: string[]; question: string; }, { answer: string; }>

Constructors

new AxRAG()

new AxRAG(queryFn, options): AxRAG

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/rag.ts#L23

Parameters

Parameter	Type
`queryFn`	(`query`) => `Promise`<`string`>
`options`	`Readonly`<`AxGenOptions` & `object`>

Returns

AxRAG

Overrides

AxChainOfThought.constructor

Methods

_forward1()

_forward1(ai, values, options): AsyncGenerator<{ delta: Partial<object & object>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L628

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	{ `context`: `string`[]; `question`: `string`; }
`values.context`	`string`[]
`values.question`	`string`
`options`	`Readonly`<`AxProgramForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<object & object>; version: number; }, void, unknown>

Inherited from

AxChainOfThought._forward1

addAssert()

addAssert(fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L133

Parameters

Parameter	Type
`fn`	(`values`) => `undefined` \| `boolean` \| `Promise`<`undefined` \| `boolean`>
`message`?	`string`

Returns

void

Inherited from

AxChainOfThought.addAssert

addFieldProcessor()

addFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L180

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

Inherited from

AxChainOfThought.addFieldProcessor

addStreamingAssert()

addStreamingAssert(fieldName, fn, message?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L137

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	(`content`, `done`?) => `undefined` \| `boolean`
`message`?	`string`

Returns

void

Inherited from

AxChainOfThought.addStreamingAssert

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName, fn): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L173

Parameters

Parameter	Type
`fieldName`	`string`
`fn`	`AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`

Returns

void

Inherited from

AxChainOfThought.addStreamingFieldProcessor

forward()

forward(ai, __namedParameters, options?): Promise<{ answer: string; reason: string; }>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/rag.ts#L44

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`__namedParameters`	`Readonly`<{ `question`: `string`; }>
`options`?	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<{ answer: string; reason: string; }>

Overrides

AxChainOfThought.forward

getSignature()

getSignature(): AxSignature

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L135

Returns

AxChainOfThought.getSignature

Inherited from

getTraces()

getTraces(): AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L223

Returns

AxChainOfThought.getTraces

Inherited from

getUsage()

getUsage(): AxTokenUsage & object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L237

Returns

AxTokenUsage & object[]

Inherited from

AxChainOfThought.getUsage

register()

register(prog): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L139

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable` & `AxUsable`>

Returns

void

Inherited from

AxChainOfThought.register

resetUsage()

resetUsage(): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L247

Returns

void

Inherited from

AxChainOfThought.resetUsage

setDemos()

setDemos(demos): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L254

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`[]

Returns

void

Inherited from

AxChainOfThought.setDemos

setExamples()

setExamples(examples): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L182

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`>

Returns

void

Inherited from

AxChainOfThought.setExamples

setId()

setId(id): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L169

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxChainOfThought.setId

setParentId()

setParentId(parentId): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L176

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxChainOfThought.setParentId

streamingForward()

streamingForward(ai, values, options?): AsyncGenerator<{ delta: Partial<object & object>; version: number; }, void, unknown>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L700

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`values`	{ `context`: `string`[]; `question`: `string`; }
`values.context`	`string`[]
`values.question`?	`string`
`options`?	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AsyncGenerator<{ delta: Partial<object & object>; version: number; }, void, unknown>

Inherited from

AxChainOfThought.streamingForward

> AxProgram

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L267

Type Parameters

Type Parameter
`IN` extends `AxGenIn`
`OUT` extends `AxGenOut`

Implements

Constructors

new AxProgram()

new AxProgram<IN, OUT>(): AxProgram<IN, OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L276

Returns

AxProgram<IN, OUT>

Methods

forward()

forward(_ai, _values, _options?): Promise<OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L288

Parameters

Parameter	Type
`_ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`_values`	`IN`
`_options`?	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT>

getTraces()

getTraces(): AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L334

Returns

AxTunable.setExamples

Implementation of

AxTunable.getTraces

getUsage()

getUsage(): AxTokenUsage & object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L348

Returns

AxTokenUsage & object[]

Implementation of

AxUsable.getUsage

register()

register(prog): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L281

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable` & `AxUsable`>

Returns

void

resetUsage()

resetUsage(): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L358

Returns

void

Implementation of

AxUsable.resetUsage

setDemos()

setDemos(demos): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L365

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`[]

Returns

void

Implementation of

AxTunable.setDemos

setExamples()

setExamples(examples): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L324

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`>

Returns

void

Implementation of

setId()

setId(id): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L311

Parameters

Parameter	Type
`id`	`string`

Returns

void

Implementation of

AxTunable.setId

setParentId()

setParentId(parentId): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L318

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Implementation of

AxTunable.setParentId

streamingForward()

streamingForward(_ai, _values, _options?): AxGenStreamingOut<OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L300

Parameters

Parameter	Type
`_ai`	`Readonly`<`AxAIService`<`unknown`, `unknown`>>
`_values`	`IN`
`_options`?	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AxGenStreamingOut<OUT>

> AxRateLimiterTokenUsage

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/rate-limit.ts#L9

Constructors

new AxRateLimiterTokenUsage()

new AxRateLimiterTokenUsage(maxTokens, refillRate, options?): AxRateLimiterTokenUsage

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/rate-limit.ts#L16

Parameters

Parameter	Type
`maxTokens`	`number`
`refillRate`	`number`
`options`?	`Readonly`<`AxRateLimiterTokenUsageOptions`>

Returns

AxRateLimiterTokenUsage

Methods

acquire()

acquire(tokens): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/rate-limit.ts#L56

Parameters

Parameter	Type
`tokens`	`number`

Returns

Promise<void>

> AxSimpleClassifier

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L29

Constructors

new AxSimpleClassifier()

new AxSimpleClassifier(ai): AxSimpleClassifier

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L35

Parameters

Parameter	Type
`ai`	`AxAIService`

Returns

AxSimpleClassifier

Methods

forward()

forward(text, options?): Promise<string>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L61

Parameters

Parameter	Type
`text`	`string`
`options`?	`Readonly`<`AxSimpleClassifierForwardOptions`>

Returns

Promise<string>

getState()

getState(): undefined | AxDBState

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L40

Returns

undefined | AxDBState

setClasses()

setClasses(classes): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L48

Parameters

Parameter	Type
`classes`	readonly `AxSimpleClassifierClass`[]

Returns

Promise<void>

setOptions()

setOptions(options): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L96

Parameters

Parameter	Type
`options`	`Readonly`<{ `debug`: `boolean`; }>

Returns

void

setState()

setState(state): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L44

Parameters

Parameter	Type
`state`	`AxDBState`

Returns

void

> AxSignature

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L37

Constructors

new AxSignature()

new AxSignature(signature?): AxSignature

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L45

Parameters

Parameter	Type
`signature`?	`Readonly`<`string` \| `AxSignature`>

Returns

AxSimpleClassifierClass

Methods

addInputField()

addInputField(field): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L118

Parameters

Parameter	Type
`field`	`Readonly`<`AxField`>

Returns

void

addOutputField()

addOutputField(field): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L123

Parameters

Parameter	Type
`field`	`Readonly`<`AxField`>

Returns

void

getDescription()

getDescription(): undefined | string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L140

Returns

undefined | string

getInputFields()

getInputFields(): readonly AxIField[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L138

Returns

readonly AxIField[]

getOutputFields()

getOutputFields(): readonly AxIField[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L139

Returns

readonly AxIField[]

hash()

hash(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L210

Returns

string

setDescription()

setDescription(desc): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L113

Parameters

Parameter	Type
`desc`	`string`

Returns

void

setInputFields()

setInputFields(fields): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L128

Parameters

Parameter	Type
`fields`	readonly `AxField`[]

Returns

void

setOutputFields()

setOutputFields(fields): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L133

Parameters

Parameter	Type
`fields`	readonly `AxField`[]

Returns

void

toJSONSchema()

toJSONSchema(): AxFunctionJSONSchema

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L148

Returns

AxFunctionJSONSchema

toString()

toString(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L212

Returns

string

> AxSimpleClassifierClass

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L11

Constructors

new AxSimpleClassifierClass()

new AxSimpleClassifierClass(name, context): AxSimpleClassifierClass

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L15

Parameters

Parameter	Type
`name`	`string`
`context`	readonly `string`[]

Returns

Methods

getContext()

getContext(): readonly string[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L24

Returns

readonly string[]

getName()

getName(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L20

Returns

string

> AxTestPrompt

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/evaluate.ts#L13

Type Parameters

Type Parameter	Default type
`IN` extends `AxGenIn`	`AxGenIn`
`OUT` extends `AxGenOut`	`AxGenOut`

Constructors

new AxTestPrompt()

new AxTestPrompt<IN, OUT>(__namedParameters): AxTestPrompt<IN, OUT>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/evaluate.ts#L21

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`AxEvaluateArgs`<`IN`, `OUT`>>

Returns

AxTestPrompt<IN, OUT>

Methods

run()

run(metricFn): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/evaluate.ts#L34

Parameters

Parameter	Type
`metricFn`	`AxMetricFn`

Returns

Promise<void>

> AxAIAnthropicModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L3

Enumeration Members

Claude21

Claude21: "claude-2.1"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L13

Claude35Haiku

Claude35Haiku: "claude-3-5-haiku-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L7

Claude35Sonnet

Claude35Sonnet: "claude-3-5-sonnet-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L6

Claude37Sonnet

Claude37Sonnet: "claude-3-7-sonnet-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L4

Claude3Haiku

Claude3Haiku: "claude-3-haiku-20240307"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L11

Claude3Opus

Claude3Opus: "claude-3-opus-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L9

Claude3Sonnet

Claude3Sonnet: "claude-3-sonnet-20240229"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L10

ClaudeInstant12

ClaudeInstant12: "claude-instant-1.2"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L14

> AxAIAnthropicVertexModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L17

Enumeration Members

Claude35Haiku

Claude35Haiku: "claude-3-5-haiku"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L19

Claude35Sonnet

Claude35Sonnet: "claude-3-5-sonnet"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L20

Claude35SonnetV2

Claude35SonnetV2: "claude-3-5-sonnet-v2"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L21

Claude37Sonnet

Claude37Sonnet: "claude-3-7-sonnet"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L18

Claude3Haiku

Claude3Haiku: "claude-3-haiku"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L22

Claude3Opus

Claude3Opus: "claude-3-opus"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L23

> AxAICohereEmbedModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L16

Cohere: Models for use in embeddings

Enumeration Members

EmbedEnglishLightV30

EmbedEnglishLightV30: "embed-english-light-v3.0"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L18

EmbedEnglishV30

EmbedEnglishV30: "embed-english-v3.0"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L17

EmbedMultiLingualLightV30

EmbedMultiLingualLightV30: "embed-multilingual-light-v3.0"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L20

EmbedMultiLingualV30

EmbedMultiLingualV30: "embed-multilingual-v3.0"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L19

> AxAICohereModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L6

Cohere: Models for text generation

Enumeration Members

Command

Command: "command"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L9

CommandLight

CommandLight: "command-light"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L10

CommandR

CommandR: "command-r"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L8

CommandRPlus

CommandRPlus: "command-r-plus"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/types.ts#L7

> AxAIDeepSeekModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/deepseek/types.ts#L4

DeepSeek: Models for text generation

Enumeration Members

DeepSeekChat

DeepSeekChat: "deepseek-chat"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/deepseek/types.ts#L5

DeepSeekCoder

DeepSeekCoder: "deepseek-coder"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/deepseek/types.ts#L6

> AxAIGoogleGeminiEmbedModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L17

Enumeration Members

TextEmbedding004

TextEmbedding004: "text-embedding-004"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L18

TextEmbedding005

TextEmbedding005: "text-embedding-005"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L19

> AxAIGoogleGeminiModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L3

Enumeration Members

AQA

AQA: "aqa"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L14

Gemini15Flash

Gemini15Flash: "gemini-1.5-flash"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L9

Gemini15Flash002

Gemini15Flash002: "gemini-1.5-flash-002"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L10

Gemini15Flash8B

Gemini15Flash8B: "gemini-1.5-flash-8b"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L11

Gemini15Pro

Gemini15Pro: "gemini-1.5-pro"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L12

Gemini1Pro

Gemini1Pro: "gemini-1.0-pro"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L8

Gemini20Flash

Gemini20Flash: "gemini-2.0-flash"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L5

Gemini20FlashLite

Gemini20FlashLite: "gemini-2.0-flash-lite-preview-02-05"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L6

Gemini20FlashThinking

Gemini20FlashThinking: "gemini-2.0-flash-thinking-exp-01-21"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L7

Gemini20Pro

Gemini20Pro: "gemini-2.0-pro-exp-02-05"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L4

Gemma2

Gemma2: "gemma-2-27b-it"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L13

> AxAIGoogleGeminiSafetyCategory

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L22

Enumeration Members

HarmCategoryDangerousContent

HarmCategoryDangerousContent: "HARM_CATEGORY_DANGEROUS_CONTENT"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L26

HarmCategoryHarassment

HarmCategoryHarassment: "HARM_CATEGORY_HARASSMENT"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L23

HarmCategoryHateSpeech

HarmCategoryHateSpeech: "HARM_CATEGORY_HATE_SPEECH"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L24

HarmCategorySexuallyExplicit

HarmCategorySexuallyExplicit: "HARM_CATEGORY_SEXUALLY_EXPLICIT"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L25

> AxAIGoogleGeminiSafetyThreshold

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L29

Enumeration Members

BlockDefault

BlockDefault: "HARM_BLOCK_THRESHOLD_UNSPECIFIED"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L34

BlockLowAndAbove

BlockLowAndAbove: "BLOCK_LOW_AND_ABOVE"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L33

BlockMediumAndAbove

BlockMediumAndAbove: "BLOCK_MEDIUM_AND_ABOVE"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L32

BlockNone

BlockNone: "BLOCK_NONE"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L30

BlockOnlyHigh

BlockOnlyHigh: "BLOCK_ONLY_HIGH"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/types.ts#L31

> AxAIGroqModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/groq/types.ts#L1

Enumeration Members

Gemma2_9B

Gemma2_9B: "gemma2-9b-it"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/groq/types.ts#L5

Llama3_8B

Llama3_8B: "llama3-8b-8192"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/groq/types.ts#L2

Llama33_70B

Llama33_70B: "llama-3.3-70b-versatile"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/groq/types.ts#L3

Mixtral_8x7B

Mixtral_8x7B: "mixtral-8x7b-32768"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/groq/types.ts#L4

> AxAIHuggingFaceModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/types.ts#L3

Enumeration Members

MetaLlama270BChatHF

MetaLlama270BChatHF: "meta-llama/Llama-2-70b-chat-hf"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/types.ts#L4

> AxAIMistralEmbedModels

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L14

Enumeration Members

MistralEmbed

MistralEmbed: "mistral-embed"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L15

> AxAIMistralModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L3

Enumeration Members

Codestral

Codestral: "codestral-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L9

Mistral7B

Mistral7B: "open-mistral-7b"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L4

Mistral8x7B

Mistral8x7B: "open-mixtral-8x7b"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L5

MistralLarge

MistralLarge: "mistral-large-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L8

MistralNemo

MistralNemo: "mistral-nemo-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L7

MistralSmall

MistralSmall: "mistral-small-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L6

OpenCodestralMamba

OpenCodestralMamba: "open-codestral-mamba"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L10

OpenMistralNemo

OpenMistralNemo: "open-mistral-nemo-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/types.ts#L11

> AxAIOpenAIModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L3

Enumeration Members

GPT35TextDavinci002

GPT35TextDavinci002: "text-davinci-002"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L15

GPT35Turbo

GPT35Turbo: "gpt-3.5-turbo"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L13

GPT35TurboInstruct

GPT35TurboInstruct: "gpt-3.5-turbo-instruct"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L14

GPT3TextAda001

GPT3TextAda001: "text-ada-001"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L17

GPT3TextBabbage002

GPT3TextBabbage002: "text-babbage-002"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L16

GPT4

GPT4: "gpt-4"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L7

GPT45

GPT45: "gpt-4.5-preview"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L8

GPT4ChatGPT4O

GPT4ChatGPT4O: "chatgpt-4o-latest"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L11

GPT4O

GPT4O: "gpt-4o"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L9

GPT4OMini

GPT4OMini: "gpt-4o-mini"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L10

GPT4Turbo

GPT4Turbo: "gpt-4-turbo"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L12

O1

O1: "o1"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L4

O1Mini

O1Mini: "o1-mini"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L5

O3Mini

O3Mini: "o3-mini"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L6

> AxAIOpenAIEmbedModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L20

Enumeration Members

TextEmbedding3Large

TextEmbedding3Large: "text-embedding-3-large"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L23

TextEmbedding3Small

TextEmbedding3Small: "text-embedding-3-small"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L22

TextEmbeddingAda002

TextEmbeddingAda002: "text-embedding-ada-002"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L21

> AxAIRekaModel

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/types.ts#L3

Enumeration Members

RekaCore

RekaCore: "reka-core"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/types.ts#L4

RekaEdge

RekaEdge: "reka-edge"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/types.ts#L6

RekaFlash

RekaFlash: "reka-flash"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/types.ts#L5

> AxJSInterpreterPermission

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/code.ts#L11

Enumeration Members

CRYPTO

CRYPTO: "crypto"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/code.ts#L15

FS

FS: "node:fs"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/code.ts#L12

NET

NET: "net"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/code.ts#L13

OS

OS: "os"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/code.ts#L14

PROCESS

PROCESS: "process"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/code.ts#L16

> AxSpanKindValues

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L53

Enumeration Members

AGENT

AGENT: "agent"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L56

TASK

TASK: "task"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L55

TOOL

TOOL: "tool"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L57

UNKNOWN

UNKNOWN: "unknown"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L58

WORKFLOW

WORKFLOW: "workflow"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L54

> AxLLMRequestTypeValues

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L46

Enumeration Members

CHAT

CHAT: "chat"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L48

COMPLETION

COMPLETION: "completion"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L47

RERANK

RERANK: "rerank"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L49

UNKNOWN

UNKNOWN: "unknown"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/trace/trace.ts#L50

> axAIAnthropicDefaultConfig

axAIAnthropicDefaultConfig(): AxAIAnthropicConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/api.ts#L31

Returns

AxAIAnthropicConfig

> axAIAzureOpenAIBestConfig

axAIAzureOpenAIBestConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/azure-openai/api.ts#L22

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

> axAIAzureOpenAICreativeConfig

axAIAzureOpenAICreativeConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/azure-openai/api.ts#L18

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

> axAIAzureOpenAIDefaultConfig

axAIAzureOpenAIDefaultConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/azure-openai/api.ts#L16

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

> axAIAzureOpenAIFastConfig

axAIAzureOpenAIFastConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/azure-openai/api.ts#L20

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

> axAICohereCreativeConfig

axAICohereCreativeConfig(): AxAICohereConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L39

Returns

AxAICohereConfig

> axAICohereDefaultConfig

axAICohereDefaultConfig(): AxAICohereConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L32

Returns

AxAICohereConfig

> axAIDeepSeekCodeConfig

axAIDeepSeekCodeConfig(): DeepSeekConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/deepseek/api.ts#L19

Returns

DeepSeekConfig

> axAIDeepSeekDefaultConfig

axAIDeepSeekDefaultConfig(): DeepSeekConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/deepseek/api.ts#L13

Returns

DeepSeekConfig

> axAIGoogleGeminiDefaultConfig

axAIGoogleGeminiDefaultConfig(): AxAIGoogleGeminiConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L60

AxAIGoogleGemini: Default Model options for text generation

Returns

AxAIGoogleGeminiConfig

> axAIGoogleGeminiDefaultCreativeConfig

axAIGoogleGeminiDefaultCreativeConfig(): AxAIGoogleGeminiConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L69

Returns

AxAIGoogleGeminiConfig

> axAIHuggingFaceCreativeConfig

axAIHuggingFaceCreativeConfig(): AxAIHuggingFaceConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L31

Returns

AxAIHuggingFaceConfig

> axAIHuggingFaceDefaultConfig

axAIHuggingFaceDefaultConfig(): AxAIHuggingFaceConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L25

Returns

AxAIHuggingFaceConfig

> axAIMistralBestConfig

axAIMistralBestConfig(): AxAIMistralConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/api.ts#L20

Returns

AxAIMistralConfig

> axAIMistralDefaultConfig

axAIMistralDefaultConfig(): AxAIMistralConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/mistral/api.ts#L14

Returns

AxAIMistralConfig

> axAIOllamaDefaultConfig

axAIOllamaDefaultConfig(): AxAIOllamaAIConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/ollama/api.ts#L10

Returns

AxAIOllamaAIConfig

> axAIOpenAIBestConfig

axAIOpenAIBestConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L43

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

> axAIOllamaDefaultCreativeConfig

axAIOllamaDefaultCreativeConfig(): AxAIOllamaAIConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/ollama/api.ts#L17

Returns

AxAIOllamaAIConfig

> axAIOpenAICreativeConfig

axAIOpenAICreativeConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L52

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

> axAIOpenAIDefaultConfig

axAIOpenAIDefaultConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L33

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

> axAIOpenAIFastConfig

axAIOpenAIFastConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L62

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

> axAIRekaBestConfig

axAIRekaBestConfig(): AxAIRekaConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L35

Returns

> axAIRekaCreativeConfig

axAIRekaCreativeConfig(): AxAIRekaConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L41

Returns

> axAIRekaDefaultConfig

axAIRekaDefaultConfig(): AxAIRekaConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L29

Returns

> axAIRekaFastConfig

axAIRekaFastConfig(): AxAIRekaConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L47

Returns

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L178

> axAITogetherDefaultConfig

axAITogetherDefaultConfig(): TogetherAIConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/together/api.ts#L9

Returns

TogetherAIConfig

> axBaseAIDefaultConfig

axBaseAIDefaultConfig(): AxModelConfig

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

Returns

AxModelConfig

> axBaseAIDefaultCreativeConfig

axBaseAIDefaultCreativeConfig(): AxModelConfig

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

Returns

AxModelConfig

> AxAIAnthropicArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/api.ts#L37

Properties

apiKey?

optional apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/api.ts#L39

config?

optional config: Readonly<Partial<AxAIAnthropicConfig>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/api.ts#L42

models?

optional models: AxAIInputModelList<AxAIAnthropicModel | AxAIAnthropicVertexModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/api.ts#L44

name

name: "anthropic"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/api.ts#L38

options?

optional options: Readonly<AxAIServiceOptions>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/api.ts#L43

projectId?

optional projectId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/api.ts#L40

region?

optional region: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/api.ts#L41

> AxAIAnthropicContentBlockDeltaEvent

Properties

delta

delta: { text: string; type: "text_delta"; } | { partial_json: string; type: "input_json_delta"; }

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L181

index

index: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L179

type

type: "content_block_delta"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L180

> AxAIAnthropicContentBlockStartEvent

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L161

Properties

content_block

content_block: { text: string; type: "text"; } | { id: string; input: object; name: string; type: "tool_use"; }

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L164

index

index: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L162

type

type: "content_block_start"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L163

> AxAIAnthropicContentBlockStopEvent

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L193

Properties

index

index: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L195

type

type: "content_block_stop"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L194

> AxAIAnthropicErrorEvent

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L221

Properties

error

error: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L223

message

message: string

type

type: "overloaded_error"

type

type: "error"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L222

> AxAIAnthropicMessageDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L199

Properties

delta

delta: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L201

stop_reason

stop_reason: null | "end_turn" | "max_tokens" | "stop_sequence"

stop_sequence

stop_sequence: null | string

type

type: "message_delta"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L200

usage

usage: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L205

output_tokens

output_tokens: number

> AxAIAnthropicMessageStartEvent

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L143

Properties

message

message: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L145

content

content: []

id

id: string

model

model: string

role

role: "assistant"

stop_reason

stop_reason: null | string

stop_sequence

stop_sequence: null | string

type

type: "message"

usage

{ input_tokens: number; output_tokens: number; }

type

type: "message_start"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L144

> AxAIAnthropicMessageStopEvent

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L211

Properties

type

type: "message_stop"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L212

> AxAIAnthropicPingEvent

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L216

Properties

type

type: "ping"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/anthropic/types.ts#L217

> AxAICohereArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L46

Properties

apiKey

apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L48

config?

optional config: Readonly<Partial<AxAICohereConfig>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L49

models?

optional models: AxAIInputModelList<AxAICohereModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L51

name

name: "cohere"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L47

options?

optional options: Readonly<AxAIServiceOptions>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/cohere/api.ts#L50

> AxAIFeatures

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

Properties

functionCot?

optional functionCot: boolean

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

functions

functions: boolean

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

streaming

streaming: boolean

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

> AxAIGoogleGeminiArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L86

Properties

apiKey?

optional apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L88

config?

optional config: Readonly<Partial<AxAIGoogleGeminiConfig>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L92

endpointId?

optional endpointId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L91

models?

optional models: AxAIInputModelList<AxAIGoogleGeminiModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L94

name

name: "google-gemini"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L87

options?

optional options: Readonly<AxAIServiceOptions & AxAIGoogleGeminiOptionsTools>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L93

projectId?

optional projectId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L89

region?

optional region: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L90

> AxAIGoogleGeminiOptionsTools

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L77

Properties

codeExecution?

optional codeExecution: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L78

googleSearch?

optional googleSearch: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L83

googleSearchRetrieval?

optional googleSearchRetrieval: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/google-gemini/api.ts#L79

dynamicThreshold?

optional dynamicThreshold: number

mode?

optional mode: "MODE_DYNAMIC"

> AxAIHuggingFaceArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L37

Properties

apiKey

apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L39

config?

optional config: Readonly<Partial<AxAIHuggingFaceConfig>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L40

models?

optional models: AxAIInputModelList<MetaLlama270BChatHF>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L42

name

name: "huggingface"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L38

options?

optional options: Readonly<AxAIServiceOptions>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/huggingface/api.ts#L41

> AxAIMemory

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/types.ts#L3

Methods

add()

add(result, sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/types.ts#L4

Parameters

Parameter Type

result readonly ({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[] | Readonly<{ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; }>

sessionId? string

Returns

void

addResult()

addResult(result, sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/types.ts#L10

Parameters

Parameter	Type
`result`	`Readonly`<`AxChatResponseResult`>
`sessionId`?	`string`

Returns

void

addTag()

addTag(name, sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/types.ts#L25

Parameters

Parameter	Type
`name`	`string`
`sessionId`?	`string`

Returns

void

getLast()

getLast(sessionId?): undefined | { chat: { cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; }; tags: string[]; }

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/types.ts#L21

Parameters

Parameter	Type
`sessionId`?	`string`

Returns

history()

history(sessionId?): ({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/types.ts#L18

Parameters

Parameter	Type
`sessionId`?	`string`

Returns

reset()

reset(sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/types.ts#L19

Parameters

Parameter	Type
`sessionId`?	`string`

Returns

void

rewindToTag()

rewindToTag(name, sessionId?): ({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/types.ts#L26

Parameters

Parameter	Type
`name`	`string`
`sessionId`?	`string`

Returns

updateResult()

updateResult(result, sessionId?): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mem/types.ts#L11

Parameters

Parameter	Type
`result`	`Readonly`<`AxChatResponseResult`> & `object`
`sessionId`?	`string`

Returns

void

> AxAIOpenAIArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L70

Extends

Omit<AxAIOpenAIBaseArgs<TModel, TEmbedModel>, "config" | "modelInfo">

Type Parameters

Type Parameter	Default type
`TName`	`"openai"`
`TModel`	`AxAIOpenAIModel`
`TEmbedModel`	`AxAIOpenAIEmbedModel`

Properties

apiKey

apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L83

Inherited from

Omit.apiKey

apiURL?

optional apiURL: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L84

Inherited from

Omit.apiURL

config?

optional config: Partial<Readonly<AxAIOpenAIConfig<TModel, TEmbedModel>>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L79

models?

optional models: AxAIInputModelList<TModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L88

Inherited from

Omit.models

name

name: TName

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L78

options?

optional options: Readonly<AxAIServiceOptions & object>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L86

Inherited from

Omit.options

> AxAIOpenAIBaseArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L82

Type Parameters

Type Parameter
`TModel`
`TEmbedModel`

Properties

apiKey

apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L83

apiURL?

optional apiURL: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L84

config

config: Readonly<AxAIOpenAIConfig<TModel, TEmbedModel>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L85

modelInfo

modelInfo: readonly AxModelInfo[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L87

models?

optional models: AxAIInputModelList<TModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L88

options?

optional options: Readonly<AxAIServiceOptions & object>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/api.ts#L86

> AxAIOpenAIResponseDelta

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L58

Type Parameters

Type Parameter
`T`

Properties

choices

choices: object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L63

delta

delta: T

finish_reason

finish_reason: "length" | "stop" | "content_filter" | "tool_calls"

index

index: number

created

created: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L61

id

id: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L59

model

model: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L62

object

object: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L60

system_fingerprint

system_fingerprint: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L69

usage?

optional usage: AxAIOpenAIUsage

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/openai/types.ts#L68

> AxAIRekaArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L52

Properties

apiKey

apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L54

apiURL?

optional apiURL: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L55

config?

optional config: Readonly<Partial<AxAIRekaConfig>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L56

modelInfo?

optional modelInfo: readonly AxModelInfo[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L58

models?

optional models: AxAIInputModelList<AxAIRekaModel>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L59

name

name: "reka"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L53

options?

optional options: Readonly<AxAIServiceOptions & object>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/reka/api.ts#L57

> AxAIService

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L246

Type Parameters

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

Methods

chat()

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

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L254

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`TModel`>>
`options`?	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`<`TModel`, `TEmbedModel`>>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L260

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`TEmbedModel`>>
`options`?	`Readonly`<`AxAIServiceActionOptions`<`TModel`, `TEmbedModel`>>

Returns

Promise<AxEmbedResponse>

getDefaultModels()

getDefaultModels(): Readonly<{ embedModel: string; model: string; }>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L251

Returns

Readonly<{ embedModel: string; model: string; }>

getFeatures()

getFeatures(model?): AxAIFeatures

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L249

Parameters

Parameter	Type
`model`?	`TModel`

Returns

getId()

getId(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L247

Returns

string

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L252

Returns

getModelList()

getModelList(): undefined | AxAIModelList

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L250

Returns

undefined | AxAIModelList

getName()

getName(): string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L248

Returns

string

getOptions()

getOptions(): Readonly<AxAIServiceOptions>

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

Returns

Readonly<AxAIServiceOptions>

setOptions()

setOptions(options): void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L265

Parameters

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

Returns

void

> AxAIServiceImpl

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L269

Type Parameters

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

Methods

createChatReq()

createChatReq(req, config): [AxAPI, TChatRequest]

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

Parameters

Parameter	Type
`req`	`Readonly`<`AxInternalChatRequest`<`TModel`>>
`config`	`Readonly`<`AxAIPromptConfig`>

Returns

[AxAPI, TChatRequest]

createChatResp()

createChatResp(resp): AxChatResponse

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L283

Parameters

Parameter	Type
`resp`	`Readonly`<`TChatResponse`>

Returns

AxChatResponse

createChatStreamResp()?

optional createChatStreamResp(resp, state): AxChatResponse

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L285

Parameters

Parameter	Type
`resp`	`Readonly`<`TChatResponseDelta`>
`state`	`object`

Returns

AxChatResponse

createEmbedReq()?

optional createEmbedReq(req): [AxAPI, TEmbedRequest]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L290

Parameters

Parameter	Type
`req`	`Readonly`<`AxInternalEmbedRequest`<`TEmbedModel`>>

Returns

[AxAPI, TEmbedRequest]

createEmbedResp()?

optional createEmbedResp(resp): AxEmbedResponse

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L294

Parameters

Parameter	Type
`resp`	`Readonly`<`TEmbedResponse`>

Returns

AxEmbedResponse

getModelConfig()

getModelConfig(): AxModelConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L296

Returns

AxModelConfig

> AxAIServiceMetrics

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L175

Properties

errors

errors: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L190

chat

{ count: number; rate: number; total: number; }

embed

{ count: number; rate: number; total: number; }

latency

latency: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/ai/types.ts#L176

chat

{ mean: number; p95: number; p99: number; samples: number[]; }

embed

{ mean: number; p95: number; p99: number; samples: number[]; }

> AxAPI

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L41

Extended by

AxAPIConfig

Properties

headers?

optional headers: Record<string, string>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L43

name?

optional name: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L42

put?

optional put: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L44

> AxAgentFeatures

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L40

Properties

canConfigureSmartModelRouting

canConfigureSmartModelRouting: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L42

Whether this agent can use smart model routing (requires an AI service)

excludeFieldsFromPassthrough

excludeFieldsFromPassthrough: string[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L44

List of fields that this agent excludes from parent->child value passing

> AxAgentic

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L28

Interface for agents that can be used as child agents. Provides methods to get the agent’s function definition and features.

Extends

AxTunable.AxUsable

Properties

getTraces()

getTraces: () => AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L89

Returns

AxTunable.setExamples

Inherited from

AxTunable.getTraces

getUsage()

getUsage: () => AxTokenUsage & object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L94

Returns

AxTokenUsage & object[]

Inherited from

AxUsable.getUsage

resetUsage()

resetUsage: () => void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L95

Returns

void

Inherited from

AxUsable.resetUsage

setDemos()

setDemos: (demos) => void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L90

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`[]

Returns

void

Inherited from

AxTunable.setDemos

setExamples()

setExamples: (examples) => void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L86

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`>

Returns

void

Inherited from

setId()

setId: (id) => void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L87

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxTunable.setId

setParentId()

setParentId: (parentId) => void

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L88

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxTunable.setParentId

Methods

getFeatures()

getFeatures(): AxAgentFeatures

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L30

Returns

AxAgentFeatures

getFunction()

getFunction(): AxFunction

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/prompts/agent.ts#L29

Returns

> AxAPIConfig

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L48

Extends

AxAPI.RequestValidation.ResponseValidation

Properties

debug?

optional debug: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L54

fetch()?

optional fetch: (input, init?) => Promise<Response>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L55

Parameters

Parameter	Type
`input`	`string` \| `URL` \| `Request`
`init`?	`RequestInit`

Returns

Promise<Response>

headers?

optional headers: Record<string, string>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L43

Inherited from

AxAPI.headers

name?

optional name: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L42

Inherited from

AxAPI.name

put?

optional put: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L44

Inherited from

AxAPI.put

retry?

optional retry: Partial<RetryConfig>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L58

span?

optional span: Span

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L56

stream?

optional stream: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L53

timeout?

optional timeout: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L57

url

url: string | URL

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L52

validateRequest()?

optional validateRequest: (request) => boolean | Promise<boolean>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L33

Parameters

Parameter	Type
`request`	`unknown`

Returns

boolean | Promise<boolean>

Inherited from

RequestValidation.validateRequest

validateResponse()?

optional validateResponse: (response) => boolean | Promise<boolean>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/apicall.ts#L37

Parameters

Parameter	Type
`response`	`unknown`

Returns

boolean | Promise<boolean>

Inherited from

ResponseValidation.validateResponse

> AxApacheTikaConvertOptions

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/tika.ts#L8

Properties

format?

optional format: "text" | "html"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/tika.ts#L9

> AxApacheTikaArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/tika.ts#L3

Properties

fetch()?

optional fetch: (input, init?) => Promise<Response>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/tika.ts#L5

Parameters

Parameter	Type
`input`	`string` \| `URL` \| `Request`
`init`?	`RequestInit`

Returns

Promise<Response>

url?

optional url: string | URL

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/tika.ts#L4

> AxBaseAIArgs

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

Type Parameters

Type Parameter
`TModel`
`TEmbedModel`

Properties

apiURL

apiURL: string

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

defaults

defaults: Readonly<{ embedModel: TEmbedModel; model: TModel; }>

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

headers()

headers: () => Promise<Record<string, string>>

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

Returns

Promise<Record<string, string>>

modelInfo

modelInfo: readonly AxModelInfo[]

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

models?

optional models: AxAIInputModelList<TModel>

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

name

name: string

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

options?

optional options: Readonly<AxAIServiceOptions>

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

supportFor

supportFor: AxAIFeatures | (model) => AxAIFeatures

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

> AxAssertion

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L3

Properties

message?

optional message: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L7

Methods

fn()

fn(values): undefined | boolean | Promise<undefined | boolean>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L4

Parameters

Parameter	Type
`values`	`Record`<`string`, `unknown`>

Returns

undefined | boolean | Promise<undefined | boolean>

> AxDBBaseArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L13

Extended by

Properties

fetch()?

optional fetch: (input, init?) => Promise<Response>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L14

Parameters

Parameter	Type
`input`	`string` \| `URL` \| `Request`
`init`?	`RequestInit`

Returns

Promise<Response>

tracer?

optional tracer: Tracer

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L15

> AxDBBaseOpOptions

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L18

Properties

span?

optional span: Span

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L19

> AxDBCloudflareArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L34

Extends

AxDBBaseArgs

Properties

accountId

accountId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L37

apiKey

apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L36

fetch()?

optional fetch: (input, init?) => Promise<Response>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L38

Parameters

Parameter	Type
`input`	`string` \| `URL` \| `Request`
`init`?	`RequestInit`

Returns

Promise<Response>

Overrides

name

name: "cloudflare"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/cloudflare.ts#L35

tracer?

optional tracer: Tracer

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L15

Inherited from

> AxDBLoaderOptions

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L14

Properties

chunker()?

optional chunker: (text) => string[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L15

Parameters

Parameter	Type
`text`	`string`

Returns

string[]

reranker?

optional reranker: AxProgram<AxRerankerIn, AxRerankerOut>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L17

rewriter?

optional rewriter: AxProgram<AxRewriteIn, AxRewriteOut>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L16

> AxDBManagerArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L20

Properties

ai

ai: AxAIService

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L21

config?

optional config: AxDBLoaderOptions

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L23

db

db: AxDBService

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L22

> AxDBMatch

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L26

Properties

score

score: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L27

text

text: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/docs/manager.ts#L28

> AxDBMemoryArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L11

Extends

AxDBBaseArgs

Properties

fetch()?

optional fetch: (input, init?) => Promise<Response>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L14

Parameters

Parameter	Type
`input`	`string` \| `URL` \| `Request`
`init`?	`RequestInit`

Returns

Promise<Response>

Inherited from

name

name: "memory"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/memory.ts#L12

tracer?

optional tracer: Tracer

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L15

Inherited from

> AxDBPineconeArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L48

Extends

AxDBBaseArgs

Properties

apiKey

apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L50

fetch()?

optional fetch: (input, init?) => Promise<Response>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L52

Parameters

Parameter	Type
`input`	`string` \| `URL` \| `Request`
`init`?	`RequestInit`

Returns

Promise<Response>

Overrides

host

host: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L51

name

name: "pinecone"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/pinecone.ts#L49

tracer?

optional tracer: Tracer

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L15

Inherited from

> AxDBQueryService

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/types.ts#L48

Extended by

AxDBService

Methods

query()

query(req): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/types.ts#L49

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>

Returns

Promise<AxDBQueryResponse>

> AxDBWeaviateArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L29

Extends

AxDBBaseArgs

Properties

apiKey

apiKey: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L31

fetch()?

optional fetch: (input, init?) => Promise<Response>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L33

Parameters

Parameter	Type
`input`	`string` \| `URL` \| `Request`
`init`?	`RequestInit`

Returns

Promise<Response>

Overrides

host

host: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L32

name

name: "weaviate"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/weaviate.ts#L30

tracer?

optional tracer: Tracer

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/base.ts#L15

Inherited from

AxDBQueryService.query

> AxDBService

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/types.ts#L36

Extends

AxDBQueryService

Methods

batchUpsert()

batchUpsert(batchReq, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/types.ts#L42

Parameters

Parameter	Type
`batchReq`	readonly `AxDBUpsertRequest`[]
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

query()

query(req): Promise<AxDBQueryResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/types.ts#L49

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBQueryRequest`>

Returns

Promise<AxDBQueryResponse>

Inherited from

upsert()

upsert(req, update?): Promise<AxDBUpsertResponse>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/db/types.ts#L37

Parameters

Parameter	Type
`req`	`Readonly`<`AxDBUpsertRequest`>
`update`?	`boolean`

Returns

Promise<AxDBUpsertResponse>

> AxDockerContainer

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L3

Properties

Command

Command: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L8

Created

Created: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L9

HostConfig

HostConfig: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L33

NetworkMode

NetworkMode: string

Id

Id: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L4

Image

Image: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L6

ImageID

ImageID: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L7

Labels

Labels: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L30

Index Signature

[key: string]: string

Mounts

Mounts: object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L46

Destination

Destination: string

Mode

Mode: string

Propagation

Propagation: string

RW

RW: boolean

Source

Source: string

Type

Type: string

Names

Names: string[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L5

NetworkSettings

NetworkSettings: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L36

Networks

{}

Ports

Ports: object[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L24

IP

IP: string

PrivatePort

PrivatePort: number

PublicPort

PublicPort: number

Type

Type: string

SizeRootFs

SizeRootFs: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L32

SizeRw

SizeRw: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L31

State

State: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L10

Dead

Dead: boolean

Error

Error: string

ExitCode

ExitCode: number

FinishedAt

FinishedAt: Date

OOMKilled

OOMKilled: boolean

Paused

Paused: boolean

Pid

Pid: number

Restarting

Restarting: boolean

Running

Running: boolean

StartedAt

StartedAt: Date

Status

Status: string

Status

Status: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/funcs/docker.ts#L23

> AxField

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L12

Properties

description?

optional description: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L15

isInternal?

optional isInternal: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L32

isOptional?

optional isOptional: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L31

name

name: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L13

title?

optional title: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L14

type?

optional type: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/sig.ts#L16

classes?

optional classes: string[]

isArray

isArray: boolean

name

name: "string" | "number" | "boolean" | "image" | "audio" | "json" | "datetime" | "date" | "code" | "class"

> AxFieldProcessor

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/fieldProcessor.ts#L24

Properties

field

field: Readonly<AxField>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/fieldProcessor.ts#L25

process

process: AxFieldProcessorProcess | AxStreamingFieldProcessorProcess

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/fieldProcessor.ts#L33

Process the field value and return a new value (or undefined if no update is needed). The returned value may be merged back into memory.

Param

The current field value.

Param

Additional context (e.g. memory and session id).

> AxGenOptions

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L56

Properties

asserts?

optional asserts: AxAssertion[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L69

description?

optional description: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L63

fastFail?

optional fastFail: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L71

functionCall?

optional functionCall: "auto" | { function: { name: string; }; type: "function"; } | "none" | "required"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L66

functions?

optional functions: AxInputFunctionType

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L65

maxRetries?

optional maxRetries: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L57

maxSteps?

optional maxSteps: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L58

mem?

optional mem: AxAIMemory

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L59

promptTemplate?

optional promptTemplate: typeof AxPromptTemplate

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L68

rateLimiter?

optional rateLimiter: AxRateLimiterFunction

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L61

stopFunction?

optional stopFunction: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L67

stream?

optional stream: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L62

streamingAsserts?

optional streamingAsserts: AxStreamingAssertion[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L70

tracer?

optional tracer: Tracer

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L60

> AxMCPTransport

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/transport.ts#L7

Methods

connect()?

optional connect(): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/transport.ts#L27

Connects to the transport if needed This method is optional and only required for transports that need connection setup

Returns

Promise<void>

send()

send(message): Promise<JSONRPCResponse<unknown>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/transport.ts#L13

Sends a JSON-RPC request or notification and returns the response

Parameters

Parameter	Type	Description
`message`	`Readonly`<`JSONRPCRequest`<`unknown`>>	The JSON-RPC request or notification to send

Returns

Promise<JSONRPCResponse<unknown>>

A Promise that resolves to the JSON-RPC response

sendNotification()

sendNotification(message): Promise<void>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/mcp/transport.ts#L21

Sends a JSON-RPC notification

Parameters

Parameter	Type	Description
`message`	`Readonly`<`JSONRPCNotification`>	The JSON-RPC notification to send

Returns

Promise<void>

> AxMiPROOptions

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L12

Properties

dataAwareProposer?

optional dataAwareProposer: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L22

earlyStoppingTrials?

optional earlyStoppingTrials: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L28

fewshotAwareProposer?

optional fewshotAwareProposer: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L25

initTemperature?

optional initTemperature: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L14

maxBootstrappedDemos?

optional maxBootstrappedDemos: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L15

maxLabeledDemos?

optional maxLabeledDemos: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L16

minibatch?

optional minibatch: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L18

minibatchFullEvalSteps?

optional minibatchFullEvalSteps: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L20

minibatchSize?

optional minibatchSize: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L19

minImprovementThreshold?

optional minImprovementThreshold: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L29

numCandidates?

optional numCandidates: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L13

numTrials?

optional numTrials: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L17

programAwareProposer?

optional programAwareProposer: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L21

seed?

optional seed: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L26

tipAwareProposer?

optional tipAwareProposer: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L24

verbose?

optional verbose: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L27

viewDataBatchSize?

optional viewDataBatchSize: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/mipro.ts#L23

> AxOptimizationStats

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L46

Properties

earlyStopped

earlyStopped: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L50

earlyStopping?

optional earlyStopping: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L51

bestScoreRound

bestScoreRound: number

patienceExhausted

patienceExhausted: boolean

estimatedTokenUsage

estimatedTokenUsage: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L49

successfulDemos

successfulDemos: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L48

totalCalls

totalCalls: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/optimize.ts#L47

> AxProgramWithSignatureOptions

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L103

Properties

description?

optional description: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L104

> AxRateLimiterTokenUsageOptions

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/rate-limit.ts#L5

Properties

debug?

optional debug: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/util/rate-limit.ts#L6

> AxResponseHandlerArgs

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L78

Type Parameters

Type Parameter
`T`

Properties

ai

ai: Readonly<AxAIService<unknown, unknown>>

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L79

fastFail?

optional fastFail: boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L87

functions?

optional functions: readonly AxFunction[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L86

mem

mem: AxAIMemory

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L83

model?

optional model: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L80

res

res: T

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L81

sessionId?

optional sessionId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L84

traceId?

optional traceId: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L85

usageInfo

usageInfo: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L82

ai

ai: string

model

model: string

> AxSimpleClassifierForwardOptions

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L7

Properties

cutoff?

optional cutoff: number

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/router.ts#L8

> AxStreamingAssertion

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L10

Properties

fieldName

fieldName: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L11

message?

optional message: string

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L13

Methods

fn()

fn(content, done?): undefined | boolean

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/asserts.ts#L12

Parameters

Parameter	Type
`content`	`string`
`done`?	`boolean`

Returns

undefined | boolean

> AxStreamingEvent

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L90

Type Parameters

Type Parameter
`T`

Properties

data

data: object

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L92

contentDelta?

optional contentDelta: string

error?

optional error: string

functions?

optional functions: AxChatResponseFunctionCall[]

partialValues?

optional partialValues: Partial<T>

event

event: "error" | "done" | "delta"

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/generate.ts#L91

> AxTunable

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L85

Extended by

AxAgentic

Properties

getTraces()

getTraces: () => AxProgramTrace[]

Defined in: https://github.com/ax-llm/ax/blob/8a4bb80b94b2763398ce036c74b5662d9a03c9d8/src/ax/dsp/program.ts#L89

Returns