@amitdeshmukh/ax-crew 8.0.2 → 8.1.0

package/examples/rlm-shared-fields.ts

@@ -0,0 +1,181 @@
+import dotenv from "dotenv";
+import { AxJSRuntime, AxJSRuntimePermission } from "@ax-llm/ax";
+import { AxCrew } from "../dist/index.js";
+import type { AxCrewConfig } from "../dist/index.js";
+
+dotenv.config();
+
+const runtime = new AxJSRuntime({
+  permissions: [AxJSRuntimePermission.TIMING],
+});
+
+const config: AxCrewConfig = {
+  crew: [
+    {
+      name: "PolicyLookupAgent",
+      description: "Looks up policy details in the provided knowledge base.",
+      executionMode: "axagent",
+      signature:
+        'question:string -> answer:string "Looks up company policies and returns a concise answer"',
+      provider: "google-gemini",
+      providerKeyName: "GEMINI_API_KEY",
+      ai: {
+        model: "gemini-2.5-flash",
+        temperature: 0,
+      },
+      axAgentOptions: {
+        // Mandatory for AxAgent RLM mode (even if empty)
+        contextFields: [],
+        runtime,
+      },
+    },
+    {
+      name: "BillingHelperAgent",
+      description: "Answers billing and account questions.",
+      executionMode: "axagent",
+      signature:
+        'question:string -> answer:string "Resolves billing and account questions"',
+      provider: "google-gemini",
+      providerKeyName: "GEMINI_API_KEY",
+      ai: {
+        model: "gemini-2.5-flash",
+        temperature: 0,
+      },
+      axAgentOptions: {
+        contextFields: [],
+        runtime,
+      },
+    },
+    {
+      name: "SentimentClassifierAgent",
+      description: "Classifies customer message sentiment.",
+      executionMode: "axagent",
+      signature: 'question:string -> sentiment:string "positive, negative, or neutral"',
+      provider: "google-gemini",
+      providerKeyName: "GEMINI_API_KEY",
+      ai: {
+        model: "gemini-2.5-flash",
+        temperature: 0,
+      },
+      axAgentOptions: {
+        contextFields: [],
+        // Opt out of parent shared fields for this specialist.
+        fields: { excluded: ["knowledgeBase", "userId"] },
+        runtime,
+      },
+    },
+    {
+      name: "CustomerSupportAgent",
+      description: "Routes queries to specialists and returns a final answer.",
+      executionMode: "axagent",
+      signature: "query:string, knowledgeBase:string, userId:string -> answer:string",
+      provider: "google-gemini",
+      providerKeyName: "GEMINI_API_KEY",
+      ai: {
+        model: "gemini-2.5-flash",
+        temperature: 0,
+      },
+      agents: [
+        "PolicyLookupAgent",
+        "BillingHelperAgent",
+        "SentimentClassifierAgent",
+      ],
+      options: {
+        debug: true,
+      },
+      axAgentOptions: {
+        // Mandatory and central to shared-field example
+        contextFields: ["knowledgeBase"],
+        fields: { shared: ["knowledgeBase", "userId"] },
+        runtime,
+      },
+    },
+  ],
+};
+
+const knowledgeBase = `
+=== COMPANY POLICIES ===
+
+REFUND POLICY:
+- Full refund within 30 days of purchase for unused items.
+- Partial refund (50%) for items returned between 31-60 days.
+- No refunds after 60 days.
+- Digital products are non-refundable after download.
+
+SHIPPING POLICY:
+- Standard shipping: 5-7 business days, free for orders over $50.
+- Express shipping: 2-3 business days, $12.99 flat rate.
+- International shipping: 10-15 business days, varies by destination.
+
+LOYALTY PROGRAM:
+- Bronze tier: 0-499 points - 5% discount on all orders.
+- Silver tier: 500-1499 points - 10% discount + free standard shipping.
+- Gold tier: 1500+ points - 15% discount + free express shipping + early access to sales.
+- Points earned: $1 spent = 1 point.
+
+=== ACCOUNT DATA (userId: cust-42) ===
+
+Name: Alice Johnson
+Tier: Silver (720 points)
+Recent Orders:
+  - Order #A100: Widget Pro, purchased 12 days ago, $89.99, delivered
+  - Order #A101: Smart Lamp, purchased 45 days ago, $34.50, delivered
+  - Order #A102: USB-C Hub, purchased 3 days ago, $24.99, shipped
+Payment Method: Visa ending in 4242
+`.trim();
+
+const main = async (): Promise<void> => {
+  const crew = new AxCrew(config);
+  try {
+    await crew.addAllAgents();
+
+    const supportAgent = crew.agents?.get("CustomerSupportAgent");
+    if (!supportAgent) throw new Error("Failed to initialize CustomerSupportAgent");
+
+    const result = await supportAgent.forward({
+      query:
+        "I want to return the Smart Lamp from order #A101. Am I eligible for a full refund? " +
+        "Also, how many more points do I need to reach Gold tier?",
+      knowledgeBase,
+      userId: "cust-42",
+    });
+
+    console.log("\n=== Support Answer ===");
+    console.log(result.answer);
+
+    const supportMetrics = (supportAgent as any).getMetrics?.();
+    const policyMetrics = (crew.agents?.get("PolicyLookupAgent") as any)?.getMetrics?.();
+    const billingMetrics = (crew.agents?.get("BillingHelperAgent") as any)?.getMetrics?.();
+    const sentimentMetrics = (crew.agents?.get("SentimentClassifierAgent") as any)?.getMetrics?.();
+    const crewMetrics = crew.getCrewMetrics();
+
+    console.log("\n=== Cost & Usage (Agents) ===");
+    console.log(
+      `CustomerSupportAgent USD=${supportMetrics?.estimatedCostUSD ?? 0}, tokens=${supportMetrics?.tokens?.totalTokens ?? 0}`
+    );
+    console.log(
+      `PolicyLookupAgent USD=${policyMetrics?.estimatedCostUSD ?? 0}, tokens=${policyMetrics?.tokens?.totalTokens ?? 0}`
+    );
+    console.log(
+      `BillingHelperAgent USD=${billingMetrics?.estimatedCostUSD ?? 0}, tokens=${billingMetrics?.tokens?.totalTokens ?? 0}`
+    );
+    console.log(
+      `SentimentClassifierAgent USD=${sentimentMetrics?.estimatedCostUSD ?? 0}, tokens=${sentimentMetrics?.tokens?.totalTokens ?? 0}`
+    );
+
+    console.log("\n=== Cost & Usage (Crew) ===");
+    console.log(`Estimated USD: ${crewMetrics?.estimatedCostUSD ?? 0}`);
+    console.log(
+      `Tokens: prompt=${crewMetrics?.tokens?.promptTokens ?? 0}, completion=${crewMetrics?.tokens?.completionTokens ?? 0}, total=${crewMetrics?.tokens?.totalTokens ?? 0}`
+    );
+  } finally {
+    crew.destroy();
+  }
+};
+
+main()
+  .then(() => process.exit(0))
+  .catch((error: unknown) => {
+    console.error(error);
+    process.exit(1);
+  });

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@amitdeshmukh/ax-crew",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "Build and launch a crew of AI agents with shared state. Built with axllm.dev",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,8 +24,8 @@
     "uuid": "^10.0.0"
   },
   "peerDependencies": {
-    "@ax-llm/ax": "^14.0.36",
-    "@ax-llm/ax-tools": "^14.0.36",
+    "@ax-llm/ax": "^19.0.11",
+    "@ax-llm/ax-tools": "^19.0.11",
     "@opentelemetry/api": "^1.9.0"
   },
   "devDependencies": {

package/src/agents/agentConfig.ts

@@ -6,6 +6,8 @@ import { AxMCPStdioTransport } from '@ax-llm/ax-tools'
 // Resolve env by provided key name
 import type { 
   AgentConfig,
+  AgentExecutionMode,
+  AxCrewAxAgentOptions,
   AxCrewConfig,
   AxCrewOptions,
   FunctionRegistryType, 
@@ -204,11 +206,16 @@ const parseAgentConfig = async (
       // Add MCP functions to functions
       ...mcpFunctions
     ];
+
+    const executionMode: AgentExecutionMode =
+      agentConfigData.executionMode === 'axgen' ? 'axgen' : 'axagent';
     
     // Return AI instance and Agent parameters
     return {
       ai: aiInstance,
       name: agentName,
+      executionMode,
+      axAgentOptions: (agentConfigData.axAgentOptions ?? {}) as AxCrewAxAgentOptions,
       description: agentConfigData.description,
       definition: (agentConfigData as any).definition ?? (agentConfigData as any).prompt,
       signature: agentConfigData.signature,
@@ -246,4 +253,4 @@ function resolveApiKey(varName: string): string | undefined {
   } catch {
     return undefined;
   }
-}
+}