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

AxFlowable

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/flow/types.ts#L65

Interface for flows that can be tuned, executed, and used in compositions. Provides methods for building and executing complex AI workflows.

Extends

Type Parameters

Type Parameter
IN
OUT

Properties

PropertyTypeInherited from
applyOptimization(optimizedProgram: AxOptimizedProgram<OUT>) => voidAxProgrammable.applyOptimization
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/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/types.ts#L184

Parameters

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

Returns

Promise<OUT>

Inherited from

AxProgrammable.forward


streamingForward()

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

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/types.ts#L190

Parameters

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

Returns

AxGenStreamingOut<OUT>

Inherited from

AxProgrammable.streamingForward