Skip to content
Ax
Search
Ctrl
K
Cancel
GitHub
Twitter
Discord
Select theme
Dark
Light
Auto
Start Here
Quick Start
Supported LLMs
About Ax
Guides
DSPy Explained
Functions Part 1
Functions Part 2
Use in production
API Docs
Classes
AxAgent
AxAI
AxAIAnthropic
AxAIAzureOpenAI
AxAICohere
AxAIDeepSeek
AxAIGoogleGemini
AxAIGroq
AxAIHuggingFace
AxAIMistral
AxAIOllama
AxAIOpenAI
AxAITogether
AxApacheTika
AxBalancer
AxBaseAI
AxBootstrapFewShot
AxChainOfThought
AxDB
AxDBCloudflare
AxDBManager
AxDBMemory
AxDBPinecone
AxDBWeaviate
AxDefaultQueryRewriter
AxDefaultResultReranker
AxDockerSession
AxEmbeddingAdapter
AxGen
AxHFDataLoader
AxInstanceRegistry
AxJSInterpreter
AxMemory
AxProgram
AxProgramWithSignature
AxPromptTemplate
AxRAG
AxRateLimiterTokenUsage
AxReAct
AxRoute
AxRouter
AxSignature
AxTestPrompt
Enums
Functions
axAIAnthropicDefaultConfig
axAIAzureOpenAIBestConfig
axAIAzureOpenAICreativeConfig
axAIAzureOpenAIDefaultConfig
axAIAzureOpenAIFastConfig
axAICohereCreativeConfig
axAICohereDefaultConfig
axAIDeepSeekCodeConfig
axAIDeepSeekDefaultConfig
axAIGoogleGeminiDefaultConfig
axAIGoogleGeminiDefaultCreativeConfig
axAIHuggingFaceCreativeConfig
axAIHuggingFaceDefaultConfig
axAIMistralBestConfig
axAIMistralDefaultConfig
axAIOllamaDefaultConfig
axAIOllamaDefaultCreativeConfig
axAIOpenAIBestConfig
axAIOpenAICreativeConfig
axAIOpenAIDefaultConfig
axAIOpenAIFastConfig
axAITogetherDefaultConfig
axBaseAIDefaultConfig
axBaseAIDefaultCreativeConfig
Interfaces
AxAgentic
AxAIAnthropicArgs
AxAIAnthropicContentBlockDeltaEvent
AxAIAnthropicContentBlockStartEvent
AxAIAnthropicContentBlockStopEvent
AxAIAnthropicErrorEvent
AxAIAnthropicMessageDeltaEvent
AxAIAnthropicMessageStartEvent
AxAIAnthropicMessageStopEvent
AxAIAnthropicPingEvent
AxAIAzureOpenAIArgs
AxAICohereArgs
AxAIDeepSeekArgs
AxAIGoogleGeminiArgs
AxAIGoogleGeminiOptionsTools
AxAIGroqArgs
AxAIHuggingFaceArgs
AxAIMemory
AxAIMistralArgs
AxAIOpenAIArgs
AxAIOpenAIResponseDelta
AxAIService
AxAITogetherArgs
AxApacheTikaArgs
AxApacheTikaConvertOptions
AxAssertion
AxBaseAIArgs
AxBaseAIFeatures
AxContext
AxDBCloudflareArgs
AxDBLoaderOptions
AxDBManagerArgs
AxDBMatch
AxDBMemoryArgs
AxDBPineconeArgs
AxDBQueryService
AxDBService
AxDBWeaviateArgs
AxDockerContainer
AxField
AxGenOptions
AxProgramWithSignatureOptions
AxResponseHandlerArgs
AxRouterForwardOptions
AxSpan
AxSpanAttributes
AxSpanContext
AxSpanException
AxSpanLink
AxSpanOptions
AxSpanStatus
AxSpanTimeInput
AxStreamingAssertion
AxTracer
AxTunable
AxUsable
Types
API
AxAgentOptions
AxAIAnthropicChatError
AxAIAnthropicChatRequest
AxAIAnthropicChatRequestCacheParam
AxAIAnthropicChatResponse
AxAIAnthropicChatResponseDelta
AxAIAnthropicConfig
AxAIArgs
AxAICohereChatRequest
AxAICohereChatRequestToolResults
AxAICohereChatResponse
AxAICohereChatResponseDelta
AxAICohereChatResponseToolCalls
AxAICohereConfig
AxAICohereEmbedRequest
AxAICohereEmbedResponse
AxAIEmbedModels
AxAIGoogleGeminiBatchEmbedRequest
AxAIGoogleGeminiBatchEmbedResponse
AxAIGoogleGeminiChatRequest
AxAIGoogleGeminiChatResponse
AxAIGoogleGeminiChatResponseDelta
AxAIGoogleGeminiConfig
AxAIGoogleGeminiContent
AxAIGoogleGeminiGenerationConfig
AxAIGoogleGeminiSafetySettings
AxAIGoogleGeminiTool
AxAIGoogleGeminiToolConfig
AxAIGoogleGeminiToolFunctionDeclaration
AxAIGoogleGeminiToolGoogleSearchRetrieval
AxAIHuggingFaceConfig
AxAIHuggingFaceRequest
AxAIHuggingFaceResponse
AxAIModelMap
AxAIModels
AxAIOllamaAIConfig
AxAIOllamaArgs
AxAIOpenAIChatRequest
AxAIOpenAIChatResponse
AxAIOpenAIChatResponseDelta
AxAIOpenAIConfig
AxAIOpenAIEmbedRequest
AxAIOpenAIEmbedResponse
AxAIOpenAILogprob
AxAIOpenAIUsage
AxAIPromptConfig
AxAIServiceActionOptions
AxAIServiceOptions
AxChatRequest
AxChatResponse
AxChatResponseResult
AxDataRow
AxDBArgs
AxDBCloudflareOpOptions
AxDBMemoryOpOptions
AxDBPineconeOpOptions
AxDBQueryRequest
AxDBQueryResponse
AxDBState
AxDBUpsertRequest
AxDBUpsertResponse
AxDBWeaviateOpOptions
AxEmbedRequest
AxEmbedResponse
AxEvaluateArgs
AxExample
AxFieldTemplateFn
AxFieldValue
AxFunction
AxFunctionHandler
AxFunctionJSONSchema
AxGenerateResult
AxGenIn
AxGenOut
AxIField
AxInternalChatRequest
AxInternalEmbedRequest
AxMetricFn
AxMetricFnArgs
AxModelConfig
AxModelInfo
AxModelInfoWithProvider
AxOptimizerArgs
AxProgramDemos
AxProgramExamples
AxProgramForwardOptions
AxProgramTrace
AxProgramUsage
AxRateLimiterFunction
AxRerankerIn
AxRerankerOut
AxRewriteIn
AxRewriteOut
AxSpanAttributeValue
AxTokenUsage
AxWritableChatPrompt
InputParsedFieldList
OutputParsedFieldList
ParsedIdentifier
ParsedSignature
Variables
axEvalUtil
axModelInfoAnthropic
axModelInfoCohere
axModelInfoDeepSeek
axModelInfoGoogleGemini
axModelInfoGroq
axModelInfoHuggingFace
axModelInfoMistral
axModelInfoOpenAI
axModelInfoTogether
axSpanAttributes
axSpanEvents
axStringUtil
GitHub
Twitter
Discord
Select theme
Dark
Light
Auto
AxProgramWithSignatureOptions
Interface: AxProgramWithSignatureOptions
Properties
description?
optional
description
:
string
Defined in
src/ax/dsp/program.ts:78