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

AxRunControl

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/runControl.ts#L33

A controller can be shared by a root run and its descendants.

Constructors

Constructor

TypeScript
new AxRunControl(): AxRunControl;

Returns

AxRunControl

Accessors

signal

Get Signature

TypeScript
get signal(): AbortSignal;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/runControl.ts#L40

Returns

AbortSignal

Methods

abort()

TypeScript
abort(): void;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/runControl.ts#L66

Returns

void


emit()

TypeScript
emit(event: AxRunControlEvent): void;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/runControl.ts#L96

Internal

Parameters

ParameterType
eventAxRunControlEvent

Returns

void


onEvent()

TypeScript
onEvent(listener: (event: AxRunControlEvent) => void): () => void;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/runControl.ts#L72

Parameters

ParameterType
listener(event: AxRunControlEvent) => void

Returns

TypeScript
(): void;
Returns

void


pending()

TypeScript
pending(path: string, after: number): readonly AxRunUpdate[];

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/runControl.ts#L80

Internal

Parameters

ParameterType
pathstring
afternumber

Returns

readonly AxRunUpdate[]


setThinkingTokenBudget()

TypeScript
setThinkingTokenBudget(level: NonNullable<undefined | "high" | "low" | "none" | "medium" | "minimal" | "highest">, options?: object): void;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/runControl.ts#L54

Parameters

ParameterType
levelNonNullable<undefined | "high" | "low" | "none" | "medium" | "minimal" | "highest">
options?{ target?: string; }
options.target?string

Returns

void


steer()

TypeScript
steer(text: string, options?: object): void;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/runControl.ts#L44

Parameters

ParameterType
textstring
options?{ target?: string; }
options.target?string

Returns

void


subscribe()

TypeScript
subscribe(listener: () => void): () => void;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/runControl.ts#L88

Internal

Parameters

ParameterType
listener() => void

Returns

TypeScript
(): void;
Returns

void

Docs