agent() API

Agent, RLM runtime, context, memory, skill, MCP, and delegation APIs.

Most Used

`agent`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`agent`
Returns	`AxAgent`<`ParseSignature`<`T`>[`"inputs"`], `ParseSignature`<`T`>[`"outputs"`]>
Source	source

Call Shape

TypeScript

function agent<T, CF>(signature: T, config: Omit<AxAgentConfig<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>, "contextFields"> & object): AxAgent<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>;

TypeScript

function agent<TInput, TOutput, CF>(signature: AxSignature<TInput, TOutput>, config: Omit<AxAgentConfig<TInput, TOutput>, "contextFields"> & object): AxAgent<TInput, TOutput>;

TypeScript

function agent(signature: Readonly<AxSignatureConfig>, config: AxAgentConfig<AxGenIn, AxGenOut>): AxAgent<AxGenIn, AxGenOut>;

Arguments And Options

Name	Type	Description
`signature`	`T`
`config`	`Omit`<`AxAgentConfig`<`ParseSignature`<`T`>[`"inputs"`], `ParseSignature`<`T`>[`"outputs"`]>, `"contextFields"`> & `object`

Full reference

`AxAgent`

Pipeline-based coordinator. Every run walks the same static sequence:

Field	Value
Kind	`class`
Form	`AxAgent`
Source	source

Call Shape

TypeScript

new AxAgent<IN, OUT>(init: Readonly<{
  agentIdentity?: Readonly<AxAgentIdentity>;
  agentModuleNamespace?: string;
  ai?: Readonly<AxAIService>;
  judgeAI?: Readonly<AxAIService>;
  signature:   | string
     | Readonly<AxSignatureConfig>
     | Readonly<AxSignature<IN, OUT>>;
}>, options: Readonly<AxAgentOptions<IN>>): AxAgent<IN, OUT>;

Full reference

`AxAgentFunctionGroup`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentFunctionGroup`
Source	source

Call Shape

TypeScript

type AxAgentFunctionGroup = AxAgentFunctionModuleMeta & object;

Full reference

`AxAgentOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentOptions`
Source	source

Call Shape

TypeScript

type AxAgentOptions<IN> = Omit<AxProgramForwardOptions<string>, "functions" | "description" | "onFunctionCall"> & object;

Full reference

Advanced / internals / full reference

`AxAgentActorTurnCallback`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentActorTurnCallback`
Returns	`void` \\| `Promise`<`void`>
Source	source

Call Shape

TypeScript

type AxAgentActorTurnCallback = (args: AxAgentActorTurnCallbackArgs) => void | Promise<void>;

Arguments And Options

Name	Type	Description
`args`	`AxAgentActorTurnCallbackArgs`

Full reference

`AxAgentActorTurnCallbackArgs`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentActorTurnCallbackArgs`
Source	source

Call Shape

TypeScript

type AxAgentActorTurnCallbackArgs = object;

Full reference

`AxAgentClarification`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentClarification`
Source	source

Call Shape

TypeScript

type AxAgentClarification = 
  | string
  | AxAgentStructuredClarification;

Full reference

`AxAgentClarificationChoice`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentClarificationChoice`
Source	source

Call Shape

TypeScript

type AxAgentClarificationChoice = 
  | string
  | {
  label: string;
  value?: string;
};

Full reference

`AxAgentClarificationError`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxAgentClarificationError`
Source	source

Call Shape

TypeScript

new AxAgentClarificationError(clarification: AxAgentClarification, options?: Readonly<{
  state?: AxAgentState;
  stateError?: string;
}>): AxAgentClarificationError;

Full reference

`AxAgentClarificationKind`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentClarificationKind`
Source	source

Call Shape

TypeScript

type AxAgentClarificationKind = "text" | "number" | "date" | "single_choice" | "multiple_choice";

Full reference

`AxAgentCompletionProtocol`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentCompletionProtocol`
Source	source

Call Shape

TypeScript

type AxAgentCompletionProtocol = Readonly<{
  askClarification: (...args: unknown[]) => never;
  failed: (message: string) => Promise<void>;
  final: (...args: unknown[]) => never;
  guideAgent: (guidance: string) => never;
  success: (message: string) => Promise<void>;
}>;

Full reference

`AxAgentConfig`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAgentConfig`
Source	source

Full reference

`AxAgentContextEvent`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentContextEvent`
Source	source

Call Shape

TypeScript

type AxAgentContextEvent = 
  | {
  actionLogEntryCount: number;
  checkpointActive: boolean;
  effectiveBudgetChars: number;
  fixedPromptChars: number;
  guidanceLogEntryCount: number;
  kind: "budget_check";
  mutablePromptChars: number;
  pressure: AxAgentContextPressure;
  stage: AxAgentContextStage;
  targetPromptChars: number;
  turn: number;
}
  | {
  coveredTurns: number[];
  kind: "checkpoint_created" | "checkpoint_cleared";
  reason: "over_budget" | "under_budget" | "disabled";
  stage: AxAgentContextStage;
  summaryChars?: number;
  turn: number;
}
  | {
  kind: "tombstone_created";
  resolvedByTurn: number;
  source: "deterministic" | "model";
  stage: AxAgentContextStage;
  summaryChars: number;
  turn: number;
}
  | {
  kind: "action_compacted";
  mode: "distill" | "compact";
  originalChars: number;
  reason: "structured_output" | "superseded" | "pressure" | "proactive" | "lean";
  renderedChars: number;
  stage: AxAgentContextStage;
  turn: number;
};

Full reference

`AxAgentContextMap`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxAgentContextMap`
Source	source

Call Shape

TypeScript

new AxAgentContextMap(input?: 
  | string
  | AxAgentContextMapSnapshot, options?: AxAgentContextMapOptions): AxAgentContextMap;

Full reference

`AxAgentContextMapConfig`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentContextMapConfig`
Source	source

Call Shape

TypeScript

type AxAgentContextMapConfig = object;

Full reference

`AxAgentContextMapOperation`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentContextMapOperation`
Source	source

Call Shape

TypeScript

type AxAgentContextMapOperation = 
  | {
  content: string;
  section: string;
  type: "ADD";
}
  | {
  itemId: string;
  type: "DELETE";
}
  | {
  content: string;
  itemId: string;
  type: "REPLACE";
};

Full reference

`AxAgentContextMapOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentContextMapOptions`
Source	source

Call Shape

TypeScript

type AxAgentContextMapOptions = object;

Full reference

`AxAgentContextMapSnapshot`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentContextMapSnapshot`
Source	source

Call Shape

TypeScript

type AxAgentContextMapSnapshot = object;

Full reference

`AxAgentContextMapUpdateResult`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentContextMapUpdateResult`
Source	source

Call Shape

TypeScript

type AxAgentContextMapUpdateResult = object;

Full reference

`AxAgentContextPressure`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentContextPressure`
Source	source

Call Shape

TypeScript

type AxAgentContextPressure = "ok" | "watch" | "critical";

Full reference

`AxAgentContextStage`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentContextStage`
Source	source

Call Shape

TypeScript

type AxAgentContextStage = "distiller" | "executor";

Full reference

`AxAgentDemos`

Demo traces for AxAgent’s split architecture. Actor demos use the runtime code field (javascriptCode for JavaScript, <language>Code for other runtimes such as pythonCode). Responder demos use the agent’s output type + optional input fields.

Field	Value
Kind	`typealias`
Form	`AxAgentDemos`
Source	source

Call Shape

TypeScript

type AxAgentDemos<IN, OUT, PREFIX> = 
  | {
  programId: `${PREFIX}.actor`;
  traces: Record<string, AxFieldValue>[];
}
  | {
  programId: `${PREFIX}.responder`;
  traces: OUT & Partial<IN>[];
};

Full reference

`AxAgentDiscoveryPromptState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentDiscoveryPromptState`
Source	source

Call Shape

TypeScript

type AxAgentDiscoveryPromptState = object;

Full reference

`AxAgentEvalDataset`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentEvalDataset`
Source	source

Call Shape

TypeScript

type AxAgentEvalDataset<IN> = 
  | readonly AxAgentEvalTask<IN>[]
  | {
  train: readonly AxAgentEvalTask<IN>[];
  validation?: readonly AxAgentEvalTask<IN>[];
};

Full reference

`AxAgentEvalFunctionCall`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentEvalFunctionCall`
Source	source

Call Shape

TypeScript

type AxAgentEvalFunctionCall = object;

Full reference

`AxAgentEvalPrediction`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentEvalPrediction`
Source	source

Call Shape

TypeScript

type AxAgentEvalPrediction<OUT> = 
  | AxAgentEvalPredictionShared & object
  | AxAgentEvalPredictionShared & object;

Full reference

`AxAgentEvalTask`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentEvalTask`
Source	source

Call Shape

TypeScript

type AxAgentEvalTask<IN> = object;

Full reference

`AxAgentExecutorResultPayload`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentExecutorResultPayload`
Source	source

Call Shape

TypeScript

type AxAgentExecutorResultPayload = AxAgentTestCompletionPayload;

Full reference

`AxAgentForwardOptions`

Forward options for AxAgent.forward(...). Extends the dsp-layer AxProgramForwardOptionsWithModels with agent-specific knobs that only make sense at the agent boundary (currently skills for one-shot preloading). Forward-time skills merge on top of init-time skills (forward overrides by id).

Field	Value
Kind	`typealias`
Form	`AxAgentForwardOptions`
Source	source

Call Shape

TypeScript

type AxAgentForwardOptions<T> = AxProgramForwardOptionsWithModels<T> & object;

Full reference

`AxAgentFunction`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentFunction`
Source	source

Call Shape

TypeScript

type AxAgentFunction = Omit<AxFunction, "description"> & object;

Full reference

`AxAgentFunctionCall`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentFunctionCall`
Source	source

Call Shape

TypeScript

type AxAgentFunctionCall = object;

Full reference

`AxAgentFunctionCallRecorder`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentFunctionCallRecorder`
Returns	`void`
Source	source

Call Shape

TypeScript

type AxAgentFunctionCallRecorder = (call: AxAgentEvalFunctionCall) => void;

Arguments And Options

Name	Type	Description
`call`	`AxAgentEvalFunctionCall`

Full reference

`AxAgentFunctionCollection`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentFunctionCollection`
Source	source

Call Shape

TypeScript

type AxAgentFunctionCollection = 
  | readonly (
  | AxAgentFunction
  | AxAnyAgentic
  | AxFunctionProvider)[]
  | readonly AxAgentFunctionGroup[];

Full reference

`AxAgentFunctionExample`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentFunctionExample`
Source	source

Call Shape

TypeScript

type AxAgentFunctionExample = object;

Full reference

`AxAgentFunctionModuleMeta`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentFunctionModuleMeta`
Source	source

Call Shape

TypeScript

type AxAgentFunctionModuleMeta = object;

Full reference

`AxAgentGuidanceLogEntry`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentGuidanceLogEntry`
Source	source

Call Shape

TypeScript

type AxAgentGuidanceLogEntry = object;

Full reference

`AxAgentGuidancePayload`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentGuidancePayload`
Source	source

Call Shape

TypeScript

type AxAgentGuidancePayload = object;

Full reference

`AxAgentGuidanceState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentGuidanceState`
Source	source

Call Shape

TypeScript

type AxAgentGuidanceState = object;

Full reference

`AxAgentic`

Interface for agents that can be used as child agents. Provides methods to get the agent’s function definition and features.

Field	Value
Kind	`interface`
Form	`AxAgentic`
Source	source

Call Shape

TypeScript

applyOptimization(optimizedProgram: AxOptimizedProgram<OUT>): void;

Full reference

`AxAgentIdentity`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentIdentity`
Source	source

Call Shape

TypeScript

type AxAgentIdentity = object;

Full reference

`AxAgentInputUpdateCallback`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentInputUpdateCallback`
Returns	\\| `Promise`<`Partial`<`IN`> \\| `undefined`> \\| `Partial`<`IN`> \\| `undefined`
Source	source

Call Shape

TypeScript

type AxAgentInputUpdateCallback<IN> = (currentInputs: Readonly<IN>) => 
  | Promise<Partial<IN> | undefined>
  | Partial<IN>
  | undefined;

Arguments And Options

Name	Type	Description
`currentInputs`	`Readonly`<`IN`>

Full reference

`AxAgentJudgeEvalInput`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentJudgeEvalInput`
Source	source

Call Shape

TypeScript

type AxAgentJudgeEvalInput = AxAgentJudgeInput & AxAgentJudgeOutput;

Full reference

`AxAgentJudgeEvalOutput`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentJudgeEvalOutput`
Source	source

Call Shape

TypeScript

type AxAgentJudgeEvalOutput = object;

Full reference

`AxAgentJudgeInput`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentJudgeInput`
Source	source

Call Shape

TypeScript

type AxAgentJudgeInput = object;

Full reference

`AxAgentJudgeOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentJudgeOptions`
Source	source

Call Shape

TypeScript

type AxAgentJudgeOptions = Partial<Omit<AxJudgeOptions, "ai">>;

Full reference

`AxAgentJudgeOutput`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentJudgeOutput`
Source	source

Call Shape

TypeScript

type AxAgentJudgeOutput = object;

Full reference

`AxAgentMemoriesSearchFn`

Memories search callback. Receives the raw search strings and the snapshot of inputs.memories already loaded for the current run (deduped by id, sorted). Use the second argument to skip work for entries that are already in scope — for example, filter your vector search by id NOT IN alreadyLoaded so you don’t re-fetch and the actor doesn’t pay tokens for duplicates. Returning already-loaded entries is still safe (the runtime dedupes by id) but wastes work.

Field	Value
Kind	`typealias`
Form	`AxAgentMemoriesSearchFn`
Returns	\\| readonly `AxAgentMemoryResult`[] \\| `Promise`<readonly `AxAgentMemoryResult`[]>
Source	source

Call Shape

TypeScript

type AxAgentMemoriesSearchFn = (searches: readonly string[], alreadyLoaded: readonly AxAgentMemoryResult[]) => 
  | readonly AxAgentMemoryResult[]
| Promise<readonly AxAgentMemoryResult[]>;

Arguments And Options

Name	Type	Description
`searches`	readonly `string`[]
`alreadyLoaded`	readonly `AxAgentMemoryResult`[]

Full reference

`AxAgentMemoryEntry`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentMemoryEntry`
Source	source

Call Shape

TypeScript

type AxAgentMemoryEntry = object;

Full reference

`AxAgentMemoryResult`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentMemoryResult`
Source	source

Call Shape

TypeScript

type AxAgentMemoryResult = object;

Full reference

`AxAgentOnContextEvent`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentOnContextEvent`
Returns	`void` \\| `Promise`<`void`>
Source	source

Call Shape

TypeScript

type AxAgentOnContextEvent = (event: Readonly<AxAgentContextEvent>) => void | Promise<void>;

Arguments And Options

Name	Type	Description
`event`	`Readonly`<`AxAgentContextEvent`>

Full reference

`AxAgentOnFunctionCall`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentOnFunctionCall`
Returns	`void` \\| `Promise`<`void`>
Source	source

Call Shape

TypeScript

type AxAgentOnFunctionCall = (call: Readonly<AxAgentFunctionCall>) => void | Promise<void>;

Arguments And Options

Name	Type	Description
`call`	`Readonly`<`AxAgentFunctionCall`>

Full reference

`AxAgentOptimizationTargetDescriptor`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentOptimizationTargetDescriptor`
Source	source

Call Shape

TypeScript

type AxAgentOptimizationTargetDescriptor = object;

Full reference

`AxAgentOptimizeOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentOptimizeOptions`
Source	source

Call Shape

TypeScript

type AxAgentOptimizeOptions<_IN, _OUT> = object & Pick<AxOptimizerArgs, 
  | "numTrials"
  | "minibatch"
  | "minibatchSize"
  | "earlyStoppingTrials"
  | "minImprovementThreshold"
  | "sampleCount"
| "seed">;

Full reference

`AxAgentOptimizeResult`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentOptimizeResult`
Source	source

Call Shape

TypeScript

type AxAgentOptimizeResult<OUT> = AxParetoResult<OUT>;

Full reference

`AxAgentOptimizeTarget`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentOptimizeTarget`
Source	source

Call Shape

TypeScript

type AxAgentOptimizeTarget = "actor" | "responder" | "all" | readonly string[];

Full reference

`AxAgentProtocolCompletionSignal`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxAgentProtocolCompletionSignal`
Source	source

Call Shape

TypeScript

new AxAgentProtocolCompletionSignal(type: "final" | "guide_agent" | "askClarification"): AxAgentProtocolCompletionSignal;

Full reference

`AxAgentRecursionOptions`

Forward options forwarded to the AxGen spawned by each llmQuery(...) call.

Field	Value
Kind	`typealias`
Form	`AxAgentRecursionOptions`
Source	source

Call Shape

TypeScript

type AxAgentRecursionOptions = Partial<Omit<AxProgramForwardOptions<string>, "functions">>;

Full reference

`AxAgentRecursiveExpensiveNode`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRecursiveExpensiveNode`
Source	source

Call Shape

TypeScript

type AxAgentRecursiveExpensiveNode = object;

Full reference

`AxAgentRecursiveFunctionCall`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRecursiveFunctionCall`
Source	source

Call Shape

TypeScript

type AxAgentRecursiveFunctionCall = object;

Full reference

`AxAgentRecursiveNodeRole`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRecursiveNodeRole`
Source	source

Call Shape

TypeScript

type AxAgentRecursiveNodeRole = "root" | "recursive" | "terminal";

Full reference

`AxAgentRecursiveStats`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRecursiveStats`
Source	source

Call Shape

TypeScript

type AxAgentRecursiveStats = object;

Full reference

`AxAgentRecursiveTargetId`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRecursiveTargetId`
Source	source

Call Shape

TypeScript

type AxAgentRecursiveTargetId = 
  | "root.actor.shared"
  | "root.actor.root"
  | "root.actor.recursive"
  | "root.actor.terminal"
  | "root.responder";

Full reference

`AxAgentRecursiveTraceNode`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRecursiveTraceNode`
Source	source

Call Shape

TypeScript

type AxAgentRecursiveTraceNode = object;

Full reference

`AxAgentRecursiveTurn`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRecursiveTurn`
Source	source

Call Shape

TypeScript

type AxAgentRecursiveTurn = object;

Full reference

`AxAgentRecursiveUsage`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRecursiveUsage`
Source	source

Call Shape

TypeScript

type AxAgentRecursiveUsage = object;

Full reference

`AxAgentRuntimeCompletionState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRuntimeCompletionState`
Source	source

Call Shape

TypeScript

type AxAgentRuntimeCompletionState = object;

Full reference

`AxAgentRuntimeExecutionContext`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRuntimeExecutionContext`
Source	source

Call Shape

TypeScript

type AxAgentRuntimeExecutionContext = object;

Full reference

`AxAgentRuntimeInputState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentRuntimeInputState`
Source	source

Call Shape

TypeScript

type AxAgentRuntimeInputState = object;

Full reference

`AxAgentSkillResult`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentSkillResult`
Source	source

Call Shape

TypeScript

type AxAgentSkillResult = object;

Full reference

`AxAgentSkillsPromptState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentSkillsPromptState`
Source	source

Call Shape

TypeScript

type AxAgentSkillsPromptState = object;

Full reference

`AxAgentSkillsSearchFn`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentSkillsSearchFn`
Returns	\\| readonly `AxAgentSkillResult`[] \\| `Promise`<readonly `AxAgentSkillResult`[]>
Source	source

Call Shape

TypeScript

type AxAgentSkillsSearchFn = (searches: readonly string[]) => 
  | readonly AxAgentSkillResult[]
| Promise<readonly AxAgentSkillResult[]>;

Arguments And Options

Name	Type	Description
`searches`	readonly `string`[]

Full reference

`AxAgentState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentState`
Source	source

Call Shape

TypeScript

type AxAgentState = object;

Full reference

`AxAgentStateActionLogEntry`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentStateActionLogEntry`
Source	source

Call Shape

TypeScript

type AxAgentStateActionLogEntry = Pick<ActionLogEntry, 
  | "turn"
  | "code"
  | "output"
  | "tags"
  | "summary"
  | "producedVars"
  | "referencedVars"
  | "stateDelta"
  | "stepKind"
  | "replayMode"
  | "rank"
| "tombstone">;

Full reference

`AxAgentStateCheckpointState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentStateCheckpointState`
Source	source

Call Shape

TypeScript

type AxAgentStateCheckpointState = CheckpointSummaryState;

Full reference

`AxAgentStateExecutorModelState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentStateExecutorModelState`
Source	source

Call Shape

TypeScript

type AxAgentStateExecutorModelState = object;

Full reference

`AxAgentStateRuntimeEntry`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentStateRuntimeEntry`
Source	source

Call Shape

TypeScript

type AxAgentStateRuntimeEntry = AxCodeSessionSnapshotEntry;

Full reference

`AxAgentStreamingForwardOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentStreamingForwardOptions`
Source	source

Call Shape

TypeScript

type AxAgentStreamingForwardOptions<T> = AxProgramStreamingForwardOptionsWithModels<T> & object;

Full reference

`AxAgentStructuredClarification`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentStructuredClarification`
Source	source

Call Shape

TypeScript

type AxAgentStructuredClarification = object;

Full reference

`AxAgentTestCompletionPayload`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentTestCompletionPayload`
Source	source

Call Shape

TypeScript

type AxAgentTestCompletionPayload = object;

Full reference

`AxAgentTestResult`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentTestResult`
Source	source

Call Shape

TypeScript

type AxAgentTestResult = 
  | string
  | AxAgentTestCompletionPayload;

Full reference

`AxAgentUsage`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentUsage`
Source	source

Call Shape

TypeScript

type AxAgentUsage = object;

Full reference

`AxAgentUsedMemoriesCallback`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentUsedMemoriesCallback`
Returns	`void` \\| `Promise`<`void`>
Source	source

Call Shape

TypeScript

type AxAgentUsedMemoriesCallback = (usedMemories: readonly AxAgentUsedMemory[]) => void | Promise<void>;

Arguments And Options

Name	Type	Description
`usedMemories`	readonly `AxAgentUsedMemory`[]

Full reference

`AxAgentUsedMemory`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentUsedMemory`
Source	source

Call Shape

TypeScript

type AxAgentUsedMemory = object;

Full reference

`AxAgentUsedSkill`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentUsedSkill`
Source	source

Call Shape

TypeScript

type AxAgentUsedSkill = object;

Full reference

`AxAgentUsedSkillsCallback`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentUsedSkillsCallback`
Returns	`void` \\| `Promise`<`void`>
Source	source

Call Shape

TypeScript

type AxAgentUsedSkillsCallback = (usedSkills: readonly AxAgentUsedSkill[]) => void | Promise<void>;

Arguments And Options

Name	Type	Description
`usedSkills`	readonly `AxAgentUsedSkill`[]

Full reference

`AxAIMemory`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIMemory`
Source	source

Call Shape

TypeScript

addFunctionResults(results: readonly AxFunctionResult[], sessionId?: string): void;

Full reference

`AxAIOpenAIResponsesMCPCallArgumentsDeltaEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIOpenAIResponsesMCPCallArgumentsDeltaEvent`
Source	source

Full reference

`AxAIOpenAIResponsesMCPCallArgumentsDoneEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIOpenAIResponsesMCPCallArgumentsDoneEvent`
Source	source

Full reference

`AxAIOpenAIResponsesMCPCallCompletedEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIOpenAIResponsesMCPCallCompletedEvent`
Source	source

Full reference

`AxAIOpenAIResponsesMCPCallFailedEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIOpenAIResponsesMCPCallFailedEvent`
Source	source

Full reference

Full Reference

Open the full TypeScript reference. This page highlights the agent symbols most relevant to everyday use.