axBuildExecutorDefinition Generated TypeScript API reference. typescript api api/reference build/apidocs/Function.axBuildExecutorDefinition.md function axBuildExecutorDefinition

axBuildExecutorDefinition

TypeScript
function axBuildExecutorDefinition(
   baseDefinition: undefined | string, 
   contextFields: readonly AxIField[], 
   responderOutputFields: readonly AxIField[], 
   options: Readonly<{
  agentFunctions?: ReadonlyArray<{
     alwaysInclude?: boolean;
     description?: string;
     name: string;
     namespace: string;
     parameters?: AxFunctionJSONSchema;
     returns?: AxFunctionJSONSchema;
  }>;
  availableModules?: ReadonlyArray<{
     namespace: string;
     selectionCriteria?: string;
  }>;
  contextMapText?: string;
  discoveredDocsMarkdown?: string;
  discoveryMode?: boolean;
  enforceIncrementalConsoleTurns?: boolean;
  formatCallable?: AxCodeRuntime["formatCallable"];
  hasAgentStatusCallback?: boolean;
  hasCompressedActionReplay?: boolean;
  hasInspectRuntime?: boolean;
  hasLiveRuntimeState?: boolean;
  isJavaScriptRuntime?: boolean;
  llmQueryPromptMode?: "simple";
  memoriesMode?: boolean;
  memoryUsageMode?: boolean;
  primitiveOverrides?: ReadonlyMap<string, readonly string[]>;
  promptLevel?: "default" | "detailed";
  runtimeCodeFenceLanguage?: string;
  runtimeCodeFieldTitle?: string;
  runtimeLanguageName?: string;
  runtimeUsageInstructions?: string;
  skillsMarkdown?: string;
  skillsMode?: boolean;
  skillUsageMode?: boolean;
  templateOverride?: string;
  usageTrackingMode?: boolean;
}>): string;

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

Builds the executor system prompt. The executor consumes inputs.executorRequest and inputs.distilledContext from the prior distiller stage and runs tools / discovery to complete the task.

Parameters

ParameterType
baseDefinitionundefined | string
contextFieldsreadonly AxIField[]
responderOutputFieldsreadonly AxIField[]
optionsReadonly<{ agentFunctions?: ReadonlyArray<{ alwaysInclude?: boolean; description?: string; name: string; namespace: string; parameters?: AxFunctionJSONSchema; returns?: AxFunctionJSONSchema; }>; availableModules?: ReadonlyArray<{ namespace: string; selectionCriteria?: string; }>; contextMapText?: string; discoveredDocsMarkdown?: string; discoveryMode?: boolean; enforceIncrementalConsoleTurns?: boolean; formatCallable?: AxCodeRuntime["formatCallable"]; hasAgentStatusCallback?: boolean; hasCompressedActionReplay?: boolean; hasInspectRuntime?: boolean; hasLiveRuntimeState?: boolean; isJavaScriptRuntime?: boolean; llmQueryPromptMode?: "simple"; memoriesMode?: boolean; memoryUsageMode?: boolean; primitiveOverrides?: ReadonlyMap<string, readonly string[]>; promptLevel?: "default" | "detailed"; runtimeCodeFenceLanguage?: string; runtimeCodeFieldTitle?: string; runtimeLanguageName?: string; runtimeUsageInstructions?: string; skillsMarkdown?: string; skillsMode?: boolean; skillUsageMode?: boolean; templateOverride?: string; usageTrackingMode?: boolean; }>

Returns

string

Docs