API Documentation
Complete API reference for the Ax LLM Framework.
Classes
AxAgent
AxAI
AxAIAnthropic
AxAIAzureOpenAI
AxAICohere
AxAIDeepSeek
AxAIGoogleGemini
AxAIGrok
AxAIGroq
AxAIHuggingFace
AxAIMistral
AxAIOllama
AxAIOpenAI
AxAIOpenAIBase
AxAIOpenAIResponses
AxAIOpenAIResponsesBase
AxAIOpenAIResponsesImpl
AxAIOpenRouter
AxAIRefusalError
AxAIReka
AxAIServiceAbortedError
AxAIServiceAuthenticationError
AxAIServiceError
AxAIServiceNetworkError
AxAIServiceResponseError
AxAIServiceStatusError
AxAIServiceStreamTerminatedError
AxAIServiceTimeoutError
AxAITogether
AxAIWebLLM
AxApacheTika
AxAssertionError
AxBalancer
AxBaseAI
AxBaseOptimizer
AxBootstrapFewShot
AxContentProcessingError
AxDB
AxDBBase
AxDBCloudflare
AxDBManager
AxDBMemory
AxDBPinecone
AxDBWeaviate
AxDefaultCostTracker
AxDefaultResultReranker
AxDockerSession
AxEmbeddingAdapter
AxFlow
AxFlowDependencyAnalyzer
AxFlowExecutionPlanner
AxFlowSubContextImpl
AxFlowTypedSubContextImpl
AxFluentFieldType
AxFunctionError
AxFunctionProcessor
AxGen
AxGenerateError
AxHFDataLoader
AxInstanceRegistry
AxMCPClient
AxMCPHTTPSSETransport
AxMCPStreambleHTTPTransport
AxMediaNotSupportedError
AxMemory
AxMiPRO
AxMockAIService
AxMultiServiceRouter
AxOptimizedProgramImpl
AxProgram
AxPromptTemplate
AxProviderRouter
AxRateLimiterTokenUsage
AxSignature
AxSignatureBuilder
AxSimpleClassifier
AxSimpleClassifierClass
AxStopFunctionCallException
AxTestPrompt
Interfaces
AxAgentConfig
AxAgentFeatures
AxAgentic
AxAIAnthropicArgs
AxAIAnthropicContentBlockDeltaEvent
AxAIAnthropicContentBlockStartEvent
AxAIAnthropicContentBlockStopEvent
AxAIAnthropicErrorEvent
AxAIAnthropicMessageDeltaEvent
AxAIAnthropicMessageStartEvent
AxAIAnthropicMessageStopEvent
AxAIAnthropicPingEvent
AxAICohereArgs
AxAIFeatures
AxAIGoogleGeminiArgs
AxAIGoogleGeminiOptionsTools
AxAIGrokOptionsTools
AxAIGrokSearchSource
AxAIHuggingFaceArgs
AxAIMemory
AxAIMetricsInstruments
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
AxAIWebLLMArgs
AxApacheTikaArgs
AxApacheTikaConvertOptions
AxAPI
AxAPIConfig
AxAssertion
AxBaseAIArgs
AxBootstrapOptimizerOptions
AxCompileOptions
AxContentProcessingServices
AxCostTracker
AxCostTrackerOptions
AxDBBaseArgs
AxDBBaseOpOptions
AxDBCloudflareArgs
AxDBLoaderOptions
AxDBManagerArgs
AxDBMatch
AxDBMemoryArgs
AxDBPineconeArgs
AxDBQueryService
AxDBService
AxDBWeaviateArgs
AxDockerContainer
AxField
AxFieldProcessor
AxFieldType
AxFlowable
AxFlowAutoParallelConfig
AxFlowBranchContext
AxFlowBranchEvaluationData
AxFlowCompleteData
AxFlowDynamicContext
AxFlowErrorData
AxFlowExecutionStep
AxFlowLoggerData
AxFlowNodeDefinition
AxFlowParallelGroup
AxFlowParallelGroupCompleteData
AxFlowParallelGroupStartData
AxFlowStartData
AxFlowStepCompleteData
AxFlowStepStartData
AxFlowSubContext
AxFlowTypedSubContext
AxFluentFieldInfo
AxForwardable
AxGenMetricsInstruments
AxMCPFunctionDescription
AxMCPInitializeParams
AxMCPInitializeResult
AxMCPJSONRPCErrorResponse
AxMCPJSONRPCNotification
AxMCPJSONRPCRequest
AxMCPJSONRPCSuccessResponse
AxMCPStreamableHTTPTransportOptions
AxMCPToolsListResult
AxMCPTransport
AxMetricsConfig
AxMiPROOptimizerOptions
AxMiPROResult
AxMultiProviderConfig
AxOptimizationCheckpoint
AxOptimizationProgress
AxOptimizationStats
AxOptimizedProgram
AxOptimizer
AxOptimizerMetricsConfig
AxOptimizerMetricsInstruments
AxOptimizerResult
AxParetoResult
AxProgrammable
AxProgramOptions
AxPromptTemplateOptions
AxRateLimiterTokenUsageOptions
AxResponseHandlerArgs
AxRoutingResult
AxSamplePickerOptions
AxSignatureConfig
AxSimpleClassifierForwardOptions
AxStreamingAssertion
AxStreamingEvent
AxTunable
AxUsable
Functions
agent
ai
ax
axAIAnthropicDefaultConfig
axAIAnthropicVertexDefaultConfig
axAICohereCreativeConfig
axAICohereDefaultConfig
axAIDeepSeekCodeConfig
axAIDeepSeekDefaultConfig
axAIGoogleGeminiDefaultConfig
axAIGoogleGeminiDefaultCreativeConfig
axAIGrokBestConfig
axAIGrokDefaultConfig
axAIHuggingFaceCreativeConfig
axAIHuggingFaceDefaultConfig
axAIMistralBestConfig
axAIMistralDefaultConfig
axAIOllamaDefaultConfig
axAIOllamaDefaultCreativeConfig
axAIOpenAIBestConfig
axAIOpenAICreativeConfig
axAIOpenAIDefaultConfig
axAIOpenAIFastConfig
axAIOpenAIResponsesBestConfig
axAIOpenAIResponsesCreativeConfig
axAIOpenAIResponsesDefaultConfig
axAIOpenRouterDefaultConfig
axAIRekaBestConfig
axAIRekaCreativeConfig
axAIRekaDefaultConfig
axAIRekaFastConfig
axAITogetherDefaultConfig
axAIWebLLMCreativeConfig
axAIWebLLMDefaultConfig
axAnalyzeChatPromptRequirements
axAnalyzeRequestRequirements
axBaseAIDefaultConfig
axBaseAIDefaultCreativeConfig
axCheckMetricsHealth
axCreateDefaultColorLogger
axCreateDefaultOptimizerColorLogger
axCreateDefaultOptimizerTextLogger
axCreateDefaultTextLogger
axCreateFlowColorLogger
axCreateFlowTextLogger
axGetCompatibilityReport
axGetFormatCompatibility
axGetMetricsConfig
axGetOptimizerMetricsConfig
axGetProvidersWithMediaSupport
axProcessContentForProvider
axRAG
axScoreProvidersForRequest
axSelectOptimalProvider
axUpdateMetricsConfig
axUpdateOptimizerMetricsConfig
axValidateChatRequestMessage
axValidateChatResponseResult
axValidateProviderCapabilities
flow
s
Enumerations
AxAIAnthropicModel
AxAIAnthropicVertexModel
AxAICohereEmbedModel
AxAICohereModel
AxAIDeepSeekModel
AxAIGoogleGeminiEmbedModel
AxAIGoogleGeminiEmbedTypes
AxAIGoogleGeminiModel
AxAIGoogleGeminiSafetyCategory
AxAIGoogleGeminiSafetyThreshold
AxAIGrokEmbedModels
AxAIGrokModel
AxAIGroqModel
AxAIHuggingFaceModel
AxAIMistralEmbedModels
AxAIMistralModel
AxAIOpenAIEmbedModel
AxAIOpenAIModel
AxAIOpenAIResponsesModel
AxAIRekaModel
AxAIWebLLMModel
AxLLMRequestTypeValues
AxSpanKindValues
Type Aliases
AxAgentOptions
AxAIAnthropicChatError
AxAIAnthropicChatRequest
AxAIAnthropicChatRequestCacheParam
AxAIAnthropicChatResponse
AxAIAnthropicChatResponseDelta
AxAIAnthropicConfig
AxAIAnthropicFunctionTool
AxAIAnthropicRequestTool
AxAIAnthropicThinkingConfig
AxAIAnthropicThinkingTokenBudgetLevels
AxAIAnthropicWebSearchTool
AxAIArgs
AxAIAzureOpenAIArgs
AxAIAzureOpenAIConfig
AxAICohereChatRequest
AxAICohereChatRequestToolResults
AxAICohereChatResponse
AxAICohereChatResponseDelta
AxAICohereChatResponseToolCalls
AxAICohereConfig
AxAICohereEmbedRequest
AxAICohereEmbedResponse
AxAIDeepSeekArgs
AxAIEmbedModels
AxAIGoogleGeminiBatchEmbedRequest
AxAIGoogleGeminiBatchEmbedResponse
AxAIGoogleGeminiChatRequest
AxAIGoogleGeminiChatResponse
AxAIGoogleGeminiChatResponseDelta
AxAIGoogleGeminiConfig
AxAIGoogleGeminiContent
AxAIGoogleGeminiContentPart
AxAIGoogleGeminiGenerationConfig
AxAIGoogleGeminiSafetySettings
AxAIGoogleGeminiThinkingConfig
AxAIGoogleGeminiThinkingTokenBudgetLevels
AxAIGoogleGeminiTool
AxAIGoogleGeminiToolConfig
AxAIGoogleGeminiToolFunctionDeclaration
AxAIGoogleGeminiToolGoogleSearchRetrieval
AxAIGoogleVertexBatchEmbedRequest
AxAIGoogleVertexBatchEmbedResponse
AxAIGrokArgs
AxAIGrokChatRequest
AxAIGroqArgs
AxAIHuggingFaceConfig
AxAIHuggingFaceRequest
AxAIHuggingFaceResponse
AxAIInputModelList
AxAIMistralArgs
AxAIMistralChatRequest
AxAIModelList
AxAIModelListBase
AxAIModels
AxAIOllamaAIConfig
AxAIOllamaArgs
AxAIOpenAIAnnotation
AxAIOpenAIChatRequest
AxAIOpenAIChatResponse
AxAIOpenAIChatResponseDelta
AxAIOpenAIConfig
AxAIOpenAIEmbedRequest
AxAIOpenAIEmbedResponse
AxAIOpenAILogprob
AxAIOpenAIResponsesConfig
AxAIOpenAIResponsesInputContentPart
AxAIOpenAIResponsesInputItem
AxAIOpenAIResponsesOutputItem
AxAIOpenAIResponsesStreamEvent
AxAIOpenAIResponsesToolCall
AxAIOpenAIResponsesToolChoice
AxAIOpenAIResponsesToolDefinition
AxAIOpenAIUrlCitation
AxAIOpenAIUsage
AxAIOpenRouterArgs
AxAIRekaChatRequest
AxAIRekaChatResponse
AxAIRekaChatResponseDelta
AxAIRekaConfig
AxAIRekaUsage
AxAIServiceActionOptions
AxAIServiceModelType
AxAIServiceOptions
AxAITogetherArgs
AxAIWebLLMChatRequest
AxAIWebLLMChatResponse
AxAIWebLLMChatResponseDelta
AxAIWebLLMConfig
AxAIWebLLMEmbedModel
AxAIWebLLMEmbedRequest
AxAIWebLLMEmbedResponse
AxBalancerOptions
AxChatRequest
AxChatResponse
AxChatResponseFunctionCall
AxChatResponseResult
AxCheckpointLoadFn
AxCheckpointSaveFn
AxCitation
AxDataRow
AxDBArgs
AxDBCloudflareOpOptions
AxDBMemoryOpOptions
AxDBPineconeOpOptions
AxDBQueryRequest
AxDBQueryResponse
AxDBState
AxDBUpsertRequest
AxDBUpsertResponse
AxDBWeaviateOpOptions
AxEmbedRequest
AxEmbedResponse
AxErrorCategory
AxEvaluateArgs
AxExample
AxFieldProcessorProcess
AxFieldTemplateFn
AxFieldValue
AxFlowLogData
AxFlowLoggerFunction
AxFlowParallelBranch
AxFlowState
AxFlowStepFunction
AxFlowTypedParallelBranch
AxFunction
AxFunctionHandler
AxFunctionJSONSchema
AxFunctionResult
AxFunctionResultFormatter
AxGenDeltaOut
AxGenerateErrorDetails
AxGenerateResult
AxGenIn
AxGenOut
AxGenStreamingOut
AxIField
AxInputFunctionType
AxInternalChatRequest
AxInternalEmbedRequest
AxLoggerData
AxLoggerFunction
AxMCPJSONRPCResponse
AxMemoryData
AxMessage
AxMetricFn
AxMetricFnArgs
AxMockAIServiceConfig
AxModelConfig
AxModelInfo
AxModelInfoWithProvider
AxModelUsage
AxMultiMetricFn
AxOptimizerArgs
AxOptimizerLoggerData
AxOptimizerLoggerFunction
AxProgramDemos
AxProgramExamples
AxProgramForwardOptions
AxProgramForwardOptionsWithModels
AxProgramStreamingForwardOptions
AxProgramStreamingForwardOptionsWithModels
AxProgramTrace
AxProgramUsage
AxRateLimiterFunction
AxRerankerIn
AxRerankerOut
AxResultPickerFunction
AxResultPickerFunctionFieldResults
AxResultPickerFunctionFunctionResults
AxRewriteIn
AxRewriteOut
AxSetExamplesOptions
AxStreamingFieldProcessorProcess
AxTokenUsage
AxTypedExample
Variables
axAIAzureOpenAIBestConfig
axAIAzureOpenAICreativeConfig
axAIAzureOpenAIDefaultConfig
axAIAzureOpenAIFastConfig
axDefaultFlowLogger
axDefaultMetricsConfig
axDefaultOptimizerLogger
axDefaultOptimizerMetricsConfig
AxEvalUtil
axGlobals
axModelInfoAnthropic
axModelInfoCohere
axModelInfoDeepSeek
axModelInfoGoogleGemini
axModelInfoGrok
axModelInfoGroq
axModelInfoHuggingFace
axModelInfoMistral
axModelInfoOpenAI
axModelInfoOpenAIResponses
axModelInfoReka
axModelInfoTogether
axModelInfoWebLLM
axSpanAttributes
axSpanEvents
AxStringUtil
f