Brandon/eng 266 conversation crew v1 (#1843)

* worked on foundation for new conversational crews. Now going to work on chatting.

* core loop should be working and ready for testing.

* high level chat working

* its alive!!

* Added in Joaos feedback to steer crew chats back towards the purpose of the crew

* properly return tool call result

* accessing crew directly instead of through uv commands

* everything is working for conversation now

* Fix linting

* fix llm_utils.py and other type errors

* fix more type errors

* fixing type error

* More fixing of types

* fix failing tests

* Fix more failing tests

* adding tests. cleaing up pr.

* improve

* drop old functions

* improve type hintings

src/crewai/cli/cli.py

@@ -1,11 +1,13 @@
+import os
 from importlib.metadata import version as get_version
-from typing import Optional
+from typing import Optional, Tuple
 
 import click
 
 from crewai.cli.add_crew_to_flow import add_crew_to_flow
 from crewai.cli.create_crew import create_crew
 from crewai.cli.create_flow import create_flow
+from crewai.cli.crew_chat import run_chat
 from crewai.memory.storage.kickoff_task_outputs_storage import (
     KickoffTaskOutputsSQLiteStorage,
 )
@@ -342,5 +344,15 @@ def flow_add_crew(crew_name):
     add_crew_to_flow(crew_name)
 
 
+@crewai.command()
+def chat():
+    """
+    Start a conversation with the Crew, collecting user-supplied inputs,
+    and using the Chat LLM to generate responses.
+    """
+    click.echo("Starting a conversation with the Crew")
+    run_chat()
+
+
 if __name__ == "__main__":
     crewai()

src/crewai/cli/constants.py

@@ -158,6 +158,8 @@ MODELS = {
     ],
 }
 
+DEFAULT_LLM_MODEL = "gpt-4o-mini"
+
 JSON_URL = "https://raw.githubusercontent.com/BerriAI/litellm/main/model_prices_and_context_window.json"
 
 

src/crewai/cli/crew_chat.py

@@ -0,0 +1,413 @@
+import json
+import re
+import sys
+from pathlib import Path
+from typing import Any, Dict, List, Optional, Set, Tuple
+
+import click
+import tomli
+
+from crewai.crew import Crew
+from crewai.llm import LLM
+from crewai.types.crew_chat import ChatInputField, ChatInputs
+from crewai.utilities.llm_utils import create_llm
+
+
+def run_chat():
+    """
+    Runs an interactive chat loop using the Crew's chat LLM with function calling.
+    Incorporates crew_name, crew_description, and input fields to build a tool schema.
+    Exits if crew_name or crew_description are missing.
+    """
+    crew, crew_name = load_crew_and_name()
+    chat_llm = initialize_chat_llm(crew)
+    if not chat_llm:
+        return
+
+    crew_chat_inputs = generate_crew_chat_inputs(crew, crew_name, chat_llm)
+    crew_tool_schema = generate_crew_tool_schema(crew_chat_inputs)
+    system_message = build_system_message(crew_chat_inputs)
+
+    # Call the LLM to generate the introductory message
+    introductory_message = chat_llm.call(
+        messages=[{"role": "system", "content": system_message}]
+    )
+    click.secho(f"\nAssistant: {introductory_message}\n", fg="green")
+
+    messages = [
+        {"role": "system", "content": system_message},
+        {"role": "assistant", "content": introductory_message},
+    ]
+
+    available_functions = {
+        crew_chat_inputs.crew_name: create_tool_function(crew, messages),
+    }
+
+    click.secho(
+        "\nEntering an interactive chat loop with function-calling.\n"
+        "Type 'exit' or Ctrl+C to quit.\n",
+        fg="cyan",
+    )
+
+    chat_loop(chat_llm, messages, crew_tool_schema, available_functions)
+
+
+def initialize_chat_llm(crew: Crew) -> Optional[LLM]:
+    """Initializes the chat LLM and handles exceptions."""
+    try:
+        return create_llm(crew.chat_llm)
+    except Exception as e:
+        click.secho(
+            f"Unable to find a Chat LLM. Please make sure you set chat_llm on the crew: {e}",
+            fg="red",
+        )
+        return None
+
+
+def build_system_message(crew_chat_inputs: ChatInputs) -> str:
+    """Builds the initial system message for the chat."""
+    required_fields_str = (
+        ", ".join(
+            f"{field.name} (desc: {field.description or 'n/a'})"
+            for field in crew_chat_inputs.inputs
+        )
+        or "(No required fields detected)"
+    )
+
+    return (
+        "You are a helpful AI assistant for the CrewAI platform. "
+        "Your primary purpose is to assist users with the crew's specific tasks. "
+        "You can answer general questions, but should guide users back to the crew's purpose afterward. "
+        "For example, after answering a general question, remind the user of your main purpose, such as generating a research report, and prompt them to specify a topic or task related to the crew's purpose. "
+        "You have a function (tool) you can call by name if you have all required inputs. "
+        f"Those required inputs are: {required_fields_str}. "
+        "Once you have them, call the function. "
+        "Please keep your responses concise and friendly. "
+        "If a user asks a question outside the crew's scope, provide a brief answer and remind them of the crew's purpose. "
+        "After calling the tool, be prepared to take user feedback and make adjustments as needed. "
+        "If you are ever unsure about a user's request or need clarification, ask the user for more information."
+        "Before doing anything else, introduce yourself with a friendly message like: 'Hey! I'm here to help you with [crew's purpose]. Could you please provide me with [inputs] so we can get started?' "
+        "For example: 'Hey! I'm here to help you with uncovering and reporting cutting-edge developments through thorough research and detailed analysis. Could you please provide me with a topic you're interested in? This will help us generate a comprehensive research report and detailed analysis.'"
+        f"\nCrew Name: {crew_chat_inputs.crew_name}"
+        f"\nCrew Description: {crew_chat_inputs.crew_description}"
+    )
+
+
+def create_tool_function(crew: Crew, messages: List[Dict[str, str]]) -> Any:
+    """Creates a wrapper function for running the crew tool with messages."""
+
+    def run_crew_tool_with_messages(**kwargs):
+        return run_crew_tool(crew, messages, **kwargs)
+
+    return run_crew_tool_with_messages
+
+
+def chat_loop(chat_llm, messages, crew_tool_schema, available_functions):
+    """Main chat loop for interacting with the user."""
+    while True:
+        try:
+            user_input = click.prompt("You", type=str)
+            if user_input.strip().lower() in ["exit", "quit"]:
+                click.echo("Exiting chat. Goodbye!")
+                break
+
+            messages.append({"role": "user", "content": user_input})
+            final_response = chat_llm.call(
+                messages=messages,
+                tools=[crew_tool_schema],
+                available_functions=available_functions,
+            )
+
+            messages.append({"role": "assistant", "content": final_response})
+            click.secho(f"\nAssistant: {final_response}\n", fg="green")
+
+        except KeyboardInterrupt:
+            click.echo("\nExiting chat. Goodbye!")
+            break
+        except Exception as e:
+            click.secho(f"An error occurred: {e}", fg="red")
+            break
+
+
+def generate_crew_tool_schema(crew_inputs: ChatInputs) -> dict:
+    """
+    Dynamically build a Littellm 'function' schema for the given crew.
+
+    crew_name: The name of the crew (used for the function 'name').
+    crew_inputs: A ChatInputs object containing crew_description
+                 and a list of input fields (each with a name & description).
+    """
+    properties = {}
+    for field in crew_inputs.inputs:
+        properties[field.name] = {
+            "type": "string",
+            "description": field.description or "No description provided",
+        }
+
+    required_fields = [field.name for field in crew_inputs.inputs]
+
+    return {
+        "type": "function",
+        "function": {
+            "name": crew_inputs.crew_name,
+            "description": crew_inputs.crew_description or "No crew description",
+            "parameters": {
+                "type": "object",
+                "properties": properties,
+                "required": required_fields,
+            },
+        },
+    }
+
+
+def run_crew_tool(crew: Crew, messages: List[Dict[str, str]], **kwargs):
+    """
+    Runs the crew using crew.kickoff(inputs=kwargs) and returns the output.
+
+    Args:
+        crew (Crew): The crew instance to run.
+        messages (List[Dict[str, str]]): The chat messages up to this point.
+        **kwargs: The inputs collected from the user.
+
+    Returns:
+        str: The output from the crew's execution.
+
+    Raises:
+        SystemExit: Exits the chat if an error occurs during crew execution.
+    """
+    try:
+        # Serialize 'messages' to JSON string before adding to kwargs
+        kwargs["crew_chat_messages"] = json.dumps(messages)
+
+        # Run the crew with the provided inputs
+        crew_output = crew.kickoff(inputs=kwargs)
+
+        # Convert CrewOutput to a string to send back to the user
+        result = str(crew_output)
+
+        return result
+    except Exception as e:
+        # Exit the chat and show the error message
+        click.secho("An error occurred while running the crew:", fg="red")
+        click.secho(str(e), fg="red")
+        sys.exit(1)
+
+
+def load_crew_and_name() -> Tuple[Crew, str]:
+    """
+    Loads the crew by importing the crew class from the user's project.
+
+    Returns:
+        Tuple[Crew, str]: A tuple containing the Crew instance and the name of the crew.
+    """
+    # Get the current working directory
+    cwd = Path.cwd()
+
+    # Path to the pyproject.toml file
+    pyproject_path = cwd / "pyproject.toml"
+    if not pyproject_path.exists():
+        raise FileNotFoundError("pyproject.toml not found in the current directory.")
+
+    # Load the pyproject.toml file using 'tomli'
+    with pyproject_path.open("rb") as f:
+        pyproject_data = tomli.load(f)
+
+    # Get the project name from the 'project' section
+    project_name = pyproject_data["project"]["name"]
+    folder_name = project_name
+
+    # Derive the crew class name from the project name
+    # E.g., if project_name is 'my_project', crew_class_name is 'MyProject'
+    crew_class_name = project_name.replace("_", " ").title().replace(" ", "")
+
+    # Add the 'src' directory to sys.path
+    src_path = cwd / "src"
+    if str(src_path) not in sys.path:
+        sys.path.insert(0, str(src_path))
+
+    # Import the crew module
+    crew_module_name = f"{folder_name}.crew"
+    try:
+        crew_module = __import__(crew_module_name, fromlist=[crew_class_name])
+    except ImportError as e:
+        raise ImportError(f"Failed to import crew module {crew_module_name}: {e}")
+
+    # Get the crew class from the module
+    try:
+        crew_class = getattr(crew_module, crew_class_name)
+    except AttributeError:
+        raise AttributeError(
+            f"Crew class {crew_class_name} not found in module {crew_module_name}"
+        )
+
+    # Instantiate the crew
+    crew_instance = crew_class().crew()
+    return crew_instance, crew_class_name
+
+
+def generate_crew_chat_inputs(crew: Crew, crew_name: str, chat_llm) -> ChatInputs:
+    """
+    Generates the ChatInputs required for the crew by analyzing the tasks and agents.
+
+    Args:
+        crew (Crew): The crew object containing tasks and agents.
+        crew_name (str): The name of the crew.
+        chat_llm: The chat language model to use for AI calls.
+
+    Returns:
+        ChatInputs: An object containing the crew's name, description, and input fields.
+    """
+    # Extract placeholders from tasks and agents
+    required_inputs = fetch_required_inputs(crew)
+
+    # Generate descriptions for each input using AI
+    input_fields = []
+    for input_name in required_inputs:
+        description = generate_input_description_with_ai(input_name, crew, chat_llm)
+        input_fields.append(ChatInputField(name=input_name, description=description))
+
+    # Generate crew description using AI
+    crew_description = generate_crew_description_with_ai(crew, chat_llm)
+
+    return ChatInputs(
+        crew_name=crew_name, crew_description=crew_description, inputs=input_fields
+    )
+
+
+def fetch_required_inputs(crew: Crew) -> Set[str]:
+    """
+    Extracts placeholders from the crew's tasks and agents.
+
+    Args:
+        crew (Crew): The crew object.
+
+    Returns:
+        Set[str]: A set of placeholder names.
+    """
+    placeholder_pattern = re.compile(r"\{(.+?)\}")
+    required_inputs: Set[str] = set()
+
+    # Scan tasks
+    for task in crew.tasks:
+        text = f"{task.description or ''} {task.expected_output or ''}"
+        required_inputs.update(placeholder_pattern.findall(text))
+
+    # Scan agents
+    for agent in crew.agents:
+        text = f"{agent.role or ''} {agent.goal or ''} {agent.backstory or ''}"
+        required_inputs.update(placeholder_pattern.findall(text))
+
+    return required_inputs
+
+
+def generate_input_description_with_ai(input_name: str, crew: Crew, chat_llm) -> str:
+    """
+    Generates an input description using AI based on the context of the crew.
+
+    Args:
+        input_name (str): The name of the input placeholder.
+        crew (Crew): The crew object.
+        chat_llm: The chat language model to use for AI calls.
+
+    Returns:
+        str: A concise description of the input.
+    """
+    # Gather context from tasks and agents where the input is used
+    context_texts = []
+    placeholder_pattern = re.compile(r"\{(.+?)\}")
+
+    for task in crew.tasks:
+        if (
+            f"{{{input_name}}}" in task.description
+            or f"{{{input_name}}}" in task.expected_output
+        ):
+            # Replace placeholders with input names
+            task_description = placeholder_pattern.sub(
+                lambda m: m.group(1), task.description
+            )
+            expected_output = placeholder_pattern.sub(
+                lambda m: m.group(1), task.expected_output
+            )
+            context_texts.append(f"Task Description: {task_description}")
+            context_texts.append(f"Expected Output: {expected_output}")
+    for agent in crew.agents:
+        if (
+            f"{{{input_name}}}" in agent.role
+            or f"{{{input_name}}}" in agent.goal
+            or f"{{{input_name}}}" in agent.backstory
+        ):
+            # Replace placeholders with input names
+            agent_role = placeholder_pattern.sub(lambda m: m.group(1), agent.role)
+            agent_goal = placeholder_pattern.sub(lambda m: m.group(1), agent.goal)
+            agent_backstory = placeholder_pattern.sub(
+                lambda m: m.group(1), agent.backstory
+            )
+            context_texts.append(f"Agent Role: {agent_role}")
+            context_texts.append(f"Agent Goal: {agent_goal}")
+            context_texts.append(f"Agent Backstory: {agent_backstory}")
+
+    context = "\n".join(context_texts)
+    if not context:
+        # If no context is found for the input, raise an exception as per instruction
+        raise ValueError(f"No context found for input '{input_name}'.")
+
+    prompt = (
+        f"Based on the following context, write a concise description (15 words or less) of the input '{input_name}'.\n"
+        "Provide only the description, without any extra text or labels. Do not include placeholders like '{topic}' in the description.\n"
+        "Context:\n"
+        f"{context}"
+    )
+    response = chat_llm.call(messages=[{"role": "user", "content": prompt}])
+    description = response.strip()
+
+    return description
+
+
+def generate_crew_description_with_ai(crew: Crew, chat_llm) -> str:
+    """
+    Generates a brief description of the crew using AI.
+
+    Args:
+        crew (Crew): The crew object.
+        chat_llm: The chat language model to use for AI calls.
+
+    Returns:
+        str: A concise description of the crew's purpose (15 words or less).
+    """
+    # Gather context from tasks and agents
+    context_texts = []
+    placeholder_pattern = re.compile(r"\{(.+?)\}")
+
+    for task in crew.tasks:
+        # Replace placeholders with input names
+        task_description = placeholder_pattern.sub(
+            lambda m: m.group(1), task.description
+        )
+        expected_output = placeholder_pattern.sub(
+            lambda m: m.group(1), task.expected_output
+        )
+        context_texts.append(f"Task Description: {task_description}")
+        context_texts.append(f"Expected Output: {expected_output}")
+    for agent in crew.agents:
+        # Replace placeholders with input names
+        agent_role = placeholder_pattern.sub(lambda m: m.group(1), agent.role)
+        agent_goal = placeholder_pattern.sub(lambda m: m.group(1), agent.goal)
+        agent_backstory = placeholder_pattern.sub(lambda m: m.group(1), agent.backstory)
+        context_texts.append(f"Agent Role: {agent_role}")
+        context_texts.append(f"Agent Goal: {agent_goal}")
+        context_texts.append(f"Agent Backstory: {agent_backstory}")
+
+    context = "\n".join(context_texts)
+    if not context:
+        raise ValueError("No context found for generating crew description.")
+
+    prompt = (
+        "Based on the following context, write a concise, action-oriented description (15 words or less) of the crew's purpose.\n"
+        "Provide only the description, without any extra text or labels. Do not include placeholders like '{topic}' in the description.\n"
+        "Context:\n"
+        f"{context}"
+    )
+    response = chat_llm.call(messages=[{"role": "user", "content": prompt}])
+    crew_description = response.strip()
+
+    return crew_description

src/crewai/cli/templates/crew/main.py

@@ -18,7 +18,11 @@ def run():
     inputs = {
         'topic': 'AI LLMs'
     }
-    {{crew_name}}().crew().kickoff(inputs=inputs)
+    
+    try:
+        {{crew_name}}().crew().kickoff(inputs=inputs)
+    except Exception as e:
+        raise Exception(f"An error occurred while running the crew: {e}")
 
 
 def train():
@@ -55,4 +59,4 @@ def test():
         {{crew_name}}().crew().test(n_iterations=int(sys.argv[1]), openai_model_name=sys.argv[2], inputs=inputs)
 
     except Exception as e:
-        raise Exception(f"An error occurred while replaying the crew: {e}")
+        raise Exception(f"An error occurred while testing the crew: {e}")