AxACE Generated TypeScript API reference. typescript api api/reference build/apidocs/Class.AxACE.md class AxACE

AxACE

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L314

AxACE implements the Agentic Context Engineering loop (Generator → Reflector → Curator). The implementation mirrors the paper’s architecture while integrating with the Ax optimizer ergonomics (unified optimized program artifacts, metrics, and checkpointing).

Extends

Constructors

Constructor

TypeScript
new AxACE(args: Readonly<AxOptimizerArgs>, options?: Readonly<AxACEOptions>): AxACE;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L329

Parameters

ParameterType
argsReadonly<AxOptimizerArgs>
options?Readonly<AxACEOptions>

Returns

AxACE

Overrides

AxBaseOptimizer.constructor

Methods

applyCurrentState()

TypeScript
applyCurrentState<IN, OUT>(program?: AxGen<IN, OUT>): void;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L399

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Parameters

ParameterType
program?AxGen<IN, OUT>

Returns

void


applyOnlineUpdate()

TypeScript
applyOnlineUpdate(args: Readonly<{
  example: AxExample;
  feedback?: string;
  prediction: unknown;
}>): Promise<undefined | AxACECuratorOutput>;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L682

Apply ACE updates after each online inference. Mirrors the online adaptation flow described in the paper; can be called by user-land code between queries.

Parameters

ParameterType
argsReadonly<{ example: AxExample; feedback?: string; prediction: unknown; }>

Returns

Promise<undefined | AxACECuratorOutput>


compile()

TypeScript
compile<IN, OUT>(
   program: Readonly<AxGen<IN, OUT>>, 
   examples: readonly AxTypedExample<IN>[], 
   metricFn: AxMetricFn, 
options?: AxACECompileOptions): Promise<AxACEResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L431

Abstract method that must be implemented by concrete optimizers

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Parameters

ParameterType
programReadonly<AxGen<IN, OUT>>
examplesreadonly AxTypedExample<IN>[]
metricFnAxMetricFn
options?AxACECompileOptions

Returns

Promise<AxACEResult<OUT>>

Overrides

AxBaseOptimizer.compile


compilePareto()

TypeScript
compilePareto<IN, OUT>(
   program: Readonly<AxGen<IN, OUT>>, 
   examples: readonly AxTypedExample<IN>[], 
   metricFn: AxMultiMetricFn, 
options?: AxCompileOptions): Promise<AxParetoResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizer.ts#L1688

Multi-objective optimization using Pareto frontier Default implementation that leverages the single-objective compile method

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Parameters

ParameterTypeDescription
programReadonly<AxGen<IN, OUT>>The program to optimize
examplesreadonly AxTypedExample<IN>[]Training examples
metricFnAxMultiMetricFnMulti-objective metric function that returns multiple scores
options?AxCompileOptionsOptional configuration options

Returns

Promise<AxParetoResult<OUT>>

Pareto optimization result with frontier of non-dominated solutions

Inherited from

AxBaseOptimizer.compilePareto


compileStream()

TypeScript
compileStream<IN, OUT>(
   program: Readonly<AxGen<IN, OUT>>, 
   examples: readonly AxTypedExample<IN>[], 
   metricFn: AxMetricFn, 
options?: AxCompileOptions): AsyncIterableIterator<AxOptimizationProgress>;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizer.ts#L1574

Optimize a program with real-time streaming updates

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Parameters

ParameterTypeDescription
programReadonly<AxGen<IN, OUT>>The program to optimize
examplesreadonly AxTypedExample<IN>[]Training examples
metricFnAxMetricFnEvaluation metric function
options?AxCompileOptionsOptional configuration options

Returns

AsyncIterableIterator<AxOptimizationProgress>

Async iterator yielding optimization progress

Inherited from

AxBaseOptimizer.compileStream


configureAuto()

TypeScript
configureAuto(level: "medium" | "light" | "heavy"): void;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L414

Parameters

ParameterType
level"medium" | "light" | "heavy"

Returns

void


getArtifact()

TypeScript
getArtifact(): AxACEOptimizationArtifact;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L395

Returns

AxACEOptimizationArtifact


getBaseInstruction()

TypeScript
getBaseInstruction(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L391

Returns

undefined | string


getPlaybook()

TypeScript
getPlaybook(): AxACEPlaybook;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L387

Returns

AxACEPlaybook


getStats()

TypeScript
getStats(): AxOptimizationStats;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizer.ts#L2685

Get current optimization statistics

Returns

AxOptimizationStats

Current optimization statistics

Inherited from

AxBaseOptimizer.getStats


hydrate()

TypeScript
hydrate<IN, OUT>(program: Readonly<AxGen<IN, OUT>>, state?: Readonly<{
  artifact?: Partial<AxACEOptimizationArtifact>;
  baseInstruction?: string;
  playbook?: AxACEPlaybook;
}>): void;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L364

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Parameters

ParameterType
programReadonly<AxGen<IN, OUT>>
state?Readonly<{ artifact?: Partial<AxACEOptimizationArtifact>; baseInstruction?: string; playbook?: AxACEPlaybook; }>

Returns

void


reset()

TypeScript
reset(): void;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/dsp/optimizers/ace.ts#L353

Reset optimizer state for reuse with different programs

Returns

void

Overrides

AxBaseOptimizer.reset

Docs