@ax-llm/ax 11.0.6 → 11.0.7

package/index.d.cts

@@ -1612,16 +1612,29 @@ declare class AxGen<IN extends AxGenIn = AxGenIn, OUT extends AxGenerateResult<A
     }, void, unknown>;
 }
 
+/**
+ * Interface for agents that can be used as child agents.
+ * Provides methods to get the agent's function definition and features.
+ */
 interface AxAgentic extends AxTunable, AxUsable {
     getFunction(): AxFunction;
     getFeatures(): AxAgentFeatures;
 }
 type AxAgentOptions = Omit<AxGenOptions, 'functions'> & {
     disableSmartModelRouting?: boolean;
+    /** List of field names that should not be automatically passed from parent to child agents */
+    excludeFieldsFromPassthrough?: string[];
 };
 interface AxAgentFeatures {
+    /** Whether this agent can use smart model routing (requires an AI service) */
     canConfigureSmartModelRouting: boolean;
+    /** List of fields that this agent excludes from parent->child value passing */
+    excludeFieldsFromPassthrough: string[];
 }
+/**
+ * An AI agent that can process inputs using an AI service and coordinate with child agents.
+ * Supports features like smart model routing and automatic input field passing to child agents.
+ */
 declare class AxAgent<IN extends AxGenIn, OUT extends AxGenOut = AxGenOut> implements AxAgentic {
     private ai?;
     private signature;
@@ -1629,6 +1642,7 @@ declare class AxAgent<IN extends AxGenIn, OUT extends AxGenOut = AxGenOut> imple
     private functions?;
     private agents?;
     private disableSmartModelRouting?;
+    private excludeFieldsFromPassthrough;
     private name;
     private description;
     private subAgentList?;
@@ -1653,9 +1667,20 @@ declare class AxAgent<IN extends AxGenIn, OUT extends AxGenOut = AxGenOut> imple
     resetUsage(): void;
     getFunction(): AxFunction;
     getFeatures(): AxAgentFeatures;
+    /**
+     * Initializes the agent's execution context, processing child agents and their functions.
+     */
     private init;
     forward(parentAi: Readonly<AxAIService>, values: IN, options?: Readonly<AxProgramForwardOptions>): Promise<OUT>;
     streamingForward(parentAi: Readonly<AxAIService>, values: IN, options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<OUT>;
+    /**
+     * Updates the agent's description.
+     * This updates both the stored description and the function's description.
+     *
+     * @param description - New description for the agent (must be at least 20 characters)
+     * @throws Error if description is too short
+     */
+    setDescription(description: string): void;
 }
 
 interface AxApacheTikaArgs {

package/index.d.ts

@@ -1612,16 +1612,29 @@ declare class AxGen<IN extends AxGenIn = AxGenIn, OUT extends AxGenerateResult<A
     }, void, unknown>;
 }
 
+/**
+ * Interface for agents that can be used as child agents.
+ * Provides methods to get the agent's function definition and features.
+ */
 interface AxAgentic extends AxTunable, AxUsable {
     getFunction(): AxFunction;
     getFeatures(): AxAgentFeatures;
 }
 type AxAgentOptions = Omit<AxGenOptions, 'functions'> & {
     disableSmartModelRouting?: boolean;
+    /** List of field names that should not be automatically passed from parent to child agents */
+    excludeFieldsFromPassthrough?: string[];
 };
 interface AxAgentFeatures {
+    /** Whether this agent can use smart model routing (requires an AI service) */
     canConfigureSmartModelRouting: boolean;
+    /** List of fields that this agent excludes from parent->child value passing */
+    excludeFieldsFromPassthrough: string[];
 }
+/**
+ * An AI agent that can process inputs using an AI service and coordinate with child agents.
+ * Supports features like smart model routing and automatic input field passing to child agents.
+ */
 declare class AxAgent<IN extends AxGenIn, OUT extends AxGenOut = AxGenOut> implements AxAgentic {
     private ai?;
     private signature;
@@ -1629,6 +1642,7 @@ declare class AxAgent<IN extends AxGenIn, OUT extends AxGenOut = AxGenOut> imple
     private functions?;
     private agents?;
     private disableSmartModelRouting?;
+    private excludeFieldsFromPassthrough;
     private name;
     private description;
     private subAgentList?;
@@ -1653,9 +1667,20 @@ declare class AxAgent<IN extends AxGenIn, OUT extends AxGenOut = AxGenOut> imple
     resetUsage(): void;
     getFunction(): AxFunction;
     getFeatures(): AxAgentFeatures;
+    /**
+     * Initializes the agent's execution context, processing child agents and their functions.
+     */
     private init;
     forward(parentAi: Readonly<AxAIService>, values: IN, options?: Readonly<AxProgramForwardOptions>): Promise<OUT>;
     streamingForward(parentAi: Readonly<AxAIService>, values: IN, options?: Readonly<AxProgramStreamingForwardOptions>): AxGenStreamingOut<OUT>;
+    /**
+     * Updates the agent's description.
+     * This updates both the stored description and the function's description.
+     *
+     * @param description - New description for the agent (must be at least 20 characters)
+     * @throws Error if description is too short
+     */
+    setDescription(description: string): void;
 }
 
 interface AxApacheTikaArgs {

package/index.js

@@ -5987,6 +5987,37 @@ var AxGen = class extends AxProgramWithSignature {
 };
 
 // prompts/agent.ts
+function processChildAgentFunction(childFunction, parentValues, parentInputKeys, modelList, options) {
+  let processedFunction = { ...childFunction };
+  if (processedFunction.parameters) {
+    const childKeys = processedFunction.parameters.properties ? Object.keys(processedFunction.parameters.properties) : [];
+    const commonKeys = parentInputKeys.filter((key) => childKeys.includes(key)).filter((key) => key !== "model");
+    const injectionKeys = commonKeys.filter(
+      (key) => !options.excludeFieldsFromPassthrough.includes(key)
+    );
+    if (injectionKeys.length > 0) {
+      processedFunction.parameters = removePropertiesFromSchema(
+        processedFunction.parameters,
+        injectionKeys
+      );
+      const originalFunc = processedFunction.func;
+      processedFunction.func = (childArgs, funcOptions) => originalFunc(
+        {
+          ...childArgs,
+          ...pick(parentValues, injectionKeys)
+        },
+        funcOptions
+      );
+    }
+  }
+  if (modelList && !options.disableSmartModelRouting && options.canConfigureSmartModelRouting) {
+    processedFunction.parameters = addModelParameter(
+      processedFunction.parameters,
+      modelList
+    );
+  }
+  return processedFunction;
+}
 var AxAgent = class {
   ai;
   signature;
@@ -5994,6 +6025,7 @@ var AxAgent = class {
   functions;
   agents;
   disableSmartModelRouting;
+  excludeFieldsFromPassthrough;
   name;
   description;
   subAgentList;
@@ -6010,6 +6042,7 @@ var AxAgent = class {
     this.agents = agents;
     this.functions = functions;
     this.disableSmartModelRouting = options?.disableSmartModelRouting;
+    this.excludeFieldsFromPassthrough = options?.excludeFieldsFromPassthrough ?? [];
     this.signature = new AxSignature(signature);
     this.signature.setDescription(description);
     if (!name || name.length < 5) {
@@ -6078,15 +6111,33 @@ var AxAgent = class {
   }
   getFeatures() {
     return {
-      canConfigureSmartModelRouting: this.ai !== void 0
+      canConfigureSmartModelRouting: this.ai === void 0,
+      excludeFieldsFromPassthrough: this.excludeFieldsFromPassthrough
     };
   }
-  init(parentAi, options) {
+  /**
+   * Initializes the agent's execution context, processing child agents and their functions.
+   */
+  init(parentAi, values, options) {
     const ai = this.ai ?? parentAi;
     const mm = ai?.getModelList();
-    const agentFuncs = this.agents?.map((a) => a.getFunction())?.map(
-      (f) => mm && !this.disableSmartModelRouting && this.agents?.find((a) => a.getFunction().name === f.name)?.getFeatures().canConfigureSmartModelRouting ? { ...f, parameters: addModelParameter(f.parameters, mm) } : f
-    );
+    const parentSchema = this.signature.toJSONSchema();
+    const parentKeys = parentSchema.properties ? Object.keys(parentSchema.properties) : [];
+    const agentFuncs = this.agents?.map((agent) => {
+      const f = agent.getFeatures();
+      const processOptions = {
+        disableSmartModelRouting: !!this.disableSmartModelRouting,
+        excludeFieldsFromPassthrough: f.excludeFieldsFromPassthrough,
+        canConfigureSmartModelRouting: f.canConfigureSmartModelRouting
+      };
+      return processChildAgentFunction(
+        agent.getFunction(),
+        values,
+        parentKeys,
+        mm,
+        processOptions
+      );
+    });
     const functions = [
       ...options?.functions ?? this.functions ?? [],
       ...agentFuncs ?? []
@@ -6094,16 +6145,33 @@ var AxAgent = class {
     return { ai, functions };
   }
   async forward(parentAi, values, options) {
-    const { ai, functions } = this.init(parentAi, options);
+    const { ai, functions } = this.init(parentAi, values, options);
     return await this.program.forward(ai, values, { ...options, functions });
   }
   async *streamingForward(parentAi, values, options) {
-    const { ai, functions } = this.init(parentAi, options);
+    const { ai, functions } = this.init(parentAi, values, options);
     return yield* this.program.streamingForward(ai, values, {
       ...options,
       functions
     });
   }
+  /**
+   * Updates the agent's description.
+   * This updates both the stored description and the function's description.
+   *
+   * @param description - New description for the agent (must be at least 20 characters)
+   * @throws Error if description is too short
+   */
+  setDescription(description) {
+    if (!description || description.length < 20) {
+      throw new Error(
+        "Agent description must be at least 20 characters (explain in detail what the agent does)"
+      );
+    }
+    this.description = description;
+    this.signature.setDescription(description);
+    this.func.description = description;
+  }
 };
 function toCamelCase(inputString) {
   const words = inputString.split(/[^a-zA-Z0-9]/);
@@ -6141,6 +6209,34 @@ function addModelParameter(parameters, models) {
     required: newRequired
   };
 }
+function removePropertiesFromSchema(schema, keys) {
+  const newSchema = structuredClone(schema);
+  if (newSchema.properties) {
+    for (const key of keys) {
+      delete newSchema.properties[key];
+    }
+  }
+  if (Array.isArray(newSchema.required)) {
+    const filteredRequired = newSchema.required.filter(
+      (r) => !keys.includes(r)
+    );
+    Object.defineProperty(newSchema, "required", {
+      value: filteredRequired,
+      writable: true,
+      configurable: true
+    });
+  }
+  return newSchema;
+}
+function pick(obj, keys) {
+  const result = {};
+  for (const key of keys) {
+    if (key in obj) {
+      result[key] = obj[key];
+    }
+  }
+  return result;
+}
 
 // docs/tika.ts
 import { createReadStream } from "node:fs";