Documentation

Build LLM-powered agents
with production-ready TypeScript

DSPy for TypeScript. Working with LLMs is complex—they don't always do what you want. DSPy makes it easier to build amazing things with LLMs. Just define your inputs and outputs (signature) and an efficient prompt is auto-generated and used. Connect together various signatures to build complex systems and workflows using LLMs.

15+ LLM Providers
End-to-end Streaming
Auto Prompt Tuning

AxAgentic

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L32

Interface for agents that can be used as child agents. Provides methods to get the agent’s function definition and features.

Extends

Type Parameters

Type Parameter
IN extends AxGenIn
OUT extends AxGenOut

Properties

PropertyTypeInherited from
getSignature() => AxSignatureAxProgrammable.getSignature
getTraces() => AxProgramTrace<IN, OUT>[]AxProgrammable.getTraces
getUsage() => AxModelUsage & object[]AxProgrammable.getUsage
resetUsage() => voidAxProgrammable.resetUsage
setDemos(demos: readonly AxProgramDemos<IN, OUT>[]) => voidAxProgrammable.setDemos
setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>) => voidAxProgrammable.setExamples
setId(id: string) => voidAxProgrammable.setId
setParentId(parentId: string) => voidAxProgrammable.setParentId

Methods

forward()

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

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/types.ts#L173

Parameters

ParameterType
aiReadonly<AxAIService>
valuesIN | AxMessage<IN>[]
options?Readonly<AxProgramForwardOptions<string>>

Returns

Promise<OUT>

Inherited from

AxProgrammable.forward


getFeatures()

getFeatures(): AxAgentFeatures;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L35

Returns

AxAgentFeatures


getFunction()

getFunction(): AxFunction;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L34

Returns

AxFunction


streamingForward()

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

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/types.ts#L179

Parameters

ParameterType
aiReadonly<AxAIService>
valuesIN | AxMessage<IN>[]
options?Readonly<AxProgramStreamingForwardOptions<string>>

Returns

AxGenStreamingOut<OUT>

Inherited from

AxProgrammable.streamingForward