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

AxAgentRuntimeExecutionContext

TypeScript
type AxAgentRuntimeExecutionContext = object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L149

Properties

applyBootstrapRuntimeContext()

TypeScript
applyBootstrapRuntimeContext: () => Promise<string | undefined>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L156

Returns

Promise<string | undefined>


bootstrapContextSummary?

TypeScript
optional bootstrapContextSummary: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L155


captureRuntimeStateSummary()

TypeScript
captureRuntimeStateSummary: () => Promise<string | undefined>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L157

Returns

Promise<string | undefined>


close()

TypeScript
close: () => void;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L180

Returns

void


consumeDiscoveryTurnArtifacts()

TypeScript
consumeDiscoveryTurnArtifacts: () => object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L158

Returns

object

NameType
summary?string
textsstring[]

consumeNativeToolActivity()?

TypeScript
optional consumeNativeToolActivity: () => readonly string[];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L150

Returns

readonly string[]


effectiveContextConfig

TypeScript
effectiveContextConfig: AxResolvedContextPolicy;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L154


executeActorCode()

TypeScript
executeActorCode: (code: string) => Promise<ActorCodeExecutionResult>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L171

Parameters

ParameterType
codestring

Returns

Promise<ActorCodeExecutionResult>


executeTestCode()

TypeScript
executeTestCode: (code: string) => Promise<AxAgentTestResult>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L172

Parameters

ParameterType
codestring

Returns

Promise<AxAgentTestResult>


exportRuntimeState()

TypeScript
exportRuntimeState: (options?: Readonly<{
  includeBindings?: boolean;
}>) => Promise<AxAgentState>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L163

Parameters

ParameterType
options?Readonly<{ includeBindings?: boolean; }>

Returns

Promise<AxAgentState>


getActorModelMatchedNamespaces()

TypeScript
getActorModelMatchedNamespaces: () => readonly string[];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L162

Returns

readonly string[]


getNativeFunctions()?

TypeScript
optional getNativeFunctions: (options: AxProgramForwardOptions) => AxFunction[];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L151

Parameters

ParameterType
optionsAxProgramForwardOptions

Returns

AxFunction[]


prepareSharedSession()?

TypeScript
optional prepareSharedSession: () => Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L179

Present only when the run participates in a pipeline-owned shared runtime session. The actor loop awaits it before the first turn: the distiller phase adopts the fresh session, the executor phase patches its bindings over the inherited one and runs the phase-boundary snippet.

Returns

Promise<void>


restoreRuntimeState()

TypeScript
restoreRuntimeState: (state: Readonly<AxAgentState>, options?: Readonly<{
  skipBindings?: boolean;
}>) => Promise<AxPreparedRestoredState>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L166

Parameters

ParameterType
stateReadonly<AxAgentState>
options?Readonly<{ skipBindings?: boolean; }>

Returns

Promise<AxPreparedRestoredState>


syncRuntimeInputsToSession()

TypeScript
syncRuntimeInputsToSession: () => Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/agentInternal/agentInternalTypes.ts#L170

Returns

Promise<void>

Docs