AxCodeSession Generated TypeScript API reference. typescript api api/reference build/apidocs/Interface.AxCodeSession.md interface AxCodeSession

AxCodeSession

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/rlm.ts#L397

A persistent code execution session. Variables persist across execute() calls.

Methods

close()

TypeScript
close(): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/rlm.ts#L414

Returns

void


execute()

TypeScript
execute(code: string, options?: object): Promise<unknown>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/rlm.ts#L398

Parameters

ParameterType
codestring
options?{ reservedNames?: readonly string[]; signal?: AbortSignal; }
options.reservedNames?readonly string[]
options.signal?AbortSignal

Returns

Promise<unknown>


inspectGlobals()?

TypeScript
optional inspectGlobals(options?: object): Promise<string>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/rlm.ts#L402

Parameters

ParameterType
options?{ reservedNames?: readonly string[]; signal?: AbortSignal; }
options.reservedNames?readonly string[]
options.signal?AbortSignal

Returns

Promise<string>


patchGlobals()

TypeScript
patchGlobals(globals: Record<string, unknown>, options?: object): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/rlm.ts#L410

Parameters

ParameterType
globalsRecord<string, unknown>
options?{ signal?: AbortSignal; }
options.signal?AbortSignal

Returns

Promise<void>


snapshotGlobals()?

TypeScript
optional snapshotGlobals(options?: object): Promise<AxCodeSessionSnapshot>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/rlm.ts#L406

Parameters

ParameterType
options?{ reservedNames?: readonly string[]; signal?: AbortSignal; }
options.reservedNames?readonly string[]
options.signal?AbortSignal

Returns

Promise<AxCodeSessionSnapshot>

Docs