> AxAI
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L85
Implements
Constructors
new AxAI()
new AxAI(
options):AxAI
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L88
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIArgs> |
Returns
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L166
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Implementation of
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L173
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest> |
options? | Readonly<AxAIServiceActionOptions> |
Returns
Promise<AxEmbedResponse>
Implementation of
getFeatures()
getFeatures(
model?):object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L142
Parameters
| Parameter | Type |
|---|---|
model? | string |
Returns
object
functions
functions:
boolean
streaming
streaming:
boolean
Implementation of
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L138
Returns
string
Implementation of
getLastUsedChatModel()
getLastUsedChatModel():
unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L150
Returns
unknown
Implementation of
AxAIService.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L154
Returns
unknown
Implementation of
AxAIService.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L158
Returns
undefined | AxModelConfig
Implementation of
AxAIService.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L162
Returns
Implementation of
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L146
Returns
undefined | AxAIModelList
Implementation of
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L134
Returns
string
Implementation of
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L184
Returns
Readonly<AxAIServiceOptions>
Implementation of
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L180
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Implementation of
> AxAIAnthropic
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L342
Extends
AxBaseAI<AxAIAnthropicModel|AxAIAnthropicVertexModel,unknown,AxAIAnthropicChatRequest,unknown,AxAIAnthropicChatResponse,AxAIAnthropicChatResponseDelta,unknown>
Constructors
new AxAIAnthropic()
new AxAIAnthropic(
__namedParameters):AxAIAnthropic
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L351
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIAnthropicArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIAnthropicModel | AxAIAnthropicVertexModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIAnthropicModel | AxAIAnthropicVertexModel, unknown>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<unknown>> |
options? | Readonly<AxAIServiceActionOptions<AxAIAnthropicModel | AxAIAnthropicVertexModel, unknown>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIAnthropicModel | AxAIAnthropicVertexModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIAnthropicModel|AxAIAnthropicVertexModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIAnthropicModel | AxAIAnthropicVertexModel
Inherited from
getLastUsedEmbedModel()
getLastUsedEmbedModel():
unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
unknown
Inherited from
AxBaseAI.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxBaseAI.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIAzureOpenAI
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/azure-openai/api.ts#L40
Extends
Constructors
new AxAIAzureOpenAI()
new AxAIAzureOpenAI(
__namedParameters):AxAIAzureOpenAI
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/azure-openai/api.ts#L44
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIAzureOpenAIArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIOpenAIModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIOpenAIModel, AxAIOpenAIEmbedModel>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<AxAIOpenAIEmbedModel>> |
options? | Readonly<AxAIServiceActionOptions<AxAIOpenAIModel, AxAIOpenAIEmbedModel>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIOpenAIModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIOpenAIModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIOpenAIModel
Inherited from
AxAIOpenAIBase.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|AxAIOpenAIEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | AxAIOpenAIEmbedModel
Inherited from
AxAIOpenAIBase.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxAIOpenAIBase.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAICohere
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L298
Extends
AxBaseAI<AxAICohereModel,AxAICohereEmbedModel,AxAICohereChatRequest,AxAICohereEmbedRequest,AxAICohereChatResponse,AxAICohereChatResponseDelta,AxAICohereEmbedResponse>
Constructors
new AxAICohere()
new AxAICohere(
__namedParameters):AxAICohere
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L307
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAICohereArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAICohereModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAICohereModel, AxAICohereEmbedModel>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<AxAICohereEmbedModel>> |
options? | Readonly<AxAIServiceActionOptions<AxAICohereModel, AxAICohereEmbedModel>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAICohereModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAICohereModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAICohereModel
Inherited from
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|AxAICohereEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | AxAICohereEmbedModel
Inherited from
AxBaseAI.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxBaseAI.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIDeepSeek
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/api.ts#L31
Extends
AxAIOpenAIBase<AxAIDeepSeekModel,undefined>
Constructors
new AxAIDeepSeek()
new AxAIDeepSeek(
__namedParameters):AxAIDeepSeek
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/api.ts#L32
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIDeepSeekArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIDeepSeekModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIDeepSeekModel, undefined>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<undefined>> |
options? | Readonly<AxAIServiceActionOptions<AxAIDeepSeekModel, undefined>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIDeepSeekModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIDeepSeekModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIDeepSeekModel
Inherited from
AxAIOpenAIBase.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined
Inherited from
AxAIOpenAIBase.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxAIOpenAIBase.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIGrok
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L76
Extends
Constructors
new AxAIGrok()
new AxAIGrok(
__namedParameters):AxAIGrok
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L81
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIGrokArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIGrokModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIGrokModel, GrokEmbedSmall>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<GrokEmbedSmall>> |
options? | Readonly<AxAIServiceActionOptions<AxAIGrokModel, GrokEmbedSmall>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIGrokModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIGrokModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIGrokModel
Inherited from
AxAIOpenAIBase.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|GrokEmbedSmall
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | GrokEmbedSmall
Inherited from
AxAIOpenAIBase.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxAIOpenAIBase.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIGoogleGemini
AxAIGoogleGemini: AI Service
Extends
AxBaseAI<AxAIGoogleGeminiModel,AxAIGoogleGeminiEmbedModel,AxAIGoogleGeminiChatRequest,AxAIGoogleGeminiBatchEmbedRequest|AxAIGoogleVertexBatchEmbedRequest,AxAIGoogleGeminiChatResponse,AxAIGoogleGeminiChatResponseDelta,AxAIGoogleGeminiBatchEmbedResponse|AxAIGoogleVertexBatchEmbedResponse>
Constructors
new AxAIGoogleGemini()
new AxAIGoogleGemini(
__namedParameters):AxAIGoogleGemini
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIGoogleGeminiArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIGoogleGeminiModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIGoogleGeminiModel, AxAIGoogleGeminiEmbedModel>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<AxAIGoogleGeminiEmbedModel>> |
options? | Readonly<AxAIServiceActionOptions<AxAIGoogleGeminiModel, AxAIGoogleGeminiEmbedModel>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIGoogleGeminiModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIGoogleGeminiModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIGoogleGeminiModel
Inherited from
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|AxAIGoogleGeminiEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | AxAIGoogleGeminiEmbedModel
Inherited from
AxBaseAI.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxBaseAI.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIGroq
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/api.ts#L27
Extends
AxAIOpenAIBase<AxAIGroqModel,undefined>
Constructors
new AxAIGroq()
new AxAIGroq(
__namedParameters):AxAIGroq
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/api.ts#L28
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIGroqArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIGroqModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIGroqModel, undefined>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<undefined>> |
options? | Readonly<AxAIServiceActionOptions<AxAIGroqModel, undefined>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIGroqModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIGroqModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIGroqModel
Inherited from
AxAIOpenAIBase.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined
Inherited from
AxAIOpenAIBase.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxAIOpenAIBase.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/api.ts#L71
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Overrides
> AxAIHuggingFace
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L165
Extends
AxBaseAI<AxAIHuggingFaceModel,unknown,AxAIHuggingFaceRequest,unknown,AxAIHuggingFaceResponse,unknown,unknown>
Constructors
new AxAIHuggingFace()
new AxAIHuggingFace(
__namedParameters):AxAIHuggingFace
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L174
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIHuggingFaceArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<MetaLlama270BChatHF>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<MetaLlama270BChatHF, unknown>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<unknown>> |
options? | Readonly<AxAIServiceActionOptions<MetaLlama270BChatHF, unknown>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | MetaLlama270BChatHF |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|MetaLlama270BChatHF
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | MetaLlama270BChatHF
Inherited from
getLastUsedEmbedModel()
getLastUsedEmbedModel():
unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
unknown
Inherited from
AxBaseAI.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxBaseAI.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIOllama
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/ollama/api.ts#L33
OllamaAI: AI Service
Extends
AxAIOpenAIBase<string,string>
Constructors
new AxAIOllama()
new AxAIOllama(
__namedParameters):AxAIOllama
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/ollama/api.ts#L34
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIOllamaArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<string>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<string, string>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<string>> |
options? | Readonly<AxAIServiceActionOptions<string, string>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | string |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | string
Inherited from
AxAIOpenAIBase.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | string
Inherited from
AxAIOpenAIBase.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxAIOpenAIBase.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIOpenAI
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L574
Extends
Constructors
new AxAIOpenAI()
new AxAIOpenAI(
__namedParameters):AxAIOpenAI
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L578
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIOpenAIArgs<"openai", AxAIOpenAIModel, AxAIOpenAIEmbedModel, AxAIOpenAIChatRequest<AxAIOpenAIModel>>, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIOpenAIModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIOpenAIModel, AxAIOpenAIEmbedModel>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<AxAIOpenAIEmbedModel>> |
options? | Readonly<AxAIServiceActionOptions<AxAIOpenAIModel, AxAIOpenAIEmbedModel>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIOpenAIModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIOpenAIModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIOpenAIModel
Inherited from
AxAIOpenAIBase.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|AxAIOpenAIEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | AxAIOpenAIEmbedModel
Inherited from
AxAIOpenAIBase.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxAIOpenAIBase.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIOpenAIBase
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L522
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
new AxAIOpenAIBase()
new AxAIOpenAIBase<
TModel,TEmbedModel,TChatReq>(__namedParameters):AxAIOpenAIBase<TModel,TEmbedModel,TChatReq>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L536
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIOpenAIBaseArgs<TModel, TEmbedModel, TChatReq>, "name">> |
Returns
AxAIOpenAIBase<TModel, TEmbedModel, TChatReq>
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<TModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<TModel, TEmbedModel>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<TEmbedModel>> |
options? | Readonly<AxAIServiceActionOptions<TModel, TEmbedModel>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | TModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|TModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | TModel
Inherited from
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|TEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | TEmbedModel
Inherited from
AxBaseAI.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxBaseAI.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIOpenAIResponses
Base class for OpenAI AI services using the /v1/responses API endpoint
Extends
AxAIOpenAIResponsesBase<AxAIOpenAIModel,AxAIOpenAIEmbedModel,AxAIOpenAIResponsesRequest<AxAIOpenAIModel>>
Constructors
new AxAIOpenAIResponses()
new AxAIOpenAIResponses(
__namedParameters):AxAIOpenAIResponses
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIOpenAIResponsesArgs<"openai-responses", AxAIOpenAIModel, AxAIOpenAIEmbedModel, AxAIOpenAIResponsesRequest<AxAIOpenAIModel>>, "name">> |
Returns
Overrides
AxAIOpenAIResponsesBase.constructor
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIOpenAIModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIOpenAIModel, AxAIOpenAIEmbedModel>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<AxAIOpenAIEmbedModel>> |
options? | Readonly<AxAIServiceActionOptions<AxAIOpenAIModel, AxAIOpenAIEmbedModel>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIOpenAIModel |
Returns
Inherited from
AxAIOpenAIResponsesBase.getFeatures
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIOpenAIModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIOpenAIModel
Inherited from
AxAIOpenAIResponsesBase.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|AxAIOpenAIEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | AxAIOpenAIEmbedModel
Inherited from
AxAIOpenAIResponsesBase.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxAIOpenAIResponsesBase.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
AxAIOpenAIResponsesBase.getMetrics
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
AxAIOpenAIResponsesBase.getModelList
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
AxAIOpenAIResponsesBase.getName
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
AxAIOpenAIResponsesBase.getOptions
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
AxAIOpenAIResponsesBase.setAPIURL
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
AxAIOpenAIResponsesBase.setHeaders
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
AxAIOpenAIResponsesBase.setName
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIMistral
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/api.ts#L35
Extends
Constructors
new AxAIMistral()
new AxAIMistral(
__namedParameters):AxAIMistral
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/api.ts#L39
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIMistralArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIMistralModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIMistralModel, MistralEmbed>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<MistralEmbed>> |
options? | Readonly<AxAIServiceActionOptions<AxAIMistralModel, MistralEmbed>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIMistralModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIMistralModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIMistralModel
Inherited from
AxAIOpenAIBase.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|MistralEmbed
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | MistralEmbed
Inherited from
AxAIOpenAIBase.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxAIOpenAIBase.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> 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
Type Parameters
| Type Parameter |
|---|
TModel |
TEmbedModel |
TResponsesReq extends AxAIOpenAIResponsesRequest<TModel> |
Constructors
new AxAIOpenAIResponsesBase()
new AxAIOpenAIResponsesBase<
TModel,TEmbedModel,TResponsesReq>(__namedParameters):AxAIOpenAIResponsesBase<TModel,TEmbedModel,TResponsesReq>
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<AxAIOpenAIResponsesBaseArgs<TModel, TEmbedModel, TResponsesReq>> |
Returns
AxAIOpenAIResponsesBase<TModel, TEmbedModel, TResponsesReq>
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<TModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<TModel, TEmbedModel>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<TEmbedModel>> |
options? | Readonly<AxAIServiceActionOptions<TModel, TEmbedModel>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | TModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|TModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | TModel
Inherited from
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|TEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | TEmbedModel
Inherited from
AxBaseAI.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxBaseAI.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> 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
new AxAIOpenAIResponsesImpl()
new AxAIOpenAIResponsesImpl<
TModel,TEmbedModel,TResponsesReq>(config,streamingUsage,responsesReqUpdater?):AxAIOpenAIResponsesImpl<TModel,TEmbedModel,TResponsesReq>
Parameters
| Parameter | Type |
|---|---|
config | Readonly<AxAIOpenAIResponsesConfig<TModel, TEmbedModel>> |
streamingUsage | boolean |
responsesReqUpdater? | ResponsesReqUpdater<TModel, TResponsesReq> |
Returns
AxAIOpenAIResponsesImpl<TModel, TEmbedModel, TResponsesReq>
Methods
createChatReq()
createChatReq(
req,_config): [Readonly<AxAPI>,Readonly<AxAIOpenAIResponsesRequest<TModel>>]
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxInternalChatRequest<TModel>> |
_config | Readonly<AxAIPromptConfig> |
Returns
[Readonly<AxAPI>, Readonly<AxAIOpenAIResponsesRequest<TModel>>]
Implementation of
createChatResp()
createChatResp(
resp):Readonly<AxChatResponse>
Parameters
| Parameter | Type |
|---|---|
resp | Readonly<AxAIOpenAIResponsesResponse> |
Returns
Readonly<AxChatResponse>
Implementation of
AxAIServiceImpl.createChatResp
createChatStreamResp()
createChatStreamResp(
streamEvent):Readonly<AxChatResponse>
Parameters
| Parameter | Type |
|---|---|
streamEvent | Readonly<AxAIOpenAIResponsesResponseDelta> |
Returns
Readonly<AxChatResponse>
Implementation of
AxAIServiceImpl.createChatStreamResp
createEmbedReq()
createEmbedReq(
req): [AxAPI,AxAIOpenAIEmbedRequest<TEmbedModel>]
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxInternalEmbedRequest<TEmbedModel>> |
Returns
[AxAPI, AxAIOpenAIEmbedRequest<TEmbedModel>]
Implementation of
AxAIServiceImpl.createEmbedReq
getModelConfig()
getModelConfig():
Readonly<AxModelConfig>
Returns
Readonly<AxModelConfig>
Implementation of
AxAIServiceImpl.getModelConfig
getTokenUsage()
getTokenUsage():
undefined|Readonly<AxTokenUsage>
Returns
undefined | Readonly<AxTokenUsage>
Implementation of
> AxAIReka
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L266
Extends
AxBaseAI<AxAIRekaModel,undefined,AxAIRekaChatRequest,unknown,AxAIRekaChatResponse,AxAIRekaChatResponseDelta,unknown>
Constructors
new AxAIReka()
new AxAIReka(
__namedParameters):AxAIReka
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L275
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAIRekaArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<AxAIRekaModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<AxAIRekaModel, undefined>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<undefined>> |
options? | Readonly<AxAIServiceActionOptions<AxAIRekaModel, undefined>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | AxAIRekaModel |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|AxAIRekaModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | AxAIRekaModel
Inherited from
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined
Inherited from
AxBaseAI.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxBaseAI.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAIServiceAbortedError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L214
Extends
Constructors
new AxAIServiceAbortedError()
new AxAIServiceAbortedError(
url,reason?,requestBody?,context?):AxAIServiceAbortedError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L215
Parameters
| Parameter | Type |
|---|---|
url | string |
reason? | string |
requestBody? | unknown |
context? | Record<string, unknown> |
Returns
Overrides
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
context
readonlycontext:Record<string,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L79
Inherited from
errorId
readonlyerrorId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L78
Inherited from
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
requestBody
readonlyrequestBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L84
Inherited from
responseBody
readonlyresponseBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L85
Inherited from
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
timestamp
readonlytimestamp:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L77
Inherited from
url
readonlyurl:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L83
Inherited from
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
AxAIServiceError.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
AxAIServiceError.stackTraceLimit
Methods
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L97
Returns a string representation of an object.
Returns
string
Inherited from
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
> AxAIServiceAuthenticationError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L232
Extends
Constructors
new AxAIServiceAuthenticationError()
new AxAIServiceAuthenticationError(
url,requestBody,responseBody,context?):AxAIServiceAuthenticationError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L233
Parameters
| Parameter | Type |
|---|---|
url | string |
requestBody | unknown |
responseBody | unknown |
context? | Record<string, unknown> |
Returns
AxAIServiceAuthenticationError
Overrides
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
context
readonlycontext:Record<string,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L79
Inherited from
errorId
readonlyerrorId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L78
Inherited from
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
requestBody
readonlyrequestBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L84
Inherited from
responseBody
readonlyresponseBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L85
Inherited from
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
timestamp
readonlytimestamp:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L77
Inherited from
url
readonlyurl:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L83
Inherited from
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
AxAIServiceError.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
AxAIServiceError.stackTraceLimit
Methods
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L97
Returns a string representation of an object.
Returns
string
Inherited from
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
> AxAIServiceError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L76
Extends
Error
Extended by
AxAIServiceAbortedErrorAxAIServiceAuthenticationErrorAxAIServiceNetworkErrorAxAIServiceResponseErrorAxAIServiceStatusErrorAxAIServiceStreamTerminatedErrorAxAIServiceTimeoutError
Constructors
new AxAIServiceError()
new AxAIServiceError(
message,url,requestBody,responseBody,context):AxAIServiceError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L81
Parameters
| Parameter | Type |
|---|---|
message | string |
url | string |
requestBody | unknown |
responseBody | unknown |
context | Record<string, unknown> |
Returns
Overrides
Error.constructor
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Error.cause
context
readonlycontext:Record<string,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L79
errorId
readonlyerrorId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L78
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Error.message
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Error.name
requestBody
readonlyrequestBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L84
responseBody
readonlyresponseBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L85
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Error.stack
timestamp
readonlytimestamp:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L77
url
readonlyurl:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L83
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
Error.stackTraceLimit
Methods
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L97
Returns a string representation of an object.
Returns
string
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTrace
> AxAIServiceNetworkError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L139
Extends
Constructors
new AxAIServiceNetworkError()
new AxAIServiceNetworkError(
originalError,url,requestBody,responseBody,context?):AxAIServiceNetworkError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L140
Parameters
| Parameter | Type |
|---|---|
originalError | Error |
url | string |
requestBody | unknown |
responseBody | unknown |
context? | Record<string, unknown> |
Returns
Overrides
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
context
readonlycontext:Record<string,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L79
Inherited from
errorId
readonlyerrorId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L78
Inherited from
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalError
readonlyoriginalError:Error
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L141
requestBody
readonlyrequestBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L84
Inherited from
responseBody
readonlyresponseBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L85
Inherited from
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
timestamp
readonlytimestamp:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L77
Inherited from
url
readonlyurl:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L83
Inherited from
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
AxAIServiceError.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
AxAIServiceError.stackTraceLimit
Methods
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L97
Returns a string representation of an object.
Returns
string
Inherited from
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
> AxAIServiceResponseError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L163
Extends
Constructors
new AxAIServiceResponseError()
new AxAIServiceResponseError(
message,url,requestBody?,context?):AxAIServiceResponseError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L164
Parameters
| Parameter | Type |
|---|---|
message | string |
url | string |
requestBody? | unknown |
context? | Record<string, unknown> |
Returns
Overrides
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
context
readonlycontext:Record<string,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L79
Inherited from
errorId
readonlyerrorId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L78
Inherited from
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
requestBody
readonlyrequestBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L84
Inherited from
responseBody
readonlyresponseBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L85
Inherited from
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
timestamp
readonlytimestamp:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L77
Inherited from
url
readonlyurl:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L83
Inherited from
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
AxAIServiceError.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
AxAIServiceError.stackTraceLimit
Methods
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L97
Returns a string representation of an object.
Returns
string
Inherited from
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
> AxAIServiceStatusError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L120
Extends
Constructors
new AxAIServiceStatusError()
new AxAIServiceStatusError(
status,statusText,url,requestBody,responseBody,context?):AxAIServiceStatusError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L121
Parameters
| Parameter | Type |
|---|---|
status | number |
statusText | string |
url | string |
requestBody | unknown |
responseBody | unknown |
context? | Record<string, unknown> |
Returns
Overrides
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
context
readonlycontext:Record<string,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L79
Inherited from
errorId
readonlyerrorId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L78
Inherited from
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
requestBody
readonlyrequestBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L84
Inherited from
responseBody
readonlyresponseBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L85
Inherited from
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
status
readonlystatus:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L122
statusText
readonlystatusText:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L123
timestamp
readonlytimestamp:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L77
Inherited from
url
readonlyurl:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L83
Inherited from
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
AxAIServiceError.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
AxAIServiceError.stackTraceLimit
Methods
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L97
Returns a string representation of an object.
Returns
string
Inherited from
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
> AxAIServiceTimeoutError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L196
Extends
Constructors
new AxAIServiceTimeoutError()
new AxAIServiceTimeoutError(
url,timeoutMs,requestBody?,context?):AxAIServiceTimeoutError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L197
Parameters
| Parameter | Type |
|---|---|
url | string |
timeoutMs | number |
requestBody? | unknown |
context? | Record<string, unknown> |
Returns
Overrides
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
context
readonlycontext:Record<string,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L79
Inherited from
errorId
readonlyerrorId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L78
Inherited from
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
requestBody
readonlyrequestBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L84
Inherited from
responseBody
readonlyresponseBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L85
Inherited from
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
timestamp
readonlytimestamp:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L77
Inherited from
url
readonlyurl:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L83
Inherited from
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
AxAIServiceError.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
AxAIServiceError.stackTraceLimit
Methods
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L97
Returns a string representation of an object.
Returns
string
Inherited from
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
> AxAIServiceStreamTerminatedError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L175
Extends
Constructors
new AxAIServiceStreamTerminatedError()
new AxAIServiceStreamTerminatedError(
url,requestBody?,lastChunk?,context?):AxAIServiceStreamTerminatedError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L176
Parameters
| Parameter | Type |
|---|---|
url | string |
requestBody? | unknown |
lastChunk? | unknown |
context? | Record<string, unknown> |
Returns
AxAIServiceStreamTerminatedError
Overrides
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
context
readonlycontext:Record<string,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L79
Inherited from
errorId
readonlyerrorId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L78
Inherited from
lastChunk?
readonlyoptionallastChunk:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L179
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
requestBody
readonlyrequestBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L84
Inherited from
responseBody
readonlyresponseBody:unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L85
Inherited from
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
timestamp
readonlytimestamp:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L77
Inherited from
url
readonlyurl:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L83
Inherited from
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
AxAIServiceError.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
AxAIServiceError.stackTraceLimit
Methods
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L97
Returns a string representation of an object.
Returns
string
Inherited from
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
> AxAITogether
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/together/api.ts#L18
Extends
AxAIOpenAIBase<string,unknown>
Constructors
new AxAITogether()
new AxAITogether(
__namedParameters):AxAITogether
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/together/api.ts#L19
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxAITogetherArgs, "name">> |
Returns
Overrides
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<string>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<string, unknown>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Inherited from
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<unknown>> |
options? | Readonly<AxAIServiceActionOptions<string, unknown>> |
Returns
Promise<AxEmbedResponse>
Inherited from
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | string |
Returns
Inherited from
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Inherited from
getLastUsedChatModel()
getLastUsedChatModel():
undefined|string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | string
Inherited from
AxAIOpenAIBase.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
unknown
Inherited from
AxAIOpenAIBase.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Inherited from
AxAIOpenAIBase.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Inherited from
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Inherited from
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Inherited from
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Inherited from
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
Inherited from
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
Inherited from
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Inherited from
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Inherited from
> AxAgent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L135
An AI agent that can process inputs using an AI service and coordinate with child agents. Supports features like smart model routing and automatic input field passing to child agents.
Type Parameters
| Type Parameter | Default type |
|---|---|
IN extends AxGenIn | - |
OUT extends AxGenOut | AxGenOut |
Implements
Constructors
new AxAgent()
new AxAgent<
IN,OUT>(__namedParameters,options?):AxAgent<IN,OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L150
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<{ agents: AxAgentic[]; ai: Readonly<AxAIService<unknown, unknown>>; definition: string; description: string; functions: AxInputFunctionType; name: string; signature: string | AxSignature; }> |
options? | Readonly<AxAgentOptions> |
Returns
AxAgent<IN, OUT>
Methods
forward()
forward(
parentAi,values,options?):Promise<OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L353
Parameters
| Parameter | Type |
|---|---|
parentAi | Readonly<AxAIService<unknown, unknown>> |
values | IN |
options? | Readonly<AxProgramForwardOptions> |
Returns
Promise<OUT>
getFeatures()
getFeatures():
AxAgentFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L301
Returns
Implementation of
getFunction()
getFunction():
AxFunction
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L251
Returns
Implementation of
getTraces()
getTraces():
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L235
Returns
Implementation of
getUsage()
getUsage():
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L243
Returns
AxModelUsage & object[]
Implementation of
resetUsage()
resetUsage():
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L247
Returns
void
Implementation of
setDefinition()
setDefinition(
definition):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L395
Parameters
| Parameter | Type |
|---|---|
definition | string |
Returns
void
setDemos()
setDemos(
demos):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L239
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
Implementation of
setDescription()
setDescription(
description):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L386
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,options?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L220
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
Implementation of
setId()
setId(
id):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L227
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Implementation of
setParentId()
setParentId(
parentId):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L231
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
Implementation of
streamingForward()
streamingForward(
parentAi,values,options?):AxGenStreamingOut<OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L366
Parameters
| Parameter | Type |
|---|---|
parentAi | Readonly<AxAIService<unknown, unknown>> |
values | IN |
options? | Readonly<AxProgramStreamingForwardOptions> |
Returns
AxGenStreamingOut<OUT>
> AxApacheTika
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/tika.ts#L12
Constructors
new AxApacheTika()
new AxApacheTika(
args?):AxApacheTika
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/tika.ts#L16
Parameters
| Parameter | Type |
|---|---|
args? | Readonly<AxApacheTikaArgs> |
Returns
Methods
convert()
convert(
files,options?):Promise<string[]>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/tika.ts#L54
Parameters
| Parameter | Type |
|---|---|
files | Readonly<string[] | Blob[]> |
options? | Readonly<{ batchSize: number; format: "text" | "html"; }> |
Returns
Promise<string[]>
> AxBalancer
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L41
Balancer that rotates through services.
Implements
AxAIService<unknown,unknown>
Constructors
new AxBalancer()
new AxBalancer(
services,options?):AxBalancer
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L54
Parameters
| Parameter | Type |
|---|---|
services | readonly AxAIService<unknown, unknown>[] |
options? | AxBalancerOptions |
Returns
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L200
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Implementation of
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L260
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest> |
options? | Readonly<AxAIServiceActionOptions> |
Returns
Promise<AxEmbedResponse>
Implementation of
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L146
Parameters
| Parameter | Type |
|---|---|
model? | string |
Returns
Implementation of
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L142
Returns
string
Implementation of
getLastUsedChatModel()
getLastUsedChatModel():
unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L75
Returns
unknown
Implementation of
AxAIService.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L78
Returns
unknown
Implementation of
AxAIService.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L81
Returns
undefined | AxModelConfig
Implementation of
AxAIService.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L150
Returns
Implementation of
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L116
Returns
undefined | AxAIModelList
Implementation of
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L138
Returns
string
Implementation of
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L290
Returns
Readonly<AxAIServiceOptions>
Implementation of
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L286
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Implementation of
inputOrderComparator()
staticinputOrderComparator():number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L88
Service comparator that respects the input order of services.
Returns
number
metricComparator()
staticmetricComparator(a,b):number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L109
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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L62
Extended by
AxAIAnthropicAxAICohereAxAIGoogleGeminiAxAIHuggingFaceAxAIOpenAIBaseAxAIOpenAIResponsesBaseAxAIReka
Type Parameters
| Type Parameter |
|---|
TModel |
TEmbedModel |
TChatRequest |
TEmbedRequest |
TChatResponse |
TChatResponseDelta |
TEmbedResponse |
Implements
AxAIService<TModel,TEmbedModel>
Constructors
new AxBaseAI()
new AxBaseAI<
TModel,TEmbedModel,TChatRequest,TEmbedRequest,TChatResponse,TChatResponseDelta,TEmbedResponse>(aiImpl,__namedParameters):AxBaseAI<TModel,TEmbedModel,TChatRequest,TEmbedRequest,TChatResponse,TChatResponseDelta,TEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L126
Parameters
| Parameter | Type |
|---|---|
aiImpl | Readonly<AxAIServiceImpl<TModel, TEmbedModel, TChatRequest, TEmbedRequest, TChatResponse, TChatResponseDelta, TEmbedResponse>> |
__namedParameters | Readonly<AxBaseAIArgs<TModel, TEmbedModel>> |
Returns
AxBaseAI<TModel, TEmbedModel, TChatRequest, TEmbedRequest, TChatResponse, TChatResponseDelta, TEmbedResponse>
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L309
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<TModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<TModel, TEmbedModel>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Implementation of
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L599
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<TEmbedModel>> |
options? | Readonly<AxAIServiceActionOptions<TModel, TEmbedModel>> |
Returns
Promise<AxEmbedResponse>
Implementation of
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L248
Parameters
| Parameter | Type |
|---|---|
model? | TModel |
Returns
Implementation of
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L183
Returns
string
Implementation of
getLastUsedChatModel()
getLastUsedChatModel():
undefined|TModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L254
Returns
undefined | TModel
Implementation of
AxAIService.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|TEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L258
Returns
undefined | TEmbedModel
Implementation of
AxAIService.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L262
Returns
undefined | AxModelConfig
Implementation of
AxAIService.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L305
Returns
Implementation of
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L217
Returns
undefined | AxAIModelList
Implementation of
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L244
Returns
string
Implementation of
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L205
Returns
Readonly<AxAIServiceOptions>
Implementation of
setAPIURL()
setAPIURL(
apiURL):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L187
Parameters
| Parameter | Type |
|---|---|
apiURL | string |
Returns
void
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L191
Parameters
| Parameter | Type |
|---|---|
headers | () => Promise<Record<string, string>> |
Returns
void
setName()
setName(
name):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L179
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L195
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Implementation of
> AxAssertionError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L16
Extends
Error
Constructors
new AxAssertionError()
new AxAssertionError(
__namedParameters):AxAssertionError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L17
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<{ message: string; }> |
Returns
Overrides
Error.constructor
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Error.cause
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Error.message
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Error.name
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Error.stack
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
Error.stackTraceLimit
Methods
getFixingInstructions()
getFixingInstructions():
object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L26
Returns
object[]
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L39
Returns a string representation of an object.
Returns
string
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTrace
> AxBootstrapFewShot
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L51
Type Parameters
| Type Parameter | Default type |
|---|---|
IN extends AxGenIn | AxGenIn |
OUT extends AxGenOut | AxGenOut |
Constructors
new AxBootstrapFewShot()
new AxBootstrapFewShot<
IN,OUT>(__namedParameters):AxBootstrapFewShot<IN,OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L76
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<AxOptimizerArgs<IN, OUT>> |
Returns
AxBootstrapFewShot<IN, OUT>
Methods
compile()
compile(
metricFn,options?):Promise<{demos:AxProgramDemos[];stats:AxOptimizationStats; }>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L244
Parameters
| Parameter | Type |
|---|---|
metricFn | AxMetricFn |
options? | Readonly<undefined | { batchSize: number; costMonitoring: boolean; debugMode: boolean; earlyStoppingPatience: number; maxDemos: number; maxExamples: number; maxRounds: number; maxTokensPerGeneration: number; teacherAI: AxAIService<unknown, unknown>; verboseMode: boolean; }> |
Returns
Promise<{ demos: AxProgramDemos[]; stats: AxOptimizationStats; }>
getStats()
getStats():
AxOptimizationStats
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L281
Returns
> AxChainOfThought
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/cot.ts#L5
Extends
AxGen<IN,OUT>
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
IN extends AxGenIn | AxGenIn |
OUT extends AxGenOut | AxGenOut |
Constructors
new AxChainOfThought()
new AxChainOfThought<
IN,OUT>(signature,options?):AxChainOfThought<IN,OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/cot.ts#L9
Parameters
| Parameter | Type |
|---|---|
signature | Readonly<string | AxSignature> |
options? | Readonly<AxGenOptions & object> |
Returns
AxChainOfThought<IN, OUT>
Overrides
Methods
_forward1()
_forward1(
ai,values,options):AsyncGenerator<{delta:Partial<OUT>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L768
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | IN |
options | Readonly<AxProgramForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<OUT>; version: number; }, void, unknown>
Inherited from
addAssert()
addAssert(
fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L164
Parameters
| Parameter | Type |
|---|---|
fn | (values) => undefined | boolean | Promise<undefined | boolean> |
message? | string |
Returns
void
Inherited from
addFieldProcessor()
addFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L211
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
Inherited from
addStreamingAssert()
addStreamingAssert(
fieldName,fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L168
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | (content, done?) => undefined | boolean |
message? | string |
Returns
void
Inherited from
addStreamingFieldProcessor()
addStreamingFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L204
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
Inherited from
AxGen.addStreamingFieldProcessor
forward()
forward(
ai,values,options?):Promise<OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L844
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | IN |
options? | Readonly<AxProgramForwardOptions> |
Returns
Promise<OUT>
Inherited from
getSignature()
getSignature():
AxSignature
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L139
Returns
Inherited from
getTraces()
getTraces():
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L234
Returns
Inherited from
getUsage()
getUsage():
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L248
Returns
AxModelUsage & object[]
Inherited from
register()
register(
prog):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L143
Parameters
| Parameter | Type |
|---|---|
prog | Readonly<AxTunable & AxUsable> |
Returns
void
Inherited from
resetUsage()
resetUsage():
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L258
Returns
void
Inherited from
setDemos()
setDemos(
demos):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L265
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
Inherited from
setExamples()
setExamples(
examples,options?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L877
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
Inherited from
setId()
setId(
id):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L173
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Inherited from
setParentId()
setParentId(
parentId):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L180
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
Inherited from
streamingForward()
streamingForward(
ai,values,options?):AsyncGenerator<{delta:Partial<OUT>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L866
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | IN |
options? | Readonly<AxProgramStreamingForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<OUT>; version: number; }, void, unknown>
Inherited from
> AxDB
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/wrap.ts#L19
Implements
Constructors
new AxDB()
new AxDB(
args):AxDB
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/wrap.ts#L21
Parameters
| Parameter | Type |
|---|---|
args | Readonly<AxDBArgs> |
Returns
Methods
batchUpsert()
batchUpsert(
batchReq,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/wrap.ts#L46
Parameters
| Parameter | Type |
|---|---|
batchReq | readonly AxDBUpsertRequest[] |
update? | boolean |
Returns
Promise<AxDBUpsertResponse>
Implementation of
query()
query(
req):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/wrap.ts#L53
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
Returns
Promise<AxDBQueryResponse>
Implementation of
upsert()
upsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/wrap.ts#L39
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBUpsertRequest> |
update? | boolean |
Returns
Promise<AxDBUpsertResponse>
Implementation of
> AxDBBase
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L22
Extended by
Implements
Constructors
new AxDBBase()
new AxDBBase(
__namedParameters):AxDBBase
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L44
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<AxDBBaseArgs & object> |
Returns
Properties
_batchUpsert()?
optional_batchUpsert: (batchReq,update?,options?) =>Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L33
Parameters
| Parameter | Type |
|---|---|
batchReq | readonly AxDBUpsertRequest[] |
update? | boolean |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
_query()?
optional_query: (req,options?) =>Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L39
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBQueryResponse>
_upsert()?
optional_upsert: (req,update?,options?) =>Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L27
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBUpsertRequest> |
update? | boolean |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Methods
batchUpsert()
batchUpsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L88
Parameters
| Parameter | Type |
|---|---|
req | readonly AxDBUpsertRequest[] |
update? | boolean |
Returns
Promise<AxDBUpsertResponse>
Implementation of
query()
query(
req):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L128
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
Returns
Promise<AxDBQueryResponse>
Implementation of
upsert()
upsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L54
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBUpsertRequest> |
update? | boolean |
Returns
Promise<AxDBUpsertResponse>
Implementation of
> AxDBCloudflare
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L44
Cloudflare: DB Service
Extends
Constructors
new AxDBCloudflare()
new AxDBCloudflare(
__namedParameters):AxDBCloudflare
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L48
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxDBCloudflareArgs, "name">> |
Returns
Overrides
Properties
_batchUpsert()?
optional_batchUpsert: (batchReq,update?,options?) =>Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L33
Parameters
| Parameter | Type |
|---|---|
batchReq | readonly AxDBUpsertRequest[] |
update? | boolean |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Inherited from
_query()?
optional_query: (req,options?) =>Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L39
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBQueryResponse>
Inherited from
Methods
_upsert()
_upsert(
req,_update?,options?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L62
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBUpsertRequest> |
_update? | boolean |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Overrides
AxDBBase._upsert
batchUpsert()
batchUpsert(
batchReq,update?,options?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L98
Parameters
| Parameter | Type |
|---|---|
batchReq | readonly AxDBUpsertRequest[] |
update? | boolean |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Overrides
query()
query(
req,options?):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L147
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBQueryResponse>
Overrides
upsert()
upsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L30
Constructors
new AxDBManager()
new AxDBManager(
__namedParameters):AxDBManager
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L37
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<AxDBManagerArgs> |
Returns
Methods
insert()
insert(
text,options?):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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,__namedParameters):Promise<AxDBMatch[][]>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L20
MemoryDB: DB Service
Extends
Constructors
new AxDBMemory()
new AxDBMemory(
__namedParameters):AxDBMemory
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L23
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxDBMemoryArgs, "name">> |
Returns
Overrides
Methods
_batchUpsert()
_batchUpsert(
batchReq,update?,_options?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L50
Parameters
| Parameter | Type |
|---|---|
batchReq | readonly AxDBUpsertRequest[] |
update? | boolean |
_options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Overrides
AxDBBase._batchUpsert
_query()
_query(
req,_options?):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L65
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
_options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBQueryResponse>
Overrides
AxDBBase._query
_upsert()
_upsert(
req,_update?,_options?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L28
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBUpsertRequest> |
_update? | boolean |
_options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Overrides
AxDBBase._upsert
batchUpsert()
batchUpsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L100
Returns
void
getDB()
getDB():
AxDBState
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L92
Returns
query()
query(
req):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L128
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
Returns
Promise<AxDBQueryResponse>
Inherited from
setDB()
setDB(
state):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L96
Parameters
| Parameter | Type |
|---|---|
state | AxDBState |
Returns
void
upsert()
upsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L58
Pinecone: DB Service
Extends
Constructors
new AxDBPinecone()
new AxDBPinecone(
__namedParameters):AxDBPinecone
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L62
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxDBPineconeArgs, "name">> |
Returns
Overrides
Properties
_query()?
optional_query: (req,options?) =>Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L39
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBQueryResponse>
Inherited from
Methods
_batchUpsert()
_batchUpsert(
batchReq,_update?,options?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L85
Parameters
| Parameter | Type |
|---|---|
batchReq | readonly AxDBUpsertRequest[] |
_update? | boolean |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Overrides
AxDBBase._batchUpsert
_upsert()
_upsert(
req,update?,options?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L76
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBUpsertRequest> |
update? | boolean |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Overrides
AxDBBase._upsert
batchUpsert()
batchUpsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L88
Parameters
| Parameter | Type |
|---|---|
req | readonly AxDBUpsertRequest[] |
update? | boolean |
Returns
Promise<AxDBUpsertResponse>
Inherited from
query()
query(
req,options?):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L111
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBQueryResponse>
Overrides
upsert()
upsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L39
Weaviate: DB Service
Extends
Constructors
new AxDBWeaviate()
new AxDBWeaviate(
__namedParameters):AxDBWeaviate
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L43
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<Omit<AxDBWeaviateArgs, "name">> |
Returns
Overrides
Methods
_batchUpsert()
_batchUpsert(
batchReq,update?,options?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L93
Parameters
| Parameter | Type |
|---|---|
batchReq | readonly AxDBUpsertRequest[] |
update? | boolean |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Overrides
AxDBBase._batchUpsert
_query()
_query(
req,options?):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L138
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBQueryResponse>
Overrides
AxDBBase._query
_upsert()
_upsert(
req,update?,options?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L57
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBUpsertRequest> |
update? | boolean |
options? | Readonly<AxDBBaseOpOptions> |
Returns
Promise<AxDBUpsertResponse>
Overrides
AxDBBase._upsert
batchUpsert()
batchUpsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L88
Parameters
| Parameter | Type |
|---|---|
req | readonly AxDBUpsertRequest[] |
update? | boolean |
Returns
Promise<AxDBUpsertResponse>
Inherited from
query()
query(
req):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L128
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
Returns
Promise<AxDBQueryResponse>
Inherited from
upsert()
upsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L54
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBUpsertRequest> |
update? | boolean |
Returns
Promise<AxDBUpsertResponse>
Inherited from
> AxDefaultQueryRewriter
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/rewriter.ts#L5
Extends
Constructors
new AxDefaultQueryRewriter()
new AxDefaultQueryRewriter(
options?):AxDefaultQueryRewriter
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/rewriter.ts#L6
Parameters
| Parameter | Type |
|---|---|
options? | Readonly<AxGenOptions> |
Returns
Overrides
Methods
_forward1()
_forward1(
ai,values,options):AsyncGenerator<{delta:Partial<AxRewriteOut>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L768
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | AxRewriteIn |
options | Readonly<AxProgramForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<AxRewriteOut>; version: number; }, void, unknown>
Inherited from
addAssert()
addAssert(
fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L164
Parameters
| Parameter | Type |
|---|---|
fn | (values) => undefined | boolean | Promise<undefined | boolean> |
message? | string |
Returns
void
Inherited from
addFieldProcessor()
addFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L211
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
Inherited from
addStreamingAssert()
addStreamingAssert(
fieldName,fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L168
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | (content, done?) => undefined | boolean |
message? | string |
Returns
void
Inherited from
addStreamingFieldProcessor()
addStreamingFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L204
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
Inherited from
AxGen.addStreamingFieldProcessor
forward()
forward(
ai,values,options?):Promise<AxRewriteOut>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L844
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | AxRewriteIn |
options? | Readonly<AxProgramForwardOptions> |
Returns
Promise<AxRewriteOut>
Inherited from
getSignature()
getSignature():
AxSignature
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L139
Returns
Inherited from
getTraces()
getTraces():
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L234
Returns
Inherited from
getUsage()
getUsage():
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L248
Returns
AxModelUsage & object[]
Inherited from
register()
register(
prog):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L143
Parameters
| Parameter | Type |
|---|---|
prog | Readonly<AxTunable & AxUsable> |
Returns
void
Inherited from
resetUsage()
resetUsage():
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L258
Returns
void
Inherited from
setDemos()
setDemos(
demos):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L265
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
Inherited from
setExamples()
setExamples(
examples,options?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L877
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
Inherited from
setId()
setId(
id):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L173
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Inherited from
setParentId()
setParentId(
parentId):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L180
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
Inherited from
streamingForward()
streamingForward(
ai,values,options?):AsyncGenerator<{delta:Partial<AxRewriteOut>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L866
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | AxRewriteIn |
options? | Readonly<AxProgramStreamingForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<AxRewriteOut>; version: number; }, void, unknown>
Inherited from
> AxDefaultResultReranker
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/reranker.ts#L8
Extends
Constructors
new AxDefaultResultReranker()
new AxDefaultResultReranker(
options?):AxDefaultResultReranker
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/reranker.ts#L12
Parameters
| Parameter | Type |
|---|---|
options? | Readonly<AxGenOptions> |
Returns
Overrides
Methods
_forward1()
_forward1(
ai,values,options):AsyncGenerator<{delta:Partial<AxRerankerOut>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L768
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | AxRerankerIn |
options | Readonly<AxProgramForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<AxRerankerOut>; version: number; }, void, unknown>
Inherited from
addAssert()
addAssert(
fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L164
Parameters
| Parameter | Type |
|---|---|
fn | (values) => undefined | boolean | Promise<undefined | boolean> |
message? | string |
Returns
void
Inherited from
addFieldProcessor()
addFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L211
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
Inherited from
addStreamingAssert()
addStreamingAssert(
fieldName,fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L168
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | (content, done?) => undefined | boolean |
message? | string |
Returns
void
Inherited from
addStreamingFieldProcessor()
addStreamingFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L204
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
Inherited from
AxGen.addStreamingFieldProcessor
forward()
forward(
ai,input,options?):Promise<AxRerankerOut>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/reranker.ts#L19
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
input | Readonly<AxRerankerIn> |
options? | Readonly<AxProgramForwardOptions> |
Returns
Promise<AxRerankerOut>
Overrides
getSignature()
getSignature():
AxSignature
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L139
Returns
Inherited from
getTraces()
getTraces():
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L234
Returns
Inherited from
getUsage()
getUsage():
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L248
Returns
AxModelUsage & object[]
Inherited from
register()
register(
prog):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L143
Parameters
| Parameter | Type |
|---|---|
prog | Readonly<AxTunable & AxUsable> |
Returns
void
Inherited from
resetUsage()
resetUsage():
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L258
Returns
void
Inherited from
setDemos()
setDemos(
demos):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L265
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
Inherited from
setExamples()
setExamples(
examples,options?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L877
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
Inherited from
setId()
setId(
id):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L173
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Inherited from
setParentId()
setParentId(
parentId):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L180
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
Inherited from
streamingForward()
streamingForward(
ai,values,options?):AsyncGenerator<{delta:Partial<AxRerankerOut>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L866
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | AxRerankerIn |
options? | Readonly<AxProgramStreamingForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<AxRerankerOut>; version: number; }, void, unknown>
Inherited from
> AxDockerSession
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L56
Constructors
new AxDockerSession()
new AxDockerSession(
apiUrl):AxDockerSession
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L60
Parameters
| Parameter | Type | Default value |
|---|---|---|
apiUrl | string | 'http://localhost:2375' |
Returns
Methods
connectToContainer()
connectToContainer(
containerId):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L186
Parameters
| Parameter | Type |
|---|---|
containerId | string |
Returns
Promise<void>
createContainer()
createContainer(
__namedParameters):Promise<{Id:string; }>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L80
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<{ doNotPullImage: boolean; imageName: string; tag: string; volumes: object[]; }> |
Returns
Promise<{ Id: string; }>
executeCommand()
executeCommand(
command):Promise<string>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L274
Parameters
| Parameter | Type |
|---|---|
command | string |
Returns
Promise<string>
findOrCreateContainer()
findOrCreateContainer(
__namedParameters):Promise<{Id:string;isNew:boolean; }>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L263
Returns
Promise<string>
listContainers()
listContainers(
all):Promise<AxDockerContainer[]>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L256
Parameters
| Parameter | Type | Default value |
|---|---|---|
all | boolean | false |
Returns
Promise<AxDockerContainer[]>
pullImage()
pullImage(
imageName):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L169
Returns
Promise<void>
stopContainers()
stopContainers(
__namedParameters):Promise<object[]>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L373
Returns
> AxEmbeddingAdapter
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/embed.ts#L7
Constructors
new AxEmbeddingAdapter()
new AxEmbeddingAdapter(
__namedParameters):AxEmbeddingAdapter
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/embed.ts#L19
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<{ ai: AxAIService; func: (args, extra?) => Promise<unknown>; info: Readonly<{ argumentDescription: string; description: string; name: string; }>; }> |
Returns
Methods
toFunction()
toFunction():
AxFunction
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/embed.ts#L60
Returns
> AxFunctionError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/functions.ts#L15
Extends
Error
Constructors
new AxFunctionError()
new AxFunctionError(
fields):AxFunctionError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/functions.ts#L16
Parameters
| Parameter | Type |
|---|---|
fields | object[] |
Returns
Overrides
Error.constructor
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Error.cause
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Error.message
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Error.name
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Error.stack
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
Error.stackTraceLimit
Methods
getFields()
getFields():
object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/functions.ts#L26
Returns
object[]
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/functions.ts#L28
Returns a string representation of an object.
Returns
string
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTrace
> AxFunctionProcessor
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/functions.ts#L109
Constructors
new AxFunctionProcessor()
new AxFunctionProcessor(
funcList):AxFunctionProcessor
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/functions.ts#L112
Parameters
| Parameter | Type |
|---|---|
funcList | readonly AxFunction[] |
Returns
Methods
execute()
execute(
func,options?):Promise<string>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/functions.ts#L152
Parameters
| Parameter | Type |
|---|---|
func | Readonly<AxChatResponseFunctionCall> |
options? | Readonly<AxAIServiceActionOptions> |
Returns
Promise<string>
> AxGen
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L118
Extends
AxProgramWithSignature<IN,OUT>
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
IN extends AxGenIn | ReadonlyArray<AxMessage> | AxGenIn | ReadonlyArray<AxMessage> |
OUT extends AxGenerateResult<AxGenOut> | AxGenerateResult<AxGenOut> |
Constructors
new AxGen()
new AxGen<
IN,OUT>(signature,options?):AxGen<IN,OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L136
Parameters
| Parameter | Type |
|---|---|
signature | Readonly<string | AxSignature> |
options? | Readonly<AxGenOptions> |
Returns
AxGen<IN, OUT>
Overrides
AxProgramWithSignature.constructor
Methods
_forward1()
_forward1(
ai,values,options):AsyncGenerator<{delta:Partial<OUT>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L768
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | IN |
options | Readonly<AxProgramForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<OUT>; version: number; }, void, unknown>
addAssert()
addAssert(
fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L164
Parameters
| Parameter | Type |
|---|---|
fn | (values) => undefined | boolean | Promise<undefined | boolean> |
message? | string |
Returns
void
addFieldProcessor()
addFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L211
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
addStreamingAssert()
addStreamingAssert(
fieldName,fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L168
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | (content, done?) => undefined | boolean |
message? | string |
Returns
void
addStreamingFieldProcessor()
addStreamingFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L204
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
forward()
forward(
ai,values,options?):Promise<OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L844
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | IN |
options? | Readonly<AxProgramForwardOptions> |
Returns
Promise<OUT>
Overrides
AxProgramWithSignature.forward
getSignature()
getSignature():
AxSignature
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L139
Returns
Inherited from
AxProgramWithSignature.getSignature
getTraces()
getTraces():
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L234
Returns
Inherited from
AxProgramWithSignature.getTraces
getUsage()
getUsage():
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L248
Returns
AxModelUsage & object[]
Inherited from
AxProgramWithSignature.getUsage
register()
register(
prog):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L143
Parameters
| Parameter | Type |
|---|---|
prog | Readonly<AxTunable & AxUsable> |
Returns
void
Inherited from
AxProgramWithSignature.register
resetUsage()
resetUsage():
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L258
Returns
void
Inherited from
AxProgramWithSignature.resetUsage
setDemos()
setDemos(
demos):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L265
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
Inherited from
AxProgramWithSignature.setDemos
setExamples()
setExamples(
examples,options?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L877
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
Overrides
AxProgramWithSignature.setExamples
setId()
setId(
id):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L173
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Inherited from
setParentId()
setParentId(
parentId):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L180
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
Inherited from
AxProgramWithSignature.setParentId
streamingForward()
streamingForward(
ai,values,options?):AsyncGenerator<{delta:Partial<OUT>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L866
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | IN |
options? | Readonly<AxProgramStreamingForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<OUT>; version: number; }, void, unknown>
Overrides
> AxGenerateError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L912
Extends
Error
Constructors
new AxGenerateError()
new AxGenerateError(
message,details,options?):AxGenerateError
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L915
Parameters
| Parameter | Type |
|---|---|
message | string |
details | Readonly<AxGenerateErrorDetails> |
options? | ErrorOptions |
Returns
Overrides
Error.constructor
Properties
cause?
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Error.cause
details
readonlydetails:AxGenerateErrorDetails
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L913
message
message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Error.message
name
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Error.name
stack?
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Error.stack
prepareStackTrace()?
staticoptionalprepareStackTrace: (err,stackTraces) =>any
Defined in: node_modules/@types/node/globals.d.ts:143
Optional override for formatting stack traces
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTrace
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:145
Inherited from
Error.stackTraceLimit
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:136
Create .stack property on a target object
Parameters
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTrace
> AxHFDataLoader
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/loader.ts#L5
Constructors
new AxHFDataLoader()
new AxHFDataLoader(
__namedParameters):AxHFDataLoader
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/loader.ts#L14
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<{ config: string; dataset: string; options: Readonly<{ length: number; offset: number; }>; split: string; }> |
Returns
Methods
getData()
getData():
AxDataRow[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/loader.ts#L67
Returns
getRows()
getRows<
T>(__namedParameters):Promise<T[]>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/loader.ts#L51
Returns
Promise<AxDataRow[]>
setData()
setData(
rows):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/loader.ts#L63
Parameters
| Parameter | Type |
|---|---|
rows | AxDataRow[] |
Returns
void
> AxInstanceRegistry
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/registry.ts#L1
Type Parameters
| Type Parameter |
|---|
T |
Constructors
new AxInstanceRegistry()
new AxInstanceRegistry<
T>():AxInstanceRegistry<T>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/registry.ts#L4
Returns
Methods
[iterator]()
[iterator]():
Generator<T,void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/registry.ts#L12
Returns
Generator<T, void, unknown>
register()
register(
instance):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/registry.ts#L8
Parameters
| Parameter | Type |
|---|---|
instance | T |
Returns
void
> AxJSInterpreter
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/code.ts#L29
Constructors
new AxJSInterpreter()
new AxJSInterpreter(
__namedParameters):AxJSInterpreter
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/code.ts#L32
Parameters
| Parameter | Type |
|---|---|
__namedParameters | undefined | Readonly<{ permissions: readonly AxJSInterpreterPermission[]; }> |
Returns
Methods
toFunction()
toFunction():
AxFunction
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/code.ts#L67
Returns
> AxMCPClient
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/client.ts#L59
Constructors
new AxMCPClient()
new AxMCPClient(
transport,options):AxMCPClient
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/client.ts#L69
Parameters
| Parameter | Type |
|---|---|
transport | AxMCPTransport |
options | Readonly<AxMCPClientOptions> |
Returns
Methods
cancelRequest()
cancelRequest(
id):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/client.ts#L193
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
init()
init():
Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/client.ts#L74
Returns
Promise<void>
ping()
ping(
timeout):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/client.ts#L168
Parameters
| Parameter | Type | Default value |
|---|---|---|
timeout | number | 3000 |
Returns
Promise<void>
toFunction()
toFunction():
AxFunction[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/client.ts#L189
Returns
> AxMCPHTTPSSETransport
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L8
Implements
Constructors
new AxMCPHTTPSSETransport()
new AxMCPHTTPSSETransport(
sseUrl):AxMCPHTTPSSETransport
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L13
Parameters
| Parameter | Type |
|---|---|
sseUrl | string |
Returns
Methods
connect()
connect():
Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L17
Connects to the transport if needed This method is optional and only required for transports that need connection setup
Returns
Promise<void>
Implementation of
send()
send(
message):Promise<JSONRPCResponse<unknown>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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
sendNotification()
sendNotification(
message):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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
> AxMCPStdioTransport
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/stdioTransport.ts#L17
Implements
Constructors
new AxMCPStdioTransport()
new AxMCPStdioTransport(
config):AxMCPStdioTransport
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/stdioTransport.ts#L25
Parameters
| Parameter | Type |
|---|---|
config | Readonly<StdioTransportConfig> |
Returns
Methods
connect()
connect():
Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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
send()
send(
message):Promise<JSONRPCResponse<unknown>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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
sendNotification()
sendNotification(
message):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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
> AxMCPStreambleHTTPTransport
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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
Constructors
new AxMCPStreambleHTTPTransport()
new AxMCPStreambleHTTPTransport(
mcpEndpoint,options?):AxMCPStreambleHTTPTransport
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L113
Parameters
| Parameter | Type |
|---|---|
mcpEndpoint | string |
options? | AxMCPStreamableHTTPTransportOptions |
Returns
Methods
close()
close():
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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
getHeaders()
getHeaders():
Record<string,string>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L180
Opens an SSE stream to listen for server-initiated messages
Returns
Promise<void>
send()
send(
message):Promise<JSONRPCResponse<unknown>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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
sendNotification()
sendNotification(
message):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L136
Update authorization header (convenience method)
Parameters
| Parameter | Type |
|---|---|
authorization | string |
Returns
void
setHeaders()
setHeaders(
headers):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L165
Set a handler for incoming server messages (requests/notifications)
Parameters
| Parameter | Type |
|---|---|
handler | (message) => void |
Returns
void
terminateSession()
terminateSession():
Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L426
Explicitly terminate the session (if supported by server)
Returns
Promise<void>
> AxMemory
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L180
Implements
Constructors
new AxMemory()
new AxMemory(
limit,options?):AxMemory
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L184
Parameters
| Parameter | Type | Default value |
|---|---|---|
limit | number | defaultLimit |
options? | { debug: boolean; debugHideSystemPrompt: boolean; } | undefined |
options.debug? | boolean | undefined |
options.debugHideSystemPrompt? | boolean | undefined |
Returns
Methods
add()
add(
value,sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L206
Parameters
| Parameter | Type |
|---|---|
value | { cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; } | ({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[] |
sessionId? | string |
Returns
void
Implementation of
addResult()
addResult(
result,sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L213
Parameters
| Parameter | Type |
|---|---|
result | Readonly<AxChatResponseResult> |
sessionId? | string |
Returns
void
Implementation of
addTag()
addTag(
name,sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L224
Parameters
| Parameter | Type |
|---|---|
name | string |
sessionId? | string |
Returns
void
Implementation of
getLast()
getLast(
sessionId?):undefined| {chat: {cache:boolean;content:string;role:"system"; } | {content:string| ({cache:boolean;text:string;type:"text"; } | {cache:boolean;details:"high"|"low"|"auto";image:string;mimeType:string;type:"image"; } | {cache:boolean;data:string;format:"wav";type:"audio"; })[];name:string;role:"user"; } | {cache:boolean;content:string;functionCalls:object[];name:string;role:"assistant"; } | {cache:boolean;functionId:string;isError:boolean;result:string;role:"function"; };tags:string[]; }
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L236
Parameters
| Parameter | Type |
|---|---|
sessionId? | string |
Returns
undefined | { chat: { cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; }; tags: string[]; }
Implementation of
history()
history(
sessionId?): ({cache:boolean;content:string;role:"system"; } | {content:string| ({cache:boolean;text:string;type:"text"; } | {cache:boolean;details:"high"|"low"|"auto";image:string;mimeType:string;type:"image"; } | {cache:boolean;data:string;format:"wav";type:"audio"; })[];name:string;role:"user"; } | {cache:boolean;content:string;functionCalls:object[];name:string;role:"assistant"; } | {cache:boolean;functionId:string;isError:boolean;result:string;role:"function"; })[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L232
Parameters
| Parameter | Type |
|---|---|
sessionId? | string |
Returns
({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[]
Implementation of
reset()
reset(
sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L240
Parameters
| Parameter | Type |
|---|---|
sessionId? | string |
Returns
void
Implementation of
rewindToTag()
rewindToTag(
name,sessionId?): ({cache:boolean;content:string;role:"system"; } | {content:string| ({cache:boolean;text:string;type:"text"; } | {cache:boolean;details:"high"|"low"|"auto";image:string;mimeType:string;type:"image"; } | {cache:boolean;data:string;format:"wav";type:"audio"; })[];name:string;role:"user"; } | {cache:boolean;content:string;functionCalls:object[];name:string;role:"assistant"; } | {cache:boolean;functionId:string;isError:boolean;result:string;role:"function"; })[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L228
Parameters
| Parameter | Type |
|---|---|
name | string |
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
updateResult()
updateResult(
result,sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/memory.ts#L217
Parameters
| Parameter | Type |
|---|---|
result | Readonly<AxChatResponseResult> |
sessionId? | string |
Returns
void
Implementation of
> AxMiPRO
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L44
Type Parameters
| Type Parameter | Default type |
|---|---|
IN extends AxGenIn | AxGenIn |
OUT extends AxGenOut | AxGenOut |
Constructors
new AxMiPRO()
new AxMiPRO<
IN,OUT>(__namedParameters):AxMiPRO<IN,OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L70
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<AxOptimizerArgs<IN, OUT>> & object |
Returns
AxMiPRO<IN, OUT>
Methods
compile()
compile(
metricFn,options?):Promise<Readonly<AxProgram<IN,OUT>>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L795
The main compile method to run MIPROv2 optimization
Parameters
| Parameter | Type | Description |
|---|---|---|
metricFn | AxMetricFn | Evaluation metric function |
options? | Readonly<{ auto: "medium" | "light" | "heavy"; teacher: Readonly<AxProgram<IN, OUT>>; valset: readonly AxExample[]; }> | Optional configuration options |
Returns
Promise<Readonly<AxProgram<IN, OUT>>>
The optimized program
configureAuto()
configureAuto(
level):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L121
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
> AxMockAIService
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L48
Implements
Constructors
new AxMockAIService()
new AxMockAIService(
config):AxMockAIService
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L60
Parameters
| Parameter | Type |
|---|---|
config | AxMockAIServiceConfig |
Returns
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L97
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<unknown>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<unknown, unknown>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Implementation of
embed()
embed(
req,_options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L139
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest> |
_options? | Readonly<AxAIServiceActionOptions> |
Returns
Promise<AxEmbedResponse>
Implementation of
getFeatures()
getFeatures(
_model?):object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L82
Parameters
| Parameter | Type |
|---|---|
_model? | string |
Returns
object
functions
functions:
boolean
streaming
streaming:
boolean
Implementation of
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L77
Returns
string
Implementation of
getLastUsedChatModel()
getLastUsedChatModel():
unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L63
Returns
unknown
Implementation of
AxAIService.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L66
Returns
unknown
Implementation of
AxAIService.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L69
Returns
undefined | AxModelConfig
Implementation of
AxAIService.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L93
Returns
Implementation of
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L89
Returns
undefined | AxAIModelList
Implementation of
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L73
Returns
string
Implementation of
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L178
Returns
Readonly<AxAIServiceOptions>
Implementation of
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L174
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Implementation of
> AxMultiServiceRouter
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L24
Implements
AxAIService<string,string>
Constructors
new AxMultiServiceRouter()
new AxMultiServiceRouter(
services):AxMultiServiceRouter
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L43
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
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L121
Delegates the chat call to the service matching the provided model key.
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<string>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<string, string>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
Implementation of
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L151
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?):object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L219
If a model key is provided, delegate to the corresponding service’s features. Otherwise, returns a default feature set.
Parameters
| Parameter | Type |
|---|---|
model? | string |
Returns
object
functionCot?
optionalfunctionCot:boolean
functions
functions:
boolean
streaming
streaming:
boolean
Implementation of
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L182
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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L108
Returns
undefined | string
Implementation of
AxAIService.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L111
Returns
undefined | string
Implementation of
AxAIService.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L114
Returns
undefined | AxModelConfig
Implementation of
AxAIService.getLastUsedModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L238
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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L201
Aggregates all available models across the underlying services.
Returns
Implementation of
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L194
Returns the name of this router.
Returns
string
Implementation of
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L271
Returns the options from the last used service, or falls back to the first service if none has been used.
Returns
Readonly<AxAIServiceOptions>
Implementation of
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/multiservice.ts#L260
Sets options on all underlying services.
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
Implementation of
> AxProgram
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L278
Type Parameters
| Type Parameter |
|---|
IN extends AxGenIn |
OUT extends AxGenOut |
Implements
Constructors
new AxProgram()
new AxProgram<
IN,OUT>():AxProgram<IN,OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L287
Returns
AxProgram<IN, OUT>
Methods
forward()
forward(
_ai,_values,_options?):Promise<OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L299
Parameters
| Parameter | Type |
|---|---|
_ai | Readonly<AxAIService<unknown, unknown>> |
_values | IN |
_options? | Readonly<AxProgramForwardOptions> |
Returns
Promise<OUT>
getTraces()
getTraces():
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L348
Returns
Implementation of
getUsage()
getUsage():
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L362
Returns
AxModelUsage & object[]
Implementation of
register()
register(
prog):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L292
Parameters
| Parameter | Type |
|---|---|
prog | Readonly<AxTunable & AxUsable> |
Returns
void
resetUsage()
resetUsage():
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L372
Returns
void
Implementation of
setDemos()
setDemos(
demos):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L379
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
Implementation of
setExamples()
setExamples(
examples,options?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L335
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
Implementation of
setId()
setId(
id):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L322
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Implementation of
setParentId()
setParentId(
parentId):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L329
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
Implementation of
streamingForward()
streamingForward(
_ai,_values,_options?):AxGenStreamingOut<OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L311
Parameters
| Parameter | Type |
|---|---|
_ai | Readonly<AxAIService<unknown, unknown>> |
_values | IN |
_options? | Readonly<AxProgramStreamingForwardOptions> |
Returns
AxGenStreamingOut<OUT>
> AxProgramWithSignature
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L107
Extended by
Type Parameters
| Type Parameter |
|---|
IN extends AxGenIn | ReadonlyArray<AxMessage> |
OUT extends AxGenOut |
Implements
Constructors
new AxProgramWithSignature()
new AxProgramWithSignature<
IN,OUT>(signature,options?):AxProgramWithSignature<IN,OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L125
Parameters
| Parameter | Type |
|---|---|
signature | Readonly<string | AxSignature> |
options? | Readonly<AxProgramWithSignatureOptions> |
Returns
AxProgramWithSignature<IN, OUT>
Methods
forward()
forward(
_ai,_values,_options?):Promise<OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L150
Parameters
| Parameter | Type |
|---|---|
_ai | Readonly<AxAIService<unknown, unknown>> |
_values | IN |
_options? | Readonly<AxProgramForwardOptions> |
Returns
Promise<OUT>
getSignature()
getSignature():
AxSignature
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L139
Returns
getTraces()
getTraces():
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L234
Returns
Implementation of
getUsage()
getUsage():
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L248
Returns
AxModelUsage & object[]
Implementation of
register()
register(
prog):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L143
Parameters
| Parameter | Type |
|---|---|
prog | Readonly<AxTunable & AxUsable> |
Returns
void
resetUsage()
resetUsage():
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L258
Returns
void
Implementation of
setDemos()
setDemos(
demos):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L265
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
Implementation of
setExamples()
setExamples(
examples,options?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L186
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
Implementation of
setId()
setId(
id):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L173
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Implementation of
setParentId()
setParentId(
parentId):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L180
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
Implementation of
streamingForward()
streamingForward(
_ai,_values,_options?):AxGenStreamingOut<OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L162
Parameters
| Parameter | Type |
|---|---|
_ai | Readonly<AxAIService<unknown, unknown>> |
_values | IN |
_options? | Readonly<AxProgramStreamingForwardOptions> |
Returns
AxGenStreamingOut<OUT>
> AxPromptTemplate
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L43
Constructors
new AxPromptTemplate()
new AxPromptTemplate(
sig,options?,fieldTemplates?):AxPromptTemplate
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L52
Parameters
| Parameter | Type |
|---|---|
sig | Readonly<AxSignature> |
options? | Readonly<AxPromptTemplateOptions> |
fieldTemplates? | Record<string, AxFieldTemplateFn> |
Returns
Methods
render()
render<
T>(values,__namedParameters): ({cache:boolean;content:string;role:"system"; } | {content:string| ({cache:boolean;text:string;type:"text"; } | {cache:boolean;details:"high"|"low"|"auto";image:string;mimeType:string;type:"image"; } | {cache:boolean;data:string;format:"wav";type:"audio"; })[];name:string;role:"user"; } | {cache:boolean;content:string;functionCalls:object[];name:string;role:"assistant"; } | {cache:boolean;functionId:string;isError:boolean;result:string;role:"function"; })[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L109
Type Parameters
| Type Parameter |
|---|
T extends AxGenIn |
Parameters
| Parameter | Type |
|---|---|
values | readonly AxMessage[] | T |
__namedParameters | Readonly<{ demos: Record<string, AxFieldValue>[]; examples: Record<string, AxFieldValue>[]; skipSystemPrompt: boolean; }> |
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"; })[]
renderExtraFields()
renderExtraFields(
extraFields): ({cache:boolean;text:string;type:"text"; } | {cache:boolean;details:"high"|"low"|"auto";image:string;mimeType:string;type:"image"; } | {cache:boolean;data:string;format:"wav";type:"audio"; })[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L257
Parameters
| Parameter | Type |
|---|---|
extraFields | readonly AxIField[] |
Returns
({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]
> AxRAG
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/rag.ts#L12
Extends
AxChainOfThought<{context:string[];question:string; }, {answer:string; }>
Constructors
new AxRAG()
new AxRAG(
queryFn,options):AxRAG
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/rag.ts#L23
Parameters
| Parameter | Type |
|---|---|
queryFn | (query) => Promise<string> |
options | Readonly<AxGenOptions & object> |
Returns
Overrides
Methods
_forward1()
_forward1(
ai,values,options):AsyncGenerator<{delta:Partial<{answer:string; }>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L768
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | { context: string[]; question: string; } |
values.context | string[] |
values.question | string |
options | Readonly<AxProgramForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<{ answer: string; }>; version: number; }, void, unknown>
Inherited from
addAssert()
addAssert(
fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L164
Parameters
| Parameter | Type |
|---|---|
fn | (values) => undefined | boolean | Promise<undefined | boolean> |
message? | string |
Returns
void
Inherited from
addFieldProcessor()
addFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L211
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
Inherited from
AxChainOfThought.addFieldProcessor
addStreamingAssert()
addStreamingAssert(
fieldName,fn,message?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L168
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | (content, done?) => undefined | boolean |
message? | string |
Returns
void
Inherited from
AxChainOfThought.addStreamingAssert
addStreamingFieldProcessor()
addStreamingFieldProcessor(
fieldName,fn):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L204
Parameters
| Parameter | Type |
|---|---|
fieldName | string |
fn | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
Inherited from
AxChainOfThought.addStreamingFieldProcessor
forward()
forward(
ai,__namedParameters,options?):Promise<{answer:string; }>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/rag.ts#L44
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
__namedParameters | Readonly<{ question: string; }> |
options? | Readonly<AxProgramForwardOptions> |
Returns
Promise<{ answer: string; }>
Overrides
getSignature()
getSignature():
AxSignature
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L139
Returns
Inherited from
getTraces()
getTraces():
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L234
Returns
Inherited from
getUsage()
getUsage():
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L248
Returns
AxModelUsage & object[]
Inherited from
register()
register(
prog):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L143
Parameters
| Parameter | Type |
|---|---|
prog | Readonly<AxTunable & AxUsable> |
Returns
void
Inherited from
resetUsage()
resetUsage():
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L258
Returns
void
Inherited from
setDemos()
setDemos(
demos):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L265
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
Inherited from
setExamples()
setExamples(
examples,options?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L877
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
Inherited from
setId()
setId(
id):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L173
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Inherited from
setParentId()
setParentId(
parentId):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L180
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
Inherited from
streamingForward()
streamingForward(
ai,values,options?):AsyncGenerator<{delta:Partial<{answer:string; }>;version:number; },void,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L866
Parameters
| Parameter | Type |
|---|---|
ai | Readonly<AxAIService<unknown, unknown>> |
values | { context: string[]; question: string; } |
values.context | string[] |
values.question? | string |
options? | Readonly<AxProgramStreamingForwardOptions> |
Returns
AsyncGenerator<{ delta: Partial<{ answer: string; }>; version: number; }, void, unknown>
Inherited from
> AxRateLimiterTokenUsage
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/rate-limit.ts#L9
Constructors
new AxRateLimiterTokenUsage()
new AxRateLimiterTokenUsage(
maxTokens,refillRate,options?):AxRateLimiterTokenUsage
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/rate-limit.ts#L16
Parameters
| Parameter | Type |
|---|---|
maxTokens | number |
refillRate | number |
options? | Readonly<AxRateLimiterTokenUsageOptions> |
Returns
Methods
acquire()
acquire(
tokens):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L37
Constructors
new AxSignature()
new AxSignature(
signature?):AxSignature
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L45
Parameters
| Parameter | Type |
|---|---|
signature? | Readonly<string | AxSignature> |
Returns
Methods
addInputField()
addInputField(
field):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L118
Parameters
| Parameter | Type |
|---|---|
field | Readonly<AxField> |
Returns
void
addOutputField()
addOutputField(
field):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L123
Parameters
| Parameter | Type |
|---|---|
field | Readonly<AxField> |
Returns
void
getDescription()
getDescription():
undefined|string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L140
Returns
undefined | string
getInputFields()
getInputFields(): readonly
AxIField[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L138
Returns
readonly AxIField[]
getOutputFields()
getOutputFields(): readonly
AxIField[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L139
Returns
readonly AxIField[]
hash()
hash():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L210
Returns
string
setDescription()
setDescription(
desc):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L113
Parameters
| Parameter | Type |
|---|---|
desc | string |
Returns
void
setInputFields()
setInputFields(
fields):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L128
Parameters
| Parameter | Type |
|---|---|
fields | readonly AxField[] |
Returns
void
setOutputFields()
setOutputFields(
fields):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L133
Parameters
| Parameter | Type |
|---|---|
fields | readonly AxField[] |
Returns
void
toJSON()
toJSON():
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L214
Returns
object
description
description:
undefined|string
id
id:
string
inputFields
inputFields:
AxIField[]
outputFields
outputFields:
AxIField[]
toJSONSchema()
toJSONSchema():
AxFunctionJSONSchema
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L148
Returns
toString()
toString():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L212
Returns
string
> AxSimpleClassifier
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L30
Constructors
new AxSimpleClassifier()
new AxSimpleClassifier(
ai):AxSimpleClassifier
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L36
Parameters
| Parameter | Type |
|---|---|
ai | AxAIService |
Returns
Methods
forward()
forward(
text,options?):Promise<string>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L41
Returns
undefined | AxDBState
setClasses()
setClasses(
classes,options?):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L49
Parameters
| Parameter | Type |
|---|---|
classes | readonly AxSimpleClassifierClass[] |
options? | Readonly<{ abortSignal: AbortSignal; }> |
Returns
Promise<void>
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L108
Parameters
| Parameter | Type |
|---|---|
options | Readonly<{ debug: boolean; }> |
Returns
void
setState()
setState(
state):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L45
Parameters
| Parameter | Type |
|---|---|
state | AxDBState |
Returns
void
> AxSimpleClassifierClass
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L12
Constructors
new AxSimpleClassifierClass()
new AxSimpleClassifierClass(
name,context):AxSimpleClassifierClass
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L16
Parameters
| Parameter | Type |
|---|---|
name | string |
context | readonly string[] |
Returns
Methods
getContext()
getContext(): readonly
string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L25
Returns
readonly string[]
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L21
Returns
string
> AxTestPrompt
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/evaluate.ts#L14
Type Parameters
| Type Parameter | Default type |
|---|---|
IN extends AxGenIn | AxGenIn |
OUT extends AxGenOut | AxGenOut |
Constructors
new AxTestPrompt()
new AxTestPrompt<
IN,OUT>(__namedParameters):AxTestPrompt<IN,OUT>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/evaluate.ts#L22
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Readonly<AxEvaluateArgs<IN, OUT>> |
Returns
AxTestPrompt<IN, OUT>
Methods
run()
run(
metricFn):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/evaluate.ts#L35
Parameters
| Parameter | Type |
|---|---|
metricFn | AxMetricFn |
Returns
Promise<void>
> AxAIAnthropicVertexModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L17
Enumeration Members
Claude35Haiku
Claude35Haiku:
"claude-3-5-haiku"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L19
Claude35Sonnet
Claude35Sonnet:
"claude-3-5-sonnet"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L20
Claude35SonnetV2
Claude35SonnetV2:
"claude-3-5-sonnet-v2"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L21
Claude37Sonnet
Claude37Sonnet:
"claude-3-7-sonnet"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L18
Claude3Haiku
Claude3Haiku:
"claude-3-haiku"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L22
Claude3Opus
Claude3Opus:
"claude-3-opus"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L23
> AxAIAnthropicModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L3
Enumeration Members
Claude21
Claude21:
"claude-2.1"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L13
Claude35Haiku
Claude35Haiku:
"claude-3-5-haiku-latest"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L7
Claude35Sonnet
Claude35Sonnet:
"claude-3-5-sonnet-latest"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L6
Claude37Sonnet
Claude37Sonnet:
"claude-3-7-sonnet-latest"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L4
Claude3Haiku
Claude3Haiku:
"claude-3-haiku-20240307"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L11
Claude3Opus
Claude3Opus:
"claude-3-opus-latest"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L9
Claude3Sonnet
Claude3Sonnet:
"claude-3-sonnet-20240229"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L10
ClaudeInstant12
ClaudeInstant12:
"claude-instant-1.2"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L14
> AxAICohereEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L16
Cohere: Models for use in embeddings
Enumeration Members
EmbedEnglishLightV30
EmbedEnglishLightV30:
"embed-english-light-v3.0"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L18
EmbedEnglishV30
EmbedEnglishV30:
"embed-english-v3.0"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L17
EmbedMultiLingualLightV30
EmbedMultiLingualLightV30:
"embed-multilingual-light-v3.0"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L20
EmbedMultiLingualV30
EmbedMultiLingualV30:
"embed-multilingual-v3.0"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L19
> AxAICohereModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L6
Cohere: Models for text generation
Enumeration Members
Command
Command:
"command"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L9
CommandLight
CommandLight:
"command-light"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L10
CommandR
CommandR:
"command-r"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L8
CommandRPlus
CommandRPlus:
"command-r-plus"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L7
> AxAIDeepSeekModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/types.ts#L4
DeepSeek: Models for text generation
Enumeration Members
DeepSeekChat
DeepSeekChat:
"deepseek-chat"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/types.ts#L5
DeepSeekCoder
DeepSeekCoder:
"deepseek-coder"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/types.ts#L6
DeepSeekReasoner
DeepSeekReasoner:
"deepseek-reasoner"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/types.ts#L7
> AxAIGoogleGeminiEmbedModel
Enumeration Members
GeminiEmbedding
GeminiEmbedding:
"gemini-embedding-exp-03-07"
TextEmbedding004
TextEmbedding004:
"text-embedding-004"
TextEmbedding005
TextEmbedding005:
"text-embedding-005"
TextEmbeddingLarge
TextEmbeddingLarge:
"text-embedding-large-exp-03-07"
> AxAIGoogleGeminiEmbedTypes
Enumeration Members
Classification
Classification:
"CLASSIFICATION"
Clustering
Clustering:
"CLUSTERING"
CodeRetrievalQuery
CodeRetrievalQuery:
"CODE_RETRIEVAL_QUERY"
FactVerification
FactVerification:
"FACT_VERIFICATION"
QuestionAnswering
QuestionAnswering:
"QUESTION_ANSWERING"
RetrievalDocument
RetrievalDocument:
"RETRIEVAL_DOCUMENT"
RetrievalQuery
RetrievalQuery:
"RETRIEVAL_QUERY"
SemanticSimilarity
SemanticSimilarity:
"SEMANTIC_SIMILARITY"
> AxAIGoogleGeminiModel
Enumeration Members
Gemini15Flash
Gemini15Flash:
"gemini-1.5-flash"
Gemini15Flash002
Gemini15Flash002:
"gemini-1.5-flash-002"
Gemini15Flash8B
Gemini15Flash8B:
"gemini-1.5-flash-8b"
Gemini15Pro
Gemini15Pro:
"gemini-1.5-pro"
Gemini1Pro
Gemini1Pro:
"gemini-1.0-pro"
Gemini20Flash
Gemini20Flash:
"gemini-2.0-flash"
Gemini20FlashLite
Gemini20FlashLite:
"gemini-2.0-flash-lite-preview-02-05"
Gemini25Flash
Gemini25Flash:
"gemini-2.5-flash-preview-04-17"
Gemini25Pro
Gemini25Pro:
"gemini-2.5-pro-preview-05-06"
> AxAIGoogleGeminiSafetyCategory
Enumeration Members
HarmCategoryDangerousContent
HarmCategoryDangerousContent:
"HARM_CATEGORY_DANGEROUS_CONTENT"
HarmCategoryHarassment
HarmCategoryHarassment:
"HARM_CATEGORY_HARASSMENT"
HarmCategoryHateSpeech
HarmCategoryHateSpeech:
"HARM_CATEGORY_HATE_SPEECH"
HarmCategorySexuallyExplicit
HarmCategorySexuallyExplicit:
"HARM_CATEGORY_SEXUALLY_EXPLICIT"
> AxAIGoogleGeminiSafetyThreshold
Enumeration Members
BlockDefault
BlockDefault:
"HARM_BLOCK_THRESHOLD_UNSPECIFIED"
BlockLowAndAbove
BlockLowAndAbove:
"BLOCK_LOW_AND_ABOVE"
BlockMediumAndAbove
BlockMediumAndAbove:
"BLOCK_MEDIUM_AND_ABOVE"
BlockNone
BlockNone:
"BLOCK_NONE"
BlockOnlyHigh
BlockOnlyHigh:
"BLOCK_ONLY_HIGH"
> AxAIGrokEmbedModels
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/types.ts#L10
Enumeration Members
GrokEmbedSmall
GrokEmbedSmall:
"grok-embed-small"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/types.ts#L11
> AxAIGrokModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/types.ts#L3
Enumeration Members
Grok3
Grok3:
"grok-3"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/types.ts#L4
Grok3Fast
Grok3Fast:
"grok-3-fast"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/types.ts#L6
Grok3Mini
Grok3Mini:
"grok-3-mini"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/types.ts#L5
Grok3MiniFast
Grok3MiniFast:
"grok-3-mini-fast"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/types.ts#L7
> AxAIGroqModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/types.ts#L1
Enumeration Members
Gemma2_9B
Gemma2_9B:
"gemma2-9b-it"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/types.ts#L5
Llama3_8B
Llama3_8B:
"llama3-8b-8192"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/types.ts#L2
Llama33_70B
Llama33_70B:
"llama-3.3-70b-versatile"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/types.ts#L3
Mixtral_8x7B
Mixtral_8x7B:
"mixtral-8x7b-32768"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/types.ts#L4
> AxAIHuggingFaceModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/types.ts#L3
Enumeration Members
MetaLlama270BChatHF
MetaLlama270BChatHF:
"meta-llama/Llama-2-70b-chat-hf"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/types.ts#L4
> AxAIMistralEmbedModels
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L14
Enumeration Members
MistralEmbed
MistralEmbed:
"mistral-embed"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L15
> AxAIOpenAIEmbedModel
Enumeration Members
TextEmbedding3Large
TextEmbedding3Large:
"text-embedding-3-large"
TextEmbedding3Small
TextEmbedding3Small:
"text-embedding-3-small"
TextEmbeddingAda002
TextEmbeddingAda002:
"text-embedding-ada-002"
> AxAIMistralModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L3
Enumeration Members
Codestral
Codestral:
"codestral-latest"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L9
Mistral7B
Mistral7B:
"open-mistral-7b"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L4
Mistral8x7B
Mistral8x7B:
"open-mixtral-8x7b"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L5
MistralLarge
MistralLarge:
"mistral-large-latest"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L8
MistralNemo
MistralNemo:
"mistral-nemo-latest"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L7
MistralSmall
MistralSmall:
"mistral-small-latest"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L6
OpenCodestralMamba
OpenCodestralMamba:
"open-codestral-mamba"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L10
OpenMistralNemo
OpenMistralNemo:
"open-mistral-nemo-latest"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/types.ts#L11
> AxAIOpenAIModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/chat_types.ts#L3
Enumeration Members
GPT35TextDavinci002
GPT35TextDavinci002:
"text-davinci-002"
GPT35Turbo
GPT35Turbo:
"gpt-3.5-turbo"
GPT35TurboInstruct
GPT35TurboInstruct:
"gpt-3.5-turbo-instruct"
GPT3TextAda001
GPT3TextAda001:
"text-ada-001"
GPT3TextBabbage002
GPT3TextBabbage002:
"text-babbage-002"
GPT4
GPT4:
"gpt-4"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/chat_types.ts#L9
GPT41
GPT41:
"gpt-4.1"
GPT41Mini
GPT41Mini:
"gpt-4.1-mini"
GPT4ChatGPT4O
GPT4ChatGPT4O:
"chatgpt-4o-latest"
GPT4O
GPT4O:
"gpt-4o"
GPT4OMini
GPT4OMini:
"gpt-4o-mini"
GPT4Turbo
GPT4Turbo:
"gpt-4-turbo"
O1
O1:
"o1"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/chat_types.ts#L4
O1Mini
O1Mini:
"o1-mini"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/chat_types.ts#L6
O3
O3:
"o3"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/chat_types.ts#L5
O3Mini
O3Mini:
"o3-mini"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/chat_types.ts#L7
O4Mini
O4Mini:
"o4-mini"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/chat_types.ts#L8
> AxAIRekaModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/types.ts#L3
Enumeration Members
RekaCore
RekaCore:
"reka-core"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/types.ts#L4
RekaEdge
RekaEdge:
"reka-edge"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/types.ts#L6
RekaFlash
RekaFlash:
"reka-flash"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/types.ts#L5
> AxJSInterpreterPermission
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/code.ts#L11
Enumeration Members
CRYPTO
CRYPTO:
"crypto"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/code.ts#L15
FS
FS:
"node:fs"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/code.ts#L12
NET
NET:
"net"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/code.ts#L13
OS
OS:
"os"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/code.ts#L14
PROCESS
PROCESS:
"process"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/code.ts#L16
> AxLLMRequestTypeValues
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L54
Enumeration Members
CHAT
CHAT:
"chat"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L56
COMPLETION
COMPLETION:
"completion"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L55
RERANK
RERANK:
"rerank"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L57
UNKNOWN
UNKNOWN:
"unknown"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L58
> AxSpanKindValues
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L61
Enumeration Members
AGENT
AGENT:
"agent"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L64
TASK
TASK:
"task"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L63
TOOL
TOOL:
"tool"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L65
UNKNOWN
UNKNOWN:
"unknown"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L66
WORKFLOW
WORKFLOW:
"workflow"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L62
> axAIAnthropicDefaultConfig
axAIAnthropicDefaultConfig():
AxAIAnthropicConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L32
Returns
> axAIAnthropicVertexDefaultConfig
axAIAnthropicVertexDefaultConfig():
AxAIAnthropicConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L38
Returns
> axAIAzureOpenAIBestConfig
axAIAzureOpenAIBestConfig():
AxAIOpenAIConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/azure-openai/api.ts#L24
Returns
> axAIAzureOpenAICreativeConfig
axAIAzureOpenAICreativeConfig():
AxAIOpenAIConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/azure-openai/api.ts#L20
Returns
> axAIAzureOpenAIDefaultConfig
axAIAzureOpenAIDefaultConfig():
AxAIOpenAIConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/azure-openai/api.ts#L18
Returns
> axAIAzureOpenAIFastConfig
axAIAzureOpenAIFastConfig():
AxAIOpenAIConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/azure-openai/api.ts#L22
Returns
> axAICohereCreativeConfig
axAICohereCreativeConfig():
AxAICohereConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L40
Returns
> axAICohereDefaultConfig
axAICohereDefaultConfig():
AxAICohereConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L33
Returns
> axAIDeepSeekCodeConfig
axAIDeepSeekCodeConfig():
DeepSeekConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/api.ts#L19
Returns
DeepSeekConfig
> axAIDeepSeekDefaultConfig
axAIDeepSeekDefaultConfig():
DeepSeekConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/api.ts#L13
Returns
DeepSeekConfig
> axAIGoogleGeminiDefaultConfig
axAIGoogleGeminiDefaultConfig():
AxAIGoogleGeminiConfig
AxAIGoogleGemini: Default Model options for text generation
Returns
> axAIGoogleGeminiDefaultCreativeConfig
axAIGoogleGeminiDefaultCreativeConfig():
AxAIGoogleGeminiConfig
Returns
> axAIGrokBestConfig
axAIGrokBestConfig():
AxAIOpenAIConfig<AxAIGrokModel,GrokEmbedSmall>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L23
Returns
> axAIGrokDefaultConfig
axAIGrokDefaultConfig():
AxAIOpenAIConfig<AxAIGrokModel,GrokEmbedSmall>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L14
Returns
> axAIHuggingFaceDefaultConfig
axAIHuggingFaceDefaultConfig():
AxAIHuggingFaceConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L26
Returns
> axAIMistralBestConfig
axAIMistralBestConfig():
AxAIMistralConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/api.ts#L20
Returns
AxAIMistralConfig
> axAIHuggingFaceCreativeConfig
axAIHuggingFaceCreativeConfig():
AxAIHuggingFaceConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L32
Returns
> axAIMistralDefaultConfig
axAIMistralDefaultConfig():
AxAIMistralConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/api.ts#L14
Returns
AxAIMistralConfig
> axAIOllamaDefaultConfig
axAIOllamaDefaultConfig():
AxAIOllamaAIConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/ollama/api.ts#L10
Returns
> axAIOllamaDefaultCreativeConfig
axAIOllamaDefaultCreativeConfig():
AxAIOllamaAIConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/ollama/api.ts#L17
Returns
> axAIOpenAIBestConfig
axAIOpenAIBestConfig():
AxAIOpenAIConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L47
Returns
> axAIOpenAICreativeConfig
axAIOpenAICreativeConfig():
AxAIOpenAIConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L56
Returns
> axAIOpenAIDefaultConfig
axAIOpenAIDefaultConfig():
AxAIOpenAIConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L37
Returns
> axAIOpenAIFastConfig
axAIOpenAIFastConfig():
AxAIOpenAIConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L66
Returns
> axAIOpenAIResponsesBestConfig
axAIOpenAIResponsesBestConfig():
AxAIOpenAIResponsesConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Returns
AxAIOpenAIResponsesConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>
> axAIOpenAIResponsesCreativeConfig
axAIOpenAIResponsesCreativeConfig():
AxAIOpenAIResponsesConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Returns
AxAIOpenAIResponsesConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>
> axAIRekaCreativeConfig
axAIRekaCreativeConfig():
AxAIRekaConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L42
Returns
> axAIOpenAIResponsesDefaultConfig
axAIOpenAIResponsesDefaultConfig():
AxAIOpenAIResponsesConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Returns
AxAIOpenAIResponsesConfig<AxAIOpenAIModel, AxAIOpenAIEmbedModel>
> axAIRekaBestConfig
axAIRekaBestConfig():
AxAIRekaConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L36
Returns
> axAIRekaDefaultConfig
axAIRekaDefaultConfig():
AxAIRekaConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L30
Returns
> axAIRekaFastConfig
axAIRekaFastConfig():
AxAIRekaConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L48
Returns
> axAITogetherDefaultConfig
axAITogetherDefaultConfig():
TogetherAIConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/together/api.ts#L9
Returns
TogetherAIConfig
> axBaseAIDefaultConfig
axBaseAIDefaultConfig():
AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L48
Returns
> axBaseAIDefaultCreativeConfig
axBaseAIDefaultCreativeConfig():
AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L55
Returns
> AxAIAnthropicArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L44
Properties
apiKey?
optionalapiKey:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L46
config?
optionalconfig:Readonly<Partial<AxAIAnthropicConfig>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L49
models?
optionalmodels:AxAIInputModelList<AxAIAnthropicModel|AxAIAnthropicVertexModel,undefined>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L51
name
name:
"anthropic"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L45
options?
optionaloptions:Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L50
projectId?
optionalprojectId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L47
region?
optionalregion:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/api.ts#L48
> AxAIAnthropicContentBlockDeltaEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L178
Properties
delta
delta: {
text:string;type:"text_delta"; } | {partial_json:string;type:"input_json_delta"; }
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L181
index
index:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L179
type
type:
"content_block_delta"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L180
> AxAIAnthropicContentBlockStartEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L161
Properties
content_block
content_block: {
text:string;type:"text"; } | {id:string;input:object;name:string;type:"tool_use"; }
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L164
index
index:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L162
type
type:
"content_block_start"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L163
> AxAIAnthropicErrorEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L221
Properties
error
error:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L223
message
message:
string
type
type:
"overloaded_error"
type
type:
"error"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L222
> AxAIAnthropicContentBlockStopEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L193
Properties
index
index:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L195
type
type:
"content_block_stop"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L194
> AxAIAnthropicMessageDeltaEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L199
Properties
delta
delta:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L201
stop_reason
stop_reason:
null|"end_turn"|"max_tokens"|"stop_sequence"
stop_sequence
stop_sequence:
null|string
type
type:
"message_delta"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L200
usage
usage:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L205
output_tokens
output_tokens:
number
> AxAIAnthropicMessageStartEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L143
Properties
message
message:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L145
content
content: []
id
id:
string
model
model:
string
role
role:
"assistant"
stop_reason
stop_reason:
null|string
stop_sequence
stop_sequence:
null|string
type
type:
"message"
usage
{
input_tokens:number;output_tokens:number; }
type
type:
"message_start"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L144
> AxAIAnthropicMessageStopEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L211
Properties
type
type:
"message_stop"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L212
> AxAIAnthropicPingEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L216
Properties
type
type:
"ping"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L217
> AxAICohereArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L47
Properties
apiKey
apiKey:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L49
config?
optionalconfig:Readonly<Partial<AxAICohereConfig>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L50
models?
optionalmodels:AxAIInputModelList<AxAICohereModel,AxAICohereEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L52
name
name:
"cohere"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L48
options?
optionaloptions:Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/api.ts#L51
> AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L29
Properties
functionCot?
optionalfunctionCot:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L32
functions
functions:
boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L30
hasShowThoughts?
optionalhasShowThoughts:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L34
hasThinkingBudget?
optionalhasThinkingBudget:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L33
streaming
streaming:
boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L31
> AxAIGoogleGeminiArgs
Properties
apiKey?
optionalapiKey:string
config?
optionalconfig:Readonly<Partial<AxAIGoogleGeminiConfig>>
endpointId?
optionalendpointId:string
modelInfo?
optionalmodelInfo:AxModelInfo[]
models?
optionalmodels:AxAIInputModelList<AxAIGoogleGeminiModel,AxAIGoogleGeminiEmbedModel>
name
name:
"google-gemini"
options?
optionaloptions:Readonly<AxAIServiceOptions&AxAIGoogleGeminiOptionsTools>
projectId?
optionalprojectId:string
region?
optionalregion:string
> AxAIGoogleGeminiOptionsTools
Properties
codeExecution?
optionalcodeExecution:boolean
googleSearch?
optionalgoogleSearch:boolean
googleSearchRetrieval?
optionalgoogleSearchRetrieval:object
dynamicThreshold?
optionaldynamicThreshold:number
mode?
optionalmode:"MODE_DYNAMIC"
urlContext?
optionalurlContext:boolean
> AxAIGrokOptionsTools
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L42
Properties
searchParameters?
optionalsearchParameters:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L43
fromDate?
optionalfromDate:string
maxSearchResults?
optionalmaxSearchResults:number
mode?
optionalmode:"auto"|"on"|"off"
returnCitations?
optionalreturnCitations:boolean
sources?
optionalsources:AxAIGrokSearchSource[]
toDate?
optionaltoDate:string
> AxAIGrokSearchSource
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L32
Properties
allowedWebsites?
optionalallowedWebsites:string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L36
country?
optionalcountry:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L34
excludedWebsites?
optionalexcludedWebsites:string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L35
links?
optionallinks:string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L39
safeSearch?
optionalsafeSearch:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L37
type
type:
"web"|"x"|"news"|"rss"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L33
xHandles?
optionalxHandles:string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L38
> AxAIHuggingFaceArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L38
Properties
apiKey
apiKey:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L40
config?
optionalconfig:Readonly<Partial<AxAIHuggingFaceConfig>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L41
models?
optionalmodels:AxAIInputModelList<MetaLlama270BChatHF,undefined>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L43
name
name:
"huggingface"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L39
options?
optionaloptions:Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/api.ts#L42
> AxAIMemory
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/types.ts#L3
Methods
add()
add(
result,sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/types.ts#L4
Parameters
| Parameter | Type |
|---|---|
result | readonly ({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[] | Readonly<{ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; }> |
sessionId? | string |
Returns
void
addResult()
addResult(
result,sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/types.ts#L10
Parameters
| Parameter | Type |
|---|---|
result | Readonly<AxChatResponseResult> |
sessionId? | string |
Returns
void
addTag()
addTag(
name,sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/types.ts#L25
Parameters
| Parameter | Type |
|---|---|
name | string |
sessionId? | string |
Returns
void
getLast()
getLast(
sessionId?):undefined| {chat: {cache:boolean;content:string;role:"system"; } | {content:string| ({cache:boolean;text:string;type:"text"; } | {cache:boolean;details:"high"|"low"|"auto";image:string;mimeType:string;type:"image"; } | {cache:boolean;data:string;format:"wav";type:"audio"; })[];name:string;role:"user"; } | {cache:boolean;content:string;functionCalls:object[];name:string;role:"assistant"; } | {cache:boolean;functionId:string;isError:boolean;result:string;role:"function"; };tags:string[]; }
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/types.ts#L21
Parameters
| Parameter | Type |
|---|---|
sessionId? | string |
Returns
undefined | { chat: { cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; }; tags: string[]; }
history()
history(
sessionId?): ({cache:boolean;content:string;role:"system"; } | {content:string| ({cache:boolean;text:string;type:"text"; } | {cache:boolean;details:"high"|"low"|"auto";image:string;mimeType:string;type:"image"; } | {cache:boolean;data:string;format:"wav";type:"audio"; })[];name:string;role:"user"; } | {cache:boolean;content:string;functionCalls:object[];name:string;role:"assistant"; } | {cache:boolean;functionId:string;isError:boolean;result:string;role:"function"; })[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/types.ts#L18
Parameters
| Parameter | Type |
|---|---|
sessionId? | string |
Returns
({ cache: boolean; content: string; role: "system"; } | { content: string | ({ cache: boolean; text: string; type: "text"; } | { cache: boolean; details: "high" | "low" | "auto"; image: string; mimeType: string; type: "image"; } | { cache: boolean; data: string; format: "wav"; type: "audio"; })[]; name: string; role: "user"; } | { cache: boolean; content: string; functionCalls: object[]; name: string; role: "assistant"; } | { cache: boolean; functionId: string; isError: boolean; result: string; role: "function"; })[]
reset()
reset(
sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/types.ts#L19
Parameters
| Parameter | Type |
|---|---|
sessionId? | string |
Returns
void
rewindToTag()
rewindToTag(
name,sessionId?): ({cache:boolean;content:string;role:"system"; } | {content:string| ({cache:boolean;text:string;type:"text"; } | {cache:boolean;details:"high"|"low"|"auto";image:string;mimeType:string;type:"image"; } | {cache:boolean;data:string;format:"wav";type:"audio"; })[];name:string;role:"user"; } | {cache:boolean;content:string;functionCalls:object[];name:string;role:"assistant"; } | {cache:boolean;functionId:string;isError:boolean;result:string;role:"function"; })[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/types.ts#L26
Parameters
| Parameter | Type |
|---|---|
name | string |
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"; })[]
updateResult()
updateResult(
result,sessionId?):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mem/types.ts#L11
Parameters
| Parameter | Type |
|---|---|
result | Readonly<AxChatResponseResult> & object |
sessionId? | string |
Returns
void
> AxAIOpenAIArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L74
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
apiKey
apiKey:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L98
Inherited from
Omit.apiKey
apiURL?
optionalapiURL:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L99
Inherited from
Omit.apiURL
chatReqUpdater?
optionalchatReqUpdater:ChatReqUpdater<TModel,TChatReq>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L104
Inherited from
Omit.chatReqUpdater
config?
optionalconfig:Partial<Readonly<AxAIOpenAIConfig<TModel,TEmbedModel>>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L86
modelInfo?
optionalmodelInfo:AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L85
models?
optionalmodels:AxAIInputModelList<TModel,TEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L103
Inherited from
Omit.models
name
name:
TName
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L84
options?
optionaloptions:Readonly<AxAIServiceOptions&object>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L101
Inherited from
Omit.options
> AxAIOpenAIBaseArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L93
Type Parameters
| Type Parameter |
|---|
TModel |
TEmbedModel |
TChatReq extends AxAIOpenAIChatRequest<TModel> |
Properties
apiKey
apiKey:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L98
apiURL?
optionalapiURL:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L99
chatReqUpdater?
optionalchatReqUpdater:ChatReqUpdater<TModel,TChatReq>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L104
config
config:
Readonly<AxAIOpenAIConfig<TModel,TEmbedModel>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L100
modelInfo
modelInfo: readonly
AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L102
models?
optionalmodels:AxAIInputModelList<TModel,TEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L103
options?
optionaloptions:Readonly<AxAIServiceOptions&object>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L101
supportFor
supportFor:
AxAIFeatures| (model) =>AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/api.ts#L105
> AxAIOpenAIResponseDelta
Type Parameters
| Type Parameter |
|---|
T |
Properties
choices
choices:
object[]
delta
delta:
T
finish_reason
finish_reason:
"length"|"stop"|"content_filter"|"tool_calls"
index
index:
number
created
created:
number
id
id:
string
model
model:
string
object
object:
string
system_fingerprint
system_fingerprint:
string
usage?
optionalusage:AxAIOpenAIUsage
> AxAIOpenAIResponsesArgs
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 | AxAIOpenAIModel |
TEmbedModel | AxAIOpenAIEmbedModel |
TChatReq extends AxAIOpenAIResponsesRequest<TModel> | AxAIOpenAIResponsesRequest<TModel> |
Properties
apiKey
apiKey:
string
Inherited from
Omit.apiKey
apiURL?
optionalapiURL:string
Inherited from
Omit.apiURL
config?
optionalconfig:Partial<AxAIOpenAIResponsesConfig<TModel,TEmbedModel>>
modelInfo?
optionalmodelInfo:AxModelInfo[]
models?
optionalmodels:AxAIInputModelList<TModel,TEmbedModel>
Inherited from
Omit.models
name
name:
TName
options?
optionaloptions:object&AxAIServiceOptions
Type declaration
streamingUsage?
optionalstreamingUsage:boolean
Inherited from
Omit.options
responsesReqUpdater()?
optionalresponsesReqUpdater: (req) =>Readonly<TChatReq>
Parameters
| Parameter | Type |
|---|---|
req | Readonly<TChatReq> |
Returns
Readonly<TChatReq>
Inherited from
Omit.responsesReqUpdater
> AxAIOpenAIResponsesCodeInterpreterToolCall
Extends
Properties
code
code:
string
id
id:
string
Inherited from
AxAIOpenAIResponsesToolCallBase.id
results?
optionalresults:unknown[]
status?
optionalstatus:string
Inherited from
AxAIOpenAIResponsesToolCallBase.status
type
type:
"code_interpreter_call"
Overrides
> AxAIOpenAIResponsesComputerToolCall
Extends
Properties
action
action:
object
id
id:
string
Inherited from
AxAIOpenAIResponsesToolCallBase.id
status?
optionalstatus:string
Inherited from
AxAIOpenAIResponsesToolCallBase.status
type
type:
"computer_call"
Overrides
> AxAIOpenAIResponsesContentPartAddedEvent
Extends
Properties
content_index
readonlycontent_index:number
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
part
readonlypart:Readonly<AxAIOpenAIResponsesOutputTextContentPart|AxAIOpenAIResponsesOutputRefusalContentPart>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.content_part.added"
Overrides
> AxAIOpenAIResponsesContentPartDoneEvent
Extends
Properties
content_index
readonlycontent_index:number
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
part
readonlypart:Readonly<AxAIOpenAIResponsesOutputTextContentPart|AxAIOpenAIResponsesOutputRefusalContentPart>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.content_part.done"
Overrides
> AxAIOpenAIResponsesDefineFunctionTool
Properties
description?
readonlyoptionaldescription:string
name
readonlyname:string
parameters
readonlyparameters:object
strict?
readonlyoptionalstrict:boolean
type
readonlytype:"function"
> AxAIOpenAIResponsesErrorEvent
Extends
Properties
code
readonlycode:null|string
message
readonlymessage:string
param
readonlyparam:null|string
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"error"
Overrides
> AxAIOpenAIResponsesFileSearchCallCompletedEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.file_search_call.completed"
Overrides
> AxAIOpenAIResponsesFileSearchCallInProgressEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.file_search_call.in_progress"
Overrides
> AxAIOpenAIResponsesFileSearchCallSearchingEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.file_search_call.searching"
Overrides
> AxAIOpenAIResponsesFileSearchToolCall
Extends
Properties
id
id:
string
Inherited from
AxAIOpenAIResponsesToolCallBase.id
queries
queries:
string[]
results?
optionalresults:object[]
attributes?
optionalattributes:Record<string,string|number|boolean>
file_id
file_id:
string
filename
filename:
string
score
score:
number
text
text:
string
status?
optionalstatus:string
Inherited from
AxAIOpenAIResponsesToolCallBase.status
type
type:
"file_search_call"
Overrides
> AxAIOpenAIResponsesFunctionCallArgumentsDeltaEvent
Extends
Properties
delta
readonlydelta:string
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.function_call_arguments.delta"
Overrides
> AxAIOpenAIResponsesFunctionCallArgumentsDoneEvent
Extends
Properties
arguments
readonlyarguments:string
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.function_call_arguments.done"
Overrides
> AxAIOpenAIResponsesImageGenerationCallCompletedEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.image_generation_call.completed"
Overrides
> AxAIOpenAIResponsesFunctionCallItem
Properties
arguments
arguments:
string
call_id
call_id:
string
id
id:
string
name
name:
string
status?
optionalstatus:"in_progress"|"completed"|"incomplete"|"searching"|"failed"
type
type:
"function_call"
> AxAIOpenAIResponsesImageGenerationCallGeneratingEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.image_generation_call.generating"
Overrides
> AxAIOpenAIResponsesImageGenerationCallInProgressEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.image_generation_call.in_progress"
Overrides
> AxAIOpenAIResponsesImageGenerationCallPartialImageEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
partial_image_b64
readonlypartial_image_b64:string
partial_image_index
readonlypartial_image_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.image_generation_call.partial_image"
Overrides
> AxAIOpenAIResponsesImageGenerationToolCall
Extends
Properties
id
id:
string
Inherited from
AxAIOpenAIResponsesToolCallBase.id
result?
optionalresult:string
status?
optionalstatus:string
Inherited from
AxAIOpenAIResponsesToolCallBase.status
type
type:
"image_generation_call"
Overrides
> AxAIOpenAIResponsesInputAudioContentPart
Properties
input_audio
readonlyinput_audio:object
data
readonlydata:string
format?
readonlyoptionalformat:string
type
readonlytype:"input_audio"
> AxAIOpenAIResponsesInputFunctionCallItem
Properties
arguments
readonlyarguments:string
call_id
readonlycall_id:string
id?
readonlyoptionalid:string
name
readonlyname:string
type
readonlytype:"function_call"
> AxAIOpenAIResponsesInputFunctionCallOutputItem
Properties
call_id
readonlycall_id:string
id?
readonlyoptionalid:string
output
readonlyoutput:string
type
readonlytype:"function_call_output"
> AxAIOpenAIResponsesInputImageUrlContentPart
Properties
image_url
readonlyimage_url:object
details?
readonlyoptionaldetails:"high"|"low"|"auto"
url
readonlyurl:string
type
readonlytype:"image_url"
> AxAIOpenAIResponsesInputTextContentPart
Properties
text
text:
string
type
readonlytype:"text"
> AxAIOpenAIResponsesInputMessageItem
Properties
content
readonlycontent:string| readonlyAxAIOpenAIResponsesInputContentPart[]
name?
readonlyoptionalname:string
role
readonlyrole:"system"|"user"|"assistant"|"developer"
type
readonlytype:"message"
> AxAIOpenAIResponsesLocalShellToolCall
Extends
Properties
action
action:
object
id
id:
string
Inherited from
AxAIOpenAIResponsesToolCallBase.id
status?
optionalstatus:string
Inherited from
AxAIOpenAIResponsesToolCallBase.status
type
type:
"local_shell_call"
Overrides
> AxAIOpenAIResponsesMCPCallArgumentsDeltaEvent
Extends
Properties
delta
readonlydelta:object
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.mcp_call.arguments.delta"
Overrides
> AxAIOpenAIResponsesMCPCallArgumentsDoneEvent
Extends
Properties
arguments
readonlyarguments:object
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.mcp_call.arguments.done"
Overrides
> AxAIOpenAIResponsesMCPCallCompletedEvent
Extends
Properties
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.mcp_call.completed"
Overrides
> AxAIOpenAIResponsesMCPCallFailedEvent
Extends
Properties
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.mcp_call.failed"
Overrides
> AxAIOpenAIResponsesMCPCallInProgressEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.mcp_call.in_progress"
Overrides
> AxAIOpenAIResponsesMCPListToolsCompletedEvent
Extends
Properties
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.mcp_list_tools.completed"
Overrides
> AxAIOpenAIResponsesMCPListToolsInProgressEvent
Extends
Properties
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.mcp_list_tools.in_progress"
Overrides
> AxAIOpenAIResponsesMCPListToolsFailedEvent
Extends
Properties
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.mcp_list_tools.failed"
Overrides
> AxAIOpenAIResponsesMCPToolCall
Extends
Properties
args
args:
string
error?
optionalerror:string
id
id:
string
Inherited from
AxAIOpenAIResponsesToolCallBase.id
name
name:
string
output?
optionaloutput:string
server_label
server_label:
string
status?
optionalstatus:string
Inherited from
AxAIOpenAIResponsesToolCallBase.status
type
type:
"mcp_call"
Overrides
> AxAIOpenAIResponsesOutputItemAddedEvent
Extends
Properties
item
readonlyitem:Readonly<AxAIOpenAIResponsesOutputItem>
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.output_item.added"
Overrides
> AxAIOpenAIResponsesOutputItemDoneEvent
Extends
Properties
item
readonlyitem:Readonly<AxAIOpenAIResponsesOutputItem>
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.output_item.done"
Overrides
> AxAIOpenAIResponsesOutputMessageItem
Properties
content
content: readonly (
AxAIOpenAIResponsesOutputTextContentPart|AxAIOpenAIResponsesOutputRefusalContentPart)[]
id
id:
string
role
role:
"assistant"
status
status:
"in_progress"|"completed"|"incomplete"
type
type:
"message"
> AxAIOpenAIResponsesOutputRefusalContentPart
Properties
refusal
readonlyrefusal:string
type
readonlytype:"refusal"
> AxAIOpenAIResponsesOutputTextAnnotationAddedEvent
Extends
Properties
annotation
readonlyannotation:object
annotation_index
readonlyannotation_index:number
content_index
readonlycontent_index:number
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.output_text_annotation.added"
Overrides
> AxAIOpenAIResponsesOutputTextContentPart
Properties
annotations?
readonlyoptionalannotations: readonlyunknown[]
text
readonlytext:string
type
readonlytype:"output_text"
> AxAIOpenAIResponsesOutputTextDeltaEvent
Extends
Properties
content_index
readonlycontent_index:number
delta
readonlydelta:string
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.output_text.delta"
Overrides
> AxAIOpenAIResponsesOutputTextDoneEvent
Extends
Properties
content_index
readonlycontent_index:number
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
text
readonlytext:string
type
readonlytype:"response.output_text.done"
Overrides
> AxAIOpenAIResponsesReasoningDeltaEvent
Extends
Properties
content_index
readonlycontent_index:number
delta
readonlydelta:object
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.reasoning.delta"
Overrides
> AxAIOpenAIResponsesReasoningDoneEvent
Extends
Properties
content_index
readonlycontent_index:number
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
text
readonlytext:string
type
readonlytype:"response.reasoning.done"
Overrides
> AxAIOpenAIResponsesReasoningItem
Properties
encrypted_content?
readonlyoptionalencrypted_content:null|string
id
readonlyid:string
status?
readonlyoptionalstatus:"in_progress"|"completed"|"incomplete"
summary
readonlysummary: readonly (string|object)[]
type
readonlytype:"reasoning"
> AxAIOpenAIResponsesReasoningSummaryDeltaEvent
Extends
Properties
delta
readonlydelta:object
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
summary_index
readonlysummary_index:number
type
readonlytype:"response.reasoning_summary.delta"
Overrides
> AxAIOpenAIResponsesReasoningSummaryDoneEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
summary_index
readonlysummary_index:number
text
readonlytext:string
type
readonlytype:"response.reasoning_summary.done"
Overrides
> AxAIOpenAIResponsesReasoningSummaryPart
Properties
text
readonlytext:string
type
readonlytype:"summary_text"
> AxAIOpenAIResponsesReasoningSummaryPartAddedEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
part
readonlypart:Readonly<AxAIOpenAIResponsesReasoningSummaryPart>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
summary_index
readonlysummary_index:number
type
readonlytype:"response.reasoning_summary_part.added"
Overrides
> AxAIOpenAIResponsesReasoningSummaryPartDoneEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
part
readonlypart:Readonly<AxAIOpenAIResponsesReasoningSummaryPart>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
summary_index
readonlysummary_index:number
type
readonlytype:"response.reasoning_summary_part.done"
Overrides
> AxAIOpenAIResponsesReasoningSummaryTextDeltaEvent
Extends
Properties
delta
readonlydelta:string
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
summary_index
readonlysummary_index:number
type
readonlytype:"response.reasoning_summary_text.delta"
Overrides
> AxAIOpenAIResponsesReasoningSummaryTextDoneEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
summary_index
readonlysummary_index:number
text
readonlytext:string
type
readonlytype:"response.reasoning_summary_text.done"
Overrides
> AxAIOpenAIResponsesRefusalDeltaEvent
Extends
Properties
content_index
readonlycontent_index:number
delta
readonlydelta:string
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.refusal.delta"
Overrides
> AxAIOpenAIResponsesRefusalDoneEvent
Extends
Properties
content_index
readonlycontent_index:number
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
refusal
readonlyrefusal:string
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.refusal.done"
Overrides
> AxAIOpenAIResponsesRequest
Type Parameters
| Type Parameter | Default type |
|---|---|
TModel | string |
Properties
background?
readonlyoptionalbackground:null|boolean
include?
readonlyoptionalinclude: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
readonlyinput:string| readonlyAxAIOpenAIResponsesInputItem[]
instructions?
readonlyoptionalinstructions:null|string
max_output_tokens?
readonlyoptionalmax_output_tokens:null|number
metadata?
readonlyoptionalmetadata:null|Readonly<Record<string,string>>
model
readonlymodel:TModel
parallel_tool_calls?
readonlyoptionalparallel_tool_calls:null|boolean
previous_response_id?
readonlyoptionalprevious_response_id:null|string
reasoning?
readonlyoptionalreasoning:null| {effort:null|"high"|"low"|"medium";summary:null|"auto"|"concise"|"detailed"; }
seed?
readonlyoptionalseed:null|number
service_tier?
readonlyoptionalservice_tier:null|"auto"|"default"|"flex"
store?
readonlyoptionalstore:null|boolean
stream?
readonlyoptionalstream:null|boolean
temperature?
readonlyoptionaltemperature:null|number
text?
readonlyoptionaltext:null| {format:null| {type:"text"; } | {type:"json_object"; } | {json_schema:object;type:"json_schema"; }; }
tool_choice?
readonlyoptionaltool_choice:null|AxAIOpenAIResponsesToolChoice
tools?
readonlyoptionaltools:null| readonlyAxAIOpenAIResponsesDefineFunctionTool[]
top_p?
readonlyoptionaltop_p:null|number
truncation?
readonlyoptionaltruncation:null|"auto"|"disabled"
user?
readonlyoptionaluser:null|string
> AxAIOpenAIResponsesResponse
Properties
created
readonlycreated:number
id
readonlyid:string
model
readonlymodel:string
object
readonlyobject:string
output
readonlyoutput: readonlyAxAIOpenAIResponsesOutputItem[]
usage?
readonlyoptionalusage:null| {completion_tokens:number;prompt_tokens:number;total_tokens:number; }
> AxAIOpenAIResponsesResponseCompletedEvent
Extends
Properties
response
readonlyresponse:Readonly<AxAIOpenAIResponsesResponse>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.completed"
Overrides
> AxAIOpenAIResponsesResponseCreatedEvent
Extends
Properties
response
readonlyresponse:Readonly<AxAIOpenAIResponsesResponse>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.created"
Overrides
> AxAIOpenAIResponsesResponseDelta
Properties
delta?
readonlyoptionaldelta:object
arguments?
readonlyoptionalarguments:string
content?
readonlyoptionalcontent:string
event?
readonlyoptionalevent:string
id?
readonlyoptionalid:string
item?
readonlyoptionalitem:Partial<Readonly<AxAIOpenAIResponsesOutputItem>>
item_index?
readonlyoptionalitem_index:number
model?
readonlyoptionalmodel:string
response?
readonlyoptionalresponse:Readonly<AxAIOpenAIResponsesResponse>
usage?
readonlyoptionalusage:null| {completion_tokens:number;prompt_tokens:number;total_tokens:number; }
> AxAIOpenAIResponsesResponseFailedEvent
Extends
Properties
response
readonlyresponse:Readonly<AxAIOpenAIResponsesResponse>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.failed"
Overrides
> AxAIOpenAIResponsesResponseInProgressEvent
Extends
Properties
response
readonlyresponse:Readonly<AxAIOpenAIResponsesResponse>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.in_progress"
Overrides
> AxAIOpenAIResponsesResponseQueuedEvent
Extends
Properties
response
readonlyresponse:Readonly<AxAIOpenAIResponsesResponse>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.queued"
Overrides
> AxAIOpenAIResponsesResponseIncompleteEvent
Extends
Properties
response
readonlyresponse:Readonly<AxAIOpenAIResponsesResponse>
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.incomplete"
Overrides
> AxAIOpenAIResponsesStreamEventBase
Extended by
AxAIOpenAIResponsesContentPartAddedEventAxAIOpenAIResponsesContentPartDoneEventAxAIOpenAIResponsesErrorEventAxAIOpenAIResponsesFileSearchCallCompletedEventAxAIOpenAIResponsesFileSearchCallInProgressEventAxAIOpenAIResponsesFileSearchCallSearchingEventAxAIOpenAIResponsesFunctionCallArgumentsDeltaEventAxAIOpenAIResponsesFunctionCallArgumentsDoneEventAxAIOpenAIResponsesImageGenerationCallCompletedEventAxAIOpenAIResponsesImageGenerationCallGeneratingEventAxAIOpenAIResponsesImageGenerationCallInProgressEventAxAIOpenAIResponsesImageGenerationCallPartialImageEventAxAIOpenAIResponsesMCPCallArgumentsDeltaEventAxAIOpenAIResponsesMCPCallArgumentsDoneEventAxAIOpenAIResponsesMCPCallCompletedEventAxAIOpenAIResponsesMCPCallFailedEventAxAIOpenAIResponsesMCPCallInProgressEventAxAIOpenAIResponsesMCPListToolsCompletedEventAxAIOpenAIResponsesMCPListToolsFailedEventAxAIOpenAIResponsesMCPListToolsInProgressEventAxAIOpenAIResponsesOutputItemAddedEventAxAIOpenAIResponsesOutputItemDoneEventAxAIOpenAIResponsesOutputTextAnnotationAddedEventAxAIOpenAIResponsesOutputTextDeltaEventAxAIOpenAIResponsesOutputTextDoneEventAxAIOpenAIResponsesReasoningDeltaEventAxAIOpenAIResponsesReasoningDoneEventAxAIOpenAIResponsesReasoningSummaryDeltaEventAxAIOpenAIResponsesReasoningSummaryDoneEventAxAIOpenAIResponsesReasoningSummaryPartAddedEventAxAIOpenAIResponsesReasoningSummaryPartDoneEventAxAIOpenAIResponsesReasoningSummaryTextDeltaEventAxAIOpenAIResponsesReasoningSummaryTextDoneEventAxAIOpenAIResponsesRefusalDeltaEventAxAIOpenAIResponsesRefusalDoneEventAxAIOpenAIResponsesResponseCompletedEventAxAIOpenAIResponsesResponseCreatedEventAxAIOpenAIResponsesResponseFailedEventAxAIOpenAIResponsesResponseInProgressEventAxAIOpenAIResponsesResponseIncompleteEventAxAIOpenAIResponsesResponseQueuedEventAxAIOpenAIResponsesWebSearchCallCompletedEventAxAIOpenAIResponsesWebSearchCallInProgressEventAxAIOpenAIResponsesWebSearchCallSearchingEvent
Properties
sequence_number
readonlysequence_number:number
type
readonlytype:string
> AxAIOpenAIResponsesToolCallBase
Extended by
AxAIOpenAIResponsesCodeInterpreterToolCallAxAIOpenAIResponsesComputerToolCallAxAIOpenAIResponsesFileSearchToolCallAxAIOpenAIResponsesImageGenerationToolCallAxAIOpenAIResponsesLocalShellToolCallAxAIOpenAIResponsesMCPToolCallAxAIOpenAIResponsesWebSearchToolCall
Properties
id
id:
string
status?
optionalstatus:string
type
type:
string
> AxAIOpenAIResponsesWebSearchCallCompletedEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.web_search_call.completed"
Overrides
> AxAIOpenAIResponsesWebSearchCallInProgressEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.web_search_call.in_progress"
Overrides
> AxAIOpenAIResponsesWebSearchCallSearchingEvent
Extends
Properties
item_id
readonlyitem_id:string
output_index
readonlyoutput_index:number
sequence_number
readonlysequence_number:number
Inherited from
AxAIOpenAIResponsesStreamEventBase.sequence_number
type
readonlytype:"response.web_search_call.searching"
Overrides
> AxAIOpenAIResponsesWebSearchToolCall
Extends
Properties
id
id:
string
Inherited from
AxAIOpenAIResponsesToolCallBase.id
queries
queries:
string[]
status?
optionalstatus:string
Inherited from
AxAIOpenAIResponsesToolCallBase.status
type
type:
"web_search_call"
Overrides
> AxAIRekaArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L53
Properties
apiKey
apiKey:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L55
apiURL?
optionalapiURL:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L56
config?
optionalconfig:Readonly<Partial<AxAIRekaConfig>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L57
modelInfo?
optionalmodelInfo: readonlyAxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L59
models?
optionalmodels:AxAIInputModelList<AxAIRekaModel,undefined>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L60
name
name:
"reka"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L54
options?
optionaloptions:Readonly<AxAIServiceOptions&object>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/api.ts#L58
> AxAIService
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L270
Type Parameters
| Type Parameter | Default type |
|---|---|
TModel | unknown |
TEmbedModel | unknown |
Methods
chat()
chat(
req,options?):Promise<AxChatResponse|ReadableStream<AxChatResponse>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L281
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxChatRequest<TModel>> |
options? | Readonly<AxAIPromptConfig & AxAIServiceActionOptions<TModel, TEmbedModel>> |
Returns
Promise<AxChatResponse | ReadableStream<AxChatResponse>>
embed()
embed(
req,options?):Promise<AxEmbedResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L287
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxEmbedRequest<TEmbedModel>> |
options? | Readonly<AxAIServiceActionOptions<TModel, TEmbedModel>> |
Returns
Promise<AxEmbedResponse>
getFeatures()
getFeatures(
model?):AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L273
Parameters
| Parameter | Type |
|---|---|
model? | TModel |
Returns
getId()
getId():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L271
Returns
string
getLastUsedChatModel()
getLastUsedChatModel():
undefined|TModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L277
Returns
undefined | TModel
getLastUsedEmbedModel()
getLastUsedEmbedModel():
undefined|TEmbedModel
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L278
Returns
undefined | TEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig():
undefined|AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L279
Returns
undefined | AxModelConfig
getMetrics()
getMetrics():
AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L275
Returns
getModelList()
getModelList():
undefined|AxAIModelList
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L274
Returns
undefined | AxAIModelList
getName()
getName():
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L272
Returns
string
getOptions()
getOptions():
Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L293
Returns
Readonly<AxAIServiceOptions>
setOptions()
setOptions(
options):void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L292
Parameters
| Parameter | Type |
|---|---|
options | Readonly<AxAIServiceOptions> |
Returns
void
> AxAIServiceImpl
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L296
Type Parameters
| Type Parameter |
|---|
TModel |
TEmbedModel |
TChatRequest |
TEmbedRequest |
TChatResponse |
TChatResponseDelta |
TEmbedResponse |
Methods
createChatReq()
createChatReq(
req,config): [AxAPI,TChatRequest]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L305
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxInternalChatRequest<TModel>> |
config | Readonly<AxAIPromptConfig> |
Returns
[AxAPI, TChatRequest]
createChatResp()
createChatResp(
resp):AxChatResponse
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L310
Parameters
| Parameter | Type |
|---|---|
resp | Readonly<TChatResponse> |
Returns
createChatStreamResp()?
optionalcreateChatStreamResp(resp,state):AxChatResponse
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L312
Parameters
| Parameter | Type |
|---|---|
resp | Readonly<TChatResponseDelta> |
state | object |
Returns
createEmbedReq()?
optionalcreateEmbedReq(req): [AxAPI,TEmbedRequest]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L317
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxInternalEmbedRequest<TEmbedModel>> |
Returns
[AxAPI, TEmbedRequest]
createEmbedResp()?
optionalcreateEmbedResp(resp):AxEmbedResponse
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L321
Parameters
| Parameter | Type |
|---|---|
resp | Readonly<TEmbedResponse> |
Returns
getModelConfig()
getModelConfig():
AxModelConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L323
Returns
getTokenUsage()
getTokenUsage():
undefined|AxTokenUsage
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L325
Returns
undefined | AxTokenUsage
> AxAIServiceMetrics
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L185
Properties
errors
errors:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L200
chat
{
count:number;rate:number;total:number; }
embed
{
count:number;rate:number;total:number; }
latency
latency:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L186
chat
{
mean:number;p95:number;p99:number;samples:number[]; }
embed
{
mean:number;p95:number;p99:number;samples:number[]; }
> AxAPI
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L42
Extended by
Properties
headers?
optionalheaders:Record<string,string>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L44
name?
optionalname:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L43
put?
optionalput:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L45
> AxAPIConfig
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L49
Extends
AxAPI.RequestValidation.ResponseValidation
Properties
abortSignal?
optionalabortSignal:AbortSignal
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L60
debug?
optionaldebug:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L55
fetch()?
optionalfetch: (input,init?) =>Promise<Response>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L56
Parameters
| Parameter | Type |
|---|---|
input | string | URL | Request |
init? | RequestInit |
Returns
Promise<Response>
headers?
optionalheaders:Record<string,string>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L44
Inherited from
name?
optionalname:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L43
Inherited from
put?
optionalput:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L45
Inherited from
retry?
optionalretry:Partial<RetryConfig>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L59
span?
optionalspan:Span
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L57
stream?
optionalstream:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L54
timeout?
optionaltimeout:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L58
url
url:
string|URL
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L53
validateRequest()?
optionalvalidateRequest: (request) =>boolean|Promise<boolean>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L34
Parameters
| Parameter | Type |
|---|---|
request | unknown |
Returns
boolean | Promise<boolean>
Inherited from
RequestValidation.validateRequest
validateResponse()?
optionalvalidateResponse: (response) =>boolean|Promise<boolean>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/apicall.ts#L38
Parameters
| Parameter | Type |
|---|---|
response | unknown |
Returns
boolean | Promise<boolean>
Inherited from
ResponseValidation.validateResponse
> AxAgentFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L40
Properties
canConfigureSmartModelRouting
canConfigureSmartModelRouting:
boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L42
Whether this agent can use smart model routing (requires an AI service)
excludeFieldsFromPassthrough
excludeFieldsFromPassthrough:
string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L44
List of fields that this agent excludes from parent->child value passing
> AxAgentic
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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
Properties
getTraces()
getTraces: () =>
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L89
Returns
Inherited from
getUsage()
getUsage: () =>
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L94
Returns
AxModelUsage & object[]
Inherited from
resetUsage()
resetUsage: () =>
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L95
Returns
void
Inherited from
setDemos()
setDemos: (
demos) =>void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L90
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
Inherited from
setExamples()
setExamples: (
examples,options?) =>void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L83
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
Inherited from
setId()
setId: (
id) =>void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L87
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Inherited from
setParentId()
setParentId: (
parentId) =>void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L88
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
Inherited from
Methods
getFeatures()
getFeatures():
AxAgentFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L30
Returns
getFunction()
getFunction():
AxFunction
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L29
Returns
> AxApacheTikaArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/tika.ts#L3
Properties
fetch()?
optionalfetch: (input,init?) =>Promise<Response>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/tika.ts#L5
Parameters
| Parameter | Type |
|---|---|
input | string | URL | Request |
init? | RequestInit |
Returns
Promise<Response>
url?
optionalurl:string|URL
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/tika.ts#L4
> AxApacheTikaConvertOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/tika.ts#L8
Properties
format?
optionalformat:"text"|"html"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/tika.ts#L9
> AxAssertion
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L3
Properties
message?
optionalmessage:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L7
Methods
fn()
fn(
values):undefined|boolean|Promise<undefined|boolean>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L37
Type Parameters
| Type Parameter |
|---|
TModel |
TEmbedModel |
Properties
apiURL
apiURL:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L39
defaults
defaults:
Readonly<{embedModel:TEmbedModel;model:TModel; }>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L42
headers()
headers: () =>
Promise<Record<string,string>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L40
Returns
Promise<Record<string, string>>
modelInfo
modelInfo: readonly
AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L41
models?
optionalmodels:AxAIInputModelList<TModel,TEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L45
name
name:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L38
options?
optionaloptions:Readonly<AxAIServiceOptions>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L43
supportFor
supportFor:
AxAIFeatures| (model) =>AxAIFeatures
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/base.ts#L44
> AxDBBaseArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L13
Extended by
Properties
fetch()?
optionalfetch: (input,init?) =>Promise<Response>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L14
Parameters
| Parameter | Type |
|---|---|
input | string | URL | Request |
init? | RequestInit |
Returns
Promise<Response>
tracer?
optionaltracer:Tracer
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L15
> AxDBBaseOpOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L18
Properties
span?
optionalspan:Span
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L19
> AxDBCloudflareArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L34
Extends
Properties
accountId
accountId:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L37
apiKey
apiKey:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L36
fetch()?
optionalfetch: (input,init?) =>Promise<Response>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L38
Parameters
| Parameter | Type |
|---|---|
input | string | URL | Request |
init? | RequestInit |
Returns
Promise<Response>
Overrides
name
name:
"cloudflare"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L35
tracer?
optionaltracer:Tracer
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L15
Inherited from
> AxDBLoaderOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L11
Properties
chunker()?
optionalchunker: (text) =>string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L12
Parameters
| Parameter | Type |
|---|---|
text | string |
Returns
string[]
reranker?
optionalreranker:AxProgram<AxRerankerIn,AxRerankerOut>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L14
rewriter?
optionalrewriter:AxProgram<AxRewriteIn,AxRewriteOut>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L13
> AxDBManagerArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L17
Properties
ai
ai:
AxAIService
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L18
config?
optionalconfig:AxDBLoaderOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L20
db
db:
AxDBService
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L19
> AxDBMatch
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L23
Properties
score
score:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L24
text
text:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L25
> AxDBMemoryArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L11
Extends
Properties
fetch()?
optionalfetch: (input,init?) =>Promise<Response>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L14
Parameters
| Parameter | Type |
|---|---|
input | string | URL | Request |
init? | RequestInit |
Returns
Promise<Response>
Inherited from
name
name:
"memory"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L12
tracer?
optionaltracer:Tracer
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L15
Inherited from
> AxDBPineconeArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L48
Extends
Properties
apiKey
apiKey:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L50
fetch()?
optionalfetch: (input,init?) =>Promise<Response>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L52
Parameters
| Parameter | Type |
|---|---|
input | string | URL | Request |
init? | RequestInit |
Returns
Promise<Response>
Overrides
host
host:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L51
name
name:
"pinecone"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L49
tracer?
optionaltracer:Tracer
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L15
Inherited from
> AxDBQueryService
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/types.ts#L48
Extended by
Methods
query()
query(
req):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/types.ts#L36
Extends
Methods
batchUpsert()
batchUpsert(
batchReq,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/types.ts#L42
Parameters
| Parameter | Type |
|---|---|
batchReq | readonly AxDBUpsertRequest[] |
update? | boolean |
Returns
Promise<AxDBUpsertResponse>
query()
query(
req):Promise<AxDBQueryResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/types.ts#L49
Parameters
| Parameter | Type |
|---|---|
req | Readonly<AxDBQueryRequest> |
Returns
Promise<AxDBQueryResponse>
Inherited from
upsert()
upsert(
req,update?):Promise<AxDBUpsertResponse>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L29
Extends
Properties
apiKey
apiKey:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L31
fetch()?
optionalfetch: (input,init?) =>Promise<Response>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L33
Parameters
| Parameter | Type |
|---|---|
input | string | URL | Request |
init? | RequestInit |
Returns
Promise<Response>
Overrides
host
host:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L32
name
name:
"weaviate"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L30
tracer?
optionaltracer:Tracer
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/base.ts#L15
Inherited from
> AxDockerContainer
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L3
Properties
Command
Command:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L8
Created
Created:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L9
HostConfig
HostConfig:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L33
NetworkMode
NetworkMode:
string
Id
Id:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L4
Image
Image:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L6
ImageID
ImageID:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L7
Labels
Labels:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L30
Index Signature
[key: string]: string
Mounts
Mounts:
object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L46
Destination
Destination:
string
Mode
Mode:
string
Propagation
Propagation:
string
RW
RW:
boolean
Source
Source:
string
Type
Type:
string
Names
Names:
string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L5
NetworkSettings
NetworkSettings:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L36
Networks
{}
Ports
Ports:
object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L24
IP
IP:
string
PrivatePort
PrivatePort:
number
PublicPort
PublicPort:
number
Type
Type:
string
SizeRootFs
SizeRootFs:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L32
SizeRw
SizeRw:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L31
State
State:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L10
Dead
Dead:
boolean
Error
Error:
string
ExitCode
ExitCode:
number
FinishedAt
FinishedAt:
Date
OOMKilled
OOMKilled:
boolean
Paused
Paused:
boolean
Pid
Pid:
number
Restarting
Restarting:
boolean
Running
Running:
boolean
StartedAt
StartedAt:
Date
Status
Status:
string
Status
Status:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/funcs/docker.ts#L23
> AxField
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L12
Properties
description?
optionaldescription:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L15
isInternal?
optionalisInternal:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L32
isOptional?
optionalisOptional:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L31
name
name:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L13
title?
optionaltitle:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L14
type?
optionaltype:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L16
classes?
optionalclasses:string[]
isArray
isArray:
boolean
name
name:
"string"|"number"|"boolean"|"image"|"audio"|"code"|"json"|"datetime"|"date"|"class"
> AxFieldProcessor
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/fieldProcessor.ts#L24
Properties
field
field:
Readonly<AxField>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/fieldProcessor.ts#L25
process
process:
AxFieldProcessorProcess|AxStreamingFieldProcessorProcess
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/fieldProcessor.ts#L33
Process the field value and return a new value (or undefined if no update is needed). The returned value may be merged back into memory.
Param
The current field value.
Param
Additional context (e.g. memory and session id).
> AxGenOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L69
Properties
asserts?
optionalasserts:AxAssertion[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L85
description?
optionaldescription:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L76
excludeContentFromTrace?
optionalexcludeContentFromTrace:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L88
fastFail?
optionalfastFail:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L87
functionCall?
optionalfunctionCall:"auto"| {function: {name:string; };type:"function"; } |"none"|"required"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L82
functions?
optionalfunctions:AxInputFunctionType
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L81
maxRetries?
optionalmaxRetries:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L70
maxSteps?
optionalmaxSteps:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L71
mem?
optionalmem:AxAIMemory
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L72
optionalOutputFields?
optionaloptionalOutputFields:string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L79
promptTemplate?
optionalpromptTemplate: typeofAxPromptTemplate
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L84
rateLimiter?
optionalrateLimiter:AxRateLimiterFunction
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L74
stopFunction?
optionalstopFunction:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L83
stream?
optionalstream:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L75
streamingAsserts?
optionalstreamingAsserts:AxStreamingAssertion[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L86
strictExamples?
optionalstrictExamples:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L78
thoughtFieldName?
optionalthoughtFieldName:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L77
traceLabel?
optionaltraceLabel:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L89
tracer?
optionaltracer:Tracer
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L73
> AxMCPStreamableHTTPTransportOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L79
Properties
authorization?
optionalauthorization:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L90
Authorization header value (convenience for common use case) If provided, will be added to the headers as ‘Authorization’
headers?
optionalheaders:Record<string,string>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/httpTransport.ts#L84
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/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/transport.ts#L7
Methods
connect()?
optionalconnect():Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/transport.ts#L27
Connects to the transport if needed This method is optional and only required for transports that need connection setup
Returns
Promise<void>
send()
send(
message):Promise<JSONRPCResponse<unknown>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/transport.ts#L13
Sends a JSON-RPC request or notification and returns the response
Parameters
| Parameter | Type | Description |
|---|---|---|
message | Readonly<JSONRPCRequest<unknown>> | The JSON-RPC request or notification to send |
Returns
Promise<JSONRPCResponse<unknown>>
A Promise that resolves to the JSON-RPC response
sendNotification()
sendNotification(
message):Promise<void>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/mcp/transport.ts#L21
Sends a JSON-RPC notification
Parameters
| Parameter | Type | Description |
|---|---|---|
message | Readonly<JSONRPCNotification> | The JSON-RPC notification to send |
Returns
Promise<void>
> AxMiPROOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L13
Properties
dataAwareProposer?
optionaldataAwareProposer:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L23
earlyStoppingTrials?
optionalearlyStoppingTrials:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L29
fewshotAwareProposer?
optionalfewshotAwareProposer:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L26
initTemperature?
optionalinitTemperature:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L15
maxBootstrappedDemos?
optionalmaxBootstrappedDemos:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L16
maxLabeledDemos?
optionalmaxLabeledDemos:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L17
minibatch?
optionalminibatch:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L19
minibatchFullEvalSteps?
optionalminibatchFullEvalSteps:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L21
minibatchSize?
optionalminibatchSize:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L20
minImprovementThreshold?
optionalminImprovementThreshold:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L30
numCandidates?
optionalnumCandidates:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L14
numTrials?
optionalnumTrials:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L18
programAwareProposer?
optionalprogramAwareProposer:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L22
seed?
optionalseed:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L27
tipAwareProposer?
optionaltipAwareProposer:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L25
verbose?
optionalverbose:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L28
viewDataBatchSize?
optionalviewDataBatchSize:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/mipro.ts#L24
> AxOptimizationStats
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L40
Properties
earlyStopped
earlyStopped:
boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L44
earlyStopping?
optionalearlyStopping:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L45
bestScoreRound
bestScoreRound:
number
patienceExhausted
patienceExhausted:
boolean
estimatedTokenUsage
estimatedTokenUsage:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L43
successfulDemos
successfulDemos:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L42
totalCalls
totalCalls:
number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L41
> AxProgramWithSignatureOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L103
Properties
description?
optionaldescription:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L104
> AxPromptTemplateOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L12
Properties
functions?
optionalfunctions: readonly (AxFunction| {toFunction: () =>AxFunction|AxFunction[]; })[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L13
optionalOutputFields?
optionaloptionalOutputFields:string[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L16
strictExamples?
optionalstrictExamples:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L15
thoughtFieldName?
optionalthoughtFieldName:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L14
> AxRateLimiterTokenUsageOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/rate-limit.ts#L5
Properties
debug?
optionaldebug:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/util/rate-limit.ts#L6
> AxResponseHandlerArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L96
Type Parameters
| Type Parameter |
|---|
T |
Properties
ai
ai:
Readonly<AxAIService<unknown,unknown>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L97
fastFail?
optionalfastFail:boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L104
functions?
optionalfunctions: readonlyAxFunction[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L103
mem
mem:
AxAIMemory
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L100
model?
optionalmodel:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L98
res
res:
T
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L99
sessionId?
optionalsessionId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L101
span?
optionalspan:Span
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L105
traceId?
optionaltraceId:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L102
> AxSimpleClassifierForwardOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L7
Properties
abortSignal?
optionalabortSignal:AbortSignal
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L9
cutoff?
optionalcutoff:number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/classifier.ts#L8
> AxStreamingAssertion
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L10
Properties
fieldName
fieldName:
string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L11
message?
optionalmessage:string
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L13
Methods
fn()
fn(
content,done?):undefined|boolean
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/asserts.ts#L12
Parameters
| Parameter | Type |
|---|---|
content | string |
done? | boolean |
Returns
undefined | boolean
> AxStreamingEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L108
Type Parameters
| Type Parameter |
|---|
T |
Properties
data
data:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L110
contentDelta?
optionalcontentDelta:string
error?
optionalerror:string
functions?
optionalfunctions:AxChatResponseFunctionCall[]
partialValues?
optionalpartialValues:Partial<T>
event
event:
"error"|"done"|"delta"
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L109
> AxTunable
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L82
Extended by
Properties
getTraces()
getTraces: () =>
AxProgramTrace[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L89
Returns
setDemos()
setDemos: (
demos) =>void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L90
Parameters
| Parameter | Type |
|---|---|
demos | readonly AxProgramDemos[] |
Returns
void
setExamples()
setExamples: (
examples,options?) =>void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L83
Parameters
| Parameter | Type |
|---|---|
examples | Readonly<AxProgramExamples> |
options? | Readonly<AxSetExamplesOptions> |
Returns
void
setId()
setId: (
id) =>void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L87
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
setParentId()
setParentId: (
parentId) =>void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L88
Parameters
| Parameter | Type |
|---|---|
parentId | string |
Returns
void
> AxUsable
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L93
Extended by
Properties
getUsage()
getUsage: () =>
AxModelUsage&object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L94
Returns
AxModelUsage & object[]
resetUsage()
resetUsage: () =>
void
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L95
Returns
void
> @ax-llm/ax
Enumerations
- AxAIAnthropicModel
- AxAIAnthropicVertexModel
- AxAICohereEmbedModel
- AxAICohereModel
- AxAIDeepSeekModel
- AxAIGoogleGeminiEmbedModel
- AxAIGoogleGeminiEmbedTypes
- AxAIGoogleGeminiModel
- AxAIGoogleGeminiSafetyCategory
- AxAIGoogleGeminiSafetyThreshold
- AxAIGrokEmbedModels
- AxAIGrokModel
- AxAIGroqModel
- AxAIHuggingFaceModel
- AxAIMistralEmbedModels
- AxAIMistralModel
- AxAIOpenAIEmbedModel
- AxAIOpenAIModel
- AxAIRekaModel
- AxJSInterpreterPermission
- AxLLMRequestTypeValues
- AxSpanKindValues
Classes
- AxAgent
- AxAI
- AxAIAnthropic
- AxAIAzureOpenAI
- AxAICohere
- AxAIDeepSeek
- AxAIGoogleGemini
- AxAIGrok
- AxAIGroq
- AxAIHuggingFace
- AxAIMistral
- AxAIOllama
- AxAIOpenAI
- AxAIOpenAIBase
- AxAIOpenAIResponses
- AxAIOpenAIResponsesBase
- AxAIOpenAIResponsesImpl
- AxAIReka
- AxAIServiceAbortedError
- AxAIServiceAuthenticationError
- AxAIServiceError
- AxAIServiceNetworkError
- AxAIServiceResponseError
- AxAIServiceStatusError
- AxAIServiceStreamTerminatedError
- AxAIServiceTimeoutError
- AxAITogether
- AxApacheTika
- AxAssertionError
- AxBalancer
- AxBaseAI
- AxBootstrapFewShot
- AxChainOfThought
- AxDB
- AxDBBase
- AxDBCloudflare
- AxDBManager
- AxDBMemory
- AxDBPinecone
- AxDBWeaviate
- AxDefaultQueryRewriter
- AxDefaultResultReranker
- AxDockerSession
- AxEmbeddingAdapter
- AxFunctionError
- AxFunctionProcessor
- AxGen
- AxGenerateError
- AxHFDataLoader
- AxInstanceRegistry
- AxJSInterpreter
- AxMCPClient
- AxMCPHTTPSSETransport
- AxMCPStdioTransport
- AxMCPStreambleHTTPTransport
- AxMemory
- AxMiPRO
- AxMockAIService
- AxMultiServiceRouter
- AxProgram
- AxProgramWithSignature
- AxPromptTemplate
- AxRAG
- AxRateLimiterTokenUsage
- AxSignature
- AxSimpleClassifier
- AxSimpleClassifierClass
- AxTestPrompt
Interfaces
- AxAgentFeatures
- AxAgentic
- AxAIAnthropicArgs
- AxAIAnthropicContentBlockDeltaEvent
- AxAIAnthropicContentBlockStartEvent
- AxAIAnthropicContentBlockStopEvent
- AxAIAnthropicErrorEvent
- AxAIAnthropicMessageDeltaEvent
- AxAIAnthropicMessageStartEvent
- AxAIAnthropicMessageStopEvent
- AxAIAnthropicPingEvent
- AxAICohereArgs
- AxAIFeatures
- AxAIGoogleGeminiArgs
- AxAIGoogleGeminiOptionsTools
- AxAIGrokOptionsTools
- AxAIGrokSearchSource
- AxAIHuggingFaceArgs
- AxAIMemory
- AxAIOpenAIArgs
- AxAIOpenAIBaseArgs
- AxAIOpenAIResponseDelta
- AxAIOpenAIResponsesArgs
- AxAIOpenAIResponsesCodeInterpreterToolCall
- AxAIOpenAIResponsesComputerToolCall
- AxAIOpenAIResponsesContentPartAddedEvent
- AxAIOpenAIResponsesContentPartDoneEvent
- AxAIOpenAIResponsesDefineFunctionTool
- AxAIOpenAIResponsesErrorEvent
- AxAIOpenAIResponsesFileSearchCallCompletedEvent
- AxAIOpenAIResponsesFileSearchCallInProgressEvent
- AxAIOpenAIResponsesFileSearchCallSearchingEvent
- AxAIOpenAIResponsesFileSearchToolCall
- AxAIOpenAIResponsesFunctionCallArgumentsDeltaEvent
- AxAIOpenAIResponsesFunctionCallArgumentsDoneEvent
- AxAIOpenAIResponsesFunctionCallItem
- AxAIOpenAIResponsesImageGenerationCallCompletedEvent
- AxAIOpenAIResponsesImageGenerationCallGeneratingEvent
- AxAIOpenAIResponsesImageGenerationCallInProgressEvent
- AxAIOpenAIResponsesImageGenerationCallPartialImageEvent
- AxAIOpenAIResponsesImageGenerationToolCall
- AxAIOpenAIResponsesInputAudioContentPart
- AxAIOpenAIResponsesInputFunctionCallItem
- AxAIOpenAIResponsesInputFunctionCallOutputItem
- AxAIOpenAIResponsesInputImageUrlContentPart
- AxAIOpenAIResponsesInputMessageItem
- AxAIOpenAIResponsesInputTextContentPart
- AxAIOpenAIResponsesLocalShellToolCall
- AxAIOpenAIResponsesMCPCallArgumentsDeltaEvent
- AxAIOpenAIResponsesMCPCallArgumentsDoneEvent
- AxAIOpenAIResponsesMCPCallCompletedEvent
- AxAIOpenAIResponsesMCPCallFailedEvent
- AxAIOpenAIResponsesMCPCallInProgressEvent
- AxAIOpenAIResponsesMCPListToolsCompletedEvent
- AxAIOpenAIResponsesMCPListToolsFailedEvent
- AxAIOpenAIResponsesMCPListToolsInProgressEvent
- AxAIOpenAIResponsesMCPToolCall
- AxAIOpenAIResponsesOutputItemAddedEvent
- AxAIOpenAIResponsesOutputItemDoneEvent
- AxAIOpenAIResponsesOutputMessageItem
- AxAIOpenAIResponsesOutputRefusalContentPart
- AxAIOpenAIResponsesOutputTextAnnotationAddedEvent
- AxAIOpenAIResponsesOutputTextContentPart
- AxAIOpenAIResponsesOutputTextDeltaEvent
- AxAIOpenAIResponsesOutputTextDoneEvent
- AxAIOpenAIResponsesReasoningDeltaEvent
- AxAIOpenAIResponsesReasoningDoneEvent
- AxAIOpenAIResponsesReasoningItem
- AxAIOpenAIResponsesReasoningSummaryDeltaEvent
- AxAIOpenAIResponsesReasoningSummaryDoneEvent
- AxAIOpenAIResponsesReasoningSummaryPart
- AxAIOpenAIResponsesReasoningSummaryPartAddedEvent
- AxAIOpenAIResponsesReasoningSummaryPartDoneEvent
- AxAIOpenAIResponsesReasoningSummaryTextDeltaEvent
- AxAIOpenAIResponsesReasoningSummaryTextDoneEvent
- AxAIOpenAIResponsesRefusalDeltaEvent
- AxAIOpenAIResponsesRefusalDoneEvent
- AxAIOpenAIResponsesRequest
- AxAIOpenAIResponsesResponse
- AxAIOpenAIResponsesResponseCompletedEvent
- AxAIOpenAIResponsesResponseCreatedEvent
- AxAIOpenAIResponsesResponseDelta
- AxAIOpenAIResponsesResponseFailedEvent
- AxAIOpenAIResponsesResponseIncompleteEvent
- AxAIOpenAIResponsesResponseInProgressEvent
- AxAIOpenAIResponsesResponseQueuedEvent
- AxAIOpenAIResponsesStreamEventBase
- AxAIOpenAIResponsesToolCallBase
- AxAIOpenAIResponsesWebSearchCallCompletedEvent
- AxAIOpenAIResponsesWebSearchCallInProgressEvent
- AxAIOpenAIResponsesWebSearchCallSearchingEvent
- AxAIOpenAIResponsesWebSearchToolCall
- AxAIRekaArgs
- AxAIService
- AxAIServiceImpl
- AxAIServiceMetrics
- AxApacheTikaArgs
- AxApacheTikaConvertOptions
- AxAPI
- AxAPIConfig
- AxAssertion
- AxBaseAIArgs
- AxDBBaseArgs
- AxDBBaseOpOptions
- AxDBCloudflareArgs
- AxDBLoaderOptions
- AxDBManagerArgs
- AxDBMatch
- AxDBMemoryArgs
- AxDBPineconeArgs
- AxDBQueryService
- AxDBService
- AxDBWeaviateArgs
- AxDockerContainer
- AxField
- AxFieldProcessor
- AxGenOptions
- AxMCPStreamableHTTPTransportOptions
- AxMCPTransport
- AxMiPROOptions
- AxOptimizationStats
- AxProgramWithSignatureOptions
- AxPromptTemplateOptions
- AxRateLimiterTokenUsageOptions
- AxResponseHandlerArgs
- AxSimpleClassifierForwardOptions
- AxStreamingAssertion
- AxStreamingEvent
- AxTunable
- AxUsable
Type Aliases
- AxAgentOptions
- AxAIAnthropicChatError
- AxAIAnthropicChatRequest
- AxAIAnthropicChatRequestCacheParam
- AxAIAnthropicChatResponse
- AxAIAnthropicChatResponseDelta
- AxAIAnthropicConfig
- AxAIArgs
- AxAIAzureOpenAIArgs
- AxAIAzureOpenAIConfig
- AxAICohereChatRequest
- AxAICohereChatRequestToolResults
- AxAICohereChatResponse
- AxAICohereChatResponseDelta
- AxAICohereChatResponseToolCalls
- AxAICohereConfig
- AxAICohereEmbedRequest
- AxAICohereEmbedResponse
- AxAIDeepSeekArgs
- AxAIEmbedModels
- AxAIGoogleGeminiBatchEmbedRequest
- AxAIGoogleGeminiBatchEmbedResponse
- AxAIGoogleGeminiChatRequest
- AxAIGoogleGeminiChatResponse
- AxAIGoogleGeminiChatResponseDelta
- AxAIGoogleGeminiConfig
- AxAIGoogleGeminiContent
- AxAIGoogleGeminiGenerationConfig
- AxAIGoogleGeminiSafetySettings
- AxAIGoogleGeminiThinkingConfig
- AxAIGoogleGeminiTool
- AxAIGoogleGeminiToolConfig
- AxAIGoogleGeminiToolFunctionDeclaration
- AxAIGoogleGeminiToolGoogleSearchRetrieval
- AxAIGoogleVertexBatchEmbedRequest
- AxAIGoogleVertexBatchEmbedResponse
- AxAIGrokArgs
- AxAIGrokChatRequest
- AxAIGroqArgs
- AxAIHuggingFaceConfig
- AxAIHuggingFaceRequest
- AxAIHuggingFaceResponse
- AxAIInputModelList
- AxAIMistralArgs
- AxAIModelList
- AxAIModelListBase
- AxAIModels
- AxAIOllamaAIConfig
- AxAIOllamaArgs
- AxAIOpenAIChatRequest
- AxAIOpenAIChatResponse
- AxAIOpenAIChatResponseDelta
- AxAIOpenAIConfig
- AxAIOpenAIEmbedRequest
- AxAIOpenAIEmbedResponse
- AxAIOpenAILogprob
- AxAIOpenAIResponsesConfig
- AxAIOpenAIResponsesInputContentPart
- AxAIOpenAIResponsesInputItem
- AxAIOpenAIResponsesOutputItem
- AxAIOpenAIResponsesStreamEvent
- AxAIOpenAIResponsesToolCall
- AxAIOpenAIResponsesToolChoice
- AxAIOpenAIResponsesToolDefinition
- AxAIOpenAIUsage
- AxAIPromptConfig
- AxAIRekaChatRequest
- AxAIRekaChatResponse
- AxAIRekaChatResponseDelta
- AxAIRekaConfig
- AxAIRekaUsage
- AxAIServiceActionOptions
- AxAIServiceOptions
- AxAITogetherArgs
- AxBalancerOptions
- AxChatRequest
- AxChatResponse
- AxChatResponseFunctionCall
- AxChatResponseResult
- AxDataRow
- AxDBArgs
- AxDBCloudflareOpOptions
- AxDBMemoryOpOptions
- AxDBPineconeOpOptions
- AxDBQueryRequest
- AxDBQueryResponse
- AxDBState
- AxDBUpsertRequest
- AxDBUpsertResponse
- AxDBWeaviateOpOptions
- AxEmbedRequest
- AxEmbedResponse
- AxEvaluateArgs
- AxExample
- AxFieldProcessorProcess
- AxFieldTemplateFn
- AxFieldValue
- AxFunction
- AxFunctionHandler
- AxFunctionJSONSchema
- AxGenDeltaOut
- AxGenerateErrorDetails
- AxGenerateResult
- AxGenIn
- AxGenOut
- AxGenStreamingOut
- AxIField
- AxInputFunctionType
- AxInternalChatRequest
- AxInternalEmbedRequest
- AxMessage
- AxMetricFn
- AxMetricFnArgs
- AxMockAIServiceConfig
- AxModelConfig
- AxModelInfo
- AxModelInfoWithProvider
- AxModelUsage
- AxOptimizerArgs
- AxProgramDemos
- AxProgramExamples
- AxProgramForwardOptions
- AxProgramStreamingForwardOptions
- AxProgramTrace
- AxProgramUsage
- AxRateLimiterFunction
- AxRerankerIn
- AxRerankerOut
- AxRewriteIn
- AxRewriteOut
- AxSetExamplesOptions
- AxStreamingFieldProcessorProcess
- AxTokenUsage
Variables
- AxEvalUtil
- axModelInfoAnthropic
- axModelInfoCohere
- axModelInfoDeepSeek
- axModelInfoGoogleGemini
- axModelInfoGrok
- axModelInfoGroq
- axModelInfoHuggingFace
- axModelInfoMistral
- axModelInfoOpenAI
- axModelInfoReka
- axModelInfoTogether
- axSpanAttributes
- axSpanEvents
- AxStringUtil
Functions
- axAIAnthropicDefaultConfig
- axAIAnthropicVertexDefaultConfig
- axAIAzureOpenAIBestConfig
- axAIAzureOpenAICreativeConfig
- axAIAzureOpenAIDefaultConfig
- axAIAzureOpenAIFastConfig
- axAICohereCreativeConfig
- axAICohereDefaultConfig
- axAIDeepSeekCodeConfig
- axAIDeepSeekDefaultConfig
- axAIGoogleGeminiDefaultConfig
- axAIGoogleGeminiDefaultCreativeConfig
- axAIGrokBestConfig
- axAIGrokDefaultConfig
- axAIHuggingFaceCreativeConfig
- axAIHuggingFaceDefaultConfig
- axAIMistralBestConfig
- axAIMistralDefaultConfig
- axAIOllamaDefaultConfig
- axAIOllamaDefaultCreativeConfig
- axAIOpenAIBestConfig
- axAIOpenAICreativeConfig
- axAIOpenAIDefaultConfig
- axAIOpenAIFastConfig
- axAIOpenAIResponsesBestConfig
- axAIOpenAIResponsesCreativeConfig
- axAIOpenAIResponsesDefaultConfig
- axAIRekaBestConfig
- axAIRekaCreativeConfig
- axAIRekaDefaultConfig
- axAIRekaFastConfig
- axAITogetherDefaultConfig
- axBaseAIDefaultConfig
- axBaseAIDefaultCreativeConfig
> AxAIAnthropicChatError
AxAIAnthropicChatError:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L134
Type declaration
error
{
message:string;type:"authentication_error"; }
type
type:
"error"
> AxAIAnthropicChatRequestCacheParam
AxAIAnthropicChatRequestCacheParam:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L30
Type declaration
cache_control?
{
type:"ephemeral"; }
> AxAIAnthropicChatRequest
AxAIAnthropicChatRequest:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L35
Type declaration
anthropic_version?
optionalanthropic_version:string
max_tokens?
optionalmax_tokens:number
messages
messages: ({
content:string| (… & … | … & … | {content: … | …;is_error:boolean;tool_use_id:string;type:"tool_result"; })[];role:"user"; } | {content:string| ({text:string;type:"text"; } | {id:string;input:object;name:string;type:"tool_use"; })[];role:"assistant"; })[]
metadata?
{
user_id:string; }
model?
optionalmodel:string
stop_sequences?
optionalstop_sequences:string[]
stream?
optionalstream:boolean
system?
optionalsystem:string|object&AxAIAnthropicChatRequestCacheParam[]
temperature?
optionaltemperature:number
tool_choice?
optionaltool_choice: {type:"auto"|"any"; } | {name:string;type:"tool"; }
tools?
optionaltools:object&AxAIAnthropicChatRequestCacheParam[]
top_k?
optionaltop_k:number
top_p?
optionaltop_p:number
> AxAIAnthropicChatResponse
AxAIAnthropicChatResponse:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L109
Type declaration
content
content: ({
text:string;type:"text"; } | {id:string;input:string;name:string;type:"tool_use"; })[]
id
id:
string
model
model:
string
role
role:
"assistant"
stop_reason
stop_reason:
"end_turn"|"max_tokens"|"stop_sequence"|"tool_use"
stop_sequence?
optionalstop_sequence:string
type
type:
"message"
usage
{
input_tokens:number;output_tokens:number; }
> AxAIAnthropicChatResponseDelta
AxAIAnthropicChatResponseDelta:
AxAIAnthropicMessageStartEvent|AxAIAnthropicContentBlockStartEvent|AxAIAnthropicContentBlockDeltaEvent|AxAIAnthropicContentBlockStopEvent|AxAIAnthropicMessageDeltaEvent|AxAIAnthropicMessageStopEvent|AxAIAnthropicPingEvent|AxAIAnthropicErrorEvent
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L230
> AxAIAnthropicConfig
AxAIAnthropicConfig:
AxModelConfig&object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/types.ts#L26
Type declaration
model
> AxAIArgs
AxAIArgs:
AxAIOpenAIArgs|AxAIOpenAIResponsesArgs|AxAIAzureOpenAIArgs|AxAITogetherArgs|AxAIAnthropicArgs|AxAIGroqArgs|AxAIGoogleGeminiArgs|AxAICohereArgs|AxAIHuggingFaceArgs|AxAIMistralArgs|AxAIDeepSeekArgs|AxAIOllamaArgs|AxAIRekaArgs
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/wrap.ts#L55
> AxAIAzureOpenAIArgs
AxAIAzureOpenAIArgs:
AxAIOpenAIArgs<"azure-openai",AxAIOpenAIModel,AxAIOpenAIEmbedModel> &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/azure-openai/api.ts#L30
Type declaration
deploymentName
deploymentName:
string
resourceName
resourceName:
string
version?
optionalversion:string
> AxAIAzureOpenAIConfig
AxAIAzureOpenAIConfig:
AxAIOpenAIConfig<AxAIOpenAIModel,AxAIOpenAIEmbedModel>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/azure-openai/api.ts#L26
> AxAICohereChatRequest
AxAICohereChatRequest:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L41
Type declaration
chat_history
chat_history: ({
message:string;role:"CHATBOT";tool_calls:AxAICohereChatResponseToolCalls; } | {message:string;role:"SYSTEM"; } | {message:string;role:"USER"; } | {message:string;role:"TOOL";tool_results:AxAICohereChatRequestToolResults; })[]
end_sequences?
optionalend_sequences: readonlystring[]
frequency_penalty?
optionalfrequency_penalty:number
k?
optionalk:number
max_tokens?
optionalmax_tokens:number
message?
optionalmessage:string
model
model:
AxAICohereModel
p?
optionalp:number
preamble?
optionalpreamble:string
presence_penalty?
optionalpresence_penalty:number
stop_sequences?
optionalstop_sequences:string[]
temperature?
optionaltemperature:number
tool_results?
optionaltool_results:AxAICohereChatRequestToolResults
tools?
optionaltools:object[]
> AxAICohereChatRequestToolResults
AxAICohereChatRequestToolResults:
object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L36
Type declaration
call
call:
AxAICohereChatResponseToolCalls[0]
outputs
outputs:
object[]
> AxAICohereChatResponse
AxAICohereChatResponse:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L89
Type declaration
finish_reason
finish_reason:
"COMPLETE"|"ERROR"|"ERROR_TOXIC"|"ERROR_LIMIT"|"USER_CANCEL"|"MAX_TOKENS"
generation_id
generation_id:
string
meta
{
billed_units: {input_tokens:number;output_tokens:number; }; }
response_id
response_id:
string
text
text:
string
tool_calls
tool_calls:
AxAICohereChatResponseToolCalls
> AxAICohereChatResponseDelta
AxAICohereChatResponseDelta:
AxAICohereChatResponse&object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L109
Type declaration
event_type
event_type:
"stream-start"|"text-generation"|"tool-calls-generation"|"stream-end"
> AxAICohereChatResponseToolCalls
AxAICohereChatResponseToolCalls:
object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L31
Type declaration
name
name:
string
parameters?
optionalparameters:object
> AxAICohereConfig
AxAICohereConfig:
AxModelConfig&object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L26
Cohere: Model options for text generation
Type declaration
embedModel?
optionalembedModel:AxAICohereEmbedModel
model
model:
AxAICohereModel
> AxAICohereEmbedRequest
AxAICohereEmbedRequest:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L117
Type declaration
model
model:
AxAICohereEmbedModel
texts
texts: readonly
string[]
truncate
truncate:
string
> AxAICohereEmbedResponse
AxAICohereEmbedResponse:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/types.ts#L123
Type declaration
embeddings
embeddings:
number[][]
id
id:
string
model
model:
AxAICohereEmbedModel
texts
texts:
string[]
> AxAIDeepSeekArgs
AxAIDeepSeekArgs:
AxAIOpenAIArgs<"deepseek",AxAIDeepSeekModel,undefined>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/api.ts#L25
> AxAIEmbedModels
> AxAIGoogleGeminiBatchEmbedRequest
AxAIGoogleGeminiBatchEmbedRequest:
object
AxAIGoogleGeminiEmbedRequest: Structure for making an embedding request to the Google Gemini API.
Type declaration
requests
requests:
object[]
> AxAIGoogleGeminiBatchEmbedResponse
AxAIGoogleGeminiBatchEmbedResponse:
object
AxAIGoogleGeminiEmbedResponse: Structure for handling responses from the Google Gemini API embedding requests.
Type declaration
embeddings
embeddings:
object[]
> AxAIGoogleGeminiChatRequest
AxAIGoogleGeminiChatRequest:
object
Type declaration
contents
contents:
AxAIGoogleGeminiContent[]
generationConfig
generationConfig:
AxAIGoogleGeminiGenerationConfig
safetySettings?
optionalsafetySettings:AxAIGoogleGeminiSafetySettings
systemInstruction?
optionalsystemInstruction:AxAIGoogleGeminiContent
toolConfig?
optionaltoolConfig:AxAIGoogleGeminiToolConfig
tools?
optionaltools:AxAIGoogleGeminiTool[]
> AxAIGoogleGeminiChatResponse
AxAIGoogleGeminiChatResponse:
object
Type declaration
candidates
candidates:
object[]
usageMetadata
{
candidatesTokenCount:number;promptTokenCount:number;thoughtsTokenCount:number;totalTokenCount:number; }
> AxAIGoogleGeminiChatResponseDelta
AxAIGoogleGeminiChatResponseDelta:
AxAIGoogleGeminiChatResponse
> AxAIGoogleGeminiConfig
AxAIGoogleGeminiConfig:
AxModelConfig&object
AxAIGoogleGeminiConfig: Configuration options for Google Gemini API
Type declaration
autoTruncate?
optionalautoTruncate:boolean
dimensions?
optionaldimensions:number
embedModel?
optionalembedModel:AxAIGoogleGeminiEmbedModel
embedType?
optionalembedType:AxAIGoogleGeminiEmbedTypes
model
model:
AxAIGoogleGeminiModel
safetySettings?
optionalsafetySettings:AxAIGoogleGeminiSafetySettings
thinking?
optionalthinking:AxAIGoogleGeminiThinkingConfig
urlContext?
optionalurlContext:string
> AxAIGoogleGeminiContent
AxAIGoogleGeminiContent: {
parts: ({text:string;thought:string; } | {inlineData: {data:string;mimeType:string; }; } | {fileData: {fileUri:string;mimeType:string; }; })[];role:"user"; } | {parts:object[] |object[];role:"model"; } | {parts:object[];role:"function"; }
> AxAIGoogleGeminiGenerationConfig
AxAIGoogleGeminiGenerationConfig:
object
Type declaration
candidateCount?
optionalcandidateCount:number
frequencyPenalty?
optionalfrequencyPenalty:number
maxOutputTokens?
optionalmaxOutputTokens:number
responseMimeType?
optionalresponseMimeType:string
stopSequences?
optionalstopSequences: readonlystring[]
temperature?
optionaltemperature:number
thinkingConfig?
{
includeThoughts:boolean;thinkingBudget:number; }
topK?
optionaltopK:number
topP?
optionaltopP:number
> AxAIGoogleGeminiSafetySettings
AxAIGoogleGeminiSafetySettings:
object[]
Type declaration
category
category:
AxAIGoogleGeminiSafetyCategory
threshold
threshold:
AxAIGoogleGeminiSafetyThreshold
> AxAIGoogleGeminiThinkingConfig
AxAIGoogleGeminiThinkingConfig:
object
Type declaration
includeThoughts?
optionalincludeThoughts:boolean
thinkingTokenBudget?
optionalthinkingTokenBudget:number
> AxAIGoogleGeminiTool
AxAIGoogleGeminiTool:
object
Type declaration
code_execution?
optionalcode_execution:object
function_declarations?
optionalfunction_declarations:AxAIGoogleGeminiToolFunctionDeclaration[]
google_search?
optionalgoogle_search:object
google_search_retrieval?
optionalgoogle_search_retrieval:AxAIGoogleGeminiToolGoogleSearchRetrieval
url_context?
optionalurl_context:object
> AxAIGoogleGeminiToolConfig
AxAIGoogleGeminiToolConfig:
object
Type declaration
function_calling_config
{
allowed_function_names:string[];mode:"ANY"|"NONE"|"AUTO"; }
> AxAIGoogleGeminiToolFunctionDeclaration
AxAIGoogleGeminiToolFunctionDeclaration:
object
Type declaration
description?
optionaldescription:string
name
name:
string
parameters?
optionalparameters:object
> AxAIGoogleGeminiToolGoogleSearchRetrieval
AxAIGoogleGeminiToolGoogleSearchRetrieval:
object
Type declaration
dynamic_retrieval_config
{
dynamic_threshold:number;mode:"MODE_DYNAMIC"; }
> AxAIGoogleVertexBatchEmbedRequest
AxAIGoogleVertexBatchEmbedRequest:
object
AxAIGoogleVertexBatchEmbedRequest: Structure for making an embedding request to the Google Vertex API.
Type declaration
instances
instances:
object[]
parameters
{
autoTruncate:boolean;outputDimensionality:number; }
> AxAIGoogleVertexBatchEmbedResponse
AxAIGoogleVertexBatchEmbedResponse:
object
AxAIGoogleVertexBatchEmbedResponse: Structure for handling responses from the Google Vertex API embedding requests.
Type declaration
predictions
predictions:
object[]
> AxAIGrokArgs
AxAIGrokArgs:
AxAIOpenAIArgs<"grok",AxAIGrokModel,AxAIGrokEmbedModels,AxAIGrokChatRequest> &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L64
Type declaration
modelInfo?
optionalmodelInfo:AxModelInfo[]
options?
optionaloptions:Readonly<AxAIServiceOptions&AxAIGrokOptionsTools> &object
Type declaration
tokensPerMinute?
optionaltokensPerMinute:number
> AxAIGrokChatRequest
AxAIGrokChatRequest:
AxAIOpenAIChatRequest<AxAIGrokModel> &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/api.ts#L53
Type declaration
search_parameters?
{
from_date:string;max_search_results:number;mode:"auto"|"on"|"off";return_citations:boolean;sources:AxAIGrokSearchSource[];to_date:string; }
> AxAIGroqArgs
AxAIGroqArgs:
AxAIOpenAIArgs<"groq",AxAIGroqModel,undefined> &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/api.ts#L22
Type declaration
modelInfo?
optionalmodelInfo:AxModelInfo[]
options?
optionaloptions:Readonly<AxAIServiceOptions> &object
Type declaration
tokensPerMinute?
optionaltokensPerMinute:number
> AxAIHuggingFaceConfig
AxAIHuggingFaceConfig:
AxModelConfig&object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/types.ts#L7
Type declaration
doSample?
optionaldoSample:boolean
maxTime?
optionalmaxTime:number
model
model:
AxAIHuggingFaceModel
returnFullText?
optionalreturnFullText:boolean
useCache?
optionaluseCache:boolean
waitForModel?
optionalwaitForModel:boolean
> AxAIHuggingFaceResponse
AxAIHuggingFaceResponse:
object
Type declaration
generated_text
generated_text:
string
> AxAIHuggingFaceRequest
AxAIHuggingFaceRequest:
object
Type declaration
inputs
inputs:
string
model
model:
AxAIHuggingFaceModel
options?
{
use_cache:boolean;wait_for_model:boolean; }
parameters
{
do_sample:boolean;max_new_tokens:number;max_time:number;num_return_sequences:number;repetition_penalty:number;return_full_text:boolean;temperature:number;top_k:number;top_p:number; }
> AxAIInputModelList
AxAIInputModelList<
TModel,TEmbedModel>:AxAIModelListBase&object& {model:TModel; } | {embedModel:TEmbedModel; }[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L9
Type Parameters
| Type Parameter |
|---|
TModel |
TEmbedModel |
> AxAIMistralArgs
AxAIMistralArgs:
AxAIOpenAIArgs<"mistral",AxAIMistralModel,AxAIMistralEmbedModels> &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/api.ts#L26
Type declaration
modelInfo?
optionalmodelInfo:AxModelInfo[]
options?
optionaloptions:Readonly<AxAIServiceOptions> &object
Type declaration
tokensPerMinute?
optionaltokensPerMinute:number
> AxAIModelList
AxAIModelList:
AxAIModelListBase& {model:string; } | {embedModel:string; }[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L18
> AxAIModelListBase
AxAIModelListBase:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L13
Type declaration
description
description:
string
key
key:
string
> AxAIModels
> AxAIOllamaAIConfig
AxAIOllamaAIConfig:
AxAIOpenAIConfig<string,string>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/ollama/api.ts#L8
> AxAIOllamaArgs
AxAIOllamaArgs:
AxAIOpenAIArgs<"ollama",string,string> &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/ollama/api.ts#L24
Type declaration
embedModel?
optionalembedModel:string
model?
optionalmodel:string
url?
optionalurl:string
> AxAIOpenAIChatRequest
AxAIOpenAIChatRequest<
TModel>:object
Type Parameters
| Type Parameter |
|---|
TModel |
Type declaration
frequency_penalty?
optionalfrequency_penalty:number
logit_bias?
optionallogit_bias:Map<string,number>
max_completion_tokens?
optionalmax_completion_tokens:number
messages
messages: ({
content:string;role:"system"; } | {content:string| ({text:string;type:"text"; } | {image_url: {details: …;url: …; };type:"image_url"; } | {input_audio: {data: …;format: …; };type:"input_audio"; })[];name:string;role:"user"; } | {content:string;name:string;role:"assistant";tool_calls:object[]; } | {content:string;role:"tool";tool_call_id:string; })[]
model
model:
TModel
n?
optionaln:number
organization?
optionalorganization:string
presence_penalty?
optionalpresence_penalty:number
reasoning_effort?
optionalreasoning_effort:"low"|"medium"|"high"
response_format?
{
type:string; }
stop?
optionalstop: readonlystring[]
store?
optionalstore:boolean
stream?
optionalstream:boolean
temperature?
optionaltemperature:number
tool_choice?
optionaltool_choice:"none"|"auto"|"required"| {function: {name:string; };type:"function"; }
tools?
optionaltools:object[]
top_p?
optionaltop_p:number
user?
optionaluser:string
web_search_options?
{
search_context_size:"low"|"medium"|"high";user_location: {approximate: {city:string;country:string;region:string;timezone:string;type:"approximate"; }; } |null; }
> AxAIOpenAIChatResponseDelta
AxAIOpenAIChatResponseDelta:
AxAIOpenAIResponseDelta<{content:string;reasoning_content:string;role:string;tool_calls:NonNullable<…[…][0]["message"]["tool_calls"]>[0] &object[]; }>
> AxAIOpenAIChatResponse
AxAIOpenAIChatResponse:
object
Type declaration
choices
choices:
object[]
created
created:
number
error?
{
code:number;message:string;param:string;type:string; }
id
id:
string
model
model:
string
object
object:
"chat.completion"
system_fingerprint
system_fingerprint:
string
usage?
optionalusage:AxAIOpenAIUsage
> AxAIOpenAIConfig
AxAIOpenAIConfig<
TModel,TEmbedModel>:Omit<AxModelConfig,"topK"> &object
Type declaration
bestOf?
optionalbestOf:number
dimensions?
optionaldimensions:number
echo?
optionalecho:boolean
embedModel?
optionalembedModel:TEmbedModel
logitBias?
optionallogitBias:Map<string,number>
logprobs?
optionallogprobs:number
model
model:
TModel
reasoningEffort?
optionalreasoningEffort:"low"|"medium"|"high"
responseFormat?
optionalresponseFormat:"json_object"
serviceTier?
optionalserviceTier:"auto"|"default"|"flex"
stop?
optionalstop:string[]
store?
optionalstore:boolean
suffix?
optionalsuffix:string|null
user?
optionaluser:string
webSearchOptions?
{
searchContextSize:"low"|"medium"|"high";userLocation: {approximate: {city:string;country:string;region:string;timezone:string;type:"approximate"; }; } |null; }
Type Parameters
| Type Parameter |
|---|
TModel |
TEmbedModel |
> AxAIOpenAIEmbedRequest
AxAIOpenAIEmbedRequest<
TEmbedModel>:object
Type Parameters
| Type Parameter |
|---|
TEmbedModel |
Type declaration
dimensions?
optionaldimensions:number
input
input: readonly
string[]
model
model:
TEmbedModel
user?
optionaluser:string
> AxAIOpenAIEmbedResponse
AxAIOpenAIEmbedResponse:
object
Type declaration
data
data:
object[]
model
model:
string
usage
usage:
AxAIOpenAIUsage
> AxAIOpenAILogprob
AxAIOpenAILogprob:
object
Type declaration
text_offset
text_offset:
number[]
token_logprobs
token_logprobs:
number[]
tokens
tokens:
string[]
top_logprobs
top_logprobs:
Map<string,number>
> AxAIOpenAIResponsesConfig
AxAIOpenAIResponsesConfig<
TModel,TEmbedModel>:Omit<AxModelConfig,"topK"> &object
Type declaration
bestOf?
optionalbestOf:number
dimensions?
optionaldimensions:number
echo?
optionalecho:boolean
embedModel?
optionalembedModel:TEmbedModel
logitBias?
optionallogitBias:Map<string,number>
logprobs?
optionallogprobs:number
model
model:
TModel
parallelToolCalls?
optionalparallelToolCalls:boolean
reasoningEffort?
optionalreasoningEffort:"low"|"medium"|"high"
responseFormat?
optionalresponseFormat:"text"|"json_object"|"json_schema"
seed?
optionalseed:number
serviceTier?
optionalserviceTier:"auto"|"default"|"flex"
stop?
optionalstop:string[]
store?
optionalstore:boolean
suffix?
optionalsuffix:string|null
systemPrompt?
optionalsystemPrompt:string
user?
optionaluser:string
Type Parameters
| Type Parameter |
|---|
TModel |
TEmbedModel |
> AxAIOpenAIResponsesInputContentPart
> AxAIOpenAIResponsesInputItem
> AxAIOpenAIResponsesOutputItem
AxAIOpenAIResponsesOutputItem:
AxAIOpenAIResponsesOutputMessageItem|AxAIOpenAIResponsesFunctionCallItem|AxAIOpenAIResponsesReasoningItem|AxAIOpenAIResponsesFileSearchToolCall|AxAIOpenAIResponsesWebSearchToolCall|AxAIOpenAIResponsesComputerToolCall|AxAIOpenAIResponsesCodeInterpreterToolCall|AxAIOpenAIResponsesImageGenerationToolCall|AxAIOpenAIResponsesLocalShellToolCall|AxAIOpenAIResponsesMCPToolCall
> AxAIOpenAIResponsesStreamEvent
AxAIOpenAIResponsesStreamEvent:
AxAIOpenAIResponsesResponseCreatedEvent|AxAIOpenAIResponsesResponseInProgressEvent|AxAIOpenAIResponsesResponseCompletedEvent|AxAIOpenAIResponsesResponseFailedEvent|AxAIOpenAIResponsesResponseIncompleteEvent|AxAIOpenAIResponsesResponseQueuedEvent|AxAIOpenAIResponsesOutputItemAddedEvent|AxAIOpenAIResponsesOutputItemDoneEvent|AxAIOpenAIResponsesContentPartAddedEvent|AxAIOpenAIResponsesContentPartDoneEvent|AxAIOpenAIResponsesOutputTextDeltaEvent|AxAIOpenAIResponsesOutputTextDoneEvent|AxAIOpenAIResponsesRefusalDeltaEvent|AxAIOpenAIResponsesRefusalDoneEvent|AxAIOpenAIResponsesFunctionCallArgumentsDeltaEvent|AxAIOpenAIResponsesFunctionCallArgumentsDoneEvent|AxAIOpenAIResponsesFileSearchCallInProgressEvent|AxAIOpenAIResponsesFileSearchCallSearchingEvent|AxAIOpenAIResponsesFileSearchCallCompletedEvent|AxAIOpenAIResponsesWebSearchCallInProgressEvent|AxAIOpenAIResponsesWebSearchCallSearchingEvent|AxAIOpenAIResponsesWebSearchCallCompletedEvent|AxAIOpenAIResponsesReasoningDeltaEvent|AxAIOpenAIResponsesReasoningDoneEvent|AxAIOpenAIResponsesReasoningSummaryPartAddedEvent|AxAIOpenAIResponsesReasoningSummaryPartDoneEvent|AxAIOpenAIResponsesReasoningSummaryTextDeltaEvent|AxAIOpenAIResponsesReasoningSummaryTextDoneEvent|AxAIOpenAIResponsesReasoningSummaryDeltaEvent|AxAIOpenAIResponsesReasoningSummaryDoneEvent|AxAIOpenAIResponsesImageGenerationCallInProgressEvent|AxAIOpenAIResponsesImageGenerationCallGeneratingEvent|AxAIOpenAIResponsesImageGenerationCallCompletedEvent|AxAIOpenAIResponsesImageGenerationCallPartialImageEvent|AxAIOpenAIResponsesMCPCallInProgressEvent|AxAIOpenAIResponsesMCPCallArgumentsDeltaEvent|AxAIOpenAIResponsesMCPCallArgumentsDoneEvent|AxAIOpenAIResponsesMCPCallCompletedEvent|AxAIOpenAIResponsesMCPCallFailedEvent|AxAIOpenAIResponsesMCPListToolsInProgressEvent|AxAIOpenAIResponsesMCPListToolsCompletedEvent|AxAIOpenAIResponsesMCPListToolsFailedEvent|AxAIOpenAIResponsesOutputTextAnnotationAddedEvent|AxAIOpenAIResponsesErrorEvent
> AxAIOpenAIResponsesToolCall
AxAIOpenAIResponsesToolCall:
AxAIOpenAIResponsesFunctionCallItem|AxAIOpenAIResponsesFileSearchToolCall|AxAIOpenAIResponsesWebSearchToolCall|AxAIOpenAIResponsesComputerToolCall|AxAIOpenAIResponsesCodeInterpreterToolCall|AxAIOpenAIResponsesImageGenerationToolCall|AxAIOpenAIResponsesLocalShellToolCall|AxAIOpenAIResponsesMCPToolCall
> AxAIOpenAIResponsesToolChoice
AxAIOpenAIResponsesToolChoice:
"none"|"auto"|"required"| {name:string;type:"function"; } | {type:"file_search"; }
> AxAIOpenAIResponsesToolDefinition
AxAIOpenAIResponsesToolDefinition:
AxAIOpenAIResponsesDefineFunctionTool
> AxAIOpenAIUsage
AxAIOpenAIUsage:
object
Type declaration
completion_tokens
completion_tokens:
number
prompt_tokens
prompt_tokens:
number
total_tokens
total_tokens:
number
> AxAIPromptConfig
AxAIPromptConfig:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L233
Type declaration
stream?
optionalstream:boolean
thinkingTokenBudget?
optionalthinkingTokenBudget:"minimal"|"low"|"medium"|"high"|"highest"|"none"
> AxAIRekaChatRequest
AxAIRekaChatRequest:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/types.ts#L20
Type declaration
frequency_penalty?
optionalfrequency_penalty:number
max_tokens?
optionalmax_tokens:number
messages
messages: ({
content:string|object[];role:"user"; } | {content:string|object[];role:"assistant"; })[]
model
model:
string
presence_penalty?
optionalpresence_penalty:number
response_format?
{
type:string; }
stop?
optionalstop: readonlystring[]
stream?
optionalstream:boolean
temperature?
optionaltemperature:number
top_k?
optionaltop_k:number
top_p?
optionaltop_p:number
usage?
optionalusage:AxAIRekaUsage
use_search_engine?
optionaluse_search_engine:boolean
> AxAIRekaChatResponse
AxAIRekaChatResponse:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/types.ts#L55
Type declaration
id
id:
string
model
model:
string
responses
responses:
object[]
usage?
optionalusage:AxAIRekaUsage
> AxAIRekaChatResponseDelta
AxAIRekaChatResponseDelta:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/types.ts#L72
Type declaration
id
id:
string
model
model:
string
responses
responses:
object[]
usage?
optionalusage:AxAIRekaUsage
> AxAIRekaConfig
AxAIRekaConfig:
Omit<AxModelConfig,"topK"> &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/types.ts#L9
Type declaration
model
model:
AxAIRekaModel
stop?
optionalstop: readonlystring[]
useSearchEngine?
optionaluseSearchEngine:boolean
> AxAIRekaUsage
AxAIRekaUsage:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/types.ts#L15
Type declaration
input_tokens
input_tokens:
number
output_tokens
output_tokens:
number
> AxAIServiceActionOptions
AxAIServiceActionOptions<
TModel,TEmbedModel>:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L254
Type Parameters
| Type Parameter | Default type |
|---|---|
TModel | unknown |
TEmbedModel | unknown |
Type declaration
abortSignal?
optionalabortSignal:AbortSignal
ai?
optionalai:Readonly<AxAIService<TModel,TEmbedModel>>
debug?
optionaldebug:boolean
debugHideSystemPrompt?
optionaldebugHideSystemPrompt:boolean
hideThought?
optionalhideThought:boolean
rateLimiter?
optionalrateLimiter:AxRateLimiterFunction
sessionId?
optionalsessionId:string
timeout?
optionaltimeout:number
traceContext?
optionaltraceContext:Context
traceId?
optionaltraceId:string
> AxAITogetherArgs
AxAITogetherArgs:
AxAIOpenAIArgs<"together",string,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/together/api.ts#L16
> AxAIServiceOptions
AxAIServiceOptions:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L244
Type declaration
abortSignal?
optionalabortSignal:AbortSignal
debug?
optionaldebug:boolean
excludeContentFromTrace?
optionalexcludeContentFromTrace:boolean
fetch?
optionalfetch: typeof__type
rateLimiter?
optionalrateLimiter:AxRateLimiterFunction
timeout?
optionaltimeout:number
tracer?
optionaltracer:Tracer
> AxAgentOptions
AxAgentOptions:
Omit<AxGenOptions,"functions"> &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/prompts/agent.ts#L33
Type declaration
debug?
optionaldebug:boolean
disableSmartModelRouting?
optionaldisableSmartModelRouting:boolean
excludeFieldsFromPassthrough?
optionalexcludeFieldsFromPassthrough:string[]
List of field names that should not be automatically passed from parent to child agents
> AxBalancerOptions
AxBalancerOptions:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/balance.ts#L30
Options for the balancer.
Type declaration
comparator()?
(
a,b) =>number
debug?
optionaldebug:boolean
initialBackoffMs?
optionalinitialBackoffMs:number
maxBackoffMs?
optionalmaxBackoffMs:number
maxRetries?
optionalmaxRetries:number
> AxChatRequest
AxChatRequest<
TModel>:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L123
Type Parameters
| Type Parameter | Default type |
|---|---|
TModel | string |
Type declaration
chatPrompt
chatPrompt: ({
cache:boolean;content:string;role:"system"; } | {content:string| ({cache:boolean;text:string;type:"text"; } | {cache:boolean;details: … | … | …;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"; })[]
functionCall?
optionalfunctionCall:"none"|"auto"|"required"| {function: {name:string; };type:"function"; }
functions?
optionalfunctions:Readonly<{description:string;name:string;parameters:AxFunctionJSONSchema; }>[]
model?
optionalmodel:TModel
modelConfig?
optionalmodelConfig:AxModelConfig
> AxChatResponse
AxChatResponse:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L107
Type declaration
modelUsage?
optionalmodelUsage:AxModelUsage
remoteId?
optionalremoteId:string
results
results: readonly
AxChatResponseResult[]
sessionId?
optionalsessionId:string
> AxChatResponseFunctionCall
AxChatResponseFunctionCall:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/functions.ts#L103
Type declaration
args
args:
string
id
id:
string
name
name:
string
> AxChatResponseResult
AxChatResponseResult:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L83
Type declaration
content?
optionalcontent:string
finishReason?
optionalfinishReason:"stop"|"length"|"function_call"|"content_filter"|"error"
functionCalls?
optionalfunctionCalls:object[]
id?
optionalid:string
name?
optionalname:string
thought?
optionalthought:string
> AxDBArgs
> AxDBCloudflareOpOptions
AxDBCloudflareOpOptions:
AxDBBaseOpOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/cloudflare.ts#L13
> AxDBMemoryOpOptions
AxDBMemoryOpOptions:
AxDBBaseOpOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L9
> AxDBPineconeOpOptions
AxDBPineconeOpOptions:
AxDBBaseOpOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/pinecone.ts#L11
> AxDBQueryRequest
AxDBQueryRequest:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/types.ts#L17
Type declaration
columns?
optionalcolumns:string[]
id?
optionalid:string
limit?
optionallimit:number
namespace?
optionalnamespace:string
table
table:
string
text?
optionaltext:string
values?
optionalvalues: readonlynumber[]
> AxDBState
AxDBState:
Record<string,Record<string,AxDBUpsertRequest>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/memory.ts#L15
> AxDBQueryResponse
AxDBQueryResponse:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/types.ts#L27
Type declaration
matches
matches:
object[]
> AxDBUpsertRequest
AxDBUpsertRequest:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/types.ts#L3
Type declaration
id
id:
string
metadata?
optionalmetadata:Record<string,string>
namespace?
optionalnamespace:string
table
table:
string
text?
optionaltext:string
values?
optionalvalues: readonlynumber[]
> AxDBUpsertResponse
AxDBUpsertResponse:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/types.ts#L12
Type declaration
ids
ids:
string[]
> AxDBWeaviateOpOptions
AxDBWeaviateOpOptions:
AxDBBaseOpOptions
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/db/weaviate.ts#L11
> AxDataRow
AxDataRow:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/loader.ts#L3
Type declaration
row
row:
Record<string,AxFieldValue>
> AxEmbedRequest
AxEmbedRequest<
TEmbedModel>:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L217
Type Parameters
| Type Parameter | Default type |
|---|---|
TEmbedModel | string |
Type declaration
embedModel?
optionalembedModel:TEmbedModel
texts?
optionaltexts: readonlystring[]
> AxEmbedResponse
AxEmbedResponse:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L114
Type declaration
embeddings
embeddings: readonly readonly
number[][]
modelUsage?
optionalmodelUsage:AxModelUsage
remoteId?
optionalremoteId:string
sessionId?
optionalsessionId:string
> AxEvaluateArgs
AxEvaluateArgs<
IN,OUT>:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/evaluate.ts#L8
Type Parameters
| Type Parameter |
|---|
IN extends AxGenIn |
OUT extends AxGenOut |
Type declaration
ai
ai:
AxAIService
examples
examples:
Readonly<AxExample[]>
program
program:
Readonly<AxProgram<IN,OUT>>
> AxExample
AxExample:
Record<string,AxFieldValue>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L14
> AxFieldProcessorProcess
AxFieldProcessorProcess: (
value,context?) =>unknown|Promise<unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/fieldProcessor.ts#L7
Parameters
| Parameter | Type |
|---|---|
value | AxFieldValue |
context? | Readonly<{ done: boolean; sessionId: string; values: AxGenOut; }> |
Returns
unknown | Promise<unknown>
> AxFieldTemplateFn
AxFieldTemplateFn: (
field,value) =>any[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/prompt.ts#L38
Parameters
| Parameter | Type |
|---|---|
field | Readonly<AxField> |
value | Readonly<AxFieldValue> |
Returns
any[]
> AxFieldValue
AxFieldValue:
string|string[] |number|boolean|object|null|undefined| {data:string;mimeType:string; } |object[] | {data:string;format:"wav"; } |object[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/types.ts#L1
> AxFunction
AxFunction:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L76
Type declaration
description
description:
string
func
func:
AxFunctionHandler
name
name:
string
parameters?
optionalparameters:AxFunctionJSONSchema
> AxFunctionHandler
AxFunctionHandler: (
args?,extra?) =>unknown
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L52
Parameters
| Parameter | Type |
|---|---|
args? | any |
extra? | Readonly<{ ai: AxAIService; debug: boolean; sessionId: string; traceId: string; }> |
Returns
unknown
> AxFunctionJSONSchema
AxFunctionJSONSchema:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L63
Type declaration
items?
optionalitems:AxFunctionJSONSchema
properties?
optionalproperties:Record<string,AxFunctionJSONSchema&object>
required?
optionalrequired:string[]
type
type:
string
> AxGenDeltaOut
AxGenDeltaOut<
OUT>:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L66
Type Parameters
| Type Parameter |
|---|
OUT extends AxGenOut |
Type declaration
delta
delta:
Partial<OUT>
version
version:
number
> AxGenIn
AxGenIn:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/types.ts#L14
Index Signature
[key: string]: AxFieldValue
> AxGenOut
AxGenOut:
Record<string,AxFieldValue>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/types.ts#L16
> AxGenStreamingOut
AxGenStreamingOut<
OUT>:AsyncGenerator<AxGenDeltaOut<OUT>,void|OUT,unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L71
Type Parameters
| Type Parameter |
|---|
OUT extends AxGenOut |
> AxGenerateErrorDetails
AxGenerateErrorDetails:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L901
Type declaration
maxTokens?
optionalmaxTokens:number
model?
optionalmodel:string
signature
{
description:string;input:Readonly<AxIField[]>;output:Readonly<AxIField[]>; }
streaming
streaming:
boolean
> AxGenerateResult
AxGenerateResult<
OUT>:OUT&object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/generate.ts#L92
Type declaration
thought?
optionalthought:string
Type Parameters
| Type Parameter |
|---|
OUT extends AxGenOut |
> AxIField
AxIField:
Omit<AxField,"title"> &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/sig.ts#L35
Type declaration
title
title:
string
> AxInputFunctionType
AxInputFunctionType: (
AxFunction| {toFunction: () =>AxFunction|AxFunction[]; })[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/functions.ts#L178
> AxInternalChatRequest
AxInternalChatRequest<
TModel>:Omit<AxChatRequest,"model"> &Required<Pick<AxChatRequest<TModel>,"model">>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L214
Type Parameters
| Type Parameter |
|---|
TModel |
> AxInternalEmbedRequest
AxInternalEmbedRequest<
TEmbedModel>:Omit<AxEmbedRequest,"embedModel"> &Required<Pick<AxEmbedRequest<TEmbedModel>,"embedModel">>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L222
Type Parameters
| Type Parameter |
|---|
TEmbedModel |
> AxMessage
AxMessage: {
role:"user";values:AxGenIn; } | {role:"assistant";values:AxGenOut; }
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/types.ts#L18
> AxMetricFnArgs
AxMetricFnArgs:
Parameters<AxMetricFn>[0]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L20
> AxMetricFn
AxMetricFn: <
T>(arg0) =>number
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L16
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends AxGenOut | AxGenOut |
Parameters
| Parameter | Type |
|---|---|
arg0 | Readonly<{ example: AxExample; prediction: T; }> |
Returns
number
> AxMockAIServiceConfig
AxMockAIServiceConfig:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mock/api.ts#L19
Type declaration
chatResponse?
optionalchatResponse:AxChatResponse|ReadableStream<AxChatResponse> | () =>Promise<AxChatResponse|ReadableStream<AxChatResponse>> | (req,options?) =>Promise<AxChatResponse|ReadableStream<AxChatResponse>>
embedModelInfo?
optionalembedModelInfo:AxModelInfoWithProvider
embedResponse?
optionalembedResponse:AxEmbedResponse| (req) =>AxEmbedResponse|Promise<AxEmbedResponse>
errorMessage?
optionalerrorMessage:string
features?
{
functions:boolean;streaming:boolean; }
id?
optionalid:string
latencyMs?
optionallatencyMs:number
modelInfo?
optionalmodelInfo:Partial<AxModelInfoWithProvider>
models?
optionalmodels:AxAIModelList
name?
optionalname:string
options?
optionaloptions:AxAIServiceOptions
shouldError?
optionalshouldError:boolean
> AxModelConfig
AxModelConfig:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L39
Type declaration
endSequences?
optionalendSequences:string[]
frequencyPenalty?
optionalfrequencyPenalty:number
maxTokens?
optionalmaxTokens:number
n?
optionaln:number
presencePenalty?
optionalpresencePenalty:number
stopSequences?
optionalstopSequences:string[]
stream?
optionalstream:boolean
temperature?
optionaltemperature:number
topK?
optionaltopK:number
topP?
optionaltopP:number
> AxModelInfo
AxModelInfo:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L21
Type declaration
aliases?
optionalaliases:string[]
characterIsToken?
optionalcharacterIsToken:boolean
completionTokenCostPer1M?
optionalcompletionTokenCostPer1M:number
currency?
optionalcurrency:string
hasShowThoughts?
optionalhasShowThoughts:boolean
hasThinkingBudget?
optionalhasThinkingBudget:boolean
name
name:
string
promptTokenCostPer1M?
optionalpromptTokenCostPer1M:number
> AxModelInfoWithProvider
AxModelInfoWithProvider:
AxModelInfo&object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L121
Type declaration
provider
provider:
string
> AxModelUsage
AxModelUsage:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L101
Type declaration
ai
ai:
string
model
model:
string
tokens?
optionaltokens:AxTokenUsage
> AxOptimizerArgs
AxOptimizerArgs<
IN,OUT>:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/optimize.ts#L22
Type Parameters
| Type Parameter |
|---|
IN extends AxGenIn |
OUT extends AxGenOut |
Type declaration
ai
ai:
AxAIService
examples
examples:
Readonly<AxExample[]>
options?
{
batchSize:number;costMonitoring:boolean;debugMode:boolean;earlyStoppingPatience:number;maxDemos:number;maxExamples:number;maxRounds:number;maxTokensPerGeneration:number;teacherAI:AxAIService;verboseMode:boolean; }
program
program:
Readonly<AxProgram<IN,OUT>>
> AxProgramDemos
AxProgramDemos:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L24
Type declaration
programId
programId:
string
traces
traces:
Record<string,AxFieldValue>[]
> AxProgramExamples
AxProgramExamples:
AxProgramDemos|AxProgramDemos["traces"]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L30
> AxProgramStreamingForwardOptions
AxProgramStreamingForwardOptions:
Omit<AxProgramForwardOptions,"stream">
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L61
> AxProgramForwardOptions
AxProgramForwardOptions:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L32
Type declaration
abortSignal?
optionalabortSignal:AbortSignal
ai?
optionalai:AxAIService
debug?
optionaldebug:boolean
debugHideSystemPrompt?
optionaldebugHideSystemPrompt:boolean
fastFail?
optionalfastFail:boolean
functionCall?
optionalfunctionCall:AxChatRequest["functionCall"]
functions?
optionalfunctions:AxInputFunctionType
maxRetries?
optionalmaxRetries:number
maxSteps?
optionalmaxSteps:number
mem?
optionalmem:AxAIMemory
model?
optionalmodel:string
modelConfig?
optionalmodelConfig:AxModelConfig
rateLimiter?
optionalrateLimiter:AxRateLimiterFunction
sessionId?
optionalsessionId:string
stopFunction?
optionalstopFunction:string
stream?
optionalstream:boolean
thinkingTokenBudget?
optionalthinkingTokenBudget:"minimal"|"low"|"medium"|"high"|"highest"|"none"
traceId?
optionaltraceId:string
traceLabel?
optionaltraceLabel:string
tracer?
optionaltracer:Tracer
> AxProgramTrace
AxProgramTrace:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L18
Type declaration
programId
programId:
string
trace
trace:
Record<string,AxFieldValue>
> AxRateLimiterFunction
AxRateLimiterFunction: <
T>(reqFunc,info) =>Promise<T|ReadableStream<T>>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L228
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
reqFunc | () => Promise<T | ReadableStream<T>> |
info | Readonly<{ modelUsage: AxModelUsage; }> |
Returns
Promise<T | ReadableStream<T>>
> AxProgramUsage
AxProgramUsage:
AxChatResponse["modelUsage"] &object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L98
Type declaration
ai
ai:
string
model
model:
string
> AxRerankerIn
AxRerankerIn:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L8
Type declaration
items
items:
string[]
query
query:
string
> AxRerankerOut
AxRerankerOut:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L9
Type declaration
rankedItems
rankedItems:
string[]
> AxRewriteIn
AxRewriteIn:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L5
Type declaration
query
query:
string
> AxRewriteOut
AxRewriteOut:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/docs/manager.ts#L6
Type declaration
rewrittenQuery
rewrittenQuery:
string
> AxSetExamplesOptions
AxSetExamplesOptions:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/program.ts#L78
Type declaration
optionalOutputFields?
optionaloptionalOutputFields:string[]
> AxStreamingFieldProcessorProcess
AxStreamingFieldProcessorProcess: (
value,context?) =>unknown|Promise<unknown>
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/fieldProcessor.ts#L16
Parameters
| Parameter | Type |
|---|---|
value | string |
context? | Readonly<{ done: boolean; sessionId: string; values: AxGenOut; }> |
Returns
unknown | Promise<unknown>
> AxEvalUtil
constAxEvalUtil:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/eval.ts#L143
Type declaration
emScore()
(
prediction,groundTruth) =>number
f1Score()
(
prediction,groundTruth) =>number
novelF1ScoreOptimized()
(
history,prediction,groundTruth,returnRecall) =>number
> AxTokenUsage
AxTokenUsage:
object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/types.ts#L32
Type declaration
completionTokens
completionTokens:
number
promptTokens
promptTokens:
number
thoughtsTokens?
optionalthoughtsTokens:number
totalTokens
totalTokens:
number
> AxStringUtil
constAxStringUtil:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/dsp/strutil.ts#L66
Type declaration
batchArray()
<
T>(arr,size) =>T[][]
dedup()
(
seq) =>string[]
extractIdAndText()
(
input) =>object
extractIndexPrefixedText()
(
input) =>string
splitIntoTwo()
(
str,separator) =>string[]
trimNonAlphaNum()
(
str) =>string
> axModelInfoAnthropic
constaxModelInfoAnthropic:AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/anthropic/info.ts#L5
> axModelInfoCohere
constaxModelInfoCohere:AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/cohere/info.ts#L5
> axModelInfoDeepSeek
constaxModelInfoDeepSeek:AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/deepseek/info.ts#L5
> axModelInfoGoogleGemini
constaxModelInfoGoogleGemini:AxModelInfo[]
AxAIGoogleGemini: Model information
> axModelInfoGrok
constaxModelInfoGrok:AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/x-grok/info.ts#L7
> axModelInfoGroq
constaxModelInfoGroq:AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/groq/info.ts#L8
AxAIGroq: Model information
> axModelInfoHuggingFace
constaxModelInfoHuggingFace:AxModelInfo[] =[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/huggingface/info.ts#L6
HuggingFace: Model information
> axModelInfoMistral
constaxModelInfoMistral:AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/mistral/info.ts#L7
> axModelInfoOpenAI
constaxModelInfoOpenAI:AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/openai/info.ts#L8
OpenAI: Model information
> axModelInfoReka
constaxModelInfoReka:AxModelInfo[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/reka/info.ts#L7
OpenAI: Model information
> axModelInfoTogether
constaxModelInfoTogether:AxModelInfo[] =[]
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/ai/together/info.ts#L3
> axSpanAttributes
constaxSpanAttributes:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L1
Type declaration
DB_ID
DB_ID:
string='db.id'
DB_NAMESPACE
DB_NAMESPACE:
string='db.namespace'
DB_OPERATION_NAME
DB_OPERATION_NAME:
string='db.operation.name'
DB_QUERY_EMBEDDINGS
DB_QUERY_EMBEDDINGS:
string='db.query.embeddings'
DB_QUERY_EMBEDDINGS_VECTOR
DB_QUERY_EMBEDDINGS_VECTOR:
string='db.query.embeddings.vector'
DB_QUERY_RESULT
DB_QUERY_RESULT:
string='db.query.result'
DB_QUERY_RESULT_DISTANCE
DB_QUERY_RESULT_DISTANCE:
string='db.query.result.distance'
DB_QUERY_RESULT_DOCUMENT
DB_QUERY_RESULT_DOCUMENT:
string='db.query.result.document'
DB_QUERY_RESULT_ID
DB_QUERY_RESULT_ID:
string='db.query.result.id'
DB_QUERY_RESULT_METADATA
DB_QUERY_RESULT_METADATA:
string='db.query.result.metadata'
DB_QUERY_RESULT_SCORE
DB_QUERY_RESULT_SCORE:
string='db.query.result.score'
DB_QUERY_RESULT_VECTOR
DB_QUERY_RESULT_VECTOR:
string='db.query.result.vector'
DB_QUERY_TEXT
DB_QUERY_TEXT:
string='db.query.text'
DB_SYSTEM
DB_SYSTEM:
string='db.system'
DB_TABLE
DB_TABLE:
string='db.table'
DB_VECTOR
DB_VECTOR:
string='db.vector'
DB_VECTOR_QUERY_TOP_K
DB_VECTOR_QUERY_TOP_K:
string='db.vector.query.top_k'
LLM_OPERATION_NAME
LLM_OPERATION_NAME:
string='gen_ai.operation.name'
LLM_REQUEST_FREQUENCY_PENALTY
LLM_REQUEST_FREQUENCY_PENALTY:
string='gen_ai.request.frequency_penalty'
LLM_REQUEST_LLM_IS_STREAMING
LLM_REQUEST_LLM_IS_STREAMING:
string='gen_ai.request.llm_is_streaming'
LLM_REQUEST_MAX_TOKENS
LLM_REQUEST_MAX_TOKENS:
string='gen_ai.request.max_tokens'
LLM_REQUEST_MODEL
LLM_REQUEST_MODEL:
string='gen_ai.request.model'
LLM_REQUEST_PRESENCE_PENALTY
LLM_REQUEST_PRESENCE_PENALTY:
string='gen_ai.request.presence_penalty'
LLM_REQUEST_STOP_SEQUENCES
LLM_REQUEST_STOP_SEQUENCES:
string='gen_ai.request.stop_sequences'
LLM_REQUEST_TEMPERATURE
LLM_REQUEST_TEMPERATURE:
string='gen_ai.request.temperature'
LLM_REQUEST_TOP_K
LLM_REQUEST_TOP_K:
string='gen_ai.request.top_k'
LLM_REQUEST_TOP_P
LLM_REQUEST_TOP_P:
string='gen_ai.request.top_p'
LLM_SYSTEM
LLM_SYSTEM:
string='gen_ai.system'
LLM_USAGE_INPUT_TOKENS
LLM_USAGE_INPUT_TOKENS:
string='gen_ai.usage.input_tokens'
LLM_USAGE_OUTPUT_TOKENS
LLM_USAGE_OUTPUT_TOKENS:
string='gen_ai.usage.output_tokens'
LLM_USAGE_THOUGHTS_TOKENS
LLM_USAGE_THOUGHTS_TOKENS:
string='gen_ai.usage.thoughts_tokens'
LLM_USAGE_TOTAL_TOKENS
LLM_USAGE_TOTAL_TOKENS:
string='gen_ai.usage.total_tokens'
> axSpanEvents
constaxSpanEvents:object
Defined in: https://github.com/ax-llm/ax/blob/b1fa2c6ed0bae779406eed86e4e0ccd645c8c651/src/ax/trace/trace.ts#L45
Type declaration
GEN_AI_ASSISTANT_MESSAGE
GEN_AI_ASSISTANT_MESSAGE:
string='gen_ai.assistant.message'
GEN_AI_CHOICE
GEN_AI_CHOICE:
string='gen_ai.choice'
GEN_AI_SYSTEM_MESSAGE
GEN_AI_SYSTEM_MESSAGE:
string='gen_ai.system.message'
GEN_AI_TOOL_MESSAGE
GEN_AI_TOOL_MESSAGE:
string='gen_ai.tool.message'
GEN_AI_USAGE
GEN_AI_USAGE:
string='gen_ai.usage'
GEN_AI_USER_MESSAGE
GEN_AI_USER_MESSAGE:
string='gen_ai.user.message'