@amitdeshmukh/ax-crew 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -5,6 +5,17 @@ This Changelog format is based on [Keep a Changelog]
 adheres to [Semantic Versioning](https://semver.org/spec/
 v2.0.0.html).
 
+## [3.1.0] - 2024-12-10
+
+### Added
+- Support for direct JSON object configuration in addition to configuration files
+- New configuration option to pass agent configuration as a JavaScript object
+- Updated documentation in README.md with examples of both configuration methods
+
+### Enhanced
+- Configuration flexibility allowing runtime configuration modifications
+- Support for dynamic agent configuration generation
+
 ## [3.0.0] - 2024-12-10
 
 ### Changed

package/README.md

@@ -28,21 +28,65 @@ Refer to the [.env.example](.env.example) file for the required environment vari
 ## Usage
 
 ### Initializing a Crew
-A Crew is a team of agents that work together to achieve a common goal. The configuration file for a crew is a YAML file that defines the agents in the crew, along with their individual configurations.
+A Crew is a team of agents that work together to achieve a common goal. You can configure your crew in two ways:
 
-See [agentConfig.json](agentConfig.json) for an example.
+1. Using a JSON configuration file that defines the agents in the crew, along with their individual configurations.
+2. Directly passing a JSON object with the crew configuration.
 
-To initialize a crew of agents, pass a config file to the `AxCrew` constructor.
+#### Using a Configuration File
+See [agentConfig.json](agentConfig.json) for an example configuration file.
 
 ```javascript
 // Import the AxCrew class
 import { AxCrew } from '@amitdeshmukh/ax-crew';
 
-// Create a new instance of AxCrew
+// Create a new instance of AxCrew using a config file
 const configFilePath = './agentConfig.json';
 const crew = new AxCrew(configFilePath);
 ```
 
+#### Using a Direct Configuration Object
+You can also pass the configuration directly as a JSON object:
+
+```javascript
+// Import the AxCrew class
+import { AxCrew } from '@amitdeshmukh/ax-crew';
+
+// Create the configuration object
+const config = {
+  crew: [
+    {
+      name: "Planner",
+      description: "Creates a plan to complete a task",
+      signature: "task:string \"a task to be completed\" -> plan:string \"a plan to execute the task in 5 steps or less\"",
+      provider: "google-gemini",
+      providerKeyName: "GEMINI_API_KEY",
+      ai: {
+        model: "gemini-1.5-flash",
+        temperature: 0
+      },
+      options: {
+        debug: false
+      }
+    }
+    // ... more agents
+  ]
+};
+
+// Create a new instance of AxCrew using the config object
+const crew = new AxCrew(config);
+```
+
+Both methods support the same configuration structure and options. Choose the one that best fits your use case:
+- Use a configuration file when you want to:
+  - Keep your configuration separate from your code
+  - Share configurations across different projects
+  - Version control your configurations
+- Use a direct configuration object when you want to:
+  - Generate configurations dynamically
+  - Modify configurations at runtime
+  - Keep everything in one file for simpler projects
+
 ### Function Registry
 Functions (aka Tools) are the building blocks of agents. They are used to perform specific tasks, such as calling external APIs, databases, or other services.
 

package/dist/agents/agentConfig.js

@@ -68,56 +68,66 @@ Original error: ${error.message}`;
     return `Error parsing agent configuration: ${error.message}`;
 };
 /**
- * Reads the AI parameters from the YAML configuration file.
- * @param {string} agentConfigFilePath - The path to the agent_config.yaml file.
- * @returns {Object} The parsed agent configs from the config.yaml file.
- * @throws Will throw an error if reading the file fails.
+ * Reads the AI parameters from either a JSON configuration file or a direct JSON object.
+ * @param {AgentConfigInput} input - Either a path to the agent_config.json file or a JSON object with crew configuration.
+ * @returns {Object} The parsed agent configs.
+ * @throws Will throw an error if reading/parsing fails.
  */
-const parseAgentConfig = (agentConfigFilePath) => {
+const parseAgentConfig = (input) => {
     try {
-        const fileContents = fs.readFileSync(agentConfigFilePath, 'utf8');
-        const parsedConfigs = JSON.parse(fileContents);
-        return parsedConfigs;
+        if (typeof input === 'string') {
+            // Handle file path input
+            const fileContents = fs.readFileSync(input, 'utf8');
+            const parsedConfigs = JSON.parse(fileContents);
+            return parsedConfigs;
+        }
+        else {
+            // Handle direct JSON object input
+            return input;
+        }
     }
     catch (e) {
         if (e instanceof Error) {
-            const formattedError = getFormattedJSONError(e, fs.readFileSync(agentConfigFilePath, 'utf8'));
-            throw new Error(formattedError);
+            if (typeof input === 'string') {
+                const formattedError = getFormattedJSONError(e, fs.readFileSync(input, 'utf8'));
+                throw new Error(formattedError);
+            }
+            throw new Error(`Error parsing agent configuration: ${e.message}`);
         }
         throw e;
     }
 };
 /**
- * Initializes the AI agent using the specified agent name and configuration file path.
+ * Initializes the AI agent using the specified agent name and configuration.
  * This function parses the agent's configuration, validates the presence of the necessary API key,
  * and creates an instance of the AI agent with the appropriate settings.
  *
  * @param {string} agentName - The identifier for the AI agent to be initialized.
- * @param {string} agentConfigFilePath - The file path to the YAML configuration for the agent.
+ * @param {AgentConfigInput} agentConfig - Either a file path to the JSON configuration or a JSON object with crew configuration.
  * @param {FunctionRegistryType} functions - The functions available to the agent.
  * @param {Object} state - The state object for the agent.
  * @returns {Object} An object containing the Agents AI instance, its name, description, signature, functions and subAgentList.
  * @throws {Error} Throws an error if the agent configuration is missing, the provider is unsupported,
  * the API key is not found, or the provider key name is not specified in the configuration.
  */
-const getAgentConfigParams = (agentName, agentConfigFilePath, functions, state) => {
+const getAgentConfigParams = (agentName, agentConfig, functions, state) => {
     try {
-        // Retrieve the parameters for the specified AI agent from a config file in yaml format
-        const agentConfig = parseAgentConfig(agentConfigFilePath).crew.find(agent => agent.name === agentName);
-        if (!agentConfig) {
+        // Retrieve the parameters for the specified AI agent from config
+        const agentConfigData = parseAgentConfig(agentConfig).crew.find(agent => agent.name === agentName);
+        if (!agentConfigData) {
             throw new Error(`AI agent with name ${agentName} is not configured`);
         }
         // Get the constructor for the AI agent's provider
-        const AIConstructor = AIConstructors[agentConfig.provider];
+        const AIConstructor = AIConstructors[agentConfigData.provider];
         if (!AIConstructor) {
-            throw new Error(`AI provider ${agentConfig.provider} is not supported. Did you mean '${agentConfig.provider.toLowerCase()}'?`);
+            throw new Error(`AI provider ${agentConfigData.provider} is not supported. Did you mean '${agentConfigData.provider.toLowerCase()}'?`);
         }
         // If an API Key property is present, get the API key for the AI agent from the environment variables
         let apiKey = '';
-        if (agentConfig.providerKeyName) {
-            apiKey = PROVIDER_API_KEYS[agentConfig.providerKeyName] || '';
+        if (agentConfigData.providerKeyName) {
+            apiKey = PROVIDER_API_KEYS[agentConfigData.providerKeyName] || '';
             if (!apiKey) {
-                throw new Error(`API key for provider ${agentConfig.provider} is not set in environment variables`);
+                throw new Error(`API key for provider ${agentConfigData.provider} is not set in environment variables`);
             }
         }
         else {
@@ -126,19 +136,19 @@ const getAgentConfigParams = (agentName, agentConfigFilePath, functions, state)
         // Create an instance of the AI agent
         const ai = new AIConstructor({
             apiKey,
-            config: agentConfig.ai,
+            config: agentConfigData.ai,
             options: {
-                debug: agentConfig.debug || false
+                debug: agentConfigData.debug || false
             }
         });
         // If an apiURL is provided in the agent config, set it in the AI agent
-        if (agentConfig.apiURL) {
-            ai.setAPIURL(agentConfig.apiURL);
+        if (agentConfigData.apiURL) {
+            ai.setAPIURL(agentConfigData.apiURL);
         }
         // Set all options from the agent configuration
-        ai.setOptions({ ...agentConfig.options });
+        ai.setOptions({ ...agentConfigData.options });
         // Prepare functions for the AI agent
-        const agentFunctions = (agentConfig.functions || [])
+        const agentFunctions = (agentConfigData.functions || [])
             .map(funcName => {
             const func = functions[funcName];
             if (!func) {
@@ -157,10 +167,10 @@ const getAgentConfigParams = (agentName, agentConfigFilePath, functions, state)
         return {
             ai,
             name: agentName,
-            description: agentConfig.description,
-            signature: agentConfig.signature,
+            description: agentConfigData.description,
+            signature: agentConfigData.signature,
             functions: agentFunctions,
-            subAgentNames: agentConfig.agents || []
+            subAgentNames: agentConfigData.agents || []
         };
     }
     catch (error) {

package/dist/agents/index.js

@@ -23,11 +23,11 @@ class StatefulAxAgent extends AxAgent {
 class AxCrew {
     /**
      * Creates an instance of AxCrew.
-     * @param {string} configFilePath - Path to the agent config file.
+     * @param {AgentConfigInput} agentConfig - Either a path to the agent config file or a JSON object with crew configuration.
      * @param {FunctionRegistryType} [functionsRegistry={}] - The registry of functions to use in the crew.
      * @param {string} [crewId=uuidv4()] - The unique identifier for the crew.
      */
-    constructor(configFilePath, functionsRegistry = {}, crewId = uuidv4()) {
+    constructor(agentConfig, functionsRegistry = {}, crewId = uuidv4()) {
         this.functionsRegistry = {};
         /**
          * Factory function for creating an agent.
@@ -37,7 +37,7 @@ class AxCrew {
          */
         this.createAgent = (agentName) => {
             try {
-                const agentConfigParams = getAgentConfigParams(agentName, this.configFilePath, this.functionsRegistry, this.state);
+                const agentConfigParams = getAgentConfigParams(agentName, this.agentConfig, this.functionsRegistry, this.state);
                 // Destructure with type assertion
                 const { ai, name, description, signature, functions, subAgentNames } = agentConfigParams;
                 // Get subagents for the AI agent
@@ -61,7 +61,7 @@ class AxCrew {
                 throw error;
             }
         };
-        this.configFilePath = configFilePath;
+        this.agentConfig = agentConfig;
         this.functionsRegistry = functionsRegistry;
         this.crewId = crewId;
         this.agents = new Map();

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@amitdeshmukh/ax-crew",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Build and launch a crew of AI agents with shared state. Built with axllm.dev",
   "main": "dist/index.js",
   "engines": {

package/src/agents/agentConfig.ts

@@ -97,33 +97,44 @@ Original error: ${error.message}`;
   return `Error parsing agent configuration: ${error.message}`;
 };
 
+type AgentConfigInput = string | { crew: AgentConfig[] };
+
 /**
- * Reads the AI parameters from the YAML configuration file.
- * @param {string} agentConfigFilePath - The path to the agent_config.yaml file.
- * @returns {Object} The parsed agent configs from the config.yaml file.
- * @throws Will throw an error if reading the file fails.
+ * Reads the AI parameters from either a JSON configuration file or a direct JSON object.
+ * @param {AgentConfigInput} input - Either a path to the agent_config.json file or a JSON object with crew configuration.
+ * @returns {Object} The parsed agent configs.
+ * @throws Will throw an error if reading/parsing fails.
  */
-const parseAgentConfig = (agentConfigFilePath: string): {crew: AgentConfig[]} => {
+const parseAgentConfig = (input: AgentConfigInput): { crew: AgentConfig[] } => {
   try {
-    const fileContents = fs.readFileSync(agentConfigFilePath, 'utf8');
-    const parsedConfigs = JSON.parse(fileContents) as { crew: AgentConfig[] };
-    return parsedConfigs;
+    if (typeof input === 'string') {
+      // Handle file path input
+      const fileContents = fs.readFileSync(input, 'utf8');
+      const parsedConfigs = JSON.parse(fileContents) as { crew: AgentConfig[] };
+      return parsedConfigs;
+    } else {
+      // Handle direct JSON object input
+      return input;
+    }
   } catch (e) {
     if (e instanceof Error) {
-      const formattedError = getFormattedJSONError(e, fs.readFileSync(agentConfigFilePath, 'utf8'));
-      throw new Error(formattedError);
+      if (typeof input === 'string') {
+        const formattedError = getFormattedJSONError(e, fs.readFileSync(input, 'utf8'));
+        throw new Error(formattedError);
+      }
+      throw new Error(`Error parsing agent configuration: ${e.message}`);
     }
     throw e;
   }
 };
 
 /**
- * Initializes the AI agent using the specified agent name and configuration file path.
+ * Initializes the AI agent using the specified agent name and configuration.
  * This function parses the agent's configuration, validates the presence of the necessary API key,
  * and creates an instance of the AI agent with the appropriate settings.
  *
  * @param {string} agentName - The identifier for the AI agent to be initialized.
- * @param {string} agentConfigFilePath - The file path to the YAML configuration for the agent.
+ * @param {AgentConfigInput} agentConfig - Either a file path to the JSON configuration or a JSON object with crew configuration.
  * @param {FunctionRegistryType} functions - The functions available to the agent.
  * @param {Object} state - The state object for the agent.
  * @returns {Object} An object containing the Agents AI instance, its name, description, signature, functions and subAgentList.
@@ -132,30 +143,30 @@ const parseAgentConfig = (agentConfigFilePath: string): {crew: AgentConfig[]} =>
  */
 const getAgentConfigParams = (
   agentName: string, 
-  agentConfigFilePath: string,
+  agentConfig: AgentConfigInput,
   functions: FunctionRegistryType,
   state: Record<string, any>
 ) => {
   try {
-    // Retrieve the parameters for the specified AI agent from a config file in yaml format
-    const agentConfig = parseAgentConfig(agentConfigFilePath).crew.find(agent => agent.name === agentName);
-    if (!agentConfig) {
+    // Retrieve the parameters for the specified AI agent from config
+    const agentConfigData = parseAgentConfig(agentConfig).crew.find(agent => agent.name === agentName);
+    if (!agentConfigData) {
       throw new Error(`AI agent with name ${agentName} is not configured`);
     }
 
     // Get the constructor for the AI agent's provider
-    const AIConstructor = AIConstructors[agentConfig.provider];
+    const AIConstructor = AIConstructors[agentConfigData.provider];
     if (!AIConstructor) {
-      throw new Error(`AI provider ${agentConfig.provider} is not supported. Did you mean '${agentConfig.provider.toLowerCase()}'?`);
+      throw new Error(`AI provider ${agentConfigData.provider} is not supported. Did you mean '${agentConfigData.provider.toLowerCase()}'?`);
     }
 
     // If an API Key property is present, get the API key for the AI agent from the environment variables
     let apiKey = '';
-    if (agentConfig.providerKeyName) {
-      apiKey = PROVIDER_API_KEYS[agentConfig.providerKeyName] || '';
+    if (agentConfigData.providerKeyName) {
+      apiKey = PROVIDER_API_KEYS[agentConfigData.providerKeyName] || '';
 
       if (!apiKey) {
-        throw new Error(`API key for provider ${agentConfig.provider} is not set in environment variables`);
+        throw new Error(`API key for provider ${agentConfigData.provider} is not set in environment variables`);
       }
     } else {
       throw new Error(`Provider key name is missing in the agent configuration`);
@@ -164,22 +175,21 @@ const getAgentConfigParams = (
     // Create an instance of the AI agent
     const ai = new AIConstructor({
       apiKey,
-      config: agentConfig.ai,
+      config: agentConfigData.ai,
       options: {
-        debug: agentConfig.debug || false
+        debug: agentConfigData.debug || false
       }
     });
-
     // If an apiURL is provided in the agent config, set it in the AI agent
-    if (agentConfig.apiURL) {
-      ai.setAPIURL(agentConfig.apiURL);
+    if (agentConfigData.apiURL) {
+      ai.setAPIURL(agentConfigData.apiURL);
     }
 
     // Set all options from the agent configuration
-    ai.setOptions({ ...agentConfig.options });
+    ai.setOptions({ ...agentConfigData.options });
     
     // Prepare functions for the AI agent
-    const agentFunctions = (agentConfig.functions || [])
+    const agentFunctions = (agentConfigData.functions || [])
       .map(funcName => {
         const func = functions[funcName];
         if (!func) {
@@ -201,10 +211,10 @@ const getAgentConfigParams = (
     return {
       ai,
       name: agentName,
-      description: agentConfig.description,
-      signature: agentConfig.signature,
+      description: agentConfigData.description,
+      signature: agentConfigData.signature,
       functions: agentFunctions,
-      subAgentNames: agentConfig.agents || []
+      subAgentNames: agentConfigData.agents || []
     };
   } catch (error) {
     if (error instanceof Error) {
@@ -214,4 +224,4 @@ const getAgentConfigParams = (
   }
 };
 
-export { getAgentConfigParams }
+export { getAgentConfigParams, AgentConfigInput };

package/src/agents/index.ts

@@ -7,6 +7,7 @@ import type {
   AxProgramForwardOptions,
 } from "@ax-llm/ax";
 import { getAgentConfigParams } from "./agentConfig.js";
+import type { AgentConfigInput } from "./agentConfig.js";
 import { FunctionRegistryType } from "../functions/index.js";
 import { createState, StateInstance } from "../state/index.js";
 
@@ -62,7 +63,7 @@ class StatefulAxAgent extends AxAgent<any, any> {
  * Represents a crew of agents with shared state functionality.
  */
 class AxCrew {
-  private configFilePath: string;
+  private agentConfig: AgentConfigInput;
   functionsRegistry: FunctionRegistryType = {};
   crewId: string;
   agents: Map<string, StatefulAxAgent> | null;
@@ -70,16 +71,16 @@ class AxCrew {
 
   /**
    * Creates an instance of AxCrew.
-   * @param {string} configFilePath - Path to the agent config file.
+   * @param {AgentConfigInput} agentConfig - Either a path to the agent config file or a JSON object with crew configuration.
    * @param {FunctionRegistryType} [functionsRegistry={}] - The registry of functions to use in the crew.
    * @param {string} [crewId=uuidv4()] - The unique identifier for the crew.
    */
   constructor(
-    configFilePath: string,
+    agentConfig: AgentConfigInput,
     functionsRegistry: FunctionRegistryType = {},
     crewId: string = uuidv4()
   ) {
-    this.configFilePath = configFilePath;
+    this.agentConfig = agentConfig;
     this.functionsRegistry = functionsRegistry;
     this.crewId = crewId;
     this.agents = new Map<string, StatefulAxAgent>();
@@ -96,7 +97,7 @@ class AxCrew {
     try {
       const agentConfigParams: AgentConfigParams = getAgentConfigParams(
         agentName,
-        this.configFilePath,
+        this.agentConfig,
         this.functionsRegistry,
         this.state
       );

package/test1.js

@@ -0,0 +1,98 @@
+import { AxCrew, AxCrewFunctions } from "./dist/index.js";
+
+// Define the configuration object directly
+const config = {
+  crew: [
+    {
+      name: "Planner",
+      description: "Creates a plan to complete a task",
+      signature: "task:string \"a task to be completed\" -> plan:string \"a plan to execute the task in 5 steps or less\"",
+      provider: "google-gemini",
+      providerKeyName: "GEMINI_API_KEY",
+      ai: {
+        model: "gemini-1.5-flash",
+        temperature: 0
+      },
+      options: {
+        debug: false
+      }
+    },
+    {
+      name: "Calculator",
+      description: "Solves math problems",
+      signature: "mathProblem:string \"a math problem to be solved using Python code\" -> solution:string \"the solution to the math problem\"",
+      provider: "google-gemini",
+      providerKeyName: "GEMINI_API_KEY",
+      ai: {
+        model: "gemini-1.5-pro",
+        temperature: 0
+      },
+      options: {
+        debug: true,
+        codeExecution: true
+      },
+      functions: ["CurrentDateTime", "DaysBetweenDates"]
+    },
+    {
+      name: "WebSearch",
+      description: "Searches the web for the latest information using Google search",
+      signature: "webSearchQuery:string \"a query for Google search\" -> webSearchResponse:string \"the result of the search\"",
+      provider: "google-gemini",
+      providerKeyName: "GEMINI_API_KEY",
+      ai: {
+        model: "gemini-1.5-pro",
+        temperature: 0
+      },
+      options: {
+        debug: true,
+        googleSearchRetrieval: true
+      },
+      functions: ["CurrentDateTime", "DaysBetweenDates"]
+    },
+    {
+      name: "Manager",
+      description: "Answers questions from the user",
+      signature: "question:string \"a question from a user\", plan:string \"a suggested plan to answer the question\" -> answer:string \"the answer\"",
+      provider: "openai",
+      providerKeyName: "OPENAI_API_KEY",
+      ai: {
+        model: "gpt-4o-mini",
+        temperature: 0
+      },
+      options: {
+        debug: true
+      },
+      functions: ["CurrentDateTime", "DaysBetweenDates"]
+    }
+  ]
+};
+
+// Create crew instance with the direct configuration
+const crew = new AxCrew(config, AxCrewFunctions);
+crew.addAgentsToCrew(["Planner", "Calculator", "WebSearch", "Manager"]);
+
+const calculateAndPrintAgentCost = (agent, agentName) => {
+  const { models, modelUsage, modelInfo } = agent.axai;
+
+  const { promptTokens, completionTokens } = modelUsage;
+  const modelDetails = modelInfo?.find((m) => m.name === models.model);
+  const totalCost = ((promptTokens / 1000000) * modelDetails?.promptTokenCostPer1M) + ((completionTokens / 1000000) * modelDetails?.completionTokenCostPer1M);
+
+  console.log(`\n${agentName} Usage:\nPrompt Token Cost: $${(promptTokens / 1000000 * modelDetails?.promptTokenCostPer1M).toFixed(6)}\nCompletion Token Cost: $${(completionTokens / 1000000 * modelDetails?.completionTokenCostPer1M).toFixed(6)}\nTotal Cost: $${totalCost.toFixed(6)}\nPrompt Tokens: ${promptTokens}\nCompletion Tokens: ${completionTokens}\nTotal Tokens: ${promptTokens + completionTokens}`);
+};
+
+const userQuery = "what is the cube root of the number of days between now and Christmas";
+console.log(`\n\nQuestion: ${userQuery}`);
+
+const Planner = crew.agents.get("Planner");
+const plannerResponse = await Planner.forward({ task: userQuery });
+console.log(`\n\nPlanner Response: ${plannerResponse.plan}`);
+
+const Manager = crew.agents.get("Manager");
+const managerResponse = await Manager.forward({ question: userQuery, plan: plannerResponse.plan });
+console.log(`\n\nManager Response: ${managerResponse.answer}`);
+
+// const calculatorResponse = await crew.agents.get("Calculator").forward({ mathProblem: userQuery });
+// calculateAndPrintAgentCost(crew.agents.get("Calculator"), "Calculator");
+
+// console.log(`\n\nAnswer: ${calculatorResponse.solution}`);