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

AxDefaultResultReranker

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/docs/reranker.ts#L11

Extends

Constructors

Constructor

new AxDefaultResultReranker(options?: Readonly<AxProgramForwardOptions<string>>): AxDefaultResultReranker;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/docs/reranker.ts#L15

Parameters

ParameterType
options?Readonly<AxProgramForwardOptions<string>>

Returns

AxDefaultResultReranker

Overrides

AxGen.constructor

Methods

_forward1()

_forward1(
   ai: Readonly<AxAIService>, 
   values: 
  | AxRerankerIn
  | AxMessage<AxRerankerIn>[], 
options: Readonly<AxProgramForwardOptions<any>>): AxGenStreamingOut<AxRerankerOut>;

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

Parameters

ParameterType
aiReadonly<AxAIService>
values| AxRerankerIn | AxMessage<AxRerankerIn>[]
optionsReadonly<AxProgramForwardOptions<any>>

Returns

AxGenStreamingOut<AxRerankerOut>

Inherited from

AxGen._forward1


addAssert()

addAssert(fn: (values: Record<string, unknown>) => undefined | boolean | Promise<undefined | boolean>, message?: string): void;

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

Parameters

ParameterType
fn(values: Record<string, unknown>) => undefined | boolean | Promise<undefined | boolean>
message?string

Returns

void

Inherited from

AxGen.addAssert


addFieldProcessor()

addFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

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

Parameters

ParameterType
fieldNamestring
fn| AxFieldProcessorProcess | AxStreamingFieldProcessorProcess

Returns

void

Inherited from

AxGen.addFieldProcessor


addStreamingAssert()

addStreamingAssert(
   fieldName: string, 
   fn: (content: string, done?: boolean) => undefined | boolean, 
   message?: string): void;

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

Parameters

ParameterType
fieldNamestring
fn(content: string, done?: boolean) => undefined | boolean
message?string

Returns

void

Inherited from

AxGen.addStreamingAssert


addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName: string, fn: 
  | AxFieldProcessorProcess
  | AxStreamingFieldProcessorProcess): void;

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

Parameters

ParameterType
fieldNamestring
fn| AxFieldProcessorProcess | AxStreamingFieldProcessorProcess

Returns

void

Inherited from

AxGen.addStreamingFieldProcessor


forward()

forward<T>(
   ai: T, 
   input: Readonly<AxRerankerIn>, 
options?: Readonly<AxProgramForwardOptionsWithModels<T>>): Promise<AxRerankerOut>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/docs/reranker.ts#L22

Type Parameters

Type Parameter
T extends Readonly<AxAIService<unknown, unknown, string>>

Parameters

ParameterType
aiT
inputReadonly<AxRerankerIn>
options?Readonly<AxProgramForwardOptionsWithModels<T>>

Returns

Promise<AxRerankerOut>

Overrides

AxGen.forward


getSignature()

getSignature(): AxSignature;

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

Returns

AxSignature

Inherited from

AxGen.getSignature


getTraces()

getTraces(): AxProgramTrace<AxRerankerIn, AxRerankerOut>[];

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

Returns

AxProgramTrace<AxRerankerIn, AxRerankerOut>[]

Inherited from

AxGen.getTraces


getUsage()

getUsage(): AxModelUsage & object[];

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

Returns

AxModelUsage & object[]

Inherited from

AxGen.getUsage


register()

register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;

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

Parameters

ParameterType
progReadonly<AxTunable<IN, OUT> & AxUsable>

Returns

void

Inherited from

AxGen.register


resetUsage()

resetUsage(): void;

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

Returns

void

Inherited from

AxGen.resetUsage


setDemos()

setDemos(demos: readonly AxProgramDemos<AxRerankerIn, AxRerankerOut>[]): void;

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

Parameters

ParameterType
demosreadonly AxProgramDemos<AxRerankerIn, AxRerankerOut>[]

Returns

void

Inherited from

AxGen.setDemos


setDescription()

setDescription(description: string): void;

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

Parameters

ParameterType
descriptionstring

Returns

void

Inherited from

AxGen.setDescription


setExamples()

setExamples(examples: Readonly<AxProgramExamples<AxRerankerIn, AxRerankerOut>>, options?: Readonly<AxSetExamplesOptions>): void;

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

Parameters

ParameterType
examplesReadonly<AxProgramExamples<AxRerankerIn, AxRerankerOut>>
options?Readonly<AxSetExamplesOptions>

Returns

void

Inherited from

AxGen.setExamples


setId()

setId(id: string): void;

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

Parameters

ParameterType
idstring

Returns

void

Inherited from

AxGen.setId


setParentId()

setParentId(parentId: string): void;

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

Parameters

ParameterType
parentIdstring

Returns

void

Inherited from

AxGen.setParentId


setSignature()

setSignature(signature: 
  | undefined
  | Readonly<
  | string
  | AxSignature<Record<string, any>, Record<string, any>>
  | AxSignatureConfig>): void;

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

Parameters

ParameterType
signature| undefined | Readonly< | string | AxSignature<Record<string, any>, Record<string, any>> | AxSignatureConfig>

Returns

void

Inherited from

AxGen.setSignature


streamingForward()

streamingForward<T>(
   ai: T, 
   values: 
  | AxRerankerIn
  | AxMessage<AxRerankerIn>[], 
options?: Readonly<AxProgramStreamingForwardOptionsWithModels<T>>): AxGenStreamingOut<AxRerankerOut>;

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

Type Parameters

Type Parameter
T extends Readonly<AxAIService<unknown, unknown, string>>

Parameters

ParameterType
aiT
values| AxRerankerIn | AxMessage<AxRerankerIn>[]
options?Readonly<AxProgramStreamingForwardOptionsWithModels<T>>

Returns

AxGenStreamingOut<AxRerankerOut>

Inherited from

AxGen.streamingForward


updateMeter()

updateMeter(meter?: Meter): void;

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

Parameters

ParameterType
meter?Meter

Returns

void

Inherited from

AxGen.updateMeter