Build LLM-powered agents with production-ready TypeScript

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L174

Parameters

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

Returns

Promise<AxEmbedResponse>

Implementation of

getFeatures()

getFeatures(model?: string): object;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L143

Parameters

Parameter	Type
`model?`	`string`

Returns

object

Name	Type
`functions`	`boolean`
`streaming`	`boolean`

Implementation of

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L139

Returns

string

Implementation of

getLastUsedChatModel()

getLastUsedChatModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L151

Returns

unknown

Implementation of

getLastUsedEmbedModel()

getLastUsedEmbedModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L155

Returns

unknown

Implementation of

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L159

Returns

undefined | AxModelConfig

Implementation of

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L189

Returns

Implementation of

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L163

Returns

Implementation of

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L147

Returns

undefined | AxAIModelList

Implementation of

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L135

Returns

string

Implementation of

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L185

Returns

Readonly<AxAIServiceOptions>

Implementation of

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/wrap.ts#L181

Parameters

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

Returns

void

Implementation of

AxAIAnthropic

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/api.ts#L509

Extends

AxBaseAI< | AxAIAnthropicModel | AxAIAnthropicVertexModel, unknown, AxAIAnthropicChatRequest, unknown, AxAIAnthropicChatResponse, AxAIAnthropicChatResponseDelta, unknown>

Constructors

Constructor

new AxAIAnthropic(__namedParameters: Readonly<Omit<AxAIAnthropicArgs, "name">>): AxAIAnthropic;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/api.ts#L518

Parameters

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

Returns

AxAIAnthropic

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<
  | AxAIAnthropicModel
  | AxAIAnthropicVertexModel, unknown>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`TModel`>>
`options?`	`Readonly`<`AxAIPromptConfig` & `AxAIServiceActionOptions`< \| `AxAIAnthropicModel` \| `AxAIAnthropicVertexModel`, `unknown`>>

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

embed(req: Readonly<AxEmbedRequest<TEmbedModel>>, options?: Readonly<AxAIServiceActionOptions<
  | AxAIAnthropicModel
| AxAIAnthropicVertexModel, unknown>>): Promise<AxEmbedResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: 
  | AxAIAnthropicModel
  | AxAIAnthropicVertexModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

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

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): 
  | undefined
  | AxAIAnthropicModel
  | AxAIAnthropicVertexModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

| undefined | AxAIAnthropicModel | AxAIAnthropicVertexModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

unknown

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/azure-openai/api.ts#L40

AxAIAzureOpenAI

Extends

AxAIOpenAIBase<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Constructors

Constructor

new AxAIAzureOpenAI(__namedParameters: Readonly<Omit<AxAIAzureOpenAIArgs, "name">>): AxAIAzureOpenAI;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/azure-openai/api.ts#L44

Parameters

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

Returns

AxAIAzureOpenAI

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIOpenAIModel, AxAIOpenAIEmbedModel>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: AxAIOpenAIModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAIOpenAIModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAIOpenAIModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | AxAIOpenAIModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): 
  | undefined
  | AxAIOpenAIEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

| undefined | AxAIOpenAIEmbedModel

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAICohere

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/cohere/api.ts#L299

Extends

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

Constructors

Constructor

new AxAICohere(__namedParameters: Readonly<Omit<AxAICohereArgs, "name">>): AxAICohere;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/cohere/api.ts#L308

Parameters

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

Returns

AxAICohere

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAICohereModel, AxAICohereEmbedModel>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: AxAICohereModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAICohereModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAICohereModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | AxAICohereModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): 
  | undefined
  | AxAICohereEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

| undefined | AxAICohereEmbedModel

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAIDeepSeek

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

Extends

AxAIOpenAIBase<AxAIDeepSeekModel, undefined>

Constructors

Constructor

new AxAIDeepSeek(__namedParameters: Readonly<Omit<AxAIDeepSeekArgs, "name">>): AxAIDeepSeek;

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

Parameters

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

Returns

AxAIDeepSeek

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIDeepSeekModel, undefined>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: AxAIDeepSeekModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAIDeepSeekModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAIDeepSeekModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | AxAIDeepSeekModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

undefined

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/api.ts#L601

AxAIGoogleGemini

AxAIGoogleGemini: AI Service

Extends

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

Constructors

Constructor

new AxAIGoogleGemini(__namedParameters: Readonly<Omit<AxAIGoogleGeminiArgs, "name">>): AxAIGoogleGemini;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/api.ts#L610

Parameters

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

Returns

AxAIGoogleGemini

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIGoogleGeminiModel, AxAIGoogleGeminiEmbedModel>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: AxAIGoogleGeminiModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAIGoogleGeminiModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): 
  | undefined
  | AxAIGoogleGeminiModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

| undefined | AxAIGoogleGeminiModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): 
  | undefined
  | AxAIGoogleGeminiEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

| undefined | AxAIGoogleGeminiEmbedModel

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAIGrok

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/x-grok/api.ts#L76

Extends

AxAIOpenAIBase<AxAIGrokModel, AxAIGrokEmbedModels, AxAIGrokChatRequest>

Constructors

Constructor

new AxAIGrok(__namedParameters: Readonly<Omit<AxAIGrokArgs, "name">>): AxAIGrok;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/x-grok/api.ts#L81

Parameters

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

Returns

AxAIGrok

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIGrokModel, GrokEmbedSmall>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: AxAIGrokModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAIGrokModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAIGrokModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | AxAIGrokModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): 
  | undefined
  | GrokEmbedSmall;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

| undefined | GrokEmbedSmall

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAIGroq

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/groq/api.ts#L27

Extends

AxAIOpenAIBase<AxAIGroqModel, undefined>

Constructors

Constructor

new AxAIGroq(__namedParameters: Readonly<Omit<AxAIGroqArgs, "name">>): AxAIGroq;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/groq/api.ts#L28

Parameters

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

Returns

AxAIGroq

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIGroqModel, undefined>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: AxAIGroqModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAIGroqModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAIGroqModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | AxAIGroqModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

undefined

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/groq/api.ts#L71

Parameters

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

Returns

void

Overrides

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/huggingface/api.ts#L166

AxAIHuggingFace

Extends

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

Constructors

Constructor

new AxAIHuggingFace(__namedParameters: Readonly<Omit<AxAIHuggingFaceArgs, "name">>): AxAIHuggingFace;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/huggingface/api.ts#L175

Parameters

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

Returns

AxAIHuggingFace

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<MetaLlama270BChatHF, unknown>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: MetaLlama270BChatHF): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`MetaLlama270BChatHF`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): 
  | undefined
  | MetaLlama270BChatHF;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

| undefined | MetaLlama270BChatHF

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

unknown

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAIMistral

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mistral/api.ts#L79

Extends

AxAIOpenAIBase<AxAIMistralModel, AxAIMistralEmbedModels>

Constructors

Constructor

new AxAIMistral(__namedParameters: Readonly<Omit<AxAIMistralArgs, "name">>): AxAIMistral;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mistral/api.ts#L83

Parameters

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

Returns

AxAIMistral

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIMistralModel, MistralEmbed>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: AxAIMistralModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAIMistralModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAIMistralModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | AxAIMistralModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): 
  | undefined
  | MistralEmbed;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

| undefined | MistralEmbed

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAIOllama

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

OllamaAI: AI Service

Extends

AxAIOpenAIBase<string, string>

Constructors

Constructor

new AxAIOllama(__namedParameters: Readonly<Omit<AxAIOllamaArgs, "name">>): AxAIOllama;

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

Parameters

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

Returns

AxAIOllama

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<string, string>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: string): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`string`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | string

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

undefined | string

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAIOpenAI

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L616

Extends

AxAIOpenAIBase<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

Constructors

Constructor

new AxAIOpenAI(__namedParameters: Readonly<Omit<AxAIOpenAIArgs, "name">>): AxAIOpenAI;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L620

Parameters

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

Returns

AxAIOpenAI

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIOpenAIModel, AxAIOpenAIEmbedModel>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: AxAIOpenAIModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAIOpenAIModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAIOpenAIModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | AxAIOpenAIModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): 
  | undefined
  | AxAIOpenAIEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

| undefined | AxAIOpenAIEmbedModel

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api_base.ts#L158

AxAIOpenAIResponses

Base class for OpenAI AI services using the /v1/responses API endpoint

Extends

AxAIOpenAIResponsesBase<AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel, AxAIOpenAIResponsesRequest<AxAIOpenAIResponsesModel>>

Constructors

Constructor

new AxAIOpenAIResponses(__namedParameters: Readonly<Omit<AxAIOpenAIResponsesArgs, "name">>): AxAIOpenAIResponses;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api_base.ts#L163

Parameters

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

Returns

AxAIOpenAIResponses

Overrides

AxAIOpenAIResponsesBase.constructor

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAIResponsesBase.chat

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAIResponsesBase.embed

getFeatures()

getFeatures(model?: AxAIOpenAIResponsesModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAIOpenAIResponsesModel`

Returns

AxAIOpenAIResponsesBase.getFeatures

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

AxAIOpenAIResponsesBase.getId

getLastUsedChatModel()

getLastUsedChatModel(): 
  | undefined
  | AxAIOpenAIResponsesModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

| undefined | AxAIOpenAIResponsesModel

Inherited from

AxAIOpenAIResponsesBase.getLastUsedChatModel

getLastUsedEmbedModel()

getLastUsedEmbedModel(): 
  | undefined
  | AxAIOpenAIEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

| undefined | AxAIOpenAIEmbedModel

Inherited from

AxAIOpenAIResponsesBase.getLastUsedEmbedModel

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

AxAIOpenAIResponsesBase.getLastUsedModelConfig

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

AxAIOpenAIResponsesBase.getLogger

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

AxAIOpenAIResponsesBase.getMetrics

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

AxAIOpenAIResponsesBase.getModelList

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

AxAIOpenAIResponsesBase.getName

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

AxAIOpenAIResponsesBase.getOptions

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

AxAIOpenAIResponsesBase.setAPIURL

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

AxAIOpenAIResponsesBase.setHeaders

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

AxAIOpenAIResponsesBase.setName

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAIOpenAIResponsesBase.setOptions

AxAIOpenAIBase

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L564

Extends

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

Extended by

Type Parameters

Type Parameter	Default type
`TModel`	-
`TEmbedModel`	-
`TChatReq` extends `AxAIOpenAIChatRequest`<`TModel`>	`AxAIOpenAIChatRequest`<`TModel`>

Constructors

Constructor

new AxAIOpenAIBase<TModel, TEmbedModel, TChatReq>(__namedParameters: Readonly<Omit<AxAIOpenAIBaseArgs<TModel, TEmbedModel, TChatReq>, "name">>): AxAIOpenAIBase<TModel, TEmbedModel, TChatReq>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L578

Parameters

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

Returns

AxAIOpenAIBase<TModel, TEmbedModel, TChatReq>

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<TModel, TEmbedModel>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: TModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`TModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | TModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | TModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined | TEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

undefined | TEmbedModel

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api_base.ts#L80

AxAIOpenAIResponsesBase

Base class for OpenAI AI services using the /v1/responses API endpoint

Extends

AxBaseAI<TModel, TEmbedModel, AxAIOpenAIResponsesRequest<TModel>, AxAIOpenAIEmbedRequest<TEmbedModel>, AxAIOpenAIResponsesResponse, AxAIOpenAIResponsesResponseDelta, AxAIOpenAIEmbedResponse>

Extended by

AxAIOpenAIResponses

Type Parameters

Type Parameter
`TModel`
`TEmbedModel`
`TResponsesReq` extends `AxAIOpenAIResponsesRequest`<`TModel`>

Constructors

Constructor

new AxAIOpenAIResponsesBase<TModel, TEmbedModel, TResponsesReq>(__namedParameters: Readonly<AxAIOpenAIResponsesBaseArgs<TModel, TEmbedModel, TResponsesReq>>): AxAIOpenAIResponsesBase<TModel, TEmbedModel, TResponsesReq>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api_base.ts#L93

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`AxAIOpenAIResponsesBaseArgs`<`TModel`, `TEmbedModel`, `TResponsesReq`>>

Returns

AxAIOpenAIResponsesBase<TModel, TEmbedModel, TResponsesReq>

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<TModel, TEmbedModel>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: TModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`TModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | TModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | TModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined | TEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

undefined | TEmbedModel

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api.ts#L47

AxAIOpenAIResponsesImpl

Type Parameters

Type Parameter
`TModel`
`TEmbedModel`
`TResponsesReq` extends `AxAIOpenAIResponsesRequest`<`TModel`>

Implements

AxAIServiceImpl<TModel, TEmbedModel, Readonly<AxAIOpenAIResponsesRequest<TModel>>, Readonly<AxAIOpenAIEmbedRequest<TEmbedModel>>, Readonly<AxAIOpenAIResponsesResponse>, Readonly<AxAIOpenAIResponsesResponseDelta>, Readonly<AxAIOpenAIEmbedResponse>>

Constructors

Constructor

new AxAIOpenAIResponsesImpl<TModel, TEmbedModel, TResponsesReq>(
   config: Readonly<AxAIOpenAIResponsesConfig<TModel, TEmbedModel>>, 
   streamingUsage: boolean, 
responsesReqUpdater?: ResponsesReqUpdater<TModel, TResponsesReq>): AxAIOpenAIResponsesImpl<TModel, TEmbedModel, TResponsesReq>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api.ts#L64

Parameters

Parameter	Type
`config`	`Readonly`<`AxAIOpenAIResponsesConfig`<`TModel`, `TEmbedModel`>>
`streamingUsage`	`boolean`
`responsesReqUpdater?`	`ResponsesReqUpdater`<`TModel`, `TResponsesReq`>

Returns

AxAIOpenAIResponsesImpl<TModel, TEmbedModel, TResponsesReq>

Methods

createChatReq()

createChatReq(req: Readonly<AxInternalChatRequest<TModel>>, config: Readonly<AxAIPromptConfig>): [Readonly<AxAPI>, Readonly<AxAIOpenAIResponsesRequest<TModel>>];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api.ts#L242

Parameters

Parameter	Type
`req`	`Readonly`<`AxInternalChatRequest`<`TModel`>>
`config`	`Readonly`<`AxAIPromptConfig`>

Returns

[Readonly<AxAPI>, Readonly<AxAIOpenAIResponsesRequest<TModel>>]

Implementation of

AxAIServiceImpl.createChatReq

createChatResp()

createChatResp(resp: Readonly<AxAIOpenAIResponsesResponse>): Readonly<AxChatResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api.ts#L420

Parameters

Parameter	Type
`resp`	`Readonly`<`AxAIOpenAIResponsesResponse`>

Returns

Readonly<AxChatResponse>

Implementation of

AxAIServiceImpl.createChatResp

createChatStreamResp()

createChatStreamResp(streamEvent: Readonly<AxAIOpenAIResponsesResponseDelta>): Readonly<AxChatResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api.ts#L600

Parameters

Parameter	Type
`streamEvent`	`Readonly`<`AxAIOpenAIResponsesResponseDelta`>

Returns

Readonly<AxChatResponse>

Implementation of

AxAIServiceImpl.createChatStreamResp

createEmbedReq()

createEmbedReq(req: Readonly<AxInternalEmbedRequest<TEmbedModel>>): [AxAPI, AxAIOpenAIEmbedRequest<TEmbedModel>];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api.ts#L1028

Parameters

Parameter	Type
`req`	`Readonly`<`AxInternalEmbedRequest`<`TEmbedModel`>>

Returns

[AxAPI, AxAIOpenAIEmbedRequest<TEmbedModel>]

Implementation of

AxAIServiceImpl.createEmbedReq

getModelConfig()

getModelConfig(): Readonly<AxModelConfig>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api.ts#L79

Returns

Readonly<AxModelConfig>

Implementation of

AxAIServiceImpl.getModelConfig

getTokenUsage()

getTokenUsage(): undefined | Readonly<AxTokenUsage>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api.ts#L75

Returns

undefined | Readonly<AxTokenUsage>

Implementation of

AxAIServiceImpl.getTokenUsage

AxAIReka

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/reka/api.ts#L268

Extends

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

Constructors

Constructor

new AxAIReka(__namedParameters: Readonly<Omit<AxAIRekaArgs, "name">>): AxAIReka;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/reka/api.ts#L277

Parameters

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

Returns

AxAIReka

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIRekaModel, undefined>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: AxAIRekaModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`AxAIRekaModel`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAIRekaModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | AxAIRekaModel

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

undefined

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAIServiceAbortedError

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L214

Extends

AxAIServiceError

Constructors

Constructor

new AxAIServiceAbortedError(
   url: string, 
   reason?: string, 
   requestBody?: unknown, 
   context?: Record<string, unknown>): AxAIServiceAbortedError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L215

Parameters

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

Returns

AxAIServiceAbortedError

Overrides

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`AxAIServiceError`.`cause`
`context`	`readonly`	`Record`<`string`, `unknown`>	-	`AxAIServiceError`.`context`
`errorId`	`readonly`	`string`	-	`AxAIServiceError`.`errorId`
`message`	`public`	`string`	-	`AxAIServiceError`.`message`
`name`	`public`	`string`	-	`AxAIServiceError`.`name`
`requestBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`requestBody`
`responseBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`responseBody`
`stack?`	`public`	`string`	-	`AxAIServiceError`.`stack`
`timestamp`	`readonly`	`string`	-	`AxAIServiceError`.`timestamp`
`url`	`readonly`	`string`	-	`AxAIServiceError`.`url`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`AxAIServiceError`.`stackTraceLimit`

Methods

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L97

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

Parameters

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

Returns

any

Inherited from

AxAIServiceAuthenticationError

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L232

Extends

AxAIServiceError

Constructors

Constructor

new AxAIServiceAuthenticationError(
   url: string, 
   requestBody: unknown, 
   responseBody: unknown, 
   context?: Record<string, unknown>): AxAIServiceAuthenticationError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L233

Parameters

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

Returns

AxAIServiceAuthenticationError

Overrides

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`AxAIServiceError`.`cause`
`context`	`readonly`	`Record`<`string`, `unknown`>	-	`AxAIServiceError`.`context`
`errorId`	`readonly`	`string`	-	`AxAIServiceError`.`errorId`
`message`	`public`	`string`	-	`AxAIServiceError`.`message`
`name`	`public`	`string`	-	`AxAIServiceError`.`name`
`requestBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`requestBody`
`responseBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`responseBody`
`stack?`	`public`	`string`	-	`AxAIServiceError`.`stack`
`timestamp`	`readonly`	`string`	-	`AxAIServiceError`.`timestamp`
`url`	`readonly`	`string`	-	`AxAIServiceError`.`url`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`AxAIServiceError`.`stackTraceLimit`

Methods

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L97

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

Parameters

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

Returns

any

Inherited from

AxAIServiceNetworkError

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L139

Extends

AxAIServiceError

Constructors

Constructor

new AxAIServiceNetworkError(
   originalError: Error, 
   url: string, 
   requestBody: unknown, 
   responseBody: unknown, 
   context?: Record<string, unknown>): AxAIServiceNetworkError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L140

Parameters

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

Returns

AxAIServiceNetworkError

Overrides

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`AxAIServiceError`.`cause`
`context`	`readonly`	`Record`<`string`, `unknown`>	-	`AxAIServiceError`.`context`
`errorId`	`readonly`	`string`	-	`AxAIServiceError`.`errorId`
`message`	`public`	`string`	-	`AxAIServiceError`.`message`
`name`	`public`	`string`	-	`AxAIServiceError`.`name`
`originalError`	`readonly`	`Error`	-	-
`requestBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`requestBody`
`responseBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`responseBody`
`stack?`	`public`	`string`	-	`AxAIServiceError`.`stack`
`timestamp`	`readonly`	`string`	-	`AxAIServiceError`.`timestamp`
`url`	`readonly`	`string`	-	`AxAIServiceError`.`url`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`AxAIServiceError`.`stackTraceLimit`

Methods

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L97

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

Parameters

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

Returns

any

Inherited from

AxAIServiceResponseError

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

Extends

AxAIServiceError

Constructors

Constructor

new AxAIServiceResponseError(
   message: string, 
   url: string, 
   requestBody?: unknown, 
   context?: Record<string, unknown>): AxAIServiceResponseError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L164

Parameters

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

Returns

AxAIServiceResponseError

Overrides

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`AxAIServiceError`.`cause`
`context`	`readonly`	`Record`<`string`, `unknown`>	-	`AxAIServiceError`.`context`
`errorId`	`readonly`	`string`	-	`AxAIServiceError`.`errorId`
`message`	`public`	`string`	-	`AxAIServiceError`.`message`
`name`	`public`	`string`	-	`AxAIServiceError`.`name`
`requestBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`requestBody`
`responseBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`responseBody`
`stack?`	`public`	`string`	-	`AxAIServiceError`.`stack`
`timestamp`	`readonly`	`string`	-	`AxAIServiceError`.`timestamp`
`url`	`readonly`	`string`	-	`AxAIServiceError`.`url`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`AxAIServiceError`.`stackTraceLimit`

Methods

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L97

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

Parameters

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

Returns

any

Inherited from

AxAIServiceStatusError

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L120

Extends

AxAIServiceError

Constructors

Constructor

new AxAIServiceStatusError(
   status: number, 
   statusText: string, 
   url: string, 
   requestBody: unknown, 
   responseBody: unknown, 
   context?: Record<string, unknown>): AxAIServiceStatusError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L121

Parameters

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

Returns

AxAIServiceStatusError

Overrides

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`AxAIServiceError`.`cause`
`context`	`readonly`	`Record`<`string`, `unknown`>	-	`AxAIServiceError`.`context`
`errorId`	`readonly`	`string`	-	`AxAIServiceError`.`errorId`
`message`	`public`	`string`	-	`AxAIServiceError`.`message`
`name`	`public`	`string`	-	`AxAIServiceError`.`name`
`requestBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`requestBody`
`responseBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`responseBody`
`stack?`	`public`	`string`	-	`AxAIServiceError`.`stack`
`status`	`readonly`	`number`	-	-
`statusText`	`readonly`	`string`	-	-
`timestamp`	`readonly`	`string`	-	`AxAIServiceError`.`timestamp`
`url`	`readonly`	`string`	-	`AxAIServiceError`.`url`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`AxAIServiceError`.`stackTraceLimit`

Methods

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L97

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

Parameters

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

Returns

any

Inherited from

AxAIServiceStreamTerminatedError

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L175

Extends

AxAIServiceError

Constructors

Constructor

new AxAIServiceStreamTerminatedError(
   url: string, 
   requestBody?: unknown, 
   lastChunk?: unknown, 
   context?: Record<string, unknown>): AxAIServiceStreamTerminatedError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L176

Parameters

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

Returns

AxAIServiceStreamTerminatedError

Overrides

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`AxAIServiceError`.`cause`
`context`	`readonly`	`Record`<`string`, `unknown`>	-	`AxAIServiceError`.`context`
`errorId`	`readonly`	`string`	-	`AxAIServiceError`.`errorId`
`lastChunk?`	`readonly`	`unknown`	-	-
`message`	`public`	`string`	-	`AxAIServiceError`.`message`
`name`	`public`	`string`	-	`AxAIServiceError`.`name`
`requestBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`requestBody`
`responseBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`responseBody`
`stack?`	`public`	`string`	-	`AxAIServiceError`.`stack`
`timestamp`	`readonly`	`string`	-	`AxAIServiceError`.`timestamp`
`url`	`readonly`	`string`	-	`AxAIServiceError`.`url`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`AxAIServiceError`.`stackTraceLimit`

Methods

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L97

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

Parameters

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

Returns

any

Inherited from

AxAIServiceTimeoutError

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L196

Extends

AxAIServiceError

Constructors

Constructor

new AxAIServiceTimeoutError(
   url: string, 
   timeoutMs: number, 
   requestBody?: unknown, 
   context?: Record<string, unknown>): AxAIServiceTimeoutError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L197

Parameters

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

Returns

AxAIServiceTimeoutError

Overrides

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`AxAIServiceError`.`cause`
`context`	`readonly`	`Record`<`string`, `unknown`>	-	`AxAIServiceError`.`context`
`errorId`	`readonly`	`string`	-	`AxAIServiceError`.`errorId`
`message`	`public`	`string`	-	`AxAIServiceError`.`message`
`name`	`public`	`string`	-	`AxAIServiceError`.`name`
`requestBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`requestBody`
`responseBody`	`readonly`	`unknown`	-	`AxAIServiceError`.`responseBody`
`stack?`	`public`	`string`	-	`AxAIServiceError`.`stack`
`timestamp`	`readonly`	`string`	-	`AxAIServiceError`.`timestamp`
`url`	`readonly`	`string`	-	`AxAIServiceError`.`url`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`AxAIServiceError`.`stackTraceLimit`

Methods

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L97

Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

Parameters

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

Returns

any

Inherited from

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

AxAIRefusalError

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L244

Extends

Error

Constructors

Constructor

new AxAIRefusalError(
   refusalMessage: string, 
   model?: string, 
   requestId?: string): AxAIRefusalError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L248

Parameters

Parameter	Type
`refusalMessage`	`string`
`model?`	`string`
`requestId?`	`string`

Returns

AxAIRefusalError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`Error.cause`
`errorId`	`readonly`	`string`	-	-
`message`	`public`	`string`	-	`Error.message`
`model?`	`readonly`	`string`	-	-
`name`	`public`	`string`	-	`Error.name`
`refusalMessage`	`readonly`	`string`	-	-
`requestId?`	`readonly`	`string`	-	-
`stack?`	`public`	`string`	-	`Error.stack`
`timestamp`	`readonly`	`string`	-	-
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`Error.stackTraceLimit`

Methods

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L259

Returns a string representation of an object.

Returns

string

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

Parameters

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

Returns

any

Inherited from

Error.prepareStackTrace

AxAIServiceError

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

Extends

Error

Extended by

Constructors

Constructor

new AxAIServiceError(
   message: string, 
   url: string, 
   requestBody: unknown, 
   responseBody: unknown, 
   context: Record<string, unknown>): AxAIServiceError;

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

Parameters

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

Returns

AxAIServiceError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`Error.cause`
`context`	`readonly`	`Record`<`string`, `unknown`>	-	-
`errorId`	`readonly`	`string`	-	-
`message`	`public`	`string`	-	`Error.message`
`name`	`public`	`string`	-	`Error.name`
`requestBody`	`readonly`	`unknown`	-	-
`responseBody`	`readonly`	`unknown`	-	-
`stack?`	`public`	`string`	-	`Error.stack`
`timestamp`	`readonly`	`string`	-	-
`url`	`readonly`	`string`	-	-
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`Error.stackTraceLimit`

Methods

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L97

Returns a string representation of an object.

Returns

string

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

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

Parameters

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

Returns

any

Inherited from

Error.prepareStackTrace

AxAITogether

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

Extends

AxAIOpenAIBase<string, unknown>

Constructors

Constructor

new AxAITogether(__namedParameters: Readonly<Omit<AxAITogetherArgs, "name">>): AxAITogether;

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

Parameters

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

Returns

AxAITogether

Overrides

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<string, unknown>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

getFeatures()

getFeatures(model?: string): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`string`

Returns

Inherited from

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Inherited from

getLastUsedChatModel()

getLastUsedChatModel(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | string

Inherited from

getLastUsedEmbedModel()

getLastUsedEmbedModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

unknown

Inherited from

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Inherited from

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Inherited from

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Inherited from

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Inherited from

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Inherited from

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Inherited from

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

Inherited from

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Inherited from

AxAgentic.getFeatures

AxAgent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L160

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
`IN` extends `AxGenIn`
`OUT` extends `AxGenOut`

Implements

AxAgentic<IN, OUT>

Constructors

Constructor

new AxAgent<IN, OUT>(__namedParameters: Readonly<{
  agents?: AxAgentic<IN, OUT>[];
  ai?: Readonly<AxAIService>;
  definition?: string;
  description: string;
  functions?: AxInputFunctionType;
  name: string;
  signature: NonNullable<ConstructorParameters<typeof AxSignature>[0]>;
}>, options?: Readonly<AxAgentOptions>): AxAgent<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L175

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `agents?`: `AxAgentic`<`IN`, `OUT`>[]; `ai?`: `Readonly`<`AxAIService`>; `definition?`: `string`; `description`: `string`; `functions?`: `AxInputFunctionType`; `name`: `string`; `signature`: `NonNullable`<`ConstructorParameters`<typeof `AxSignature`>[`0`]>; }>
`options?`	`Readonly`<`AxAgentOptions`>

Returns

AxAgent<IN, OUT>

Methods

forward()

forward(
   parentAi: Readonly<AxAIService>, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramForwardOptions>): Promise<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L384

Parameters

Parameter	Type
`parentAi`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options?`	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT>

getFeatures()

getFeatures(): AxAgentFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L332

Returns

AxAgentFeatures

Implementation of

getFunction()

getFunction(): AxFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L278

Returns

AxAgentic.getFunction

Implementation of

getTraces()

getTraces(): AxProgramTrace<IN, OUT>[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L262

Returns

AxProgramTrace<IN, OUT>[]

Implementation of

AxAgentic.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L270

Returns

AxModelUsage & object[]

Implementation of

AxAgentic.getUsage

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L274

Returns

void

Implementation of

AxAgentic.resetUsage

setDefinition()

setDefinition(definition: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L426

Parameters

Parameter	Type
`definition`	`string`

Returns

void

setDemos()

setDemos(demos: readonly AxProgramDemos<IN, OUT>[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L266

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<`IN`, `OUT`>[]

Returns

void

Implementation of

AxAgentic.setDemos

setDescription()

setDescription(description: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L417

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: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L247

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`<`IN`, `OUT`>>
`options?`	`Readonly`<`AxSetExamplesOptions`>

Returns

void

Implementation of

AxAgentic.setExamples

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L254

Parameters

Parameter	Type
`id`	`string`

Returns

void

Implementation of

AxAgentic.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L258

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Implementation of

AxAgentic.setParentId

streamingForward()

streamingForward(
   parentAi: Readonly<AxAIService>, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L397

Parameters

Parameter	Type
`parentAi`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options?`	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

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

AxApacheTika

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

Constructors

Constructor

new AxApacheTika(args?: Readonly<AxApacheTikaArgs>): AxApacheTika;

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

Parameters

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

Returns

AxApacheTika

Methods

convert()

convert(files: Readonly<string[] | Blob[]>, options?: Readonly<{
  batchSize?: number;
  format?: "text" | "html";
}>): Promise<string[]>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/asserts.ts#L16

Extends

Error

Constructors

Constructor

new AxAssertionError(__namedParameters: Readonly<{
  message: string;
}>): AxAssertionError;

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

Parameters

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

Returns

AxAssertionError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`Error.cause`
`message`	`public`	`string`	-	`Error.message`
`name`	`public`	`string`	-	`Error.name`
`stack?`	`public`	`string`	-	`Error.stack`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`Error.stackTraceLimit`

Methods

getFixingInstructions()

getFixingInstructions(): object[];

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

Returns

object[]

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/asserts.ts#L39

Returns a string representation of an object.

Returns

string

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

Parameters

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

Returns

any

Inherited from

Error.prepareStackTrace

AxBalancer

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L42

Balancer that rotates through services.

Implements

AxAIService<unknown, unknown>

Constructors

Constructor

new AxBalancer(services: readonly AxAIService<unknown, unknown>[], options?: AxBalancerOptions): AxBalancer;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L55

Parameters

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

Returns

AxBalancer

Methods

chat()

chat(req: Readonly<AxChatRequest>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L201

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L261

Parameters

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

Returns

Promise<AxEmbedResponse>

Implementation of

getFeatures()

getFeatures(model?: string): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L147

Parameters

Parameter	Type
`model?`	`string`

Returns

Implementation of

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L143

Returns

string

Implementation of

getLastUsedChatModel()

getLastUsedChatModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L76

Returns

unknown

Implementation of

getLastUsedEmbedModel()

getLastUsedEmbedModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L79

Returns

unknown

Implementation of

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L82

Returns

undefined | AxModelConfig

Implementation of

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L295

Returns

Implementation of

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L151

Returns

Implementation of

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L117

Returns

undefined | AxAIModelList

Implementation of

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L139

Returns

string

Implementation of

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L291

Returns

Readonly<AxAIServiceOptions>

Implementation of

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L287

Parameters

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

Returns

void

Implementation of

inputOrderComparator()

static inputOrderComparator(): number;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/balance.ts#L89

Service comparator that respects the input order of services.

Returns

number

metricComparator()

static metricComparator(a: AxAIService, b: AxAIService): number;

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

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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L72

Extended by

Type Parameters

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

Implements

AxAIService<TModel, TEmbedModel>

Constructors

Constructor

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L137

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: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<TModel, TEmbedModel>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L326

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L625

Parameters

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

Returns

Promise<AxEmbedResponse>

Implementation of

getFeatures()

getFeatures(model?: TModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`model?`	`TModel`

Returns

Implementation of

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L194

Returns

string

Implementation of

getLastUsedChatModel()

getLastUsedChatModel(): undefined | TModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L271

Returns

undefined | TModel

Implementation of

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined | TEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L275

Returns

undefined | TEmbedModel

Implementation of

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L279

Returns

undefined | AxModelConfig

Implementation of

getLogger()

getLogger(): AxLoggerFunction;

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

Returns

Implementation of

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L322

Returns

Implementation of

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L234

Returns

undefined | AxAIModelList

Implementation of

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L261

Returns

string

Implementation of

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L217

Returns

Readonly<AxAIServiceOptions>

Implementation of

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L198

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L202

Parameters

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

Returns

void

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L190

Parameters

Parameter	Type
`name`	`string`

Returns

void

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L206

Parameters

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

Returns

void

Implementation of

AxOptimizer.compilePareto

AxBaseOptimizer

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L447

Abstract base class for optimizers that provides common functionality and standardized handling of AxOptimizerArgs

Extended by

Type Parameters

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

Implements

AxOptimizer<IN, OUT>

Constructors

Constructor

new AxBaseOptimizer<IN, OUT>(args: Readonly<AxOptimizerArgs>): AxBaseOptimizer<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L487

Parameters

Parameter	Type
`args`	`Readonly`<`AxOptimizerArgs`>

Returns

AxBaseOptimizer<IN, OUT>

Methods

compile()

abstract compile(
   program: Readonly<AxProgram<IN, OUT>>, 
   metricFn: AxMetricFn, 
options?: AxCompileOptions): Promise<AxOptimizerResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L682

Abstract method that must be implemented by concrete optimizers

Parameters

Parameter	Type
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>
`metricFn`	`AxMetricFn`
`options?`	`AxCompileOptions`

Returns

Promise<AxOptimizerResult<OUT>>

Implementation of

AxOptimizer.compile

compilePareto()

compilePareto(
   program: Readonly<AxProgram<IN, OUT>>, 
   metricFn: AxMultiMetricFn, 
options?: AxCompileOptions): Promise<AxParetoResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L750

Multi-objective optimization using Pareto frontier Default implementation that leverages the single-objective compile method

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>	The program to optimize
`metricFn`	`AxMultiMetricFn`	Multi-objective metric function that returns multiple scores
`options?`	`AxCompileOptions`	Optional configuration options

Returns

Promise<AxParetoResult<OUT>>

Pareto optimization result with frontier of non-dominated solutions

Implementation of

getStats()

getStats(): AxOptimizationStats;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L691

Get current optimization statistics

Returns

AxOptimizer.validateProgram

Implementation of

AxOptimizer.getStats

reset()

reset(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L698

Reset optimizer state for reuse with different programs

Returns

void

Implementation of

AxOptimizer.reset

validateProgram()

validateProgram(program: Readonly<AxProgram<IN, OUT>>): object;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L709

Basic program validation that can be extended by concrete optimizers

Parameters

Parameter	Type
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>

Returns

object

Name	Type
`issues`	`string`[]
`isValid`	`boolean`
`suggestions`	`string`[]

Implementation of

AxBootstrapFewShot

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/bootstrapFewshot.ts#L20

Abstract base class for optimizers that provides common functionality and standardized handling of AxOptimizerArgs

Extends

AxBaseOptimizer<IN, OUT>

Type Parameters

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

Constructors

Constructor

new AxBootstrapFewShot<IN, OUT>(args: Readonly<AxOptimizerArgs & object>): AxBootstrapFewShot<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/bootstrapFewshot.ts#L35

Parameters

Parameter	Type
`args`	`Readonly`<`AxOptimizerArgs` & `object`>

Returns

AxBootstrapFewShot<IN, OUT>

Overrides

AxBaseOptimizer.constructor

Methods

compile()

compile(
   program: Readonly<AxProgram<IN, OUT>>, 
   metricFn: AxMetricFn, 
options?: AxBootstrapCompileOptions): Promise<AxOptimizerResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/bootstrapFewshot.ts#L204

Abstract method that must be implemented by concrete optimizers

Parameters

Parameter	Type
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>
`metricFn`	`AxMetricFn`
`options?`	`AxBootstrapCompileOptions`

Returns

Promise<AxOptimizerResult<OUT>>

Overrides

AxBaseOptimizer.compile

compilePareto()

compilePareto(
   program: Readonly<AxProgram<IN, OUT>>, 
   metricFn: AxMultiMetricFn, 
options?: AxCompileOptions): Promise<AxParetoResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L750

Multi-objective optimization using Pareto frontier Default implementation that leverages the single-objective compile method

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>	The program to optimize
`metricFn`	`AxMultiMetricFn`	Multi-objective metric function that returns multiple scores
`options?`	`AxCompileOptions`	Optional configuration options

Returns

Promise<AxParetoResult<OUT>>

Pareto optimization result with frontier of non-dominated solutions

Inherited from

AxBaseOptimizer.compilePareto

getStats()

getStats(): AxOptimizationStats;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L691

Get current optimization statistics

Returns

AxBaseOptimizer.getStats

Inherited from

reset()

reset(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L698

Reset optimizer state for reuse with different programs

Returns

void

Inherited from

AxBaseOptimizer.reset

validateProgram()

validateProgram(program: Readonly<AxProgram<IN, OUT>>): object;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L709

Basic program validation that can be extended by concrete optimizers

Parameters

Parameter	Type
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>

Returns

object

Name	Type
`issues`	`string`[]
`isValid`	`boolean`
`suggestions`	`string`[]

Inherited from

AxBaseOptimizer.validateProgram

AxChainOfThought

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/cot.ts#L6

Extends

AxGen<IN, OUT>

Extended by

AxRAG

Type Parameters

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

Constructors

Constructor

new AxChainOfThought<IN, OUT>(signature: Readonly<string | AxSignature>, options?: Readonly<AxProgramForwardOptions & object>): AxChainOfThought<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/cot.ts#L10

Parameters

Parameter	Type
`signature`	`Readonly`<`string` \| `AxSignature`>
`options?`	`Readonly`<`AxProgramForwardOptions` & `object`>

Returns

AxChainOfThought<IN, OUT>

Overrides

AxGen.constructor

Methods

_forward1()

_forward1(
   ai: Readonly<AxAIService>, 
   values: IN | AxMessage<IN>[], 
options: Readonly<AxProgramForwardOptions>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L521

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options`	`Readonly`<`AxProgramForwardOptions`>

Returns

AxGen.addFieldProcessor

Inherited from

AxGen._forward1

addAssert()

addAssert(fn: (values: Record<string, unknown>) => undefined | boolean | Promise<undefined | boolean>, message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L154

Parameters

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

Returns

void

Inherited from

AxGen.addAssert

addFieldProcessor()

addFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L201

Parameters

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

Returns

void

Inherited from

addStreamingAssert()

addStreamingAssert(
   fieldName: string, 
   fn: (content: string, done?: boolean) => undefined | boolean, 
   message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L158

Parameters

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

Returns

void

Inherited from

AxGen.addStreamingAssert

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L194

Parameters

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

Returns

void

Inherited from

AxGen.addStreamingFieldProcessor

forward()

forward(
   ai: Readonly<AxAIService>, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramForwardOptions>): Promise<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L602

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options?`	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT>

Inherited from

AxGen.forward

getSignature()

getSignature(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L210

Returns

Inherited from

AxGen.getSignature

getTraces()

getTraces(): AxProgramTrace<IN, OUT>[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L307

Returns

AxProgramTrace<IN, OUT>[]

Inherited from

AxGen.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L321

Returns

AxModelUsage & object[]

Inherited from

AxGen.getUsage

register()

register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L214

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable`<`IN`, `OUT`> & `AxUsable`>

Returns

void

Inherited from

AxGen.register

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L331

Returns

void

Inherited from

AxGen.resetUsage

setDemos()

setDemos(demos: readonly AxProgramDemos<IN, OUT>[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L338

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<`IN`, `OUT`>[]

Returns

void

Inherited from

AxGen.setDemos

setExamples()

setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L695

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`<`IN`, `OUT`>>
`options?`	`Readonly`<`AxSetExamplesOptions`>

Returns

void

Inherited from

AxGen.setExamples

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L244

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxGen.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L251

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxGen.setParentId

streamingForward()

streamingForward(
   ai: Readonly<AxAIService>, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L640

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options?`	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AxGen.streamingForward

Inherited from

AxDB

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

Implements

AxDBService

Constructors

Constructor

new AxDB(args: Readonly<AxDBArgs>): AxDB;

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

Parameters

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

Returns

AxDB

Methods

batchUpsert()

batchUpsert(batchReq: readonly AxDBUpsertRequest[], update?: boolean): Promise<AxDBUpsertResponse>;

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

Parameters

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

Returns

Promise<AxDBUpsertResponse>

Implementation of

AxDBService.batchUpsert

query()

query(req: Readonly<AxDBQueryRequest>): Promise<AxDBQueryResponse>;

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

Parameters

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

Returns

Promise<AxDBQueryResponse>

Implementation of

AxDBService.query

upsert()

upsert(req: Readonly<AxDBUpsertRequest>, update?: boolean): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/base.ts#L22

Extended by

Implements

AxDBService

Constructors

Constructor

new AxDBBase(__namedParameters: Readonly<AxDBBaseArgs & object>): AxDBBase;

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

Parameters

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

Returns

AxDBBase

Properties

Property	Type
`_batchUpsert?`	(`batchReq`: readonly `AxDBUpsertRequest`[], `update?`: `boolean`, `options?`: `Readonly`<`AxDBBaseOpOptions`>) => `Promise`<`AxDBUpsertResponse`>
`_query?`	(`req`: `Readonly`<`AxDBQueryRequest`>, `options?`: `Readonly`<`AxDBBaseOpOptions`>) => `Promise`<`AxDBQueryResponse`>
`_upsert?`	(`req`: `Readonly`<`AxDBUpsertRequest`>, `update?`: `boolean`, `options?`: `Readonly`<`AxDBBaseOpOptions`>) => `Promise`<`AxDBUpsertResponse`>

Methods

batchUpsert()

batchUpsert(req: readonly AxDBUpsertRequest[], update?: boolean): Promise<AxDBUpsertResponse>;

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

Parameters

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

Returns

Promise<AxDBUpsertResponse>

Implementation of

AxDBService.batchUpsert

query()

query(req: Readonly<AxDBQueryRequest>): Promise<AxDBQueryResponse>;

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

Parameters

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

Returns

Promise<AxDBQueryResponse>

Implementation of

AxDBService.query

upsert()

upsert(req: Readonly<AxDBUpsertRequest>, update?: boolean): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/cloudflare.ts#L44

Cloudflare: DB Service

Extends

AxDBBase

Constructors

Constructor

new AxDBCloudflare(__namedParameters: Readonly<Omit<AxDBCloudflareArgs, "name">>): AxDBCloudflare;

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

Parameters

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

Returns

AxDBCloudflare

Overrides

Properties

Property	Type	Inherited from
`_batchUpsert?`	(`batchReq`: readonly `AxDBUpsertRequest`[], `update?`: `boolean`, `options?`: `Readonly`<`AxDBBaseOpOptions`>) => `Promise`<`AxDBUpsertResponse`>	`AxDBBase`.`_batchUpsert`
`_query?`	(`req`: `Readonly`<`AxDBQueryRequest`>, `options?`: `Readonly`<`AxDBBaseOpOptions`>) => `Promise`<`AxDBQueryResponse`>	`AxDBBase`.`_query`

Methods

_upsert()

_upsert(
   req: Readonly<AxDBUpsertRequest>, 
   _update?: boolean, 
options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: readonly AxDBUpsertRequest[], 
   update?: boolean, 
options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBUpsertResponse>;

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

Parameters

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

Returns

Promise<AxDBUpsertResponse>

Overrides

query()

query(req: Readonly<AxDBQueryRequest>, options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBQueryResponse>;

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

Parameters

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

Returns

Promise<AxDBQueryResponse>

Overrides

upsert()

upsert(req: Readonly<AxDBUpsertRequest>, update?: boolean): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/docs/manager.ts#L30

Constructors

Constructor

new AxDBManager(__namedParameters: Readonly<AxDBManagerArgs>): AxDBManager;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/docs/manager.ts#L37

Parameters

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

Returns

AxDBManager

Methods

insert()

insert(text: Readonly<string | string[]>, options?: Readonly<{
  abortSignal?: AbortSignal;
  batchSize?: number;
  maxWordsPerChunk?: number;
  minWordsPerChunk?: number;
}>): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/docs/manager.ts#L50

Parameters

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

Returns

Promise<void>

query()

query(query: Readonly<string | number | string[] | number[]>, __namedParameters: 
  | undefined
  | Readonly<{
  abortSignal?: AbortSignal;
  topPercent?: number;
}>): Promise<AxDBMatch[][]>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/docs/manager.ts#L112

Parameters

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

Returns

Promise<AxDBMatch[][]>

AxDBMemory

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

MemoryDB: DB Service

Extends

AxDBBase

Constructors

Constructor

new AxDBMemory(__namedParameters: Readonly<Omit<AxDBMemoryArgs, "name">>): AxDBMemory;

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

Parameters

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

Returns

AxDBMemory

Overrides

Methods

_batchUpsert()

_batchUpsert(
   batchReq: readonly AxDBUpsertRequest[], 
   update?: boolean, 
_options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: Readonly<AxDBQueryRequest>, _options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBQueryResponse>;

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

Parameters

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

Returns

Promise<AxDBQueryResponse>

Overrides

AxDBBase._query

_upsert()

_upsert(
   req: Readonly<AxDBUpsertRequest>, 
   _update?: boolean, 
_options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: readonly AxDBUpsertRequest[], update?: boolean): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/memory.ts#L100

Returns

void

getDB()

getDB(): AxDBState;

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

Returns

AxDBState

query()

query(req: Readonly<AxDBQueryRequest>): Promise<AxDBQueryResponse>;

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

Parameters

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

Returns

Promise<AxDBQueryResponse>

Inherited from

setDB()

setDB(state: AxDBState): void;

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

Parameters

Parameter	Type
`state`	`AxDBState`

Returns

void

upsert()

upsert(req: Readonly<AxDBUpsertRequest>, update?: boolean): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/pinecone.ts#L58

Pinecone: DB Service

Extends

AxDBBase

Constructors

Constructor

new AxDBPinecone(__namedParameters: Readonly<Omit<AxDBPineconeArgs, "name">>): AxDBPinecone;

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

Parameters

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

Returns

AxDBPinecone

Overrides

Properties

Property	Type	Inherited from
`_query?`	(`req`: `Readonly`<`AxDBQueryRequest`>, `options?`: `Readonly`<`AxDBBaseOpOptions`>) => `Promise`<`AxDBQueryResponse`>	`AxDBBase`.`_query`

Methods

_batchUpsert()

_batchUpsert(
   batchReq: readonly AxDBUpsertRequest[], 
   _update?: boolean, 
options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: Readonly<AxDBUpsertRequest>, 
   update?: boolean, 
options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: readonly AxDBUpsertRequest[], update?: boolean): Promise<AxDBUpsertResponse>;

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

Parameters

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

Returns

Promise<AxDBUpsertResponse>

Inherited from

query()

query(req: Readonly<AxDBQueryRequest>, options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBQueryResponse>;

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

Parameters

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

Returns

Promise<AxDBQueryResponse>

Overrides

upsert()

upsert(req: Readonly<AxDBUpsertRequest>, update?: boolean): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/weaviate.ts#L39

Weaviate: DB Service

Extends

AxDBBase

Constructors

Constructor

new AxDBWeaviate(__namedParameters: Readonly<Omit<AxDBWeaviateArgs, "name">>): AxDBWeaviate;

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

Parameters

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

Returns

AxDBWeaviate

Overrides

Methods

_batchUpsert()

_batchUpsert(
   batchReq: readonly AxDBUpsertRequest[], 
   update?: boolean, 
options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: Readonly<AxDBQueryRequest>, options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBQueryResponse>;

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

Parameters

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

Returns

Promise<AxDBQueryResponse>

Overrides

AxDBBase._query

_upsert()

_upsert(
   req: Readonly<AxDBUpsertRequest>, 
   update?: boolean, 
options?: Readonly<AxDBBaseOpOptions>): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: readonly AxDBUpsertRequest[], update?: boolean): Promise<AxDBUpsertResponse>;

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

Parameters

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

Returns

Promise<AxDBUpsertResponse>

Inherited from

query()

query(req: Readonly<AxDBQueryRequest>): Promise<AxDBQueryResponse>;

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

Parameters

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

Returns

Promise<AxDBQueryResponse>

Inherited from

upsert()

upsert(req: Readonly<AxDBUpsertRequest>, update?: boolean): Promise<AxDBUpsertResponse>;

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

Parameters

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

Returns

Promise<AxDBUpsertResponse>

Inherited from

AxCostTracker.getCurrentCost

AxDefaultCostTracker

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L382

Implements

AxCostTracker

Constructors

Constructor

new AxDefaultCostTracker(options?: AxCostTrackerOptions): AxDefaultCostTracker;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L391

Parameters

Parameter	Type
`options?`	`AxCostTrackerOptions`

Returns

AxDefaultCostTracker

Methods

getCurrentCost()

getCurrentCost(): number;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L402

Returns

number

Implementation of

getTokenUsage()

getTokenUsage(): Record<string, number>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L412

Returns

Record<string, number>

Implementation of

AxCostTracker.getTokenUsage

getTotalTokens()

getTotalTokens(): number;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L416

Returns

number

Implementation of

AxCostTracker.getTotalTokens

isLimitReached()

isLimitReached(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L420

Returns

boolean

Implementation of

AxCostTracker.isLimitReached

reset()

reset(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L437

Returns

void

Implementation of

AxCostTracker.reset

trackTokens()

trackTokens(count: number, model: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L397

Parameters

Parameter	Type
`count`	`number`
`model`	`string`

Returns

void

Implementation of

AxCostTracker.trackTokens

AxDefaultResultReranker

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

Extends

AxGen<AxRerankerIn, AxRerankerOut>

Constructors

Constructor

new AxDefaultResultReranker(options?: Readonly<AxProgramForwardOptions>): AxDefaultResultReranker;

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

Parameters

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

Returns

AxDefaultResultReranker

Overrides

AxGen.constructor

Methods

_forward1()

_forward1(
   ai: Readonly<AxAIService>, 
   values: 
  | AxRerankerIn
  | AxMessage<AxRerankerIn>[], 
options: Readonly<AxProgramForwardOptions>): AxGenStreamingOut<AxRerankerOut>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L521

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	\| `AxRerankerIn` \| `AxMessage`<`AxRerankerIn`>[]
`options`	`Readonly`<`AxProgramForwardOptions`>

Returns

AxGenStreamingOut<AxRerankerOut>

Inherited from

AxGen._forward1

addAssert()

addAssert(fn: (values: Record<string, unknown>) => undefined | boolean | Promise<undefined | boolean>, message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L154

Parameters

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

Returns

void

Inherited from

AxGen.addAssert

addFieldProcessor()

addFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L201

Parameters

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

Returns

void

Inherited from

AxGen.addFieldProcessor

addStreamingAssert()

addStreamingAssert(
   fieldName: string, 
   fn: (content: string, done?: boolean) => undefined | boolean, 
   message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L158

Parameters

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

Returns

void

Inherited from

AxGen.addStreamingAssert

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L194

Parameters

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

Returns

void

Inherited from

AxGen.addStreamingFieldProcessor

forward()

forward(
   ai: Readonly<AxAIService>, 
   input: Readonly<AxRerankerIn>, 
options?: Readonly<AxProgramForwardOptions>): Promise<AxRerankerOut>;

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

Parameters

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

Returns

Promise<AxRerankerOut>

Overrides

AxGen.forward

getSignature()

getSignature(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L210

Returns

AxGenStreamingOut<AxRerankerOut>

Inherited from

AxGen.getSignature

getTraces()

getTraces(): AxProgramTrace<AxRerankerIn, AxRerankerOut>[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L307

Returns

AxProgramTrace<AxRerankerIn, AxRerankerOut>[]

Inherited from

AxGen.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L321

Returns

AxModelUsage & object[]

Inherited from

AxGen.getUsage

register()

register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L214

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable`<`IN`, `OUT`> & `AxUsable`>

Returns

void

Inherited from

AxGen.register

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L331

Returns

void

Inherited from

AxGen.resetUsage

setDemos()

setDemos(demos: readonly AxProgramDemos<AxRerankerIn, AxRerankerOut>[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L338

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<`AxRerankerIn`, `AxRerankerOut`>[]

Returns

void

Inherited from

AxGen.setDemos

setExamples()

setExamples(examples: Readonly<AxProgramExamples<AxRerankerIn, AxRerankerOut>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L695

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`<`AxRerankerIn`, `AxRerankerOut`>>
`options?`	`Readonly`<`AxSetExamplesOptions`>

Returns

void

Inherited from

AxGen.setExamples

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L244

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxGen.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L251

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxGen.setParentId

streamingForward()

streamingForward(
   ai: Readonly<AxAIService>, 
   values: 
  | AxRerankerIn
  | AxMessage<AxRerankerIn>[], 
options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<AxRerankerOut>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L640

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	\| `AxRerankerIn` \| `AxMessage`<`AxRerankerIn`>[]
`options?`	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

Inherited from

AxGen.streamingForward

AxDockerSession

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

Constructors

Constructor

new AxDockerSession(apiUrl: string): AxDockerSession;

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

Parameters

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

Returns

AxDockerSession

Methods

connectToContainer()

connectToContainer(containerId: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/docker.ts#L186

Parameters

Parameter	Type
`containerId`	`string`

Returns

Promise<void>

createContainer()

createContainer(__namedParameters: Readonly<{
  doNotPullImage?: boolean;
  imageName: string;
  tag?: string;
  volumes?: object[];
}>): Promise<{
  Id: string;
}>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: string): Promise<string>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/docker.ts#L274

Parameters

Parameter	Type
`command`	`string`

Returns

Promise<string>

findOrCreateContainer()

findOrCreateContainer(__namedParameters: Readonly<{
  doNotPullImage?: boolean;
  imageName: string;
  tag: string;
  volumes?: object[];
}>): Promise<{
  Id: string;
  isNew: boolean;
}>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/docker.ts#L263

Returns

Promise<string>

listContainers()

listContainers(all: boolean): Promise<AxDockerContainer[]>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/docker.ts#L256

Parameters

Parameter	Type	Default value
`all`	`boolean`	`false`

Returns

Promise<AxDockerContainer[]>

pullImage()

pullImage(imageName: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/docker.ts#L169

Returns

Promise<void>

stopContainers()

stopContainers(__namedParameters: Readonly<{
  remove?: boolean;
  tag?: string;
  timeout?: number;
}>): Promise<object[]>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/docker.ts#L373

Returns

AxEmbeddingAdapter

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/embed.ts#L7

Constructors

Constructor

new AxEmbeddingAdapter(__namedParameters: Readonly<{
  ai: AxAIService;
  func: (args: readonly number[], extra?: Readonly<AxAIServiceActionOptions>) => Promise<unknown>;
  info: Readonly<{
     argumentDescription: string;
     description: string;
     name: string;
  }>;
}>): AxEmbeddingAdapter;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/embed.ts#L19

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `ai`: `AxAIService`; `func`: (`args`: readonly `number`[], `extra?`: `Readonly`<`AxAIServiceActionOptions`>) => `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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/embed.ts#L60

Returns

AxProgramWithSignature.constructor

AxFlow

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/flow/flow.ts#L68

AxFlow - A fluent, chainable API for building and orchestrating complex, stateful AI programs.

Allows developers to define computational nodes declaratively and then compose them imperatively using loops, conditionals, and dynamic context.

Example

const flow = new AxFlow<{ topic: string }, { summary: string; analysis: string }>()
  .node('summarizer', { 'text:string': { summary: f.string() } })
  .node('analyzer', { 'text:string': { analysis: f.string() } })
  .map(input => ({ originalText: `Some long text about ${input.topic}` }))
  .execute('summarizer', state => ({ text: state.originalText }), { ai: cheapAI })
  .execute('analyzer', state => ({ text: state.originalText }), { ai: powerfulAI })
  .map(state => ({
    summary: state.summarizerResult.summary,
    analysis: state.analyzerResult.analysis
  }))

const result = await flow.forward(ai, { topic: "the future of AI" })

Extends

AxProgramWithSignature<IN, OUT>

Type Parameters

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

Constructors

Constructor

new AxFlow<IN, OUT>(signature: NonNullable<
  | undefined
  | Readonly<
  | string
  | AxSignatureConfig
| AxSignature>>): AxFlow<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/flow/flow.ts#L78

Parameters

Parameter	Type	Default value
`signature`	`NonNullable`< \| `undefined` \| `Readonly`< \| `string` \| `AxSignatureConfig` \| `AxSignature`>>	`'userInput:string -> flowOutput:string'`

Returns

AxFlow<IN, OUT>

Overrides

Methods

endWhile()

endWhile(): this;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/flow/flow.ts#L292

Marks the end of a loop block.

Returns

this

this (for chaining)

execute()

execute(
   nodeName: string, 
   mapping: (state: AxFlowState) => Record<string, AxFieldValue>, 
   dynamicContext?: AxFlowDynamicContext): this;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/flow/flow.ts#L212

Executes a previously defined node.

Example

flow.execute('summarizer', state => ({ text: state.originalText }), { ai: cheapAI })

Parameters

Parameter	Type	Description
`nodeName`	`string`	The name of the node to execute (must exist in the nodes map)
`mapping`	(`state`: `AxFlowState`) => `Record`<`string`, `AxFieldValue`>	Function that takes the current state and returns the input object required by the node
`dynamicContext?`	`AxFlowDynamicContext`	Optional object to override the AI service or options for this specific step

Returns

this

this (for chaining)

forward()

forward(
   ai: Readonly<AxAIService>, 
   values: IN, 
options?: Readonly<AxProgramForwardOptions>): Promise<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/flow/flow.ts#L340

Executes the flow with the given AI service and input values.

Parameters

Parameter	Type	Description
`ai`	`Readonly`<`AxAIService`>	The AI service to use as the default for all steps
`values`	`IN`	The input values for the flow
`options?`	`Readonly`<`AxProgramForwardOptions`>	Optional forward options to use as defaults

Returns

Promise<OUT>

Promise that resolves to the final output

Overrides

AxProgramWithSignature.forward

getSignature()

getSignature(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L210

Returns

AxProgramWithSignature.getSignature

Inherited from

getTraces()

getTraces(): AxProgramTrace<IN, OUT>[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L307

Returns

AxProgramTrace<IN, OUT>[]

Inherited from

AxProgramWithSignature.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L321

Returns

AxModelUsage & object[]

Inherited from

AxProgramWithSignature.getUsage

map()

map(transform: (state: AxFlowState) => AxFlowState): this;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/flow/flow.ts#L192

Applies a synchronous transformation to the state object.

Example

flow.map(state => ({ ...state, processedText: state.text.toLowerCase() }))

Parameters

Parameter	Type	Description
`transform`	(`state`: `AxFlowState`) => `AxFlowState`	Function that takes the current state and returns a new state

Returns

this

this (for chaining)

node()

node(name: string, signature: Record<string, Record<string, unknown>>): this;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/flow/flow.ts#L99

Declares a reusable computational node and its input/output signature.

Example

flow.node('summarizer', { 'text:string': { summary: f.string() } })

Parameters

Parameter	Type	Description
`name`	`string`	The name of the node
`signature`	`Record`<`string`, `Record`<`string`, `unknown`>>	An object where the key is a string representation of inputs and the value is an object representing outputs

Returns

this

this (for chaining)

register()

register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L214

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable`<`IN`, `OUT`> & `AxUsable`>

Returns

void

Inherited from

AxProgramWithSignature.register

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L331

Returns

void

Inherited from

AxProgramWithSignature.resetUsage

setDemos()

setDemos(demos: readonly AxProgramDemos<IN, OUT>[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L338

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<`IN`, `OUT`>[]

Returns

void

Inherited from

AxProgramWithSignature.setDemos

setExamples()

setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L257

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`<`IN`, `OUT`>>
`options?`	`Readonly`<`AxSetExamplesOptions`>

Returns

void

Inherited from

AxProgramWithSignature.setExamples

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L244

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxProgramWithSignature.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L251

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxProgramWithSignature.setParentId

streamingForward()

streamingForward(
   _ai: Readonly<AxAIService>, 
   _values: IN | AxMessage<IN>[], 
_options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L233

Parameters

Parameter	Type
`_ai`	`Readonly`<`AxAIService`>
`_values`	`IN` \| `AxMessage`<`IN`>[]
`_options?`	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AxProgramWithSignature.streamingForward

Inherited from

while()

while(condition: (state: AxFlowState) => boolean): this;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/flow/flow.ts#L262

Marks the beginning of a loop block.

Example

flow.while(state => state.iterations < 3)
  .map(state => ({ ...state, iterations: (state.iterations || 0) + 1 }))
  .endWhile()

Parameters

Parameter	Type	Description
`condition`	(`state`: `AxFlowState`) => `boolean`	Function that takes the current state and returns a boolean

Returns

this

this (for chaining)

AxFunctionProcessor

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/functions.ts#L107

Constructors

Constructor

new AxFunctionProcessor(funcList: readonly AxFunction[]): AxFunctionProcessor;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/functions.ts#L110

Parameters

Parameter	Type
`funcList`	readonly `AxFunction`[]

Returns

AxFunctionProcessor

Methods

execute()

execute(func: Readonly<AxChatResponseFunctionCall>, options?: Readonly<AxAIServiceActionOptions>): Promise<string>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/functions.ts#L158

Parameters

Parameter	Type
`func`	`Readonly`<`AxChatResponseFunctionCall`>
`options?`	`Readonly`<`AxAIServiceActionOptions`>

Returns

Promise<string>

AxFunctionError

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/functions.ts#L13

Extends

Error

Constructors

Constructor

new AxFunctionError(fields: object[]): AxFunctionError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/functions.ts#L14

Parameters

Parameter	Type
`fields`	`object`[]

Returns

AxFunctionError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`Error.cause`
`message`	`public`	`string`	-	`Error.message`
`name`	`public`	`string`	-	`Error.name`
`stack?`	`public`	`string`	-	`Error.stack`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`Error.stackTraceLimit`

Methods

getFields()

getFields(): object[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/functions.ts#L24

Returns

object[]

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/functions.ts#L26

Returns a string representation of an object.

Returns

string

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

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

Parameters

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

Returns

any

Inherited from

Error.prepareStackTrace

AxGen

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L99

Extends

AxProgramWithSignature<IN, OUT>

Extended by

Type Parameters

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

Constructors

Constructor

new AxGen<IN, OUT>(signature: NonNullable<
  | undefined
  | Readonly<
  | string
  | AxSignatureConfig
| AxSignature>>, options?: Readonly<AxProgramForwardOptions>): AxGen<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L113

Parameters

Parameter	Type
`signature`	`NonNullable`< \| `undefined` \| `Readonly`< \| `string` \| `AxSignatureConfig` \| `AxSignature`>>
`options?`	`Readonly`<`AxProgramForwardOptions`>

Returns

AxGen<IN, OUT>

Overrides

AxProgramWithSignature.constructor

Methods

_forward1()

_forward1(
   ai: Readonly<AxAIService>, 
   values: IN | AxMessage<IN>[], 
options: Readonly<AxProgramForwardOptions>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L521

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options`	`Readonly`<`AxProgramForwardOptions`>

Returns

AxProgramWithSignature.forward

addAssert()

addAssert(fn: (values: Record<string, unknown>) => undefined | boolean | Promise<undefined | boolean>, message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L154

Parameters

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

Returns

void

addFieldProcessor()

addFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L201

Parameters

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

Returns

void

addStreamingAssert()

addStreamingAssert(
   fieldName: string, 
   fn: (content: string, done?: boolean) => undefined | boolean, 
   message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L158

Parameters

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

Returns

void

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L194

Parameters

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

Returns

void

forward()

forward(
   ai: Readonly<AxAIService>, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramForwardOptions>): Promise<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L602

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options?`	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT>

Overrides

getSignature()

getSignature(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L210

Returns

AxProgramWithSignature.getSignature

Inherited from

getTraces()

getTraces(): AxProgramTrace<IN, OUT>[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L307

Returns

AxProgramTrace<IN, OUT>[]

Inherited from

AxProgramWithSignature.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L321

Returns

AxModelUsage & object[]

Inherited from

AxProgramWithSignature.getUsage

register()

register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L214

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable`<`IN`, `OUT`> & `AxUsable`>

Returns

void

Inherited from

AxProgramWithSignature.register

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L331

Returns

void

Inherited from

AxProgramWithSignature.resetUsage

setDemos()

setDemos(demos: readonly AxProgramDemos<IN, OUT>[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L338

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<`IN`, `OUT`>[]

Returns

void

Inherited from

AxProgramWithSignature.setDemos

setExamples()

setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L695

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`<`IN`, `OUT`>>
`options?`	`Readonly`<`AxSetExamplesOptions`>

Returns

void

Overrides

AxProgramWithSignature.setExamples

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L244

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxProgramWithSignature.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L251

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxProgramWithSignature.setParentId

streamingForward()

streamingForward(
   ai: Readonly<AxAIService>, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L640

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options?`	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AxProgramWithSignature.streamingForward

Overrides

AxGenerateError

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L733

Extends

Error

Constructors

Constructor

new AxGenerateError(
   message: string, 
   details: Readonly<AxGenerateErrorDetails>, 
   options?: ErrorOptions): AxGenerateError;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L736

Parameters

Parameter	Type
`message`	`string`
`details`	`Readonly`<`AxGenerateErrorDetails`>
`options?`	`ErrorOptions`

Returns

AxGenerateError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`Error.cause`
`details`	`readonly`	`AxGenerateErrorDetails`	-	-
`message`	`public`	`string`	-	`Error.message`
`name`	`public`	`string`	-	`Error.name`
`stack?`	`public`	`string`	-	`Error.stack`
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`Error.stackTraceLimit`

Methods

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

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

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

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

Parameters

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

Returns

any

Inherited from

Error.prepareStackTrace

AxHFDataLoader

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/loader.ts#L5

Constructors

Constructor

new AxHFDataLoader(__namedParameters: Readonly<{
  config: string;
  dataset: string;
  options?: Readonly<{
     length?: number;
     offset?: number;
  }>;
  split: string;
}>): AxHFDataLoader;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/loader.ts#L67

Returns

AxDataRow[]

getRows()

getRows<T>(__namedParameters: Readonly<{
  count: number;
  fields: readonly string[];
  renameMap?: Record<string, string>;
}>): Promise<T[]>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/loader.ts#L51

Returns

Promise<AxDataRow[]>

setData()

setData(rows: AxDataRow[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/loader.ts#L63

Parameters

Parameter	Type
`rows`	`AxDataRow`[]

Returns

void

AxInstanceRegistry

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/registry.ts#L10

Type Parameters

Type Parameter
`T` extends `AxTunable`<`IN`, `OUT`>
`IN` extends `AxGenIn`
`OUT` extends `AxGenOut`

Constructors

Constructor

new AxInstanceRegistry<T, IN, OUT>(): AxInstanceRegistry<T, IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/registry.ts#L17

Returns

AxInstanceRegistry<T, IN, OUT>

Methods

[iterator]()

iterator: Generator<undefined | AxInstanceRegistryItem<T, IN, OUT>, void, unknown>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/registry.ts#L25

Returns

Generator<undefined | AxInstanceRegistryItem<T, IN, OUT>, void, unknown>

register()

register(instance: AxInstanceRegistryItem<T, IN, OUT>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/registry.ts#L21

Parameters

Parameter	Type
`instance`	`AxInstanceRegistryItem`<`T`, `IN`, `OUT`>

Returns

void

AxJSInterpreter

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/code.ts#L29

Constructors

Constructor

new AxJSInterpreter(__namedParameters: 
  | undefined
  | Readonly<{
  permissions?: readonly AxJSInterpreterPermission[];
}>): AxJSInterpreter;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/code.ts#L67

Returns

AxMCPTransport.connect

AxMCPHTTPSSETransport

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L8

Implements

AxMCPTransport

Constructors

Constructor

new AxMCPHTTPSSETransport(sseUrl: string): AxMCPHTTPSSETransport;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L13

Parameters

Parameter	Type
`sseUrl`	`string`

Returns

AxMCPHTTPSSETransport

Methods

connect()

connect(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: JSONRPCNotification | JSONRPCRequest<unknown>): Promise<JSONRPCResponse<unknown>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: Readonly<JSONRPCNotification>): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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

AxMCPClient

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/client.ts#L58

Constructors

Constructor

new AxMCPClient(transport: AxMCPTransport, options: Readonly<AxMCPClientOptions>): AxMCPClient;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/client.ts#L69

Parameters

Parameter	Type
`transport`	`AxMCPTransport`
`options`	`Readonly`<`AxMCPClientOptions`>

Returns

AxMCPClient

Methods

cancelRequest()

cancelRequest(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/client.ts#L197

Parameters

Parameter	Type
`id`	`string`

Returns

void

init()

init(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/client.ts#L76

Returns

Promise<void>

ping()

ping(timeout: number): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/client.ts#L172

Parameters

Parameter	Type	Default value
`timeout`	`number`	`3000`

Returns

Promise<void>

toFunction()

toFunction(): AxFunction[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/client.ts#L193

Returns

AxFunction[]

AxMCPStdioTransport

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/stdioTransport.ts#L17

Implements

AxMCPTransport

Constructors

Constructor

new AxMCPStdioTransport(config: Readonly<StdioTransportConfig>): AxMCPStdioTransport;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: Readonly<JSONRPCRequest<unknown>>): Promise<JSONRPCResponse<unknown>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: Readonly<JSONRPCNotification>): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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

AxMCPStreambleHTTPTransport

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L97

AxMCPStreambleHTTPTransport implements the 2025-03-26 Streamable HTTP transport specification This transport uses a single HTTP endpoint that supports both POST and GET methods

Implements

AxMCPTransport

Constructors

Constructor

new AxMCPStreambleHTTPTransport(mcpEndpoint: string, options?: AxMCPStreamableHTTPTransportOptions): AxMCPStreambleHTTPTransport;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L113

Parameters

Parameter	Type
`mcpEndpoint`	`string`
`options?`	`AxMCPStreamableHTTPTransportOptions`

Returns

AxMCPStreambleHTTPTransport

Methods

close()

close(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L453

Close any open connections

Returns

void

connect()

connect(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L171

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

getHeaders()

getHeaders(): Record<string, string>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L143

Get a copy of the current custom headers

Returns

Record<string, string>

openListeningStream()

openListeningStream(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L180

Opens an SSE stream to listen for server-initiated messages

Returns

Promise<void>

send()

send(message: Readonly<JSONRPCRequest<unknown>>): Promise<JSONRPCResponse<unknown>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L287

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: Readonly<JSONRPCNotification>): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L394

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

setAuthorization()

setAuthorization(authorization: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L136

Update authorization header (convenience method)

Parameters

Parameter	Type
`authorization`	`string`

Returns

void

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L129

Update custom headers (useful for refreshing tokens)

Parameters

Parameter	Type
`headers`	`Record`<`string`, `string`>

Returns

void

setMessageHandler()

setMessageHandler(handler: (message: JSONRPCNotification | JSONRPCRequest<unknown>) => void): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L165

Set a handler for incoming server messages (requests/notifications)

Parameters

Parameter	Type
`handler`	(`message`: `JSONRPCNotification` \| `JSONRPCRequest`<`unknown`>) => `void`

Returns

void

terminateSession()

terminateSession(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L426

Explicitly terminate the session (if supported by server)

Returns

Promise<void>

AxMiPRO

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/miproV2.ts#L35

Abstract base class for optimizers that provides common functionality and standardized handling of AxOptimizerArgs

Extends

AxBaseOptimizer<IN, OUT>

Type Parameters

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

Constructors

Constructor

new AxMiPRO<IN, OUT>(args: Readonly<AxOptimizerArgs & object>): AxMiPRO<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/miproV2.ts#L70

Parameters

Parameter	Type
`args`	`Readonly`<`AxOptimizerArgs` & `object`>

Returns

AxMiPRO<IN, OUT>

Overrides

AxBaseOptimizer.constructor

Methods

compile()

compile(
   program: Readonly<AxProgram<IN, OUT>>, 
   metricFn: AxMetricFn, 
options?: AxCompileOptions): Promise<AxMiPROResult<IN, OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/miproV2.ts#L750

The main compile method to run MIPROv2 optimization

Parameters

Parameter	Type
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>
`metricFn`	`AxMetricFn`
`options?`	`AxCompileOptions`

Returns

Promise<AxMiPROResult<IN, OUT>>

Overrides

AxBaseOptimizer.compile

compilePareto()

compilePareto(
   program: Readonly<AxProgram<IN, OUT>>, 
   metricFn: AxMultiMetricFn, 
options?: AxCompileOptions): Promise<AxParetoResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L750

Multi-objective optimization using Pareto frontier Default implementation that leverages the single-objective compile method

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>	The program to optimize
`metricFn`	`AxMultiMetricFn`	Multi-objective metric function that returns multiple scores
`options?`	`AxCompileOptions`	Optional configuration options

Returns

Promise<AxParetoResult<OUT>>

Pareto optimization result with frontier of non-dominated solutions

Inherited from

AxBaseOptimizer.compilePareto

configureAuto()

configureAuto(level: "medium" | "light" | "heavy"): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/miproV2.ts#L111

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

getConfiguration()

getConfiguration(): Record<string, unknown>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/miproV2.ts#L959

Get optimizer-specific configuration

Returns

Record<string, unknown>

Current optimizer configuration

getStats()

getStats(): AxOptimizationStats;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L691

Get current optimization statistics

Returns

AxBaseOptimizer.getStats

Inherited from

reset()

reset(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/miproV2.ts#L1023

Reset optimizer state for reuse with different programs

Returns

void

Overrides

AxBaseOptimizer.reset

updateConfiguration()

updateConfiguration(config: Readonly<Record<string, unknown>>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/miproV2.ts#L986

Update optimizer configuration

Parameters

Parameter	Type	Description
`config`	`Readonly`<`Record`<`string`, `unknown`>>	New configuration to merge with existing

Returns

void

validateProgram()

validateProgram(program: Readonly<AxProgram<IN, OUT>>): object;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/miproV2.ts#L1038

Validate that the optimizer can handle the given program

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>	Program to validate

Returns

object

Validation result with any issues found

Name	Type
`issues`	`string`[]
`isValid`	`boolean`
`suggestions`	`string`[]

Overrides

AxBaseOptimizer.validateProgram

AxMemory

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L214

Implements

AxAIMemory

Constructors

Constructor

new AxMemory(options?: object): AxMemory;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L218

Parameters

Parameter	Type
`options?`	{ `debug?`: `boolean`; `debugHideSystemPrompt?`: `boolean`; }
`options.debug?`	`boolean`
`options.debugHideSystemPrompt?`	`boolean`

Returns

AxMemory

Methods

addFunctionResults()

addFunctionResults(results: readonly AxFunctionResult[], sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L254

Parameters

Parameter	Type
`results`	readonly `AxFunctionResult`[]
`sessionId?`	`string`

Returns

void

Implementation of

AxAIMemory.addFunctionResults

addRequest()

addRequest(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";
})[], sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L239

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

sessionId? string

Returns

void

Implementation of

AxAIMemory.addRequest

addResponse()

addResponse(results: readonly AxChatResponseResult[], sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L246

Parameters

Parameter	Type
`results`	readonly `AxChatResponseResult`[]
`sessionId?`	`string`

Returns

void

Implementation of

AxAIMemory.addResponse

addTag()

addTag(name: string, sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L268

Parameters

Parameter	Type
`name`	`string`
`sessionId?`	`string`

Returns

void

Implementation of

AxAIMemory.addTag

getLast()

getLast(sessionId?: string): 
  | undefined
  | {
  chat: object[];
  role: "function" | "system" | "user" | "assistant";
  tags?: string[];
  updatable?: boolean;
};

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L280

Parameters

Parameter	Type
`sessionId?`	`string`

Returns

| undefined | { chat: object[]; role: "function" | "system" | "user" | "assistant"; tags?: string[]; updatable?: boolean; }

Implementation of

AxAIMemory.getLast

history()

history(index: number, sessionId?: string): (
  | {
  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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L276

Parameters

Parameter	Type
`index`	`number`
`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?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L284

Parameters

Parameter	Type
`sessionId?`	`string`

Returns

void

Implementation of

AxAIMemory.reset

rewindToTag()

rewindToTag(name: string, sessionId?: string): AxMemoryData;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L272

Parameters

Parameter	Type
`name`	`string`
`sessionId?`	`string`

Returns

AxMemoryData

Implementation of

AxAIMemory.rewindToTag

updateResult()

updateResult(result: Readonly<AxChatResponseResult & object>, sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/memory.ts#L261

Parameters

Parameter	Type
`result`	`Readonly`<`AxChatResponseResult` & `object`>
`sessionId?`	`string`

Returns

void

Implementation of

AxAIMemory.updateResult

AxMockAIService

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L49

Implements

AxAIService

Constructors

Constructor

new AxMockAIService(config: AxMockAIServiceConfig): AxMockAIService;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L61

Parameters

Parameter	Type
`config`	`AxMockAIServiceConfig`

Returns

AxMockAIService

Methods

chat()

chat(req: Readonly<AxChatRequest<unknown>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<unknown, unknown>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L104

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

embed()

embed(req: Readonly<AxEmbedRequest>, _options?: Readonly<AxAIServiceActionOptions>): Promise<AxEmbedResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L147

Parameters

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

Returns

Promise<AxEmbedResponse>

Implementation of

getFeatures()

getFeatures(_model?: string): object;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L89

Parameters

Parameter	Type
`_model?`	`string`

Returns

object

Name	Type
`functions`	`boolean`
`streaming`	`boolean`

Implementation of

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L84

Returns

string

Implementation of

getLastUsedChatModel()

getLastUsedChatModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L64

Returns

unknown

Implementation of

getLastUsedEmbedModel()

getLastUsedEmbedModel(): unknown;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L67

Returns

unknown

Implementation of

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L70

Returns

undefined | AxModelConfig

Implementation of

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L190

Returns

Implementation of

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L100

Returns

Implementation of

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L96

Returns

undefined | AxAIModelList

Implementation of

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L80

Returns

string

Implementation of

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L186

Returns

Readonly<AxAIServiceOptions>

Implementation of

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mock/api.ts#L182

Parameters

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

Returns

void

Implementation of

AxMultiServiceRouter

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L25

Implements

AxAIService<string, string>

Constructors

Constructor

new AxMultiServiceRouter(services: (
  | AxAIService<string, string>
  | AxAIServiceListItem<string, string>)[]): AxMultiServiceRouter;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L44

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`<`string`, `string`> \| `AxAIServiceListItem`<`string`, `string`>)[]

Returns

AxMultiServiceRouter

Methods

chat()

chat(req: Readonly<AxChatRequest<string>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<string, string>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L122

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: Readonly<AxEmbedRequest<string>>, options?: Readonly<AxAIServiceActionOptions<string, string>>): Promise<AxEmbedResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L152

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

getFeatures()

getFeatures(model?: string): object;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L220

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

Name	Type
`functionCot?`	`boolean`
`functions`	`boolean`
`streaming`	`boolean`

Implementation of

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L183

Returns a composite ID built from the IDs of the underlying services.

Returns

string

Implementation of

getLastUsedChatModel()

getLastUsedChatModel(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L109

Returns

undefined | string

Implementation of

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L112

Returns

undefined | string

Implementation of

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L115

Returns

undefined | AxModelConfig

Implementation of

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L280

Returns the logger from the last used service, or falls back to the first service if none has been used.

Returns

Implementation of

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L239

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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L202

Aggregates all available models across the underlying services.

Returns

AxAIModelList

Implementation of

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L195

Returns the name of this router.

Returns

string

Implementation of

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L272

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: Readonly<AxAIServiceOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/multiservice.ts#L261

Sets options on all underlying services.

Parameters

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

Returns

void

Implementation of

AxTunable.setExamples

AxProgram

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L361

Type Parameters

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

Implements

AxTunable<IN, OUT>
AxUsable

Constructors

Constructor

new AxProgram<IN, OUT>(): AxProgram<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L374

Returns

AxProgram<IN, OUT>

Methods

forward()

forward(
   _ai: Readonly<AxAIService>, 
   _values: IN | AxMessage<IN>[], 
_options?: Readonly<AxProgramForwardOptions>): Promise<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L386

Parameters

Parameter	Type
`_ai`	`Readonly`<`AxAIService`>
`_values`	`IN` \| `AxMessage`<`IN`>[]
`_options?`	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT>

getTraces()

getTraces(): AxProgramTrace<IN, OUT>[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L435

Returns

AxProgramTrace<IN, OUT>[]

Implementation of

AxTunable.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L449

Returns

AxModelUsage & object[]

Implementation of

AxUsable.getUsage

register()

register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L379

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable`<`IN`, `OUT`> & `AxUsable`>

Returns

void

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L459

Returns

void

Implementation of

AxUsable.resetUsage

setDemos()

setDemos(demos: readonly AxProgramDemos<IN, OUT>[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L466

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<`IN`, `OUT`>[]

Returns

void

Implementation of

AxTunable.setDemos

setExamples()

setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L422

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`<`IN`, `OUT`>>
`options?`	`Readonly`<`AxSetExamplesOptions`>

Returns

void

Implementation of

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L409

Parameters

Parameter	Type
`id`	`string`

Returns

void

Implementation of

AxTunable.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L416

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Implementation of

AxTunable.setParentId

streamingForward()

streamingForward(
   _ai: Readonly<AxAIService>, 
   _values: IN | AxMessage<IN>[], 
_options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L398

Parameters

Parameter	Type
`_ai`	`Readonly`<`AxAIService`>
`_values`	`IN` \| `AxMessage`<`IN`>[]
`_options?`	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AxProgramWithSignature

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L177

Extended by

Type Parameters

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

Implements

AxTunable<IN, OUT>
AxUsable

Constructors

Constructor

new AxProgramWithSignature<IN, OUT>(signature: NonNullable<
  | undefined
  | Readonly<
  | string
  | AxSignatureConfig
| AxSignature>>, options?: Readonly<AxProgramWithSignatureOptions>): AxProgramWithSignature<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L192

Parameters

Parameter	Type
`signature`	`NonNullable`< \| `undefined` \| `Readonly`< \| `string` \| `AxSignatureConfig` \| `AxSignature`>>
`options?`	`Readonly`<`AxProgramWithSignatureOptions`>

Returns

AxProgramWithSignature<IN, OUT>

Methods

forward()

forward(
   _ai: Readonly<AxAIService>, 
   _values: IN | AxMessage<IN>[], 
_options?: Readonly<AxProgramForwardOptions>): Promise<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L221

Parameters

Parameter	Type
`_ai`	`Readonly`<`AxAIService`>
`_values`	`IN` \| `AxMessage`<`IN`>[]
`_options?`	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<OUT>

getSignature()

getSignature(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L210

Returns

AxTunable.setExamples

getTraces()

getTraces(): AxProgramTrace<IN, OUT>[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L307

Returns

AxProgramTrace<IN, OUT>[]

Implementation of

AxTunable.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L321

Returns

AxModelUsage & object[]

Implementation of

AxUsable.getUsage

register()

register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L214

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable`<`IN`, `OUT`> & `AxUsable`>

Returns

void

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L331

Returns

void

Implementation of

AxUsable.resetUsage

setDemos()

setDemos(demos: readonly AxProgramDemos<IN, OUT>[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L338

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<`IN`, `OUT`>[]

Returns

void

Implementation of

AxTunable.setDemos

setExamples()

setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L257

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`<`IN`, `OUT`>>
`options?`	`Readonly`<`AxSetExamplesOptions`>

Returns

void

Implementation of

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L244

Parameters

Parameter	Type
`id`	`string`

Returns

void

Implementation of

AxTunable.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L251

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Implementation of

AxTunable.setParentId

streamingForward()

streamingForward(
   _ai: Readonly<AxAIService>, 
   _values: IN | AxMessage<IN>[], 
_options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L233

Parameters

Parameter	Type
`_ai`	`Readonly`<`AxAIService`>
`_values`	`IN` \| `AxMessage`<`IN`>[]
`_options?`	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AxChainOfThought.constructor

AxRAG

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/rag.ts#L10

Extends

AxChainOfThought<{ context: string[]; question: string; }, { answer: string; }>

Constructors

Constructor

new AxRAG(queryFn: (query: string) => Promise<string>, options: Readonly<AxProgramForwardOptions & object>): AxRAG;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/rag.ts#L21

Parameters

Parameter	Type
`queryFn`	(`query`: `string`) => `Promise`<`string`>
`options`	`Readonly`<`AxProgramForwardOptions` & `object`>

Returns

AxRAG

Overrides

Methods

_forward1()

_forward1(
   ai: Readonly<AxAIService>, 
   values: 
  | {
  context: string[];
  question: string;
}
  | AxMessage<{
  context: string[];
  question: string;
}>[], 
   options: Readonly<AxProgramForwardOptions>): AxGenStreamingOut<{
  answer: string;
}>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L521

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	\| { `context`: `string`[]; `question`: `string`; } \| `AxMessage`<{ `context`: `string`[]; `question`: `string`; }>[]
`options`	`Readonly`<`AxProgramForwardOptions`>

Returns

AxGenStreamingOut<{ answer: string; }>

Inherited from

AxChainOfThought._forward1

addAssert()

addAssert(fn: (values: Record<string, unknown>) => undefined | boolean | Promise<undefined | boolean>, message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L154

Parameters

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

Returns

void

Inherited from

AxChainOfThought.addAssert

addFieldProcessor()

addFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L201

Parameters

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

Returns

void

Inherited from

AxChainOfThought.addFieldProcessor

addStreamingAssert()

addStreamingAssert(
   fieldName: string, 
   fn: (content: string, done?: boolean) => undefined | boolean, 
   message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L158

Parameters

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

Returns

void

Inherited from

AxChainOfThought.addStreamingAssert

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L194

Parameters

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

Returns

void

Inherited from

AxChainOfThought.addStreamingFieldProcessor

forward()

forward(
   ai: Readonly<AxAIService>, 
   values: 
  | {
  context: string[];
  question: string;
}
  | AxMessage<{
  context: string[];
  question: string;
}>[], 
   options?: Readonly<AxProgramForwardOptions>): Promise<{
  answer: string;
}>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/rag.ts#L42

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	\| { `context`: `string`[]; `question`: `string`; } \| `AxMessage`<{ `context`: `string`[]; `question`: `string`; }>[]
`options?`	`Readonly`<`AxProgramForwardOptions`>

Returns

Promise<{ answer: string; }>

Overrides

AxChainOfThought.forward

getSignature()

getSignature(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L210

Returns

AxChainOfThought.getSignature

Inherited from

getTraces()

getTraces(): AxProgramTrace<{
  context: string[];
  question: string;
}, {
  answer: string;
}>[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L307

Returns

AxProgramTrace<{ context: string[]; question: string; }, { answer: string; }>[]

Inherited from

AxChainOfThought.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L321

Returns

AxModelUsage & object[]

Inherited from

AxChainOfThought.getUsage

register()

register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L214

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable`<`IN`, `OUT`> & `AxUsable`>

Returns

void

Inherited from

AxChainOfThought.register

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L331

Returns

void

Inherited from

AxChainOfThought.resetUsage

setDemos()

setDemos(demos: readonly AxProgramDemos<{
  context: string[];
  question: string;
}, {
  answer: string;
}>[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L338

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<{ `context`: `string`[]; `question`: `string`; }, { `answer`: `string`; }>[]

Returns

void

Inherited from

AxChainOfThought.setDemos

setExamples()

setExamples(examples: Readonly<AxProgramExamples<{
  context: string[];
  question: string;
}, {
  answer: string;
}>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L695

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`<{ `context`: `string`[]; `question`: `string`; }, { `answer`: `string`; }>>
`options?`	`Readonly`<`AxSetExamplesOptions`>

Returns

void

Inherited from

AxChainOfThought.setExamples

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L244

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxChainOfThought.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/program.ts#L251

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Inherited from

AxChainOfThought.setParentId

streamingForward()

streamingForward(
   ai: Readonly<AxAIService>, 
   values: 
  | {
  context: string[];
  question: string;
}
  | AxMessage<{
  context: string[];
  question: string;
}>[], 
   options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<{
  answer: string;
}>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/generate.ts#L640

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	\| { `context`: `string`[]; `question`: `string`; } \| `AxMessage`<{ `context`: `string`[]; `question`: `string`; }>[]
`options?`	`Readonly`<`AxProgramStreamingForwardOptions`>

Returns

AxGenStreamingOut<{ answer: string; }>

Inherited from

AxChainOfThought.streamingForward

AxPromptTemplate

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/prompt.ts#L42

Constructors

Constructor

new AxPromptTemplate(
   sig: Readonly<AxSignature>, 
   options?: Readonly<AxPromptTemplateOptions>, 
   fieldTemplates?: Record<string, AxFieldTemplateFn>): AxPromptTemplate;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/prompt.ts#L49

Parameters

Parameter	Type
`sig`	`Readonly`<`AxSignature`>
`options?`	`Readonly`<`AxPromptTemplateOptions`>
`fieldTemplates?`	`Record`<`string`, `AxFieldTemplateFn`>

Returns

AxPromptTemplate

Methods

render()

render<T>(values: T | readonly AxMessage<T>[], __namedParameters: Readonly<{
  demos?: Record<string, AxFieldValue>[];
  examples?: Record<string, AxFieldValue>[];
  skipSystemPrompt?: boolean;
}>): (
  | {
  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";
})[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/prompt.ts#L122

Type Parameters

Type Parameter
`T` extends `AxGenIn`

Parameters

Parameter	Type
`values`	`T` \| readonly `AxMessage`<`T`>[]
`__namedParameters`	`Readonly`<{ `demos?`: `Record`<`string`, `AxFieldValue`>[]; `examples?`: `Record`<`string`, `AxFieldValue`>[]; `skipSystemPrompt?`: `boolean`; }>

Returns

renderExtraFields()

renderExtraFields(extraFields: readonly AxIField[]): (
  | {
  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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/prompt.ts#L231

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

AxRateLimiterTokenUsage

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/rate-limit.ts#L9

Constructors

Constructor

new AxRateLimiterTokenUsage(
   maxTokens: number, 
   refillRate: number, 
   options?: Readonly<AxRateLimiterTokenUsageOptions>): AxRateLimiterTokenUsage;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/rate-limit.ts#L16

Parameters

Parameter	Type
`maxTokens`	`number`
`refillRate`	`number`
`options?`	`Readonly`<`AxRateLimiterTokenUsageOptions`>

Returns

AxRateLimiterTokenUsage

Methods

acquire()

acquire(tokens: number): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/rate-limit.ts#L56

Parameters

Parameter	Type
`tokens`	`number`

Returns

Promise<void>

AxSignature

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L55

Constructors

Constructor

new AxSignature(signature?: Readonly<
  | string
  | AxSignatureConfig
  | AxSignature>): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L66

Parameters

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

Returns

AxSignature

Methods

addInputField()

addInputField(field: Readonly<AxField>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L214

Parameters

Parameter	Type
`field`	`Readonly`<`AxField`>

Returns

void

addOutputField()

addOutputField(field: Readonly<AxField>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L255

Parameters

Parameter	Type
`field`	`Readonly`<`AxField`>

Returns

void

getDescription()

getDescription(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L354

Returns

undefined | string

getInputFields()

getInputFields(): readonly AxIField[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L352

Returns

readonly AxIField[]

getOutputFields()

getOutputFields(): readonly AxIField[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L353

Returns

readonly AxIField[]

hash()

hash(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L541

Returns

string

setDescription()

setDescription(desc: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L201

Parameters

Parameter	Type
`desc`	`string`

Returns

void

setInputFields()

setInputFields(fields: readonly AxField[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L296

Parameters

Parameter	Type
`fields`	readonly `AxField`[]

Returns

void

setOutputFields()

setOutputFields(fields: readonly AxField[]): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L324

Parameters

Parameter	Type
`fields`	readonly `AxField`[]

Returns

void

toJSON()

toJSON(): object;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L545

Returns

object

Name	Type
`description`	`undefined` \| `string`
`id`	`string`
`inputFields`	`AxIField`[]
`outputFields`	`AxIField`[]

toJSONSchema()

toJSONSchema(): AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L366

Returns

AxFunctionJSONSchema

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L543

Returns

string

validate()

validate(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L520

Returns

boolean

AxSimpleClassifier

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L30

Constructors

Constructor

new AxSimpleClassifier(ai: AxAIService): AxSimpleClassifier;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L36

Parameters

Parameter	Type
`ai`	`AxAIService`

Returns

AxSimpleClassifier

Methods

forward()

forward(text: string, options?: Readonly<AxSimpleClassifierForwardOptions>): Promise<string>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L68

Parameters

Parameter	Type
`text`	`string`
`options?`	`Readonly`<`AxSimpleClassifierForwardOptions`>

Returns

Promise<string>

getState()

getState(): undefined | AxDBState;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L41

Returns

undefined | AxDBState

setClasses()

setClasses(classes: readonly AxSimpleClassifierClass[], options?: Readonly<{
  abortSignal?: AbortSignal;
}>): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L49

Parameters

Parameter	Type
`classes`	readonly `AxSimpleClassifierClass`[]
`options?`	`Readonly`<{ `abortSignal?`: `AbortSignal`; }>

Returns

Promise<void>

setOptions()

setOptions(options: Readonly<{
  debug?: boolean;
}>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L108

Parameters

Parameter	Type
`options`	`Readonly`<{ `debug?`: `boolean`; }>

Returns

void

setState()

setState(state: AxDBState): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L45

Parameters

Parameter	Type
`state`	`AxDBState`

Returns

void

AxTestPrompt

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/evaluate.ts#L14

Type Parameters

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

Constructors

Constructor

new AxTestPrompt<IN, OUT>(__namedParameters: Readonly<AxEvaluateArgs<IN, OUT>>): AxTestPrompt<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/evaluate.ts#L22

Parameters

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

Returns

AxTestPrompt<IN, OUT>

Methods

run()

run(metricFn: AxMetricFn): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/evaluate.ts#L35

Parameters

Parameter	Type
`metricFn`	`AxMetricFn`

Returns

Promise<void>

AxSimpleClassifierClass

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L12

Constructors

Constructor

new AxSimpleClassifierClass(name: string, context: readonly string[]): AxSimpleClassifierClass;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L16

Parameters

Parameter	Type
`name`	`string`
`context`	readonly `string`[]

Returns

AxSimpleClassifierClass

Methods

getContext()

getContext(): readonly string[];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L25

Returns

readonly string[]

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/classifier.ts#L21

Returns

string

AxAIAnthropicModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L3

Enumeration Members

Enumeration Member	Value
`Claude21`	`"claude-2.1"`
`Claude35Haiku`	`"claude-3-5-haiku-latest"`
`Claude35Sonnet`	`"claude-3-5-sonnet-latest"`
`Claude37Sonnet`	`"claude-3-7-sonnet-latest"`
`Claude3Haiku`	`"claude-3-haiku-20240307"`
`Claude3Opus`	`"claude-3-opus-latest"`
`Claude3Sonnet`	`"claude-3-sonnet-20240229"`
`Claude4Opus`	`"claude-opus-4-20250514"`
`Claude4Sonnet`	`"claude-sonnet-4-20250514"`
`ClaudeInstant12`	`"claude-instant-1.2"`

AxAIAnthropicVertexModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L19

Enumeration Members

Enumeration Member	Value
`Claude35Haiku`	`"claude-3-5-haiku"`
`Claude35Sonnet`	`"claude-3-5-sonnet"`
`Claude35SonnetV2`	`"claude-3-5-sonnet-v2"`
`Claude37Sonnet`	`"claude-3-7-sonnet"`
`Claude3Haiku`	`"claude-3-haiku"`
`Claude3Opus`	`"claude-3-opus"`

AxAICohereModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/cohere/types.ts#L6

Cohere: Models for text generation

Enumeration Members

Enumeration Member	Value
`Command`	`"command"`
`CommandLight`	`"command-light"`
`CommandR`	`"command-r"`
`CommandRPlus`	`"command-r-plus"`

AxAIDeepSeekModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/deepseek/types.ts#L4

DeepSeek: Models for text generation

Enumeration Members

Enumeration Member	Value
`DeepSeekChat`	`"deepseek-chat"`
`DeepSeekCoder`	`"deepseek-coder"`
`DeepSeekReasoner`	`"deepseek-reasoner"`

AxAICohereEmbedModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/cohere/types.ts#L16

Cohere: Models for use in embeddings

Enumeration Members

Enumeration Member	Value
`EmbedEnglishLightV30`	`"embed-english-light-v3.0"`
`EmbedEnglishV30`	`"embed-english-v3.0"`
`EmbedMultiLingualLightV30`	`"embed-multilingual-light-v3.0"`
`EmbedMultiLingualV30`	`"embed-multilingual-v3.0"`

AxAIGoogleGeminiEmbedModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/types.ts#L16

Enumeration Members

Enumeration Member	Value
`GeminiEmbedding`	`"gemini-embedding-exp"`
`TextEmbedding004`	`"text-embedding-004"`
`TextEmbedding005`	`"text-embedding-005"`
`TextEmbeddingLarge`	`"text-embedding-large-exp-03-07"`

AxAIGoogleGeminiEmbedTypes

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/types.ts#L38

Enumeration Members

Enumeration Member	Value
`Classification`	`"CLASSIFICATION"`
`Clustering`	`"CLUSTERING"`
`CodeRetrievalQuery`	`"CODE_RETRIEVAL_QUERY"`
`FactVerification`	`"FACT_VERIFICATION"`
`QuestionAnswering`	`"QUESTION_ANSWERING"`
`RetrievalDocument`	`"RETRIEVAL_DOCUMENT"`
`RetrievalQuery`	`"RETRIEVAL_QUERY"`
`SemanticSimilarity`	`"SEMANTIC_SIMILARITY"`

AxAIGoogleGeminiSafetyCategory

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/types.ts#L23

Enumeration Members

Enumeration Member	Value
`HarmCategoryDangerousContent`	`"HARM_CATEGORY_DANGEROUS_CONTENT"`
`HarmCategoryHarassment`	`"HARM_CATEGORY_HARASSMENT"`
`HarmCategoryHateSpeech`	`"HARM_CATEGORY_HATE_SPEECH"`
`HarmCategorySexuallyExplicit`	`"HARM_CATEGORY_SEXUALLY_EXPLICIT"`

AxAIGoogleGeminiModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/types.ts#L3

Enumeration Members

Enumeration Member	Value
`Gemini15Flash`	`"gemini-1.5-flash"`
`Gemini15Flash002`	`"gemini-1.5-flash-002"`
`Gemini15Flash8B`	`"gemini-1.5-flash-8b"`
`Gemini15Pro`	`"gemini-1.5-pro"`
`Gemini1Pro`	`"gemini-1.0-pro"`
`Gemini20Flash`	`"gemini-2.0-flash"`
`Gemini20FlashLite`	`"gemini-2.0-flash-lite-preview-02-05"`
`Gemini25Flash`	`"gemini-2.5-flash"`
`Gemini25FlashLite`	`"gemini-2.5-flash-lite-preview-06-17"`
`Gemini25Pro`	`"gemini-2.5-pro"`

AxAIGoogleGeminiSafetyThreshold

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/types.ts#L30

Enumeration Members

Enumeration Member	Value
`BlockDefault`	`"HARM_BLOCK_THRESHOLD_UNSPECIFIED"`
`BlockLowAndAbove`	`"BLOCK_LOW_AND_ABOVE"`
`BlockMediumAndAbove`	`"BLOCK_MEDIUM_AND_ABOVE"`
`BlockNone`	`"BLOCK_NONE"`
`BlockOnlyHigh`	`"BLOCK_ONLY_HIGH"`

AxAIGrokEmbedModels

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/x-grok/types.ts#L10

Enumeration Members

Enumeration Member	Value
`GrokEmbedSmall`	`"grok-embed-small"`

AxAIGrokModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/x-grok/types.ts#L3

Enumeration Members

Enumeration Member	Value
`Grok3`	`"grok-3"`
`Grok3Fast`	`"grok-3-fast"`
`Grok3Mini`	`"grok-3-mini"`
`Grok3MiniFast`	`"grok-3-mini-fast"`

AxAIGroqModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/groq/types.ts#L1

Enumeration Members

Enumeration Member	Value
`Gemma2_9B`	`"gemma2-9b-it"`
`Llama3_8B`	`"llama3-8b-8192"`
`Llama33_70B`	`"llama-3.3-70b-versatile"`
`Mixtral_8x7B`	`"mixtral-8x7b-32768"`

AxAIMistralEmbedModels

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mistral/types.ts#L14

Enumeration Members

Enumeration Member	Value
`MistralEmbed`	`"mistral-embed"`

AxAIHuggingFaceModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/huggingface/types.ts#L3

Enumeration Members

Enumeration Member	Value
`MetaLlama270BChatHF`	`"meta-llama/Llama-2-70b-chat-hf"`

AxAIMistralModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mistral/types.ts#L3

Enumeration Members

Enumeration Member	Value
`Codestral`	`"codestral-latest"`
`Mistral7B`	`"open-mistral-7b"`
`Mistral8x7B`	`"open-mixtral-8x7b"`
`MistralLarge`	`"mistral-large-latest"`
`MistralNemo`	`"mistral-nemo-latest"`
`MistralSmall`	`"mistral-small-latest"`
`OpenCodestralMamba`	`"open-codestral-mamba"`
`OpenMistralNemo`	`"open-mistral-nemo-latest"`

AxAIOpenAIEmbedModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/chat_types.ts#L20

Enumeration Members

Enumeration Member	Value
`TextEmbedding3Large`	`"text-embedding-3-large"`
`TextEmbedding3Small`	`"text-embedding-3-small"`
`TextEmbeddingAda002`	`"text-embedding-ada-002"`

AxAIOpenAIModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/chat_types.ts#L3

Enumeration Members

Enumeration Member	Value
`GPT35TextDavinci002`	`"text-davinci-002"`
`GPT35Turbo`	`"gpt-3.5-turbo"`
`GPT35TurboInstruct`	`"gpt-3.5-turbo-instruct"`
`GPT3TextAda001`	`"text-ada-001"`
`GPT3TextBabbage002`	`"text-babbage-002"`
`GPT4`	`"gpt-4"`
`GPT41`	`"gpt-4.1"`
`GPT41Mini`	`"gpt-4.1-mini"`
`GPT4ChatGPT4O`	`"chatgpt-4o-latest"`
`GPT4O`	`"gpt-4o"`
`GPT4OMini`	`"gpt-4o-mini"`
`GPT4Turbo`	`"gpt-4-turbo"`
`O1`	`"o1"`
`O1Mini`	`"o1-mini"`

AxJSInterpreterPermission

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/code.ts#L11

Enumeration Members

Enumeration Member	Value
`CRYPTO`	`"crypto"`
`FS`	`"node:fs"`
`NET`	`"net"`
`OS`	`"os"`
`PROCESS`	`"process"`

AxAIRekaModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/reka/types.ts#L3

Enumeration Members

Enumeration Member	Value
`RekaCore`	`"reka-core"`
`RekaEdge`	`"reka-edge"`
`RekaFlash`	`"reka-flash"`

AxAIOpenAIResponsesModel

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L8

Enumeration Members

Enumeration Member	Value
`GPT35TextDavinci002`	`"text-davinci-002"`
`GPT35Turbo`	`"gpt-3.5-turbo"`
`GPT35TurboInstruct`	`"gpt-3.5-turbo-instruct"`
`GPT3TextAda001`	`"text-ada-001"`
`GPT3TextBabbage002`	`"text-babbage-002"`
`GPT4`	`"gpt-4"`
`GPT41`	`"gpt-4.1"`
`GPT41Mini`	`"gpt-4.1-mini"`
`GPT4ChatGPT4O`	`"chatgpt-4o-latest"`
`GPT4O`	`"gpt-4o"`
`GPT4OMini`	`"gpt-4o-mini"`
`GPT4Turbo`	`"gpt-4-turbo"`
`O1`	`"o1"`
`O1Mini`	`"o1-mini"`
`O3`	`"o3"`
`O3Mini`	`"o3-mini"`
`O4Mini`	`"o4-mini"`

AxSpanKindValues

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/trace/trace.ts#L61

Enumeration Members

Enumeration Member	Value
`AGENT`	`"agent"`
`TASK`	`"task"`
`TOOL`	`"tool"`
`UNKNOWN`	`"unknown"`
`WORKFLOW`	`"workflow"`

AxLLMRequestTypeValues

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/trace/trace.ts#L54

Enumeration Members

Enumeration Member	Value
`CHAT`	`"chat"`
`COMPLETION`	`"completion"`
`RERANK`	`"rerank"`
`UNKNOWN`	`"unknown"`

ax

function ax<IN, OUT>(strings: TemplateStringsArray, ...values: readonly AxSignatureTemplateValue[]): AxGen<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/template.ts#L95

Type Parameters

Type Parameter	Default type
`IN` extends `AxGenIn`	`AxGenIn`
`OUT` extends `AxGenerateResult`<`AxGenOut`>	`AxGenerateResult`<`AxGenOut`>

Parameters

Parameter	Type
`strings`	`TemplateStringsArray`
…`values`	readonly `AxSignatureTemplateValue`[]

Returns

AxGen<IN, OUT>

axAIAnthropicDefaultConfig

function axAIAnthropicDefaultConfig(): AxAIAnthropicConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/api.ts#L37

Returns

AxAIAnthropicConfig

axAIAnthropicVertexDefaultConfig

function axAIAnthropicVertexDefaultConfig(): AxAIAnthropicConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/api.ts#L51

Returns

AxAIAnthropicConfig

axAICohereCreativeConfig

function axAICohereCreativeConfig(): AxAICohereConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/cohere/api.ts#L40

Returns

AxAICohereConfig

axAICohereDefaultConfig

function axAICohereDefaultConfig(): AxAICohereConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/cohere/api.ts#L33

Returns

AxAICohereConfig

axAIDeepSeekCodeConfig

function axAIDeepSeekCodeConfig(): DeepSeekConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/deepseek/api.ts#L19

Returns

DeepSeekConfig

axAIDeepSeekDefaultConfig

function axAIDeepSeekDefaultConfig(): DeepSeekConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/deepseek/api.ts#L13

Returns

DeepSeekConfig

axAIGoogleGeminiDefaultConfig

function axAIGoogleGeminiDefaultConfig(): AxAIGoogleGeminiConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/api.ts#L68

AxAIGoogleGemini: Default Model options for text generation

Returns

AxAIGoogleGeminiConfig

axAIGoogleGeminiDefaultCreativeConfig

function axAIGoogleGeminiDefaultCreativeConfig(): AxAIGoogleGeminiConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/api.ts#L84

Returns

AxAIGoogleGeminiConfig

axAIGrokBestConfig

function axAIGrokBestConfig(): AxAIOpenAIConfig<AxAIGrokModel, GrokEmbedSmall>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/x-grok/api.ts#L23

Returns

AxAIOpenAIConfig<AxAIGrokModel, GrokEmbedSmall>

axAIGrokDefaultConfig

function axAIGrokDefaultConfig(): AxAIOpenAIConfig<AxAIGrokModel, GrokEmbedSmall>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/x-grok/api.ts#L14

Returns

AxAIOpenAIConfig<AxAIGrokModel, GrokEmbedSmall>

axAIHuggingFaceCreativeConfig

function axAIHuggingFaceCreativeConfig(): AxAIHuggingFaceConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/huggingface/api.ts#L32

Returns

AxAIHuggingFaceConfig

axAIHuggingFaceDefaultConfig

function axAIHuggingFaceDefaultConfig(): AxAIHuggingFaceConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/huggingface/api.ts#L26

Returns

AxAIHuggingFaceConfig

axAIMistralBestConfig

function axAIMistralBestConfig(): AxAIMistralConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mistral/api.ts#L24

Returns

AxAIMistralConfig

axAIMistralDefaultConfig

function axAIMistralDefaultConfig(): AxAIMistralConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/mistral/api.ts#L17

Returns

AxAIMistralConfig

axAIOllamaDefaultConfig

function axAIOllamaDefaultConfig(): AxAIOllamaAIConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/ollama/api.ts#L10

Returns

AxAIOllamaAIConfig

axAIOllamaDefaultCreativeConfig

function axAIOllamaDefaultCreativeConfig(): AxAIOllamaAIConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/ollama/api.ts#L17

Returns

AxAIOllamaAIConfig

axAIOpenAIBestConfig

function axAIOpenAIBestConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L48

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

axAIOpenAICreativeConfig

function axAIOpenAICreativeConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L57

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

axAIOpenAIDefaultConfig

function axAIOpenAIDefaultConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L38

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

axAIOpenAIFastConfig

function axAIOpenAIFastConfig(): AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L67

Returns

AxAIOpenAIConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>

axAIOpenAIResponsesBestConfig

function axAIOpenAIResponsesBestConfig(): AxAIOpenAIResponsesConfig<AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api_base.ts#L39

Returns

AxAIOpenAIResponsesConfig<AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel>

axAIOpenAIResponsesCreativeConfig

function axAIOpenAIResponsesCreativeConfig(): AxAIOpenAIResponsesConfig<AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api_base.ts#L48

Returns

AxAIOpenAIResponsesConfig<AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel>

axAIOpenAIResponsesDefaultConfig

function axAIOpenAIResponsesDefaultConfig(): AxAIOpenAIResponsesConfig<AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api_base.ts#L27

Returns

AxAIOpenAIResponsesConfig<AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel>

axAIRekaCreativeConfig

function axAIRekaCreativeConfig(): AxAIRekaConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/reka/api.ts#L42

Returns

axAIRekaBestConfig

function axAIRekaBestConfig(): AxAIRekaConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/reka/api.ts#L36

Returns

axAIRekaDefaultConfig

function axAIRekaDefaultConfig(): AxAIRekaConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/reka/api.ts#L30

Returns

axAITogetherDefaultConfig

function axAITogetherDefaultConfig(): TogetherAIConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/together/api.ts#L9

Returns

TogetherAIConfig

axAIRekaFastConfig

function axAIRekaFastConfig(): AxAIRekaConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/reka/api.ts#L48

Returns

axBaseAIDefaultCreativeConfig

function axBaseAIDefaultCreativeConfig(): AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L56

Returns

AxModelConfig

axBaseAIDefaultConfig

function axBaseAIDefaultConfig(): AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L49

Returns

AxModelConfig

axCreateDefaultTextLogger

function axCreateDefaultTextLogger(output: (message: string) => void): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/loggers.ts#L67

Parameters

Parameter	Type	Default value
`output`	(`message`: `string`) => `void`	`defaultOutput`

Returns

axCreateDefaultLogger

function axCreateDefaultLogger(output: (message: string) => void): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/loggers.ts#L12

Parameters

Parameter	Type	Default value
`output`	(`message`: `string`) => `void`	`defaultOutput`

Returns

axCreateOptimizerLogger

function axCreateOptimizerLogger(output: (message: string) => void): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/loggers.ts#L103

Factory function to create an enhanced optimizer logger with clean visual formatting that works for all optimizer types using semantic tags for proper categorization

Parameters

Parameter	Type
`output`	(`message`: `string`) => `void`

Returns

axValidateChatRequestMessage

function axValidateChatRequestMessage(item: 
  | {
  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";
}): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/validate.ts#L10

Validates a chat request message item to ensure it meets the required criteria

Parameters

Parameter	Type	Description
`item`	\| { `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"`; }	The chat request message to validate

Returns

void

Throws

When validation fails with a descriptive error message

s

function s(strings: TemplateStringsArray, ...values: readonly AxSignatureTemplateValue[]): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/template.ts#L44

Parameters

Parameter	Type
`strings`	`TemplateStringsArray`
…`values`	readonly `AxSignatureTemplateValue`[]

Returns

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L195

AxAIAnthropicArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/api.ts#L65

Properties

Property	Type
`apiKey?`	`string`
`config?`	`Readonly`<`Partial`<`AxAIAnthropicConfig`>>
`models?`	`AxAIInputModelList`< \| `AxAIAnthropicModel` \| `AxAIAnthropicVertexModel`, `undefined`>
`name`	`"anthropic"`
`options?`	`Readonly`<`AxAIServiceOptions`>
`projectId?`	`string`
`region?`	`string`

axValidateChatResponseResult

function axValidateChatResponseResult(results: 
  | readonly AxChatResponseResult[]
  | Readonly<AxChatResponseResult>): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/validate.ts#L190

Validates a chat response result to ensure it meets the required criteria

Parameters

Parameter	Type	Description
`results`	\| readonly `AxChatResponseResult`[] \| `Readonly`<`AxChatResponseResult`>	The chat response results to validate (single result or array)

Returns

void

Throws

When validation fails with a descriptive error message

AxAIAnthropicContentBlockStartEvent

Properties

Property	Type
`content_block`	\| { `text`: `string`; `type`: `"text"`; } \| { `id`: `string`; `input`: `object`; `name`: `string`; `type`: `"tool_use"`; } \| { `thinking`: `string`; `type`: `"thinking"`; }
`index`	`number`
`type`	`"content_block_start"`

AxAIAnthropicContentBlockDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L216

Properties

Property	Type
`delta`	\| { `text`: `string`; `type`: `"text_delta"`; } \| { `partial_json`: `string`; `type`: `"input_json_delta"`; } \| { `thinking`: `string`; `type`: `"thinking_delta"`; } \| { `signature`: `string`; `type`: `"signature_delta"`; }
`index`	`number`
`type`	`"content_block_delta"`

AxAIAnthropicContentBlockStopEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L239

Properties

Property	Type
`index`	`number`
`type`	`"content_block_stop"`

AxAIAnthropicErrorEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L267

Properties

Property	Type
`error`	`object`
`error.message`	`string`
`error.type`	`"overloaded_error"`
`type`	`"error"`

AxAIAnthropicMessageDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L245

Properties

Property	Type
`delta`	`object`
`delta.stop_reason`	`null` \| `"end_turn"` \| `"max_tokens"` \| `"stop_sequence"`
`delta.stop_sequence`	`null` \| `string`
`type`	`"message_delta"`
`usage`	`object`
`usage.output_tokens`	`number`

AxAIAnthropicMessageStartEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L177

Properties

Property	Type
`message`	`object`
`message.content`	[]
`message.id`	`string`
`message.model`	`string`
`message.role`	`"assistant"`
`message.stop_reason`	`null` \| `string`
`message.stop_sequence`	`null` \| `string`
`message.type`	`"message"`
`message.usage`	`object`
`message.usage.input_tokens`	`number`
`message.usage.output_tokens`	`number`
`type`	`"message_start"`

AxAIAnthropicMessageStopEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L257

Properties

Property	Type
`type`	`"message_stop"`

AxAIAnthropicPingEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/anthropic/types.ts#L262

Properties

Property	Type
`type`	`"ping"`

AxAICohereArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/cohere/api.ts#L47

Properties

Property	Type
`apiKey`	`string`
`config?`	`Readonly`<`Partial`<`AxAICohereConfig`>>
`models?`	`AxAIInputModelList`<`AxAICohereModel`, `AxAICohereEmbedModel`>
`name`	`"cohere"`
`options?`	`Readonly`<`AxAIServiceOptions`>

AxAIFeatures

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L30

Properties

Property	Type
`functionCot?`	`boolean`
`functions`	`boolean`
`hasShowThoughts?`	`boolean`
`hasThinkingBudget?`	`boolean`
`streaming`	`boolean`

AxAIGoogleGeminiArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/api.ts#L109

Properties

Property	Type
`apiKey?`	`string`
`config?`	`Readonly`<`Partial`<`AxAIGoogleGeminiConfig`>>
`endpointId?`	`string`
`modelInfo?`	`AxModelInfo`[]
`models?`	`AxAIInputModelList`<`AxAIGoogleGeminiModel`, `AxAIGoogleGeminiEmbedModel`>
`name`	`"google-gemini"`
`options?`	`Readonly`<`AxAIServiceOptions` & `AxAIGoogleGeminiOptionsTools`>
`projectId?`	`string`
`region?`	`string`

AxAIGoogleGeminiOptionsTools

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/google-gemini/api.ts#L99

Properties

Property	Type
`codeExecution?`	`boolean`
`googleSearch?`	`boolean`
`googleSearchRetrieval?`	`object`
`googleSearchRetrieval.dynamicThreshold?`	`number`
`googleSearchRetrieval.mode?`	`"MODE_DYNAMIC"`
`urlContext?`	`boolean`

AxAIGrokOptionsTools

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/x-grok/api.ts#L42

Properties

Property	Type
`searchParameters?`	`object`
`searchParameters.fromDate?`	`string`
`searchParameters.maxSearchResults?`	`number`
`searchParameters.mode?`	`"auto"` \| `"on"` \| `"off"`
`searchParameters.returnCitations?`	`boolean`
`searchParameters.sources?`	`AxAIGrokSearchSource`[]
`searchParameters.toDate?`	`string`

AxAIGrokSearchSource

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/x-grok/api.ts#L32

Properties

Property	Type
`allowedWebsites?`	`string`[]
`country?`	`string`
`excludedWebsites?`	`string`[]
`links?`	`string`[]
`safeSearch?`	`boolean`
`type`	`"web"` \| `"x"` \| `"news"` \| `"rss"`
`xHandles?`	`string`[]

AxAIHuggingFaceArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/huggingface/api.ts#L38

Properties

Property	Type
`apiKey`	`string`
`config?`	`Readonly`<`Partial`<`AxAIHuggingFaceConfig`>>
`models?`	`AxAIInputModelList`<`MetaLlama270BChatHF`, `undefined`>
`name`	`"huggingface"`
`options?`	`Readonly`<`AxAIServiceOptions`>

AxAIMemory

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L17

Methods

addFunctionResults()

addFunctionResults(results: readonly AxFunctionResult[], sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L30

Parameters

Parameter	Type
`results`	readonly `AxFunctionResult`[]
`sessionId?`	`string`

Returns

void

addRequest()

addRequest(result: (
  | {
  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): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L18

Parameters

Parameter Type

result ( | { 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

addResponse()

addResponse(results: readonly AxChatResponseResult[], sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L20

Parameters

Parameter	Type
`results`	readonly `AxChatResponseResult`[]
`sessionId?`	`string`

Returns

void

addTag()

addTag(name: string, sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L40

Parameters

Parameter	Type
`name`	`string`
`sessionId?`	`string`

Returns

void

getLast()

getLast(sessionId?: string): 
  | undefined
  | {
  chat: object[];
  role: "function" | "system" | "user" | "assistant";
  tags?: string[];
  updatable?: boolean;
};

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L38

Parameters

Parameter	Type
`sessionId?`	`string`

Returns

| undefined | { chat: object[]; role: "function" | "system" | "user" | "assistant"; tags?: string[]; updatable?: boolean; }

history()

history(index: number, sessionId?: string): (
  | {
  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/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L35

Parameters

Parameter	Type
`index`	`number`
`sessionId?`	`string`

Returns

reset()

reset(sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L36

Parameters

Parameter	Type
`sessionId?`	`string`

Returns

void

rewindToTag()

rewindToTag(name: string, sessionId?: string): AxMemoryData;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L41

Parameters

Parameter	Type
`name`	`string`
`sessionId?`	`string`

Returns

AxMemoryData

updateResult()

updateResult(results: Readonly<AxChatResponseResult> & object, sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mem/types.ts#L25

Parameters

Parameter	Type
`results`	`Readonly`<`AxChatResponseResult`> & `object`
`sessionId?`	`string`

Returns

void

AxAIOpenAIBaseArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L94

Type Parameters

Type Parameter
`TModel`
`TEmbedModel`
`TChatReq` extends `AxAIOpenAIChatRequest`<`TModel`>

Properties

Property	Type
`apiKey`	`string`
`apiURL?`	`string`
`chatReqUpdater?`	`ChatReqUpdater`<`TModel`, `TChatReq`>
`config`	`Readonly`<`AxAIOpenAIConfig`<`TModel`, `TEmbedModel`>>
`modelInfo`	readonly `AxModelInfo`[]
`models?`	`AxAIInputModelList`<`TModel`, `TEmbedModel`>
`options?`	`Readonly`<`AxAIServiceOptions` & `object`>
`supportFor`	\| `AxAIFeatures` \| (`model`: `TModel`) => `AxAIFeatures`

AxAIOpenAIArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/api.ts#L75

Extends

Omit<AxAIOpenAIBaseArgs<TModel, TEmbedModel, TChatReq>, "config" | "supportFor" | "modelInfo">

Type Parameters

Type Parameter	Default type
`TName`	`"openai"`
`TModel`	`AxAIOpenAIModel`
`TEmbedModel`	`AxAIOpenAIEmbedModel`
`TChatReq` extends `AxAIOpenAIChatRequest`<`TModel`>	`AxAIOpenAIChatRequest`<`TModel`>

Properties

Property	Type	Inherited from
`apiKey`	`string`	`Omit.apiKey`
`apiURL?`	`string`	`Omit.apiURL`
`chatReqUpdater?`	`ChatReqUpdater`<`TModel`, `TChatReq`>	`Omit.chatReqUpdater`
`config?`	`Partial`<`Readonly`<`AxAIOpenAIConfig`<`TModel`, `TEmbedModel`>>>	-
`modelInfo?`	`AxModelInfo`[]	-
`models?`	`AxAIInputModelList`<`TModel`, `TEmbedModel`>	`Omit.models`
`name`	`TName`	-
`options?`	`Readonly`<`AxAIServiceOptions` & `object`>	`Omit.options`

AxAIOpenAIResponseDelta

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/chat_types.ts#L83

Type Parameters

Type Parameter
`T`

Properties

Property	Type
`choices`	`object`[]
`created`	`number`
`id`	`string`
`model`	`string`
`object`	`string`
`system_fingerprint`	`string`
`usage?`	`AxAIOpenAIUsage`

AxAIOpenAIResponsesArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_api_base.ts#L141

Ready-to-use implementation of the OpenAI Responses API client This class uses OpenAI’s /v1/responses API endpoint which supports text, image, and audio inputs

Extends

Omit<AxAIOpenAIResponsesBaseArgs<TModel, TEmbedModel, TChatReq>, "config" | "supportFor" | "modelInfo">

Type Parameters

Type Parameter	Default type
`TName`	`"openai-responses"`
`TModel`	`AxAIOpenAIResponsesModel`
`TEmbedModel`	`AxAIOpenAIEmbedModel`
`TChatReq` extends `AxAIOpenAIResponsesRequest`<`TModel`>	`AxAIOpenAIResponsesRequest`<`TModel`>

Properties

Property	Type	Inherited from
`apiKey`	`string`	`Omit.apiKey`
`apiURL?`	`string`	`Omit.apiURL`
`config?`	`Partial`<`AxAIOpenAIResponsesConfig`<`TModel`, `TEmbedModel`>>	-
`modelInfo?`	`AxModelInfo`[]	-
`models?`	`AxAIInputModelList`<`TModel`, `TEmbedModel`>	`Omit.models`
`name`	`TName`	-
`options?`	`object` & `AxAIServiceOptions`	`Omit.options`
`responsesReqUpdater?`	(`req`: `Readonly`<`TResponsesReq`>) => `Readonly`<`TResponsesReq`>	`Omit.responsesReqUpdater`

AxAIOpenAIResponsesCodeInterpreterToolCall

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L781

Extends

AxAIOpenAIResponsesToolCallBase

Properties

Property	Type	Overrides	Inherited from
`code`	`string`	-	-
`id`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`id`
`results?`	`unknown`[]	-	-
`status?`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`status`
`type`	`"code_interpreter_call"`	`AxAIOpenAIResponsesToolCallBase`.`type`	-

AxAIOpenAIResponsesComputerToolCall

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L775

Extends

AxAIOpenAIResponsesToolCallBase

Properties

Property	Type	Overrides	Inherited from
`action`	`object`	-	-
`id`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`id`
`status?`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`status`
`type`	`"computer_call"`	`AxAIOpenAIResponsesToolCallBase`.`type`	-

AxAIOpenAIResponsesContentPartAddedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L341

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`content_index`	`readonly`	`number`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`part`	`readonly`	`Readonly`< \| `AxAIOpenAIResponsesOutputTextContentPart` \| `AxAIOpenAIResponsesOutputRefusalContentPart`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.content_part.added"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesContentPartDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L353

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`content_index`	`readonly`	`number`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`part`	`readonly`	`Readonly`< \| `AxAIOpenAIResponsesOutputTextContentPart` \| `AxAIOpenAIResponsesOutputRefusalContentPart`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.content_part.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesDefineFunctionTool

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L135

Properties

Property	Modifier	Type
`description?`	`readonly`	`string`
`name`	`readonly`	`string`
`parameters`	`readonly`	`object`
`strict?`	`readonly`	`boolean`
`type`	`readonly`	`"function"`

AxAIOpenAIResponsesErrorEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L632

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`code`	`readonly`	`null` \| `string`	-	-
`message`	`readonly`	`string`	-	-
`param`	`readonly`	`null` \| `string`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"error"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesFileSearchCallCompletedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L436

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.file_search_call.completed"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesFileSearchCallInProgressEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L422

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.file_search_call.in_progress"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesFileSearchCallSearchingEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L429

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.file_search_call.searching"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesFileSearchToolCall

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L756

Extends

AxAIOpenAIResponsesToolCallBase

Properties

Property	Type	Overrides	Inherited from
`id`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`id`
`queries`	`string`[]	-	-
`results?`	`object`[]	-	-
`status?`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`status`
`type`	`"file_search_call"`	`AxAIOpenAIResponsesToolCallBase`.`type`	-

AxAIOpenAIResponsesFunctionCallArgumentsDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L404

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`delta`	`readonly`	`string`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.function_call_arguments.delta"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesFunctionCallArgumentsDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L412

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`arguments`	`readonly`	`string`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.function_call_arguments.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesFunctionCallItem

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L215

Properties

Property	Type
`arguments`	`string`
`call_id`	`string`
`id`	`string`
`name`	`string`
`status?`	`"in_progress"` \| `"completed"` \| `"incomplete"` \| `"searching"` \| `"failed"`
`type`	`"function_call"`

AxAIOpenAIResponsesImageGenerationCallCompletedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L554

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.image_generation_call.completed"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesImageGenerationCallGeneratingEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L547

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.image_generation_call.generating"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesImageGenerationCallInProgressEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L540

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.image_generation_call.in_progress"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesImageGenerationCallPartialImageEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L561

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`partial_image_b64`	`readonly`	`string`	-	-
`partial_image_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.image_generation_call.partial_image"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesImageGenerationToolCall

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L788

Extends

AxAIOpenAIResponsesToolCallBase

Properties

Property	Type	Overrides	Inherited from
`id`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`id`
`result?`	`string`	-	-
`status?`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`status`
`type`	`"image_generation_call"`	`AxAIOpenAIResponsesToolCallBase`.`type`	-

AxAIOpenAIResponsesInputAudioContentPart

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L84

Properties

Property	Modifier	Type
`input_audio`	`readonly`	`object`
`input_audio.data`	`readonly`	`string`
`input_audio.format?`	`readonly`	`string`
`type`	`readonly`	`"input_audio"`

AxAIOpenAIResponsesInputFunctionCallOutputItem

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L118

Properties

Property	Modifier	Type
`call_id`	`readonly`	`string`
`id?`	`readonly`	`string`
`output`	`readonly`	`string`
`type`	`readonly`	`"function_call_output"`

AxAIOpenAIResponsesInputFunctionCallItem

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L107

Properties

Property	Modifier	Type
`arguments`	`readonly`	`string`
`call_id`	`readonly`	`string`
`id?`	`readonly`	`string`
`name`	`readonly`	`string`
`type`	`readonly`	`"function_call"`

AxAIOpenAIResponsesInputImageUrlContentPart

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L76

Properties

Property	Modifier	Type
`image_url`	`readonly`	`object`
`image_url.details?`	`readonly`	`"high"` \| `"low"` \| `"auto"`
`image_url.url`	`readonly`	`string`
`type`	`readonly`	`"image_url"`

AxAIOpenAIResponsesInputMessageItem

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L98

Properties

Property	Modifier	Type
`content`	`readonly`	\| `string` \| readonly `AxAIOpenAIResponsesInputContentPart`[]
`name?`	`readonly`	`string`
`role`	`readonly`	`"system"` \| `"user"` \| `"assistant"` \| `"developer"`
`type`	`readonly`	`"message"`

AxAIOpenAIResponsesInputTextContentPart

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L71

Properties

Property	Modifier	Type
`text`	`public`	`string`
`type`	`readonly`	`"text"`

AxAIOpenAIResponsesLocalShellToolCall

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L794

Extends

AxAIOpenAIResponsesToolCallBase

Properties

Property	Type	Overrides	Inherited from
`action`	`object`	-	-
`id`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`id`
`status?`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`status`
`type`	`"local_shell_call"`	`AxAIOpenAIResponsesToolCallBase`.`type`	-

AxAIOpenAIResponsesMCPCallArgumentsDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L578

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`delta`	`readonly`	`object`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.mcp_call.arguments.delta"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesMCPCallArgumentsDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L586

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`arguments`	`readonly`	`object`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.mcp_call.arguments.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesMCPCallCompletedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L595

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.mcp_call.completed"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesMCPCallFailedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L600

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.mcp_call.failed"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesMCPCallInProgressEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L571

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.mcp_call.in_progress"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesMCPListToolsCompletedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L610

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.mcp_list_tools.completed"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesMCPListToolsFailedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L615

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.mcp_list_tools.failed"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesMCPToolCall

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L800

Extends

AxAIOpenAIResponsesToolCallBase

Properties

Property	Type	Overrides	Inherited from
`args`	`string`	-	-
`error?`	`string`	-	-
`id`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`id`
`name`	`string`	-	-
`output?`	`string`	-	-
`server_label`	`string`	-	-
`status?`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`status`
`type`	`"mcp_call"`	`AxAIOpenAIResponsesToolCallBase`.`type`	-

AxAIOpenAIResponsesMCPListToolsInProgressEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L605

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.mcp_list_tools.in_progress"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesOutputItemAddedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L326

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item`	`readonly`	`Readonly`<`AxAIOpenAIResponsesOutputItem`>	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.output_item.added"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesOutputItemDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L333

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item`	`readonly`	`Readonly`<`AxAIOpenAIResponsesOutputItem`>	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.output_item.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesOutputMessageItem

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L203

Properties

Property	Type
`content`	readonly ( \| `AxAIOpenAIResponsesOutputTextContentPart` \| `AxAIOpenAIResponsesOutputRefusalContentPart`)[]
`id`	`string`
`role`	`"assistant"`
`status`	`"in_progress"` \| `"completed"` \| `"incomplete"`
`type`	`"message"`

AxAIOpenAIResponsesOutputRefusalContentPart

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L241

Properties

Property	Modifier	Type
`refusal`	`readonly`	`string`
`type`	`readonly`	`"refusal"`

AxAIOpenAIResponsesOutputTextAnnotationAddedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L621

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`annotation`	`readonly`	`object`	-	-
`annotation_index`	`readonly`	`number`	-	-
`content_index`	`readonly`	`number`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.output_text_annotation.added"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesOutputTextDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L375

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`content_index`	`readonly`	`number`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`text`	`readonly`	`string`	-	-
`type`	`readonly`	`"response.output_text.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesOutputTextContentPart

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L235

Properties

Property	Modifier	Type
`annotations?`	`readonly`	readonly `unknown`[]
`text`	`readonly`	`string`
`type`	`readonly`	`"output_text"`

AxAIOpenAIResponsesOutputTextDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L366

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`content_index`	`readonly`	`number`	-	-
`delta`	`readonly`	`string`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.output_text.delta"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesReasoningDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L466

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`content_index`	`readonly`	`number`	-	-
`delta`	`readonly`	`object`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.reasoning.delta"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesReasoningItem

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L226

Properties

Property	Modifier	Type
`encrypted_content?`	`readonly`	`null` \| `string`
`id`	`readonly`	`string`
`status?`	`readonly`	`"in_progress"` \| `"completed"` \| `"incomplete"`
`summary`	`readonly`	readonly (`string` \| `object`)[]
`type`	`readonly`	`"reasoning"`

AxAIOpenAIResponsesReasoningDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L475

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`content_index`	`readonly`	`number`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`text`	`readonly`	`string`	-	-
`type`	`readonly`	`"response.reasoning.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesReasoningSummaryDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L521

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`delta`	`readonly`	`object`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`summary_index`	`readonly`	`number`	-	-
`type`	`readonly`	`"response.reasoning_summary.delta"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesReasoningSummaryDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L530

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`summary_index`	`readonly`	`number`	-	-
`text`	`readonly`	`string`	-	-
`type`	`readonly`	`"response.reasoning_summary.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesReasoningSummaryPart

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L247

Properties

Property	Modifier	Type
`text`	`readonly`	`string`
`type`	`readonly`	`"summary_text"`

AxAIOpenAIResponsesReasoningSummaryPartAddedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L485

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`part`	`readonly`	`Readonly`<`AxAIOpenAIResponsesReasoningSummaryPart`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`summary_index`	`readonly`	`number`	-	-
`type`	`readonly`	`"response.reasoning_summary_part.added"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesReasoningSummaryPartDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L494

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`part`	`readonly`	`Readonly`<`AxAIOpenAIResponsesReasoningSummaryPart`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`summary_index`	`readonly`	`number`	-	-
`type`	`readonly`	`"response.reasoning_summary_part.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesReasoningSummaryTextDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L503

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`delta`	`readonly`	`string`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`summary_index`	`readonly`	`number`	-	-
`type`	`readonly`	`"response.reasoning_summary_text.delta"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesReasoningSummaryTextDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L512

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`summary_index`	`readonly`	`number`	-	-
`text`	`readonly`	`string`	-	-
`type`	`readonly`	`"response.reasoning_summary_text.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesRefusalDeltaEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L385

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`content_index`	`readonly`	`number`	-	-
`delta`	`readonly`	`string`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.refusal.delta"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesRefusalDoneEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L394

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`content_index`	`readonly`	`number`	-	-
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`refusal`	`readonly`	`string`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.refusal.done"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesRequest

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L161

Type Parameters

Type Parameter	Default type
`TModel`	`AxAIOpenAIResponsesModel`

Properties

Property	Modifier	Type
`background?`	`readonly`	`null` \| `boolean`
`include?`	`readonly`	\| `null` \| readonly ( \| `"file_search_call.results"` \| `"message.input_image.image_url"` \| `"computer_call_output.output.image_url"` \| `"reasoning.encrypted_content"` \| `"code_interpreter_call.outputs"`)[]
`input`	`readonly`	\| `string` \| readonly `AxAIOpenAIResponsesInputItem`[]
`instructions?`	`readonly`	`null` \| `string`
`max_output_tokens?`	`readonly`	`null` \| `number`
`metadata?`	`readonly`	`null` \| `Readonly`<`Record`<`string`, `string`>>
`model`	`readonly`	`TModel`
`parallel_tool_calls?`	`readonly`	`null` \| `boolean`
`previous_response_id?`	`readonly`	`null` \| `string`
`reasoning?`	`readonly`	\| `null` \| { `effort?`: `null` \| `"high"` \| `"low"` \| `"medium"`; `summary?`: `null` \| `"auto"` \| `"concise"` \| `"detailed"`; }
`seed?`	`readonly`	`null` \| `number`
`service_tier?`	`readonly`	`null` \| `"auto"` \| `"default"` \| `"flex"`
`store?`	`readonly`	`null` \| `boolean`
`stream?`	`readonly`	`null` \| `boolean`
`temperature?`	`readonly`	`null` \| `number`
`text?`	`readonly`	\| `null` \| { `format?`: \| `null` \| { `type`: `"text"`; } \| { `type`: `"json_object"`; } \| { `json_schema?`: `object`; `type`: `"json_schema"`; }; }
`tool_choice?`	`readonly`	\| `null` \| `AxAIOpenAIResponsesToolChoice`
`tools?`	`readonly`	\| `null` \| readonly `AxAIOpenAIResponsesDefineFunctionTool`[]
`top_p?`	`readonly`	`null` \| `number`
`truncation?`	`readonly`	`null` \| `"auto"` \| `"disabled"`
`user?`	`readonly`	`null` \| `string`

AxAIOpenAIResponsesResponse

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L266

Properties

Property	Modifier	Type
`created`	`readonly`	`number`
`id`	`readonly`	`string`
`model`	`readonly`	`string`
`object`	`readonly`	`string`
`output`	`readonly`	readonly `AxAIOpenAIResponsesOutputItem`[]
`usage?`	`readonly`	\| `null` \| { `completion_tokens`: `number`; `prompt_tokens`: `number`; `total_tokens`: `number`; }

AxAIOpenAIResponsesResponseCompletedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L301

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`response`	`readonly`	`Readonly`<`AxAIOpenAIResponsesResponse`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.completed"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesResponseCreatedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L289

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`response`	`readonly`	`Readonly`<`AxAIOpenAIResponsesResponse`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.created"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesResponseFailedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L307

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`response`	`readonly`	`Readonly`<`AxAIOpenAIResponsesResponse`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.failed"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesResponseDelta

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L688

Properties

Property	Modifier	Type
`delta?`	`readonly`	`object`
`delta.arguments?`	`readonly`	`string`
`delta.content?`	`readonly`	`string`
`event?`	`readonly`	`string`
`id?`	`readonly`	`string`
`item?`	`readonly`	`Partial`<`Readonly`<`AxAIOpenAIResponsesOutputItem`>>
`item_index?`	`readonly`	`number`
`model?`	`readonly`	`string`
`response?`	`readonly`	`Readonly`<`AxAIOpenAIResponsesResponse`>
`usage?`	`readonly`	\| `null` \| { `completion_tokens`: `number`; `prompt_tokens`: `number`; `total_tokens`: `number`; }

AxAIOpenAIResponsesResponseInProgressEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L295

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`response`	`readonly`	`Readonly`<`AxAIOpenAIResponsesResponse`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.in_progress"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesResponseIncompleteEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L313

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`response`	`readonly`	`Readonly`<`AxAIOpenAIResponsesResponse`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.incomplete"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesResponseQueuedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L319

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`response`	`readonly`	`Readonly`<`AxAIOpenAIResponsesResponse`>	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.queued"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesStreamEventBase

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L283

Extended by

Properties

Property	Modifier	Type
`sequence_number`	`readonly`	`number`
`type`	`readonly`	`string`

AxAIOpenAIResponsesToolCallBase

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L750

Extended by

Properties

Property	Type
`id`	`string`
`status?`	`string`
`type`	`string`

AxAIOpenAIResponsesWebSearchCallCompletedEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L458

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.web_search_call.completed"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesWebSearchCallInProgressEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L444

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.web_search_call.in_progress"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesWebSearchCallSearchingEvent

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L451

Extends

AxAIOpenAIResponsesStreamEventBase

Properties

Property	Modifier	Type	Overrides	Inherited from
`item_id`	`readonly`	`string`	-	-
`output_index`	`readonly`	`number`	-	-
`sequence_number`	`readonly`	`number`	-	`AxAIOpenAIResponsesStreamEventBase`.`sequence_number`
`type`	`readonly`	`"response.web_search_call.searching"`	`AxAIOpenAIResponsesStreamEventBase`.`type`	-

AxAIOpenAIResponsesWebSearchToolCall

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/openai/responses_types.ts#L769

Extends

AxAIOpenAIResponsesToolCallBase

Properties

Property	Type	Overrides	Inherited from
`id`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`id`
`queries`	`string`[]	-	-
`status?`	`string`	-	`AxAIOpenAIResponsesToolCallBase`.`status`
`type`	`"web_search_call"`	`AxAIOpenAIResponsesToolCallBase`.`type`	-

AxAIRekaArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/reka/api.ts#L53

Properties

Property	Type
`apiKey`	`string`
`apiURL?`	`string`
`config?`	`Readonly`<`Partial`<`AxAIRekaConfig`>>
`modelInfo?`	readonly `AxModelInfo`[]
`models?`	`AxAIInputModelList`<`AxAIRekaModel`, `undefined`>
`name`	`"reka"`
`options?`	`Readonly`<`AxAIServiceOptions` & `object`>

AxAIService

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L326

Type Parameters

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

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel>>, options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions<TModel, TEmbedModel>>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L338

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L344

Parameters

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

Returns

Promise<AxEmbedResponse>

getFeatures()

getFeatures(model?: TModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L329

Parameters

Parameter	Type
`model?`	`TModel`

Returns

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L327

Returns

string

getLastUsedChatModel()

getLastUsedChatModel(): undefined | TModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L334

Returns

undefined | TModel

getLastUsedEmbedModel()

getLastUsedEmbedModel(): undefined | TEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L335

Returns

undefined | TEmbedModel

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L336

Returns

undefined | AxModelConfig

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L332

Returns

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L331

Returns

getModelList()

getModelList(): undefined | AxAIModelList;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L330

Returns

undefined | AxAIModelList

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L328

Returns

string

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L350

Returns

Readonly<AxAIServiceOptions>

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L349

Parameters

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

Returns

void

AxAIServiceImpl

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L353

Type Parameters

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

Methods

createChatReq()

createChatReq(req: Readonly<AxInternalChatRequest<TModel>>, config: Readonly<AxAIPromptConfig>): [AxAPI, TChatRequest];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L362

Parameters

Parameter	Type
`req`	`Readonly`<`AxInternalChatRequest`<`TModel`>>
`config`	`Readonly`<`AxAIPromptConfig`>

Returns

[AxAPI, TChatRequest]

createChatResp()

createChatResp(resp: Readonly<TChatResponse>): AxChatResponse;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L367

Parameters

Parameter	Type
`resp`	`Readonly`<`TChatResponse`>

Returns

AxChatResponse

createChatStreamResp()?

optional createChatStreamResp(resp: Readonly<TChatResponseDelta>, state: object): AxChatResponse;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L369

Parameters

Parameter	Type
`resp`	`Readonly`<`TChatResponseDelta`>
`state`	`object`

Returns

AxChatResponse

createEmbedReq()?

optional createEmbedReq(req: Readonly<AxInternalEmbedRequest<TEmbedModel>>): [AxAPI, TEmbedRequest];

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L374

Parameters

Parameter	Type
`req`	`Readonly`<`AxInternalEmbedRequest`<`TEmbedModel`>>

Returns

[AxAPI, TEmbedRequest]

createEmbedResp()?

optional createEmbedResp(resp: Readonly<TEmbedResponse>): AxEmbedResponse;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L378

Parameters

Parameter	Type
`resp`	`Readonly`<`TEmbedResponse`>

Returns

AxEmbedResponse

getModelConfig()

getModelConfig(): AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L380

Returns

AxModelConfig

getTokenUsage()

getTokenUsage(): undefined | AxTokenUsage;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L382

Returns

undefined | AxTokenUsage

AxAIServiceMetrics

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/types.ts#L200

Properties

Property	Type
`errors`	`object`
`errors.chat`	`object`
`errors.chat.count`	`number`
`errors.chat.rate`	`number`
`errors.chat.total`	`number`
`errors.embed`	`object`
`errors.embed.count`	`number`
`errors.embed.rate`	`number`
`errors.embed.total`	`number`
`latency`	`object`
`latency.chat`	`object`
`latency.chat.mean`	`number`
`latency.chat.p95`	`number`
`latency.chat.p99`	`number`
`latency.chat.samples`	`number`[]
`latency.embed`	`object`
`latency.embed.mean`	`number`
`latency.embed.p95`	`number`
`latency.embed.p99`	`number`
`latency.embed.samples`	`number`[]

AxAPI

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L42

Extended by

AxAPIConfig

Properties

Property	Type
`headers?`	`Record`<`string`, `string`>
`name?`	`string`
`put?`	`boolean`

AxAPIConfig

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/util/apicall.ts#L49

Extends

AxAPI.RequestValidation.ResponseValidation

Properties

Property	Type	Inherited from
`abortSignal?`	`AbortSignal`	-
`debug?`	`boolean`	-
`fetch?`	(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`>	-
`headers?`	`Record`<`string`, `string`>	`AxAPI`.`headers`
`name?`	`string`	`AxAPI`.`name`
`put?`	`boolean`	`AxAPI`.`put`
`retry?`	`Partial`<`RetryConfig`>	-
`span?`	`Span`	-
`stream?`	`boolean`	-
`timeout?`	`number`	-
`url`	`string` \| `URL`	-
`validateRequest?`	(`request`: `unknown`) => `boolean` \| `Promise`<`boolean`>	`RequestValidation.validateRequest`
`validateResponse?`	(`response`: `unknown`) => `boolean` \| `Promise`<`boolean`>	`ResponseValidation.validateResponse`

AxAgentFeatures

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L42

Properties

Property	Type	Description
`canConfigureSmartModelRouting`	`boolean`	Whether this agent can use smart model routing (requires an AI service)
`excludeFieldsFromPassthrough`	`string`[]	List of fields that this agent excludes from parent->child value passing

AxAgentic

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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<IN, OUT>.AxUsable

Type Parameters

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

Properties

Property	Type	Inherited from
`getTraces`	() => `AxProgramTrace`<`IN`, `OUT`>[]	`AxTunable`.`getTraces`
`getUsage`	() => `AxModelUsage` & `object`[]	`AxUsable`.`getUsage`
`resetUsage`	() => `void`	`AxUsable`.`resetUsage`
`setDemos`	(`demos`: readonly `AxProgramDemos`<`IN`, `OUT`>[]) => `void`	`AxTunable`.`setDemos`
`setExamples`	(`examples`: `Readonly`<`AxProgramExamples`<`IN`, `OUT`>>, `options?`: `Readonly`<`AxSetExamplesOptions`>) => `void`	`AxTunable`.`setExamples`
`setId`	(`id`: `string`) => `void`	`AxTunable`.`setId`
`setParentId`	(`parentId`: `string`) => `void`	`AxTunable`.`setParentId`

Methods

getFeatures()

getFeatures(): AxAgentFeatures;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L32

Returns

AxAgentFeatures

getFunction()

getFunction(): AxFunction;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/prompts/agent.ts#L31

Returns

AxDBQueryService.query

AxApacheTikaArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/docs/tika.ts#L3

Properties

Property	Type
`fetch?`	(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`>
`url?`	`string` \| `URL`

AxApacheTikaConvertOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/docs/tika.ts#L8

Properties

Property	Type
`format?`	`"text"` \| `"html"`

AxAssertion

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/asserts.ts#L3

Properties

Property	Type
`message?`	`string`

Methods

fn()

fn(values: Record<string, unknown>): undefined | boolean | Promise<undefined | boolean>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/asserts.ts#L4

Parameters

Parameter	Type
`values`	`Record`<`string`, `unknown`>

Returns

undefined | boolean | Promise<undefined | boolean>

AxBaseAIArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/ai/base.ts#L38

Type Parameters

Type Parameter
`TModel`
`TEmbedModel`

Properties

Property	Type
`apiURL`	`string`
`defaults`	`Readonly`<{ `embedModel?`: `TEmbedModel`; `model`: `TModel`; }>
`headers`	() => `Promise`<`Record`<`string`, `string`>>
`modelInfo`	readonly `AxModelInfo`[]
`models?`	`AxAIInputModelList`<`TModel`, `TEmbedModel`>
`name`	`string`
`options?`	`Readonly`<`AxAIServiceOptions`>
`supportFor`	\| `AxAIFeatures` \| (`model`: `TModel`) => `AxAIFeatures`

AxBootstrapCompileOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L359

Extends

AxCompileOptions

Properties

Property	Type	Inherited from
`earlyStoppingPatience?`	`number`	`AxCompileOptions`.`earlyStoppingPatience`
`maxDemos?`	`number`	-
`maxIterations?`	`number`	`AxCompileOptions`.`maxIterations`
`overrideCheckpointInterval?`	`number`	`AxCompileOptions`.`overrideCheckpointInterval`
`overrideCheckpointLoad?`	`AxCheckpointLoadFn`	`AxCompileOptions`.`overrideCheckpointLoad`
`overrideCheckpointSave?`	`AxCheckpointSaveFn`	`AxCompileOptions`.`overrideCheckpointSave`
`overrideCostTracker?`	`AxCostTracker`	`AxCompileOptions`.`overrideCostTracker`
`overrideOnEarlyStop?`	(`reason`: `string`, `stats`: `Readonly`<`AxOptimizationStats`>) => `void`	`AxCompileOptions`.`overrideOnEarlyStop`
`overrideOnProgress?`	(`progress`: `Readonly`<`AxOptimizationProgress`>) => `void`	`AxCompileOptions`.`overrideOnProgress`
`overrideTargetScore?`	`number`	`AxCompileOptions`.`overrideTargetScore`
`overrideTeacherAI?`	`AxAIService`<`unknown`, `unknown`>	`AxCompileOptions`.`overrideTeacherAI`
`overrideValidationSet?`	readonly `AxExample`[]	`AxCompileOptions`.`overrideValidationSet`
`saveCheckpointOnComplete?`	`boolean`	`AxCompileOptions`.`saveCheckpointOnComplete`
`teacherProgram?`	`Readonly`<`AxProgram`<`AxGenIn`, `AxGenOut`>>	-
`validationExamples?`	readonly `AxExample`[]	-
`verbose?`	`boolean`	`AxCompileOptions`.`verbose`

AxBootstrapOptimizerOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L309

Properties

Property	Type
`adaptiveBatching?`	`boolean`
`batchSize?`	`number`
`costMonitoring?`	`boolean`
`debugMode?`	`boolean`
`diversityWeight?`	`number`
`dynamicTemperature?`	`boolean`
`earlyStoppingPatience?`	`number`
`maxDemos?`	`number`
`maxExamples?`	`number`
`maxRounds?`	`number`
`maxTokensPerGeneration?`	`number`
`qualityThreshold?`	`number`
`teacherAI?`	`AxAIService`<`unknown`, `unknown`>
`verboseMode?`	`boolean`

AxCompileOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L196

Extended by

Properties

Property	Type
`earlyStoppingPatience?`	`number`
`maxIterations?`	`number`
`overrideCheckpointInterval?`	`number`
`overrideCheckpointLoad?`	`AxCheckpointLoadFn`
`overrideCheckpointSave?`	`AxCheckpointSaveFn`
`overrideCostTracker?`	`AxCostTracker`
`overrideOnEarlyStop?`	(`reason`: `string`, `stats`: `Readonly`<`AxOptimizationStats`>) => `void`
`overrideOnProgress?`	(`progress`: `Readonly`<`AxOptimizationProgress`>) => `void`
`overrideTargetScore?`	`number`
`overrideTeacherAI?`	`AxAIService`<`unknown`, `unknown`>
`overrideValidationSet?`	readonly `AxExample`[]
`saveCheckpointOnComplete?`	`boolean`
`verbose?`	`boolean`

AxCostTracker

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L42

Methods

getCurrentCost()

getCurrentCost(): number;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L44

Returns

number

getTokenUsage()

getTokenUsage(): Record<string, number>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L45

Returns

Record<string, number>

getTotalTokens()

getTotalTokens(): number;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L46

Returns

number

isLimitReached()

isLimitReached(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L47

Returns

boolean

reset()

reset(): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L48

Returns

void

trackTokens()

trackTokens(count: number, model: string): void;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L43

Parameters

Parameter	Type
`count`	`number`
`model`	`string`

Returns

void

AxCostTrackerOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L88

Properties

Property	Type
`costPerModel?`	`Record`<`string`, `number`>
`maxCost?`	`number`
`maxTokens?`	`number`

AxDBBaseOpOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/base.ts#L18

Properties

Property	Type
`span?`	`Span`

AxDBBaseArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/base.ts#L13

Extended by

Properties

Property	Type
`fetch?`	(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`>
`tracer?`	`Tracer`

AxDBCloudflareArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/cloudflare.ts#L34

Extends

AxDBBaseArgs

Properties

Property	Type	Overrides	Inherited from
`accountId`	`string`	-	-
`apiKey`	`string`	-	-
`fetch?`	(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`>	`AxDBBaseArgs`.`fetch`	-
`name`	`"cloudflare"`	-	-
`tracer?`	`Tracer`	-	`AxDBBaseArgs`.`tracer`

AxDBLoaderOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/docs/manager.ts#L11

Properties

Property	Type
`chunker?`	(`text`: `string`) => `string`[]
`reranker?`	`AxProgram`<`AxRerankerIn`, `AxRerankerOut`>
`rewriter?`	`AxProgram`<`AxRewriteIn`, `AxRewriteOut`>

AxDBManagerArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/docs/manager.ts#L17

Properties

Property	Type
`ai`	`AxAIService`
`config?`	`AxDBLoaderOptions`
`db`	`AxDBService`

AxDBMatch

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/docs/manager.ts#L23

Properties

Property	Type
`score`	`number`
`text`	`string`

AxDBMemoryArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/memory.ts#L11

Extends

AxDBBaseArgs

Properties

Property	Type	Inherited from
`fetch?`	(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`>	`AxDBBaseArgs`.`fetch`
`name`	`"memory"`	-
`tracer?`	`Tracer`	`AxDBBaseArgs`.`tracer`

AxDBPineconeArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/pinecone.ts#L48

Extends

AxDBBaseArgs

Properties

Property	Type	Overrides	Inherited from
`apiKey`	`string`	-	-
`fetch?`	(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`>	`AxDBBaseArgs`.`fetch`	-
`host`	`string`	-	-
`name`	`"pinecone"`	-	-
`tracer?`	`Tracer`	-	`AxDBBaseArgs`.`tracer`

AxDBQueryService

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/types.ts#L48

Extended by

AxDBService

Methods

query()

query(req: Readonly<AxDBQueryRequest>): Promise<AxDBQueryResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/types.ts#L49

Parameters

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

Returns

Promise<AxDBQueryResponse>

AxDBService

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/types.ts#L36

Extends

AxDBQueryService

Methods

batchUpsert()

batchUpsert(batchReq: readonly AxDBUpsertRequest[], update?: boolean): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/types.ts#L42

Parameters

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

Returns

Promise<AxDBUpsertResponse>

query()

query(req: Readonly<AxDBQueryRequest>): Promise<AxDBQueryResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/types.ts#L49

Parameters

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

Returns

Promise<AxDBQueryResponse>

Inherited from

upsert()

upsert(req: Readonly<AxDBUpsertRequest>, update?: boolean): Promise<AxDBUpsertResponse>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/types.ts#L37

Parameters

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

Returns

Promise<AxDBUpsertResponse>

AxDBWeaviateArgs

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/db/weaviate.ts#L29

Extends

AxDBBaseArgs

Properties

Property	Type	Overrides	Inherited from
`apiKey`	`string`	-	-
`fetch?`	(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`>	`AxDBBaseArgs`.`fetch`	-
`host`	`string`	-	-
`name`	`"weaviate"`	-	-
`tracer?`	`Tracer`	-	`AxDBBaseArgs`.`tracer`

AxDockerContainer

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/funcs/docker.ts#L3

Properties

Property	Type
`Command`	`string`
`Created`	`number`
`HostConfig`	`object`
`HostConfig.NetworkMode`	`string`
`Id`	`string`
`Image`	`string`
`ImageID`	`string`
`Labels`	`object`
`Mounts`	`object`[]
`Names`	`string`[]
`NetworkSettings`	`object`
`NetworkSettings.Networks`	`object`
`Ports`	`object`[]
`SizeRootFs`	`number`
`SizeRw`	`number`
`State`	`object`
`State.Dead`	`boolean`
`State.Error`	`string`
`State.ExitCode`	`number`
`State.FinishedAt`	`Date`
`State.OOMKilled`	`boolean`
`State.Paused`	`boolean`
`State.Pid`	`number`
`State.Restarting`	`boolean`
`State.Running`	`boolean`
`State.StartedAt`	`Date`
`State.Status`	`string`
`Status`	`string`

AxFieldDescriptor

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/template.ts#L35

Properties

Property	Modifier	Type
`description?`	`readonly`	`string`
`isInternal?`	`readonly`	`boolean`
`isOptional?`	`readonly`	`boolean`
`name`	`readonly`	`string`
`type?`	`readonly`	`AxFieldType`

AxField

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/sig.ts#L13

Properties

Property	Type
`description?`	`string`
`isInternal?`	`boolean`
`isOptional?`	`boolean`
`name`	`string`
`title?`	`string`
`type?`	`object`
`type.isArray?`	`boolean`
`type.name`	\| `"string"` \| `"number"` \| `"boolean"` \| `"image"` \| `"audio"` \| `"code"` \| `"json"` \| `"datetime"` \| `"date"` \| `"class"`
`type.options?`	`string`[]

AxFieldProcessor

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/fieldProcessor.ts#L24

Properties

Property	Type	Description
`field`	`Readonly`<`AxField`>	-
`process`	\| `AxFieldProcessorProcess` \| `AxStreamingFieldProcessorProcess`	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).

AxFieldType

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/template.ts#L16

Properties

Property	Modifier	Type
`description?`	`readonly`	`string`
`isArray?`	`readonly`	`boolean`
`isInternal?`	`readonly`	`boolean`
`isOptional?`	`readonly`	`boolean`
`options?`	`readonly`	readonly `string`[]
`type`	`readonly`	\| `"string"` \| `"number"` \| `"boolean"` \| `"image"` \| `"audio"` \| `"code"` \| `"json"` \| `"datetime"` \| `"date"` \| `"class"`

AxMCPStreamableHTTPTransportOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/httpTransport.ts#L79

Properties

Property	Type	Description
`authorization?`	`string`	Authorization header value (convenience for common use case) If provided, will be added to the headers as ‘Authorization’
`headers?`	`Record`<`string`, `string`>	Custom headers to include with all HTTP requests Note: Content-Type, Accept, and Mcp-Session-Id are managed automatically

AxMCPTransport

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/mcp/transport.ts#L7

Methods

connect()?

optional connect(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: Readonly<JSONRPCRequest<unknown>>): Promise<JSONRPCResponse<unknown>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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: Readonly<JSONRPCNotification>): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/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>

AxMiPROCompileOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L365

Extends

AxCompileOptions

Properties

Property	Type	Inherited from
`auto?`	`"medium"` \| `"light"` \| `"heavy"`	-
`customProposer?`	(`context`: `Readonly`<{ `dataSummary`: `string`; `previousInstructions`: `string`[]; `programSummary`: `string`; }>) => `Promise`<`string`[]>	-
`earlyStoppingPatience?`	`number`	`AxCompileOptions`.`earlyStoppingPatience`
`instructionCandidates?`	`string`[]	-
`maxIterations?`	`number`	`AxCompileOptions`.`maxIterations`
`overrideCheckpointInterval?`	`number`	`AxCompileOptions`.`overrideCheckpointInterval`
`overrideCheckpointLoad?`	`AxCheckpointLoadFn`	`AxCompileOptions`.`overrideCheckpointLoad`
`overrideCheckpointSave?`	`AxCheckpointSaveFn`	`AxCompileOptions`.`overrideCheckpointSave`
`overrideCostTracker?`	`AxCostTracker`	`AxCompileOptions`.`overrideCostTracker`
`overrideOnEarlyStop?`	(`reason`: `string`, `stats`: `Readonly`<`AxOptimizationStats`>) => `void`	`AxCompileOptions`.`overrideOnEarlyStop`
`overrideOnProgress?`	(`progress`: `Readonly`<`AxOptimizationProgress`>) => `void`	`AxCompileOptions`.`overrideOnProgress`
`overrideTargetScore?`	`number`	`AxCompileOptions`.`overrideTargetScore`
`overrideTeacherAI?`	`AxAIService`<`unknown`, `unknown`>	`AxCompileOptions`.`overrideTeacherAI`
`overrideValidationSet?`	readonly `AxExample`[]	`AxCompileOptions`.`overrideValidationSet`
`saveCheckpointOnComplete?`	`boolean`	`AxCompileOptions`.`saveCheckpointOnComplete`
`teacher?`	`Readonly`<`AxProgram`<`AxGenIn`, `AxGenOut`>>	-
`validationExamples?`	readonly `AxExample`[]	-
`verbose?`	`boolean`	`AxCompileOptions`.`verbose`

AxMiPROResult

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizers/miproV2.ts#L30

Extends

AxOptimizerResult<OUT>

Type Parameters

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

Properties

Property	Type	Inherited from
`bestScore`	`number`	`AxOptimizerResult`.`bestScore`
`configurationHistory?`	`Record`<`string`, `unknown`>[]	`AxOptimizerResult`.`configurationHistory`
`demos?`	`AxProgramDemos`<`AxGenIn`, `OUT`>[]	`AxOptimizerResult`.`demos`
`finalConfiguration?`	`Record`<`string`, `unknown`>	`AxOptimizerResult`.`finalConfiguration`
`optimizedGen?`	`AxGen`<`IN`, `OUT`>	-
`scoreHistory?`	`number`[]	`AxOptimizerResult`.`scoreHistory`
`stats`	`AxOptimizationStats`	`AxOptimizerResult`.`stats`

AxOptimizationCheckpoint

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L52

Properties

Property	Type
`bestConfiguration?`	`Record`<`string`, `unknown`>
`bestScore`	`number`
`configurationHistory`	`Record`<`string`, `unknown`>[]
`currentRound`	`number`
`examples`	readonly `AxExample`[]
`optimizerConfig`	`Record`<`string`, `unknown`>
`optimizerState`	`Record`<`string`, `unknown`>
`optimizerType`	`string`
`scoreHistory`	`number`[]
`stats`	`AxOptimizationStats`
`timestamp`	`number`
`totalRounds`	`number`
`validationSet?`	readonly `AxExample`[]
`version`	`string`

AxOptimizationProgress

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L24

Properties

Property	Type
`bestScore`	`number`
`convergenceInfo?`	`object`
`convergenceInfo.improvement`	`number`
`convergenceInfo.isConverging`	`boolean`
`convergenceInfo.stagnationRounds`	`number`
`currentConfiguration?`	`Record`<`string`, `unknown`>
`currentScore`	`number`
`round`	`number`
`successfulExamples`	`number`
`timeElapsed`	`number`
`tokensUsed`	`number`
`totalExamples`	`number`
`totalRounds`	`number`

AxOptimizationStats

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L130

Properties

Property	Type
`convergenceInfo`	`object`
`convergenceInfo.converged`	`boolean`
`convergenceInfo.convergenceThreshold`	`number`
`convergenceInfo.finalImprovement`	`number`
`convergenceInfo.stagnationRounds`	`number`
`earlyStopped`	`boolean`
`earlyStopping?`	`object`
`earlyStopping.bestScoreRound`	`number`
`earlyStopping.patienceExhausted`	`boolean`
`earlyStopping.reason`	`string`
`estimatedTokenUsage`	`number`
`evaluationBreakdown?`	`object`
`evaluationBreakdown.crossValidationScores?`	`number`[]
`evaluationBreakdown.standardDeviation?`	`number`
`evaluationBreakdown.trainingScore`	`number`
`evaluationBreakdown.validationScore`	`number`
`resourceUsage`	`object`
`resourceUsage.avgLatencyPerEval`	`number`
`resourceUsage.costByModel`	`Record`<`string`, `number`>
`resourceUsage.peakMemoryUsage?`	`number`
`resourceUsage.totalTime`	`number`
`resourceUsage.totalTokens`	`number`
`successfulDemos`	`number`
`totalCalls`	`number`

AxMiPROOptimizerOptions

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L328

Properties

Property	Type
`acquisitionFunction?`	\| `"expected_improvement"` \| `"upper_confidence_bound"` \| `"probability_improvement"`
`bayesianOptimization?`	`boolean`
`dataAwareProposer?`	`boolean`
`earlyStoppingTrials?`	`number`
`explorationWeight?`	`number`
`fewshotAwareProposer?`	`boolean`
`initTemperature?`	`number`
`maxBootstrappedDemos?`	`number`
`maxLabeledDemos?`	`number`
`minibatch?`	`boolean`
`minibatchFullEvalSteps?`	`number`
`minibatchSize?`	`number`
`minImprovementThreshold?`	`number`
`numCandidates?`	`number`
`numTrials?`	`number`
`programAwareProposer?`	`boolean`
`sampleCount?`	`number`
`tipAwareProposer?`	`boolean`
`verbose?`	`boolean`
`viewDataBatchSize?`	`number`

AxOptimizerResult

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L168

Extended by

Type Parameters

Type Parameter
`OUT` extends `AxGenOut`

Properties

Property	Type
`bestScore`	`number`
`configurationHistory?`	`Record`<`string`, `unknown`>[]
`demos?`	`AxProgramDemos`<`AxGenIn`, `OUT`>[]
`finalConfiguration?`	`Record`<`string`, `unknown`>
`scoreHistory?`	`number`[]
`stats`	`AxOptimizationStats`

AxOptimizer

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L223

Type Parameters

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

Methods

cancel()?

optional cancel(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L276

Cancel ongoing optimization gracefully

Returns

Promise<void>

Promise that resolves when cancellation is complete

compile()

compile(
   program: Readonly<AxProgram<IN, OUT>>, 
   metricFn: AxMetricFn, 
options?: AxCompileOptions): Promise<AxOptimizerResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L234

Optimize a program using the provided metric function

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>	The program to optimize (moved from constructor)
`metricFn`	`AxMetricFn`	Evaluation metric function to assess program performance
`options?`	`AxCompileOptions`	Optional configuration options that can override constructor settings

Returns

Promise<AxOptimizerResult<OUT>>

Optimization result containing demos, stats, and configuration

compilePareto()?

optional compilePareto(
   program: Readonly<AxProgram<IN, OUT>>, 
   metricFn: AxMultiMetricFn, 
options?: AxCompileOptions): Promise<AxParetoResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L260

Multi-objective optimization using Pareto frontier

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>	The program to optimize
`metricFn`	`AxMultiMetricFn`	Multi-objective metric function
`options?`	`AxCompileOptions`	Optional configuration options

Returns

Promise<AxParetoResult<OUT>>

Pareto optimization result

compileStream()?

optional compileStream(
   program: Readonly<AxProgram<IN, OUT>>, 
   metricFn: AxMetricFn, 
options?: AxCompileOptions): AsyncIterableIterator<AxOptimizationProgress>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L247

Optimize a program with real-time streaming updates

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxProgram`<`IN`, `OUT`>>	The program to optimize
`metricFn`	`AxMetricFn`	Evaluation metric function
`options?`	`AxCompileOptions`	Optional configuration options

Returns

AsyncIterableIterator<AxOptimizationProgress>

Async iterator yielding optimization progress

getConfiguration()?

optional getConfiguration(): Record<string, unknown>;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L287

Get optimizer-specific configuration

Returns

Record<string, unknown>

Current optimizer configuration

getStats()

getStats(): AxOptimizationStats;

Defined in: https://github.com/ax-llm/ax/blob/106cb89c8759fca348b2bebaf677ebb35ee6daf1/src/ax/dsp/optimizer.ts#L270

Get current optimization statistics

Returns