AxStepHooks Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxStepHooks.md type AxStepHooks

AxStepHooks

TypeScript
type AxStepHooks = object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L91

Hooks called at various points during the multi-step generation loop.

Properties

afterFunctionExecution()?

TypeScript
optional afterFunctionExecution: (ctx: AxStepContext) => void | Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L94

Parameters

ParameterType
ctxAxStepContext

Returns

void | Promise<void>


afterStep()?

TypeScript
optional afterStep: (ctx: AxStepContext) => void | Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L93

Parameters

ParameterType
ctxAxStepContext

Returns

void | Promise<void>


beforeStep()?

TypeScript
optional beforeStep: (ctx: AxStepContext) => void | Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L92

Parameters

ParameterType
ctxAxStepContext

Returns

void | Promise<void>

Docs