Files
crewAI/src/crewai/cli/templates/pipeline_router
C0deZ e66a135d5d refactor: Move BaseTool to main package and centralize tool description generation (#1514)
* move base_tool to main package and consolidate tool desscription generation

* update import path

* update tests

* update doc

* add base_tool test

* migrate agent delegation tools to use BaseTool

* update tests

* update import path for tool

* fix lint

* update param signature

* add from_langchain to BaseTool for backwards support of langchain tools

* fix the case where StructuredTool doesn't have func

---------

Co-authored-by: c0dez <li@vitablehealth.com>
Co-authored-by: Brandon Hancock (bhancock_ai) <109994880+bhancockio@users.noreply.github.com>
2024-11-01 12:30:48 -04:00
..
2024-10-30 00:07:46 -03:00

{{crew_name}} Crew

Welcome to the {{crew_name}} Crew project, powered by crewAI. This template is designed to help you set up a multi-agent AI system with ease, leveraging the powerful and flexible framework provided by crewAI. Our goal is to enable your agents to collaborate effectively on complex tasks, maximizing their collective intelligence and capabilities.

Installation

Ensure you have Python >=3.10 <=3.13 installed on your system. This project uses Poetry for dependency management and package handling, offering a seamless setup and execution experience.

First, if you haven't already, install Poetry:

pip install poetry

Next, navigate to your project directory and install the dependencies:

  1. First lock the dependencies and then install them:
crewai install

Customizing

Add your OPENAI_API_KEY into the .env file

  • Modify src/{{folder_name}}/config/agents.yaml to define your agents
  • Modify src/{{folder_name}}/config/tasks.yaml to define your tasks
  • Modify src/{{folder_name}}/crew.py to add your own logic, tools and specific args
  • Modify src/{{folder_name}}/main.py to add custom inputs for your agents and tasks

Running the Project

To kickstart your crew of AI agents and begin task execution, run this from the root folder of your project:

crewai run

This command initializes the {{name}} Crew, assembling the agents and assigning them tasks as defined in your configuration.

This example, unmodified, will run the create a report.md file with the output of a research on LLMs in the root folder.

Understanding Your Crew

The {{name}} Crew is composed of multiple AI agents, each with unique roles, goals, and tools. These agents collaborate on a series of tasks, defined in config/tasks.yaml, leveraging their collective skills to achieve complex objectives. The config/agents.yaml file outlines the capabilities and configurations of each agent in your crew.

Support

For support, questions, or feedback regarding the {{crew_name}} Crew or crewAI.

Let's create wonders together with the power and simplicity of crewAI.