AxStepContext

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L47

Mutable context object that flows through the generation loop. Accessible to functions and step hooks, enabling per-step control over model, options, functions, and loop flow.

Uses a pending mutations pattern: changes are collected during a step and applied at the top of the next iteration.

Properties

Property	Modifier	Type
`functionsExecuted`	`readonly`	`ReadonlySet`<`string`>
`isFirstStep`	`readonly`	`boolean`
`lastFunctionCalls`	`readonly`	readonly `AxFunctionCallRecord`[]
`maxSteps`	`readonly`	`number`
`state`	`readonly`	`Map`<`string`, `unknown`>
`stepIndex`	`readonly`	`number`
`usage`	`readonly`	`Readonly`<`AxStepUsage`>

Methods

addFunctions()

TypeScript

addFunctions(functions: AxInputFunctionType): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L69

Parameters

Parameter	Type
`functions`	`AxInputFunctionType`

Returns

void

removeFunctions()

TypeScript

removeFunctions(...names: string[]): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L70

Parameters

Parameter	Type
…`names`	`string`[]

Returns

void

setMaxTokens()

TypeScript

setMaxTokens(maxTokens: number): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L63

Parameters

Parameter	Type
`maxTokens`	`number`

Returns

void

setModel()

TypeScript

setModel(model: string): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L60

Parameters

Parameter	Type
`model`	`string`

Returns

void

setOptions()

TypeScript

setOptions(options: Partial<AxAIServiceOptions & object>): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L64

Parameters

Parameter	Type
`options`	`Partial`<`AxAIServiceOptions` & `object`>

Returns

void

setTemperature()

TypeScript

setTemperature(temperature: number): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L62

Parameters

Parameter	Type
`temperature`	`number`

Returns

void

setThinkingBudget()

TypeScript

setThinkingBudget(budget: undefined | "high" | "low" | "minimal" | "medium" | "highest" | "none"): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L61

Parameters

Parameter	Type
`budget`	`undefined` \| `"high"` \| `"low"` \| `"minimal"` \| `"medium"` \| `"highest"` \| `"none"`

Returns

void

stop()

TypeScript

stop(resultValues?: Record<string, unknown>): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L71

Parameters

Parameter	Type
`resultValues?`	`Record`<`string`, `unknown`>

Returns

void