diff --git a/README.md b/README.md index 8d081a446..ac7da2f9d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@
-![Logo of crewAI, two people rowing on a boat](./docs/crewai_logo.png) +![Logo of CrewAI, two people rowing on a boat](./docs/crewai_logo.png) -# **crewAI** +# **CrewAI** -πŸ€– **crewAI**: Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks. +πŸ€– **CrewAI**: Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.

@@ -44,83 +44,222 @@ To get started with CrewAI, follow these simple steps: ### 1. Installation +Ensure you have Python >=3.10 <=3.13 installed on your system. CrewAI uses [Poetry](https://python-poetry.org/) for dependency management and package handling, offering a seamless setup and execution experience. + +First, if you haven't already, install Poetry: + +```bash +pip install poetry +``` + +Then, install CrewAI: + ```shell pip install crewai ``` -If you want to install the 'crewai' package along with its optional features that include additional tools for agents, you can do so by using the following command: pip install 'crewai[tools]'. This command installs the basic package and also adds extra components which require more dependencies to function." +If you want to install the 'crewai' package along with its optional features that include additional tools for agents, you can do so by using the following command: ```shell pip install 'crewai[tools]' ``` +The command above installs the basic package and also adds extra components which require more dependencies to function. -### 2. Setting Up Your Crew +### 2. Setting Up Your Crew with the YAML Configuration + +To create a new CrewAI project, run the following CLI (Command Line Interface) command: + +```shell +crewai create crew +``` + +This command creates a new project folder with the following structure: + +``` +my_project/ +β”œβ”€β”€ .gitignore +β”œβ”€β”€ pyproject.toml +β”œβ”€β”€ README.md +β”œβ”€β”€ .env +└── src/ + └── my_project/ + β”œβ”€β”€ __init__.py + β”œβ”€β”€ main.py + β”œβ”€β”€ crew.py + β”œβ”€β”€ tools/ + β”‚ β”œβ”€β”€ custom_tool.py + β”‚ └── __init__.py + └── config/ + β”œβ”€β”€ agents.yaml + └── tasks.yaml +``` + +You can now start developing your crew by editing the files in the `src/my_project` folder. The `main.py` file is the entry point of the project, the `crew.py` file is where you define your crew, the `agents.yaml` file is where you define your agents, and the `tasks.yaml` file is where you define your tasks. + +#### To customize your project, you can: + +- Modify `src/my_project/config/agents.yaml` to define your agents. +- Modify `src/my_project/config/tasks.yaml` to define your tasks. +- Modify `src/my_project/crew.py` to add your own logic, tools, and specific arguments. +- Modify `src/my_project/main.py` to add custom inputs for your agents and tasks. +- Add your environment variables into the `.env` file. + +#### Example of a simple crew with a sequential process: + +Instatiate your crew: + +```shell +crewai create crew latest-ai-development +``` + +Modify the files as needed to fit your use case: + +**agents.yaml** + +```yaml +# src/my_project/config/agents.yaml +researcher: + role: > + {topic} Senior Data Researcher + goal: > + Uncover cutting-edge developments in {topic} + backstory: > + You're a seasoned researcher with a knack for uncovering the latest + developments in {topic}. Known for your ability to find the most relevant + information and present it in a clear and concise manner. + +reporting_analyst: + role: > + {topic} Reporting Analyst + goal: > + Create detailed reports based on {topic} data analysis and research findings + backstory: > + You're a meticulous analyst with a keen eye for detail. You're known for + your ability to turn complex data into clear and concise reports, making + it easy for others to understand and act on the information you provide. +``` + +**tasks.yaml** + +```yaml +# src/my_project/config/tasks.yaml +research_task: + description: > + Conduct a thorough research about {topic} + Make sure you find any interesting and relevant information given + the current year is 2024. + expected_output: > + A list with 10 bullet points of the most relevant information about {topic} + agent: researcher + +reporting_task: + description: > + Review the context you got and expand each topic into a full section for a report. + Make sure the report is detailed and contains any and all relevant information. + expected_output: > + A fully fledge reports with the mains topics, each with a full section of information. + Formatted as markdown without '```' + agent: reporting_analyst + output_file: report.md +``` + +**crew.py** ```python -import os -from crewai import Agent, Task, Crew, Process +# src/my_project/crew.py +from crewai import Agent, Crew, Process, Task +from crewai.project import CrewBase, agent, crew, task from crewai_tools import SerperDevTool -os.environ["OPENAI_API_KEY"] = "YOUR_API_KEY" -os.environ["SERPER_API_KEY"] = "Your Key" # serper.dev API key +@CrewBase +class LatestAiDevelopmentCrew(): + """LatestAiDevelopment crew""" -# It can be a local model through Ollama / LM Studio or a remote -# model like OpenAI, Mistral, Antrophic or others (https://docs.crewai.com/how-to/LLM-Connections/) + @agent + def researcher(self) -> Agent: + return Agent( + config=self.agents_config['researcher'], + verbose=True, + tools=[SerperDevTool()] + ) -# Define your agents with roles and goals -researcher = Agent( - role='Senior Research Analyst', - goal='Uncover cutting-edge developments in AI and data science', - backstory="""You work at a leading tech think tank. - Your expertise lies in identifying emerging trends. - You have a knack for dissecting complex data and presenting actionable insights.""", - verbose=True, - allow_delegation=False, - # You can pass an optional llm attribute specifying what model you wanna use. - # llm=ChatOpenAI(model_name="gpt-3.5", temperature=0.7), - tools=[SerperDevTool()] -) -writer = Agent( - role='Tech Content Strategist', - goal='Craft compelling content on tech advancements', - backstory="""You are a renowned Content Strategist, known for your insightful and engaging articles. - You transform complex concepts into compelling narratives.""", - verbose=True, - allow_delegation=True -) + @agent + def reporting_analyst(self) -> Agent: + return Agent( + config=self.agents_config['reporting_analyst'], + verbose=True + ) -# Create tasks for your agents -task1 = Task( - description="""Conduct a comprehensive analysis of the latest advancements in AI in 2024. - Identify key trends, breakthrough technologies, and potential industry impacts.""", - expected_output="Full analysis report in bullet points", - agent=researcher -) + @task + def research_task(self) -> Task: + return Task( + config=self.tasks_config['research_task'], + ) -task2 = Task( - description="""Using the insights provided, develop an engaging blog - post that highlights the most significant AI advancements. - Your post should be informative yet accessible, catering to a tech-savvy audience. - Make it sound cool, avoid complex words so it doesn't sound like AI.""", - expected_output="Full blog post of at least 4 paragraphs", - agent=writer -) + @task + def reporting_task(self) -> Task: + return Task( + config=self.tasks_config['reporting_task'], + output_file='report.md' + ) -# Instantiate your crew with a sequential process -crew = Crew( - agents=[researcher, writer], - tasks=[task1, task2], - verbose=True, - process = Process.sequential -) - -# Get your crew to work! -result = crew.kickoff() - -print("######################") -print(result) + @crew + def crew(self) -> Crew: + """Creates the LatestAiDevelopment crew""" + return Crew( + agents=self.agents, # Automatically created by the @agent decorator + tasks=self.tasks, # Automatically created by the @task decorator + process=Process.sequential, + verbose=True, + ) ``` +**main.py** + +```python +#!/usr/bin/env python +# src/my_project/main.py +import sys +from latest_ai_development.crew import LatestAiDevelopmentCrew + +def run(): + """ + Run the crew. + """ + inputs = { + 'topic': 'AI Agents' + } + LatestAiDevelopmentCrew().crew().kickoff(inputs=inputs) +``` + +### 3. Running Your Crew + +Before running your crew, make sure you have the following keys set as environment variables in your `.env` file: + +- An [OpenAI API key](https://platform.openai.com/account/api-keys) (or other LLM API key): `OPENAI_API_KEY=sk-...` +- A [Serper.dev](https://serper.dev/) API key: `SERPER_API_KEY=YOUR_KEY_HERE` + +Lock the dependencies and install them by using the CLI command but first, navigate to your project directory: + +```shell +cd my_project +crewai install +``` + +To run your crew, execute the following command in the root of your project: + +```bash +crewai run +``` + +or + +```bash +python src/my_project/main.py +``` + +You should see the output in the console and the `report.md` file should be created in the root of your project with the full final report. + In addition to the sequential process, you can use the hierarchical process, which automatically assigns a manager to the defined crew to properly coordinate the planning and execution of tasks through delegation and validation of results. [See more about the processes here](https://docs.crewai.com/core-concepts/Processes/). ## Key Features @@ -131,13 +270,13 @@ In addition to the sequential process, you can use the hierarchical process, whi - **Processes Driven**: Currently only supports `sequential` task execution and `hierarchical` processes, but more complex processes like consensual and autonomous are being worked on. - **Save output as file**: Save the output of individual tasks as a file, so you can use it later. - **Parse output as Pydantic or Json**: Parse the output of individual tasks as a Pydantic model or as a Json if you want to. -- **Works with Open Source Models**: Run your crew using Open AI or open source models refer to the [Connect crewAI to LLMs](https://docs.crewai.com/how-to/LLM-Connections/) page for details on configuring your agents' connections to models, even ones running locally! +- **Works with Open Source Models**: Run your crew using Open AI or open source models refer to the [Connect CrewAI to LLMs](https://docs.crewai.com/how-to/LLM-Connections/) page for details on configuring your agents' connections to models, even ones running locally! ![CrewAI Mind Map](./docs/crewAI-mindmap.png "CrewAI Mind Map") ## Examples -You can test different real life examples of AI crews in the [crewAI-examples repo](https://github.com/crewAIInc/crewAI-examples?tab=readme-ov-file): +You can test different real life examples of AI crews in the [CrewAI-examples repo](https://github.com/crewAIInc/crewAI-examples?tab=readme-ov-file): - [Landing Page Generator](https://github.com/crewAIInc/crewAI-examples/tree/main/landing_page_generator) - [Having Human input on the execution](https://docs.crewai.com/how-to/Human-Input-on-Execution) @@ -168,9 +307,9 @@ You can test different real life examples of AI crews in the [crewAI-examples re ## Connecting Your Crew to a Model -crewAI supports using various LLMs through a variety of connection options. By default your agents will use the OpenAI API when querying the model. However, there are several other ways to allow your agents to connect to models. For example, you can configure your agents to use a local model via the Ollama tool. +CrewAI supports using various LLMs through a variety of connection options. By default your agents will use the OpenAI API when querying the model. However, there are several other ways to allow your agents to connect to models. For example, you can configure your agents to use a local model via the Ollama tool. -Please refer to the [Connect crewAI to LLMs](https://docs.crewai.com/how-to/LLM-Connections/) page for details on configuring you agents' connections to models. +Please refer to the [Connect CrewAI to LLMs](https://docs.crewai.com/how-to/LLM-Connections/) page for details on configuring you agents' connections to models. ## How CrewAI Compares @@ -241,7 +380,7 @@ It's pivotal to understand that **NO data is collected** concerning prompts, tas Data collected includes: -- Version of crewAI +- Version of CrewAI - So we can understand how many users are using the latest version - Version of Python - So we can decide on what versions to better support @@ -266,7 +405,7 @@ Users can opt-in to Further Telemetry, sharing the complete telemetry data by se ## License -CrewAI is released under the MIT License. +CrewAI is released under the [MIT License](https://github.com/crewAIInc/crewAI/blob/main/LICENSE). ## Frequently Asked Questions (FAQ) @@ -299,7 +438,7 @@ A: Yes, CrewAI is open-source and welcomes contributions from the community. A: CrewAI uses anonymous telemetry to collect usage data for improvement purposes. No sensitive data (like prompts, task descriptions, or API calls) is collected. Users can opt-in to share more detailed data by setting `share_crew=True` on their Crews. ### Q: Where can I find examples of CrewAI in action? -A: You can find various real-life examples in the [crewAI-examples repository](https://github.com/crewAIInc/crewAI-examples), including trip planners, stock analysis tools, and more. +A: You can find various real-life examples in the [CrewAI-examples repository](https://github.com/crewAIInc/crewAI-examples), including trip planners, stock analysis tools, and more. ### Q: How can I contribute to CrewAI? A: Contributions are welcome! You can fork the repository, create a new branch for your feature, add your improvement, and send a pull request. Check the Contribution section in the README for more details. diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index e21535791..000000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -docs.crewai.com \ No newline at end of file diff --git a/docs/core-concepts/Agents.md b/docs/concepts/agents.mdx similarity index 81% rename from docs/core-concepts/Agents.md rename to docs/concepts/agents.mdx index 2a1c656b2..16518e626 100644 --- a/docs/core-concepts/Agents.md +++ b/docs/concepts/agents.mdx @@ -1,20 +1,23 @@ --- -title: crewAI Agents -description: What are crewAI Agents and how to use them. +title: Agents +description: What are CrewAI Agents and how to use them. +icon: robot --- -## What is an Agent? -!!! note "What is an Agent?" - An agent is an **autonomous unit** programmed to: -
    -
  • Perform tasks
    • -
  • Make decisions
    • -
  • Communicate with other agents
    • -
-
- Think of an agent as a member of a team, with specific skills and a particular job to do. Agents can have different roles like 'Researcher', 'Writer', or 'Customer Support', each contributing to the overall goal of the crew. +## What is an agent? -## Agent Attributes +An agent is an **autonomous unit** programmed to: +
    +
  • Perform tasks
    • +
  • Make decisions
    • +
  • Communicate with other agents
    • +
+ + +Think of an agent as a member of a team, with specific skills and a particular job to do. Agents can have different roles like `Researcher`, `Writer`, or `Customer Support`, each contributing to the overall goal of the crew. + + +## Agent attributes | Attribute | Parameter | Description | | :------------------------- | :--------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -30,7 +33,7 @@ description: What are crewAI Agents and how to use them. | **Verbose** *(optional)* | `verbose` | Setting this to `True` configures the internal logger to provide detailed execution logs, aiding in debugging and monitoring. Default is `False`. | | **Allow Delegation** *(optional)* | `allow_delegation` | Agents can delegate tasks or questions to one another, ensuring that each task is handled by the most suitable agent. Default is `False`. | **Step Callback** *(optional)* | `step_callback` | A function that is called after each step of the agent. This can be used to log the agent's actions or to perform other operations. It will overwrite the crew `step_callback`. | -| **Cache** *(optional)* | `cache` | Indicates if the agent should use a cache for tool usage. Default is `True`. | +| gbv vbn zzdsxcdsdfc**Cache** *(optional)* | `cache` | Indicates if the agent should use a cache for tool usage. Default is `True`. | | **System Template** *(optional)* | `system_template` | Specifies the system format for the agent. Default is `None`. | | **Prompt Template** *(optional)* | `prompt_template` | Specifies the prompt format for the agent. Default is `None`. | | **Response Template** *(optional)* | `response_template` | Specifies the response format for the agent. Default is `None`. | @@ -39,25 +42,25 @@ description: What are crewAI Agents and how to use them. | **Use System Prompt** *(optional)* | `use_system_prompt` | Adds the ability to not use system prompt (to support o1 models). Default is `True`. | | **Respect Context Window** *(optional)* | `respect_context_window` | Summary strategy to avoid overflowing the context window. Default is `True`. | -## Creating an Agent +## Creating an agent -!!! note "Agent Interaction" - Agents can interact with each other using crewAI's built-in delegation and communication mechanisms. This allows for dynamic task management and problem-solving within the crew. + + **Agent interaction**: Agents can interact with each other using CrewAI's built-in delegation and communication mechanisms. This allows for dynamic task management and problem-solving within the crew. + To create an agent, you would typically initialize an instance of the `Agent` class with the desired properties. Here's a conceptual example including all attributes: -```python -# Example: Creating an agent with all attributes +```python Code example from crewai import Agent agent = Agent( role='Data Analyst', goal='Extract actionable insights', backstory="""You're a data analyst at a large company. - You're responsible for analyzing data and providing insights - to the business. - You're currently working on a project to analyze the - performance of our marketing campaigns.""", + You're responsible for analyzing data and providing insights + to the business. + You're currently working on a project to analyze the + performance of our marketing campaigns.""", tools=[my_tool1, my_tool2], # Optional, defaults to an empty list llm=my_llm, # Optional function_calling_llm=my_llm, # Optional @@ -87,32 +90,31 @@ agent = Agent( Prompt templates are used to format the prompt for the agent. You can use to update the system, regular and response templates for the agent. Here's an example of how to set prompt templates: -```python +```python Code example agent = Agent( role="{topic} specialist", goal="Figure {goal} out", backstory="I am the master of {role}", system_template="""<|start_header_id|>system<|end_header_id|> - -{{ .System }}<|eot_id|>""", + {{ .System }}<|eot_id|>""", prompt_template="""<|start_header_id|>user<|end_header_id|> - -{{ .Prompt }}<|eot_id|>""", + {{ .Prompt }}<|eot_id|>""", response_template="""<|start_header_id|>assistant<|end_header_id|> - -{{ .Response }}<|eot_id|>""", - ) + {{ .Response }}<|eot_id|>""", +) ``` -## Bring your Third Party Agents -!!! note "Extend your Third Party Agents like LlamaIndex, Langchain, Autogen or fully custom agents using the the crewai's BaseAgent class." +## Bring your third-party agents - BaseAgent includes attributes and methods required to integrate with your crews to run and delegate tasks to other agents within your own crew. +Extend your third-party agents like LlamaIndex, Langchain, Autogen or fully custom agents using the the CrewAI's `BaseAgent` class. - CrewAI is a universal multi-agent framework that allows for all agents to work together to automate tasks and solve problems. + + **BaseAgent** includes attributes and methods required to integrate with your crews to run and delegate tasks to other agents within your own crew. + +CrewAI is a universal multi-agent framework that allows for all agents to work together to automate tasks and solve problems. -```py +```python Code example from crewai import Agent, Task, Crew from custom_agent import CustomAgent # You need to build and extend your own agent logic with the CrewAI BaseAgent class then import it here. @@ -152,4 +154,6 @@ crew = my_crew.kickoff(inputs={"input": "Mark Twain"}) ``` ## Conclusion -Agents are the building blocks of the CrewAI framework. By understanding how to define and interact with agents, you can create sophisticated AI systems that leverage the power of collaborative intelligence. \ No newline at end of file + +Agents are the building blocks of the CrewAI framework. By understanding how to define and interact with agents, +you can create sophisticated AI systems that leverage the power of collaborative intelligence. \ No newline at end of file diff --git a/docs/core-concepts/Cli.md b/docs/concepts/cli.mdx similarity index 77% rename from docs/core-concepts/Cli.md rename to docs/concepts/cli.mdx index 15546dcd7..26fdffc1d 100644 --- a/docs/core-concepts/Cli.md +++ b/docs/concepts/cli.mdx @@ -1,3 +1,9 @@ +--- +title: CLI +description: Learn how to use the CrewAI CLI to interact with CrewAI. +icon: terminal +--- + # CrewAI CLI Documentation The CrewAI CLI provides a set of commands to interact with CrewAI, allowing you to create, train, run, and manage crews and pipelines. @@ -6,7 +12,7 @@ The CrewAI CLI provides a set of commands to interact with CrewAI, allowing you To use the CrewAI CLI, make sure you have CrewAI & Poetry installed: -``` +```shell pip install crewai poetry ``` @@ -14,17 +20,17 @@ pip install crewai poetry The basic structure of a CrewAI CLI command is: -``` +```shell crewai [COMMAND] [OPTIONS] [ARGUMENTS] ``` ## Available Commands -### 1. create +### 1. Create Create a new crew or pipeline. -``` +```shell crewai create [OPTIONS] TYPE NAME ``` @@ -33,32 +39,32 @@ crewai create [OPTIONS] TYPE NAME - `--router`: (Optional) Create a pipeline with router functionality Example: -``` +```shell crewai create crew my_new_crew crewai create pipeline my_new_pipeline --router ``` -### 2. version +### 2. Version Show the installed version of CrewAI. -``` +```shell crewai version [OPTIONS] ``` - `--tools`: (Optional) Show the installed version of CrewAI tools Example: -``` +```shell crewai version crewai version --tools ``` -### 3. train +### 3. Train Train the crew for a specified number of iterations. -``` +```shell crewai train [OPTIONS] ``` @@ -66,39 +72,39 @@ crewai train [OPTIONS] - `-f, --filename TEXT`: Path to a custom file for training (default: "trained_agents_data.pkl") Example: -``` +```shell crewai train -n 10 -f my_training_data.pkl ``` -### 4. replay +### 4. Replay Replay the crew execution from a specific task. -``` +```shell crewai replay [OPTIONS] ``` - `-t, --task_id TEXT`: Replay the crew from this task ID, including all subsequent tasks Example: -``` +```shell crewai replay -t task_123456 ``` -### 5. log_tasks_outputs +### 5. Log-tasks-outputs Retrieve your latest crew.kickoff() task outputs. -``` -crewai log_tasks_outputs +```shell +crewai log-tasks-outputs ``` -### 6. reset_memories +### 6. Reset-memories Reset the crew memories (long, short, entity, latest_crew_kickoff_outputs). -``` -crewai reset_memories [OPTIONS] +```shell +crewai reset-memories [OPTIONS] ``` - `-l, --long`: Reset LONG TERM memory @@ -108,16 +114,16 @@ crewai reset_memories [OPTIONS] - `-a, --all`: Reset ALL memories Example: -``` -crewai reset_memories --long --short -crewai reset_memories --all +```shell +crewai reset-memories --long --short +crewai reset-memories --all ``` -### 7. test +### 7. Test Test the crew and evaluate the results. -``` +```shell crewai test [OPTIONS] ``` @@ -125,18 +131,18 @@ crewai test [OPTIONS] - `-m, --model TEXT`: LLM Model to run the tests on the Crew (default: "gpt-4o-mini") Example: -``` +```shell crewai test -n 5 -m gpt-3.5-turbo ``` -### 8. run +### 8. Run Run the crew. -``` +```shell crewai run ``` - -## Note - -Make sure to run these commands from the directory where your CrewAI project is set up. Some commands may require additional configuration or setup within your project structure. + +Make sure to run these commands from the directory where your CrewAI project is set up. +Some commands may require additional configuration or setup within your project structure. + \ No newline at end of file diff --git a/docs/concepts/collaboration.mdx b/docs/concepts/collaboration.mdx new file mode 100644 index 000000000..0aad7abf5 --- /dev/null +++ b/docs/concepts/collaboration.mdx @@ -0,0 +1,52 @@ +--- +title: Collaboration +description: Exploring the dynamics of agent collaboration within the CrewAI framework, focusing on the newly integrated features for enhanced functionality. +icon: screen-users +--- + +## Collaboration Fundamentals + +Collaboration in CrewAI is fundamental, enabling agents to combine their skills, share information, and assist each other in task execution, embodying a truly cooperative ecosystem. + +- **Information Sharing**: Ensures all agents are well-informed and can contribute effectively by sharing data and findings. +- **Task Assistance**: Allows agents to seek help from peers with the required expertise for specific tasks. +- **Resource Allocation**: Optimizes task execution through the efficient distribution and sharing of resources among agents. + +## Enhanced Attributes for Improved Collaboration + +The `Crew` class has been enriched with several attributes to support advanced functionalities: + +| Feature | Description | +|:-------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Language Model Management** (`manager_llm`, `function_calling_llm`) | Manages language models for executing tasks and tools. `manager_llm` is required for hierarchical processes, while `function_calling_llm` is optional with a default value for streamlined interactions. | +| **Custom Manager Agent** (`manager_agent`) | Specifies a custom agent as the manager, replacing the default CrewAI manager. | +| **Process Flow** (`process`) | Defines execution logic (e.g., sequential, hierarchical) for task distribution. | +| **Verbose Logging** (`verbose`) | Provides detailed logging for monitoring and debugging. Accepts integer and boolean values to control verbosity level. | +| **Rate Limiting** (`max_rpm`) | Limits requests per minute to optimize resource usage. Setting guidelines depend on task complexity and load. | +| **Internationalization / Customization** (`language`, `prompt_file`) | Supports prompt customization for global usability. [Example of file](https://github.com/joaomdmoura/crewAI/blob/main/src/crewai/translations/en.json) | +| **Execution and Output Handling** (`full_output`) | Controls output granularity, distinguishing between full and final outputs. | +| **Callback and Telemetry** (`step_callback`, `task_callback`) | Enables step-wise and task-level execution monitoring and telemetry for performance analytics. | +| **Crew Sharing** (`share_crew`) | Allows sharing crew data with CrewAI for model improvement. Privacy implications and benefits should be considered. | +| **Usage Metrics** (`usage_metrics`) | Logs all LLM usage metrics during task execution for performance insights. | +| **Memory Usage** (`memory`) | Enables memory for storing execution history, aiding in agent learning and task efficiency. | +| **Embedder Configuration** (`embedder`) | Configures the embedder for language understanding and generation, with support for provider customization. | +| **Cache Management** (`cache`) | Specifies whether to cache tool execution results, enhancing performance. | +| **Output Logging** (`output_log_file`) | Defines the file path for logging crew execution output. | +| **Planning Mode** (`planning`) | Enables action planning before task execution. Set `planning=True` to activate. | +| **Replay Feature** (`replay`) | Provides CLI for listing tasks from the last run and replaying from specific tasks, aiding in task management and troubleshooting. | + +## Delegation (Dividing to Conquer) + +Delegation enhances functionality by allowing agents to intelligently assign tasks or seek help, thereby amplifying the crew's overall capability. + +## Implementing Collaboration and Delegation + +Setting up a crew involves defining the roles and capabilities of each agent. CrewAI seamlessly manages their interactions, ensuring efficient collaboration and delegation, with enhanced customization and monitoring features to adapt to various operational needs. + +## Example Scenario + +Consider a crew with a researcher agent tasked with data gathering and a writer agent responsible for compiling reports. The integration of advanced language model management and process flow attributes allows for more sophisticated interactions, such as the writer delegating complex research tasks to the researcher or querying specific information, thereby facilitating a seamless workflow. + +## Conclusion + +The integration of advanced attributes and functionalities into the CrewAI framework significantly enriches the agent collaboration ecosystem. These enhancements not only simplify interactions but also offer unprecedented flexibility and control, paving the way for sophisticated AI-driven solutions capable of tackling complex tasks through intelligent collaboration and delegation. \ No newline at end of file diff --git a/docs/core-concepts/Crews.md b/docs/concepts/crews.mdx similarity index 97% rename from docs/core-concepts/Crews.md rename to docs/concepts/crews.mdx index 56c8ff9dd..fdb1c382f 100644 --- a/docs/core-concepts/Crews.md +++ b/docs/concepts/crews.mdx @@ -1,6 +1,7 @@ --- -title: crewAI Crews +title: Crews description: Understanding and utilizing crews in the crewAI framework with comprehensive attributes and functionalities. +icon: people-group --- ## What is a Crew? @@ -36,14 +37,14 @@ A crew in crewAI represents a collaborative group of agents working together to | **Planning** *(optional)* | `planning` | Adds planning ability to the Crew. When activated before each Crew iteration, all Crew data is sent to an AgentPlanner that will plan the tasks and this plan will be added to each task description. | | **Planning LLM** *(optional)* | `planning_llm` | The language model used by the AgentPlanner in a planning process. | -!!! note "Crew Max RPM" -The `max_rpm` attribute sets the maximum number of requests per minute the crew can perform to avoid rate limits and will override individual agents' `max_rpm` settings if you set it. + +**Crew Max RPM**: The `max_rpm` attribute sets the maximum number of requests per minute the crew can perform to avoid rate limits and will override individual agents' `max_rpm` settings if you set it. + ## Crew Output -!!! note "Understanding Crew Outputs" -The output of a crew in the crewAI framework is encapsulated within the `CrewOutput` class. +The output of a crew in the CrewAI framework is encapsulated within the `CrewOutput` class. This class provides a structured way to access results of the crew's execution, including various formats such as raw strings, JSON, and Pydantic models. The `CrewOutput` includes the results from the final task output, token usage, and individual task outputs. @@ -71,7 +72,7 @@ Once a crew has been executed, its output can be accessed through the `output` a #### Example -```python +```python Code # Example crew execution crew = Crew( agents=[research_agent, writer_agent], @@ -103,7 +104,7 @@ Caches can be employed to store the results of tools' execution, making the proc After the crew execution, you can access the `usage_metrics` attribute to view the language model (LLM) usage metrics for all tasks executed by the crew. This provides insights into operational efficiency and areas for improvement. -```python +```python Code # Access the crew's usage metrics crew = Crew(agents=[agent1, agent2], tasks=[task1, task2]) crew.kickoff() @@ -119,7 +120,7 @@ print(crew.usage_metrics) Once your crew is assembled, initiate the workflow with the `kickoff()` method. This starts the execution process according to the defined process flow. -```python +```python Code # Start the crew's task execution result = my_crew.kickoff() print(result) @@ -134,7 +135,7 @@ Once your crew is assembled, initiate the workflow with the appropriate kickoff - `kickoff_async()`: Initiates the workflow asynchronously. - `kickoff_for_each_async()`: Executes tasks for each agent individually in an asynchronous manner. -```python +```python Code # Start the crew's task execution result = my_crew.kickoff() print(result) diff --git a/docs/concepts/flows.mdx b/docs/concepts/flows.mdx new file mode 100644 index 000000000..4791fc6c3 --- /dev/null +++ b/docs/concepts/flows.mdx @@ -0,0 +1,656 @@ +--- +title: Flows +description: Learn how to create and manage AI workflows using CrewAI Flows. +icon: arrow-progress +--- + +## Introduction + +CrewAI Flows is a powerful feature designed to streamline the creation and management of AI workflows. Flows allow developers to combine and coordinate coding tasks and Crews efficiently, providing a robust framework for building sophisticated AI automations. + +Flows allow you to create structured, event-driven workflows. They provide a seamless way to connect multiple tasks, manage state, and control the flow of execution in your AI applications. With Flows, you can easily design and implement multi-step processes that leverage the full potential of CrewAI's capabilities. + +1. **Simplified Workflow Creation**: Easily chain together multiple Crews and tasks to create complex AI workflows. + +2. **State Management**: Flows make it super easy to manage and share state between different tasks in your workflow. + +3. **Event-Driven Architecture**: Built on an event-driven model, allowing for dynamic and responsive workflows. + +4. **Flexible Control Flow**: Implement conditional logic, loops, and branching within your workflows. + +## Getting Started + +Let's create a simple Flow where you will use OpenAI to generate a random city in one task and then use that city to generate a fun fact in another task. + +```python Code +import asyncio + +from crewai.flow.flow import Flow, listen, start +from litellm import completion + + +class ExampleFlow(Flow): + model = "gpt-4o-mini" + + @start() + def generate_city(self): + print("Starting flow") + + response = completion( + model=self.model, + messages=[ + { + "role": "user", + "content": "Return the name of a random city in the world.", + }, + ], + ) + + random_city = response["choices"][0]["message"]["content"] + print(f"Random City: {random_city}") + + return random_city + + @listen(generate_city) + def generate_fun_fact(self, random_city): + response = completion( + model=self.model, + messages=[ + { + "role": "user", + "content": f"Tell me a fun fact about {random_city}", + }, + ], + ) + + fun_fact = response["choices"][0]["message"]["content"] + return fun_fact + + +async def main(): + flow = ExampleFlow() + result = await flow.kickoff() + + print(f"Generated fun fact: {result}") + +asyncio.run(main()) +``` + +In the above example, we have created a simple Flow that generates a random city using OpenAI and then generates a fun fact about that city. The Flow consists of two tasks: `generate_city` and `generate_fun_fact`. The `generate_city` task is the starting point of the Flow, and the `generate_fun_fact` task listens for the output of the `generate_city` task. + +When you run the Flow, it will generate a random city and then generate a fun fact about that city. The output will be printed to the console. + +### @start() + +The `@start()` decorator is used to mark a method as the starting point of a Flow. When a Flow is started, all the methods decorated with `@start()` are executed in parallel. You can have multiple start methods in a Flow, and they will all be executed when the Flow is started. + +### @listen() + +The `@listen()` decorator is used to mark a method as a listener for the output of another task in the Flow. The method decorated with `@listen()` will be executed when the specified task emits an output. The method can access the output of the task it is listening to as an argument. + +#### Usage + +The `@listen()` decorator can be used in several ways: + +1. **Listening to a Method by Name**: You can pass the name of the method you want to listen to as a string. When that method completes, the listener method will be triggered. + + ```python Code + @listen("generate_city") + def generate_fun_fact(self, random_city): + # Implementation + ``` + +2. **Listening to a Method Directly**: You can pass the method itself. When that method completes, the listener method will be triggered. + ```python Code + @listen(generate_city) + def generate_fun_fact(self, random_city): + # Implementation + ``` + +### Flow Output + +Accessing and handling the output of a Flow is essential for integrating your AI workflows into larger applications or systems. CrewAI Flows provide straightforward mechanisms to retrieve the final output, access intermediate results, and manage the overall state of your Flow. + +#### Retrieving the Final Output + +When you run a Flow, the final output is determined by the last method that completes. The `kickoff()` method returns the output of this final method. + +Here's how you can access the final output: + + +```python Code +import asyncio +from crewai.flow.flow import Flow, listen, start + +class OutputExampleFlow(Flow): + @start() + def first_method(self): + return "Output from first_method" + + @listen(first_method) + def second_method(self, first_output): + return f"Second method received: {first_output}" + +async def main(): + flow = OutputExampleFlow() + final_output = await flow.kickoff() + print("---- Final Output ----") + print(final_output) + +asyncio.run(main()) +``` + +``` text Output +---- Final Output ---- +Second method received: Output from first_method +``` + + + +In this example, the `second_method` is the last method to complete, so its output will be the final output of the Flow. +The `kickoff()` method will return the final output, which is then printed to the console. + + +#### Accessing and Updating State + +In addition to retrieving the final output, you can also access and update the state within your Flow. The state can be used to store and share data between different methods in the Flow. After the Flow has run, you can access the state to retrieve any information that was added or updated during the execution. + +Here's an example of how to update and access the state: + + + +```python Code +import asyncio +from crewai.flow.flow import Flow, listen, start +from pydantic import BaseModel + +class ExampleState(BaseModel): + counter: int = 0 + message: str = "" + +class StateExampleFlow(Flow[ExampleState]): + + @start() + def first_method(self): + self.state.message = "Hello from first_method" + self.state.counter += 1 + + @listen(first_method) + def second_method(self): + self.state.message += " - updated by second_method" + self.state.counter += 1 + return self.state.message + +async def main(): + flow = StateExampleFlow() + final_output = await flow.kickoff() + print(f"Final Output: {final_output}") + print("Final State:") + print(flow.state) + +asyncio.run(main()) +``` + +``` text Output +Final Output: Hello from first_method - updated by second_method +Final State: +counter=2 message='Hello from first_method - updated by second_method' +``` + + +In this example, the state is updated by both `first_method` and `second_method`. +After the Flow has run, you can access the final state to see the updates made by these methods. + +By ensuring that the final method's output is returned and providing access to the state, CrewAI Flows make it easy to integrate the results of your AI workflows into larger applications or systems, +while also maintaining and accessing the state throughout the Flow's execution. + +## Flow State Management + +Managing state effectively is crucial for building reliable and maintainable AI workflows. CrewAI Flows provides robust mechanisms for both unstructured and structured state management, +allowing developers to choose the approach that best fits their application's needs. + +### Unstructured State Management + +In unstructured state management, all state is stored in the `state` attribute of the `Flow` class. +This approach offers flexibility, enabling developers to add or modify state attributes on the fly without defining a strict schema. + +```python Code +import asyncio + +from crewai.flow.flow import Flow, listen, start + +class UntructuredExampleFlow(Flow): + + @start() + def first_method(self): + self.state.message = "Hello from structured flow" + self.state.counter = 0 + + @listen(first_method) + def second_method(self): + self.state.counter += 1 + self.state.message += " - updated" + + @listen(second_method) + def third_method(self): + self.state.counter += 1 + self.state.message += " - updated again" + + print(f"State after third_method: {self.state}") + + +async def main(): + flow = UntructuredExampleFlow() + await flow.kickoff() + + +asyncio.run(main()) +``` + +**Key Points:** + +- **Flexibility:** You can dynamically add attributes to `self.state` without predefined constraints. +- **Simplicity:** Ideal for straightforward workflows where state structure is minimal or varies significantly. + +### Structured State Management + +Structured state management leverages predefined schemas to ensure consistency and type safety across the workflow. +By using models like Pydantic's `BaseModel`, developers can define the exact shape of the state, enabling better validation and auto-completion in development environments. + +```python Code +import asyncio + +from crewai.flow.flow import Flow, listen, start +from pydantic import BaseModel + + +class ExampleState(BaseModel): + counter: int = 0 + message: str = "" + + +class StructuredExampleFlow(Flow[ExampleState]): + + @start() + def first_method(self): + self.state.message = "Hello from structured flow" + + @listen(first_method) + def second_method(self): + self.state.counter += 1 + self.state.message += " - updated" + + @listen(second_method) + def third_method(self): + self.state.counter += 1 + self.state.message += " - updated again" + + print(f"State after third_method: {self.state}") + + +async def main(): + flow = StructuredExampleFlow() + await flow.kickoff() + + +asyncio.run(main()) +``` + +**Key Points:** + +- **Defined Schema:** `ExampleState` clearly outlines the state structure, enhancing code readability and maintainability. +- **Type Safety:** Leveraging Pydantic ensures that state attributes adhere to the specified types, reducing runtime errors. +- **Auto-Completion:** IDEs can provide better auto-completion and error checking based on the defined state model. + +### Choosing Between Unstructured and Structured State Management + +- **Use Unstructured State Management when:** + + - The workflow's state is simple or highly dynamic. + - Flexibility is prioritized over strict state definitions. + - Rapid prototyping is required without the overhead of defining schemas. + +- **Use Structured State Management when:** + - The workflow requires a well-defined and consistent state structure. + - Type safety and validation are important for your application's reliability. + - You want to leverage IDE features like auto-completion and type checking for better developer experience. + +By providing both unstructured and structured state management options, CrewAI Flows empowers developers to build AI workflows that are both flexible and robust, catering to a wide range of application requirements. + +## Flow Control + +### Conditional Logic: `or` + +The `or_` function in Flows allows you to listen to multiple methods and trigger the listener method when any of the specified methods emit an output. + + + +```python Code +import asyncio +from crewai.flow.flow import Flow, listen, or_, start + +class OrExampleFlow(Flow): + + @start() + def start_method(self): + return "Hello from the start method" + + @listen(start_method) + def second_method(self): + return "Hello from the second method" + + @listen(or_(start_method, second_method)) + def logger(self, result): + print(f"Logger: {result}") + + +async def main(): + flow = OrExampleFlow() + await flow.kickoff() + + +asyncio.run(main()) +``` + +``` text Output +Logger: Hello from the start method +Logger: Hello from the second method +``` + + + +When you run this Flow, the `logger` method will be triggered by the output of either the `start_method` or the `second_method`. +The `or_` function is used to listen to multiple methods and trigger the listener method when any of the specified methods emit an output. + +### Conditional Logic: `and` + +The `and_` function in Flows allows you to listen to multiple methods and trigger the listener method only when all the specified methods emit an output. + + + +```python Code +import asyncio +from crewai.flow.flow import Flow, and_, listen, start + +class AndExampleFlow(Flow): + + @start() + def start_method(self): + self.state["greeting"] = "Hello from the start method" + + @listen(start_method) + def second_method(self): + self.state["joke"] = "What do computers eat? Microchips." + + @listen(and_(start_method, second_method)) + def logger(self): + print("---- Logger ----") + print(self.state) + + +async def main(): + flow = AndExampleFlow() + await flow.kickoff() + + +asyncio.run(main()) +``` + +``` text Output +---- Logger ---- +{'greeting': 'Hello from the start method', 'joke': 'What do computers eat? Microchips.'} +``` + + + +When you run this Flow, the `logger` method will be triggered only when both the `start_method` and the `second_method` emit an output. +The `and_` function is used to listen to multiple methods and trigger the listener method only when all the specified methods emit an output. + +### Router + +The `@router()` decorator in Flows allows you to define conditional routing logic based on the output of a method. +You can specify different routes based on the output of the method, allowing you to control the flow of execution dynamically. + + + +```python Code +import asyncio +import random +from crewai.flow.flow import Flow, listen, router, start +from pydantic import BaseModel + +class ExampleState(BaseModel): + success_flag: bool = False + +class RouterFlow(Flow[ExampleState]): + + @start() + def start_method(self): + print("Starting the structured flow") + random_boolean = random.choice([True, False]) + self.state.success_flag = random_boolean + + @router(start_method) + def second_method(self): + if self.state.success_flag: + return "success" + else: + return "failed" + + @listen("success") + def third_method(self): + print("Third method running") + + @listen("failed") + def fourth_method(self): + print("Fourth method running") + + +async def main(): + flow = RouterFlow() + await flow.kickoff() + + +asyncio.run(main()) +``` + +``` text Output +Starting the structured flow +Third method running +Fourth method running +``` + + + +In the above example, the `start_method` generates a random boolean value and sets it in the state. +The `second_method` uses the `@router()` decorator to define conditional routing logic based on the value of the boolean. +If the boolean is `True`, the method returns `"success"`, and if it is `False`, the method returns `"failed"`. +The `third_method` and `fourth_method` listen to the output of the `second_method` and execute based on the returned value. + +When you run this Flow, the output will change based on the random boolean value generated by the `start_method`. + +## Adding Crews to Flows + +Creating a flow with multiple crews in CrewAI is straightforward. + +You can generate a new CrewAI project that includes all the scaffolding needed to create a flow with multiple crews by running the following command: + +```bash +crewai create flow name_of_flow +``` + +This command will generate a new CrewAI project with the necessary folder structure. The generated project includes a prebuilt crew called `poem_crew` that is already working. You can use this crew as a template by copying, pasting, and editing it to create other crews. + +### Folder Structure + +After running the `crewai create flow name_of_flow` command, you will see a folder structure similar to the following: + +| Directory/File | Description | +|:---------------------------------|:------------------------------------------------------------------| +| `name_of_flow/` | Root directory for the flow. | +| β”œβ”€β”€ `crews/` | Contains directories for specific crews. | +| β”‚ └── `poem_crew/` | Directory for the "poem_crew" with its configurations and scripts.| +| β”‚ β”œβ”€β”€ `config/` | Configuration files directory for the "poem_crew". | +| β”‚ β”‚ β”œβ”€β”€ `agents.yaml` | YAML file defining the agents for "poem_crew". | +| β”‚ β”‚ └── `tasks.yaml` | YAML file defining the tasks for "poem_crew". | +| β”‚ β”œβ”€β”€ `poem_crew.py` | Script for "poem_crew" functionality. | +| β”œβ”€β”€ `tools/` | Directory for additional tools used in the flow. | +| β”‚ └── `custom_tool.py` | Custom tool implementation. | +| β”œβ”€β”€ `main.py` | Main script for running the flow. | +| β”œβ”€β”€ `README.md` | Project description and instructions. | +| β”œβ”€β”€ `pyproject.toml` | Configuration file for project dependencies and settings. | +| └── `.gitignore` | Specifies files and directories to ignore in version control. | + + +### Building Your Crews + +In the `crews` folder, you can define multiple crews. Each crew will have its own folder containing configuration files and the crew definition file. For example, the `poem_crew` folder contains: + +- `config/agents.yaml`: Defines the agents for the crew. +- `config/tasks.yaml`: Defines the tasks for the crew. +- `poem_crew.py`: Contains the crew definition, including agents, tasks, and the crew itself. + +You can copy, paste, and edit the `poem_crew` to create other crews. + +### Connecting Crews in `main.py` + +The `main.py` file is where you create your flow and connect the crews together. You can define your flow by using the `Flow` class and the decorators `@start` and `@listen` to specify the flow of execution. + +Here's an example of how you can connect the `poem_crew` in the `main.py` file: + +```python Code +#!/usr/bin/env python +import asyncio +from random import randint + +from pydantic import BaseModel +from crewai.flow.flow import Flow, listen, start +from .crews.poem_crew.poem_crew import PoemCrew + +class PoemState(BaseModel): + sentence_count: int = 1 + poem: str = "" + +class PoemFlow(Flow[PoemState]): + + @start() + def generate_sentence_count(self): + print("Generating sentence count") + # Generate a number between 1 and 5 + self.state.sentence_count = randint(1, 5) + + @listen(generate_sentence_count) + def generate_poem(self): + print("Generating poem") + poem_crew = PoemCrew().crew() + result = poem_crew.kickoff(inputs={"sentence_count": self.state.sentence_count}) + + print("Poem generated", result.raw) + self.state.poem = result.raw + + @listen(generate_poem) + def save_poem(self): + print("Saving poem") + with open("poem.txt", "w") as f: + f.write(self.state.poem) + +async def run(): + """ + Run the flow. + """ + poem_flow = PoemFlow() + await poem_flow.kickoff() + +def main(): + asyncio.run(run()) + +if __name__ == "__main__": + main() +``` + +In this example, the `PoemFlow` class defines a flow that generates a sentence count, uses the `PoemCrew` to generate a poem, and then saves the poem to a file. The flow is kicked off by calling the `kickoff()` method. + +### Running the Flow + +Before running the flow, make sure to install the dependencies by running: + +```bash +poetry install +``` + +Once all of the dependencies are installed, you need to activate the virtual environment by running: + +```bash +poetry shell +``` + +After activating the virtual environment, you can run the flow by executing one of the following commands: + +```bash +crewai flow run +``` + +or + +```bash +poetry run run_flow +``` + +The flow will execute, and you should see the output in the console. + +## Plot Flows + +Visualizing your AI workflows can provide valuable insights into the structure and execution paths of your flows. CrewAI offers a powerful visualization tool that allows you to generate interactive plots of your flows, making it easier to understand and optimize your AI workflows. + +### What are Plots? + +Plots in CrewAI are graphical representations of your AI workflows. They display the various tasks, their connections, and the flow of data between them. This visualization helps in understanding the sequence of operations, identifying bottlenecks, and ensuring that the workflow logic aligns with your expectations. + +### How to Generate a Plot + +CrewAI provides two convenient methods to generate plots of your flows: + +#### Option 1: Using the `plot()` Method + +If you are working directly with a flow instance, you can generate a plot by calling the `plot()` method on your flow object. This method will create an HTML file containing the interactive plot of your flow. + +```python Code +# Assuming you have a flow instance +flow.plot("my_flow_plot") +``` + +This will generate a file named `my_flow_plot.html` in your current directory. You can open this file in a web browser to view the interactive plot. + +#### Option 2: Using the Command Line + +If you are working within a structured CrewAI project, you can generate a plot using the command line. This is particularly useful for larger projects where you want to visualize the entire flow setup. + +```bash +crewai flow plot +``` + +This command will generate an HTML file with the plot of your flow, similar to the `plot()` method. The file will be saved in your project directory, and you can open it in a web browser to explore the flow. + +### Understanding the Plot + +The generated plot will display nodes representing the tasks in your flow, with directed edges indicating the flow of execution. The plot is interactive, allowing you to zoom in and out, and hover over nodes to see additional details. + +By visualizing your flows, you can gain a clearer understanding of the workflow's structure, making it easier to debug, optimize, and communicate your AI processes to others. + +### Conclusion + +Plotting your flows is a powerful feature of CrewAI that enhances your ability to design and manage complex AI workflows. Whether you choose to use the `plot()` method or the command line, generating plots will provide you with a visual representation of your workflows, aiding in both development and presentation. + +## Next Steps + +If you're interested in exploring additional examples of flows, we have a variety of recommendations in our examples repository. Here are four specific flow examples, each showcasing unique use cases to help you match your current problem type to a specific example: + +1. **Email Auto Responder Flow**: This example demonstrates an infinite loop where a background job continually runs to automate email responses. It's a great use case for tasks that need to be performed repeatedly without manual intervention. [View Example](https://github.com/crewAIInc/crewAI-examples/tree/main/email_auto_responder_flow) + +2. **Lead Score Flow**: This flow showcases adding human-in-the-loop feedback and handling different conditional branches using the router. It's an excellent example of how to incorporate dynamic decision-making and human oversight into your workflows. [View Example](https://github.com/crewAIInc/crewAI-examples/tree/main/lead-score-flow) + +3. **Write a Book Flow**: This example excels at chaining multiple crews together, where the output of one crew is used by another. Specifically, one crew outlines an entire book, and another crew generates chapters based on the outline. Eventually, everything is connected to produce a complete book. This flow is perfect for complex, multi-step processes that require coordination between different tasks. [View Example](https://github.com/crewAIInc/crewAI-examples/tree/main/write_a_book_with_flows) + +4. **Meeting Assistant Flow**: This flow demonstrates how to broadcast one event to trigger multiple follow-up actions. For instance, after a meeting is completed, the flow can update a Trello board, send a Slack message, and save the results. It's a great example of handling multiple outcomes from a single event, making it ideal for comprehensive task management and notification systems. [View Example](https://github.com/crewAIInc/crewAI-examples/tree/main/meeting_assistant_flow) + +By exploring these examples, you can gain insights into how to leverage CrewAI Flows for various use cases, from automating repetitive tasks to managing complex, multi-step processes with dynamic decision-making and human feedback. \ No newline at end of file diff --git a/docs/core-concepts/Using-LangChain-Tools.md b/docs/concepts/langchain-tools.mdx similarity index 72% rename from docs/core-concepts/Using-LangChain-Tools.md rename to docs/concepts/langchain-tools.mdx index 3ebb93467..538581aee 100644 --- a/docs/core-concepts/Using-LangChain-Tools.md +++ b/docs/concepts/langchain-tools.mdx @@ -1,13 +1,16 @@ --- title: Using LangChain Tools description: Learn how to integrate LangChain tools with CrewAI agents to enhance search-based queries and more. +icon: link --- ## Using LangChain Tools -!!! info "LangChain Integration" - CrewAI seamlessly integrates with LangChain’s comprehensive [list of tools](https://python.langchain.com/docs/integrations/tools/), all of which can be used with crewAI. -```python + + CrewAI seamlessly integrates with LangChain’s comprehensive [list of tools](https://python.langchain.com/docs/integrations/tools/), all of which can be used with CrewAI. + + +```python Code import os from crewai import Agent from langchain.agents import Tool @@ -36,4 +39,7 @@ agent = Agent( ``` ## Conclusion -Tools are pivotal in extending the capabilities of CrewAI agents, enabling them to undertake a broad spectrum of tasks and collaborate effectively. When building solutions with CrewAI, leverage both custom and existing tools to empower your agents and enhance the AI ecosystem. Consider utilizing error handling, caching mechanisms, and the flexibility of tool arguments to optimize your agents' performance and capabilities. \ No newline at end of file + +Tools are pivotal in extending the capabilities of CrewAI agents, enabling them to undertake a broad spectrum of tasks and collaborate effectively. +When building solutions with CrewAI, leverage both custom and existing tools to empower your agents and enhance the AI ecosystem. Consider utilizing error handling, caching mechanisms, +and the flexibility of tool arguments to optimize your agents' performance and capabilities. \ No newline at end of file diff --git a/docs/core-concepts/Using-LlamaIndex-Tools.md b/docs/concepts/llamaindex-tools.mdx similarity index 66% rename from docs/core-concepts/Using-LlamaIndex-Tools.md rename to docs/concepts/llamaindex-tools.mdx index 96199d92f..3a5ec1412 100644 --- a/docs/core-concepts/Using-LlamaIndex-Tools.md +++ b/docs/concepts/llamaindex-tools.mdx @@ -1,14 +1,18 @@ --- title: Using LlamaIndex Tools description: Learn how to integrate LlamaIndex tools with CrewAI agents to enhance search-based queries and more. +icon: toolbox --- ## Using LlamaIndex Tools -!!! info "LlamaIndex Integration" - CrewAI seamlessly integrates with LlamaIndex’s comprehensive toolkit for RAG (Retrieval-Augmented Generation) and agentic pipelines, enabling advanced search-based queries and more. Here are the available built-in tools offered by LlamaIndex. + + CrewAI seamlessly integrates with LlamaIndex’s comprehensive toolkit for RAG (Retrieval-Augmented Generation) and agentic pipelines, enabling advanced search-based queries and more. + -```python +Here are the available built-in tools offered by LlamaIndex. + +```python Code from crewai import Agent from crewai_tools import LlamaIndexTool @@ -16,7 +20,11 @@ from crewai_tools import LlamaIndexTool from llama_index.core.tools import FunctionTool your_python_function = lambda ...: ... -og_tool = FunctionTool.from_defaults(your_python_function, name="", description='') +og_tool = FunctionTool.from_defaults( + your_python_function, + name="", + description='' +) tool = LlamaIndexTool.from_tool(og_tool) # Example 2: Initialize from LlamaHub Tools @@ -48,10 +56,16 @@ agent = Agent( To effectively use the LlamaIndexTool, follow these steps: -1. **Package Installation**: Confirm that the `crewai[tools]` package is installed in your Python environment. - - ```shell - pip install 'crewai[tools]' - ``` - -2. **Install and Use LlamaIndex**: Follow the LlamaIndex documentation [LlamaIndex Documentation](https://docs.llamaindex.ai/) to set up a RAG/agent pipeline. \ No newline at end of file + + + Make sure that `crewai[tools]` package is installed in your Python environment: + + ```shell Terminal + pip install 'crewai[tools]' + ``` + + + + Follow the LlamaIndex documentation [LlamaIndex Documentation](https://docs.llamaindex.ai/) to set up a RAG/agent pipeline. + + \ No newline at end of file diff --git a/docs/concepts/llms.mdx b/docs/concepts/llms.mdx new file mode 100644 index 000000000..728c88c36 --- /dev/null +++ b/docs/concepts/llms.mdx @@ -0,0 +1,158 @@ +--- +title: LLMs +description: Learn how to configure and optimize LLMs for your CrewAI projects. +icon: microchip-ai +--- + +# Large Language Models (LLMs) in CrewAI + +Large Language Models (LLMs) are the backbone of intelligent agents in the CrewAI framework. This guide will help you understand, configure, and optimize LLM usage for your CrewAI projects. + +## Key Concepts + +- **LLM**: Large Language Model, the AI powering agent intelligence +- **Agent**: A CrewAI entity that uses an LLM to perform tasks +- **Provider**: A service that offers LLM capabilities (e.g., OpenAI, Anthropic, Ollama, [more providers](https://docs.litellm.ai/docs/providers)) + +## Configuring LLMs for Agents + +CrewAI offers flexible options for setting up LLMs: + +### 1. Default Configuration + +By default, CrewAI uses the `gpt-4o-mini` model. It uses environment variables if no LLM is specified: +- `OPENAI_MODEL_NAME` (defaults to "gpt-4o-mini" if not set) +- `OPENAI_API_BASE` +- `OPENAI_API_KEY` + +### 2. String Identifier + +```python Code +agent = Agent(llm="gpt-4o", ...) +``` + +### 3. LLM Instance + +List of [more providers](https://docs.litellm.ai/docs/providers). + +```python Code +from crewai import LLM + +llm = LLM(model="gpt-4", temperature=0.7) +agent = Agent(llm=llm, ...) +``` + +### 4. Custom LLM Objects + +Pass a custom LLM implementation or object from another library. + +## Connecting to OpenAI-Compatible LLMs + +You can connect to OpenAI-compatible LLMs using either environment variables or by setting specific attributes on the LLM class: + +1. Using environment variables: + +```python Code +import os + +os.environ["OPENAI_API_KEY"] = "your-api-key" +os.environ["OPENAI_API_BASE"] = "https://api.your-provider.com/v1" +``` + +2. Using LLM class attributes: + +```python Code +llm = LLM( + model="custom-model-name", + api_key="your-api-key", + base_url="https://api.your-provider.com/v1" +) +agent = Agent(llm=llm, ...) +``` + +## LLM Configuration Options + +When configuring an LLM for your agent, you have access to a wide range of parameters: + +| Parameter | Type | Description | +|:------------------|:---------------:|:-------------------------------------------------------------------------------------------------| +| **model** | `str` | Name of the model to use (e.g., "gpt-4", "gpt-3.5-turbo", "ollama/llama3.1"). For more options, visit the providers documentation. | +| **timeout** | `float, int` | Maximum time (in seconds) to wait for a response. | +| **temperature** | `float` | Controls randomness in output (0.0 to 1.0). | +| **top_p** | `float` | Controls diversity of output (0.0 to 1.0). | +| **n** | `int` | Number of completions to generate. | +| **stop** | `str, List[str]` | Sequence(s) where generation should stop. | +| **max_tokens** | `int` | Maximum number of tokens to generate. | +| **presence_penalty** | `float` | Penalizes new tokens based on their presence in prior text. | +| **frequency_penalty**| `float` | Penalizes new tokens based on their frequency in prior text. | +| **logit_bias** | `Dict[int, float]`| Modifies likelihood of specified tokens appearing. | +| **response_format** | `Dict[str, Any]` | Specifies the format of the response (e.g., JSON object). | +| **seed** | `int` | Sets a random seed for deterministic results. | +| **logprobs** | `bool` | Returns log probabilities of output tokens if enabled. | +| **top_logprobs** | `int` | Number of most likely tokens for which to return log probabilities. | +| **base_url** | `str` | The base URL for the API endpoint. | +| **api_version** | `str` | Version of the API to use. | +| **api_key** | `str` | Your API key for authentication. | + + +Example: + +```python Code +llm = LLM( + model="gpt-4", + temperature=0.8, + max_tokens=150, + top_p=0.9, + frequency_penalty=0.1, + presence_penalty=0.1, + stop=["END"], + seed=42, + base_url="https://api.openai.com/v1", + api_key="your-api-key-here" +) +agent = Agent(llm=llm, ...) +``` +## Using Ollama (Local LLMs) + +crewAI supports using Ollama for running open-source models locally: + +1. Install Ollama: [ollama.ai](https://ollama.ai/) +2. Run a model: `ollama run llama2` +3. Configure agent: + +```python Code +agent = Agent( + llm=LLM(model="ollama/llama3.1", base_url="http://localhost:11434"), + ... +) +``` + +## Changing the Base API URL + +You can change the base API URL for any LLM provider by setting the `base_url` parameter: + +```python Code +llm = LLM( + model="custom-model-name", + base_url="https://api.your-provider.com/v1", + api_key="your-api-key" +) +agent = Agent(llm=llm, ...) +``` + +This is particularly useful when working with OpenAI-compatible APIs or when you need to specify a different endpoint for your chosen provider. + +## Best Practices + +1. **Choose the right model**: Balance capability and cost. +2. **Optimize prompts**: Clear, concise instructions improve output. +3. **Manage tokens**: Monitor and limit token usage for efficiency. +4. **Use appropriate temperature**: Lower for factual tasks, higher for creative ones. +5. **Implement error handling**: Gracefully manage API errors and rate limits. + +## Troubleshooting + +- **API Errors**: Check your API key, network connection, and rate limits. +- **Unexpected Outputs**: Refine your prompts and adjust temperature or top_p. +- **Performance Issues**: Consider using a more powerful model or optimizing your queries. +- **Timeout Errors**: Increase the `timeout` parameter or optimize your input. \ No newline at end of file diff --git a/docs/core-concepts/Memory.md b/docs/concepts/memory.mdx similarity index 55% rename from docs/core-concepts/Memory.md rename to docs/concepts/memory.mdx index 2b9d7160b..eb117f9c1 100644 --- a/docs/core-concepts/Memory.md +++ b/docs/concepts/memory.mdx @@ -1,21 +1,23 @@ --- -title: crewAI Memory Systems -description: Leveraging memory systems in the crewAI framework to enhance agent capabilities. +title: Memory +description: Leveraging memory systems in the CrewAI framework to enhance agent capabilities. +icon: database --- -## Introduction to Memory Systems in crewAI +## Introduction to Memory Systems in CrewAI -!!! note "Enhancing Agent Intelligence" - The crewAI framework introduces a sophisticated memory system designed to significantly enhance the capabilities of AI agents. This system comprises short-term memory, long-term memory, entity memory, and contextual memory, each serving a unique purpose in aiding agents to remember, reason, and learn from past interactions. +The crewAI framework introduces a sophisticated memory system designed to significantly enhance the capabilities of AI agents. +This system comprises `short-term memory`, `long-term memory`, `entity memory`, and `contextual memory`, each serving a unique purpose in aiding agents to remember, +reason, and learn from past interactions. ## Memory System Components -| Component | Description | -| :------------------- | :---------------------------------------------------------------------------------------------------------------------- | -| **Short-Term Memory**| Temporarily stores recent interactions and outcomes using `RAG`, enabling agents to recall and utilize information relevant to their current context during the current executions.| -| **Long-Term Memory** | Preserves valuable insights and learnings from past executions, allowing agents to build and refine their knowledge over time. | -| **Entity Memory** | Captures and organizes information about entities (people, places, concepts) encountered during tasks, facilitating deeper understanding and relationship mapping. Uses `RAG` for storing entity information. | -| **Contextual Memory**| Maintains the context of interactions by combining `ShortTermMemory`, `LongTermMemory`, and `EntityMemory`, aiding in the coherence and relevance of agent responses over a sequence of tasks or a conversation. | +| Component | Description | +| :-------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Short-Term Memory** | Temporarily stores recent interactions and outcomes using `RAG`, enabling agents to recall and utilize information relevant to their current context during the current executions. | +| **Long-Term Memory** | Preserves valuable insights and learnings from past executions, allowing agents to build and refine their knowledge over time. | +| **Entity Memory** | Captures and organizes information about entities (people, places, concepts) encountered during tasks, facilitating deeper understanding and relationship mapping. Uses `RAG` for storing entity information. | +| **Contextual Memory** | Maintains the context of interactions by combining `ShortTermMemory`, `LongTermMemory`, and `EntityMemory`, aiding in the coherence and relevance of agent responses over a sequence of tasks or a conversation. | ## How Memory Systems Empower Agents @@ -28,7 +30,9 @@ description: Leveraging memory systems in the crewAI framework to enhance agent ## Implementing Memory in Your Crew When configuring a crew, you can enable and customize each memory component to suit the crew's objectives and the nature of tasks it will perform. -By default, the memory system is disabled, and you can ensure it is active by setting `memory=True` in the crew configuration. The memory will use OpenAI embeddings by default, but you can change it by setting `embedder` to a different model. It's also possible to initialize the memory instance with your own instance. +By default, the memory system is disabled, and you can ensure it is active by setting `memory=True` in the crew configuration. +The memory will use OpenAI embeddings by default, but you can change it by setting `embedder` to a different model. +It's also possible to initialize the memory instance with your own instance. The 'embedder' only applies to **Short-Term Memory** which uses Chroma for RAG using the EmbedChain package. The **Long-Term Memory** uses SQLite3 to store task results. Currently, there is no way to override these storage implementations. @@ -37,7 +41,7 @@ and the name of the project can be overridden using the **CREWAI_STORAGE_DIR** e ### Example: Configuring Memory for a Crew -```python +```python Code from crewai import Crew, Agent, Task, Process # Assemble your crew with memory capabilities @@ -52,7 +56,7 @@ my_crew = Crew( ### Example: Use Custom Memory Instances e.g FAISS as the VectorDB -```python +```python Code from crewai import Crew, Agent, Task, Process # Assemble your crew with memory capabilities @@ -88,11 +92,11 @@ my_crew = Crew( ) ``` - ## Additional Embedding Providers ### Using OpenAI embeddings (already default) -```python + +```python Code from crewai import Crew, Agent, Task, Process my_crew = Crew( @@ -111,7 +115,8 @@ my_crew = Crew( ``` ### Using Google AI embeddings -```python + +```python Code from crewai import Crew, Agent, Task, Process my_crew = Crew( @@ -132,7 +137,8 @@ my_crew = Crew( ``` ### Using Azure OpenAI embeddings -```python + +```python Code from crewai import Crew, Agent, Task, Process my_crew = Crew( @@ -152,7 +158,8 @@ my_crew = Crew( ``` ### Using GPT4ALL embeddings -```python + +```python Code from crewai import Crew, Agent, Task, Process my_crew = Crew( @@ -168,7 +175,8 @@ my_crew = Crew( ``` ### Using Vertex AI embeddings -```python + +```python Code from crewai import Crew, Agent, Task, Process my_crew = Crew( @@ -187,7 +195,8 @@ my_crew = Crew( ``` ### Using Cohere embeddings -```python + +```python Code from crewai import Crew, Agent, Task, Process my_crew = Crew( @@ -207,59 +216,28 @@ my_crew = Crew( ``` ### Resetting Memory -```sh -crewai reset_memories [OPTIONS] + +```shell +crewai reset-memories [OPTIONS] ``` #### Resetting Memory Options -- **`-l, --long`** - - **Description:** Reset LONG TERM memory. - - **Type:** Flag (boolean) - - **Default:** False -- **`-s, --short`** - - **Description:** Reset SHORT TERM memory. - - **Type:** Flag (boolean) - - **Default:** False +| Option | Description | Type | Default | +| :------------------------ | :--------------------------------- | :------------- | :------ | +| `-l`, `--long` | Reset LONG TERM memory. | Flag (boolean) | False | +| `-s`, `--short` | Reset SHORT TERM memory. | Flag (boolean) | False | +| `-e`, `--entities` | Reset ENTITIES memory. | Flag (boolean) | False | +| `-k`, `--kickoff-outputs` | Reset LATEST KICKOFF TASK OUTPUTS. | Flag (boolean) | False | +| `-a`, `--all` | Reset ALL memories. | Flag (boolean) | False | -- **`-e, --entities`** - - **Description:** Reset ENTITIES memory. - - **Type:** Flag (boolean) - - **Default:** False +## Benefits of Using CrewAI's Memory System -- **`-k, --kickoff-outputs`** - - **Description:** Reset LATEST KICKOFF TASK OUTPUTS. - - **Type:** Flag (boolean) - - **Default:** False +- 🦾 **Adaptive Learning:** Crews become more efficient over time, adapting to new information and refining their approach to tasks. +- 🫑 **Enhanced Personalization:** Memory enables agents to remember user preferences and historical interactions, leading to personalized experiences. +- 🧠 **Improved Problem Solving:** Access to a rich memory store aids agents in making more informed decisions, drawing on past learnings and contextual insights. -- **`-a, --all`** - - **Description:** Reset ALL memories. - - **Type:** Flag (boolean) - - **Default:** False +## Conclusion -## Use Mem0 to store memories -[Mem0](https://www.mem0.ai/) enhances AI assistants and agents with an intelligent memory layer, enabling personalized AI interactions. Mem0 remembers user preferences, adapts to individual needs, and continuously improves over time, making it ideal for customer support chatbots, AI assistants, and autonomous systems. - -In order to use Mem0 as the memory provider for your crew, you will have to set `MEM0_API_KEY` as an environment variable. Refer to the [Mem0 documentation](https://docs.mem0.ai/platform/quickstart) for more information on how to obtain an API key. - -### Example: Using Mem0 as the Memory Provider -```python -from crewai import Crew, Agent, Task, Process - -my_crew = Crew( - agents=[...], - tasks=[...], - process=Process.sequential, - memory=True, - verbose=True, - memory_provider="mem0" -) -``` - -## Benefits of Using crewAI's Memory System -- **Adaptive Learning:** Crews become more efficient over time, adapting to new information and refining their approach to tasks. -- **Enhanced Personalization:** Memory enables agents to remember user preferences and historical interactions, leading to personalized experiences. -- **Improved Problem Solving:** Access to a rich memory store aids agents in making more informed decisions, drawing on past learnings and contextual insights. - -## Getting Started -Integrating crewAI's memory system into your projects is straightforward. By leveraging the provided memory components and configurations, you can quickly empower your agents with the ability to remember, reason, and learn from their interactions, unlocking new levels of intelligence and capability. \ No newline at end of file +Integrating CrewAI's memory system into your projects is straightforward. By leveraging the provided memory components and configurations, +you can quickly empower your agents with the ability to remember, reason, and learn from their interactions, unlocking new levels of intelligence and capability. diff --git a/docs/core-concepts/Pipeline.md b/docs/concepts/pipeline.mdx similarity index 90% rename from docs/core-concepts/Pipeline.md rename to docs/concepts/pipeline.mdx index 26000f809..67dae8cc0 100644 --- a/docs/core-concepts/Pipeline.md +++ b/docs/concepts/pipeline.mdx @@ -1,11 +1,12 @@ --- -title: crewAI Pipelines +title: Pipelines description: Understanding and utilizing pipelines in the crewAI framework for efficient multi-stage task processing. +icon: timeline-arrow --- ## What is a Pipeline? -A pipeline in crewAI represents a structured workflow that allows for the sequential or parallel execution of multiple crews. It provides a way to organize complex processes involving multiple stages, where the output of one stage can serve as input for subsequent stages. +A pipeline in CrewAI represents a structured workflow that allows for the sequential or parallel execution of multiple crews. It provides a way to organize complex processes involving multiple stages, where the output of one stage can serve as input for subsequent stages. ## Key Terminology @@ -18,7 +19,7 @@ Understanding the following terms is crucial for working effectively with pipeli Example pipeline structure: -``` +```bash Pipeline crew1 >> [crew2, crew3] >> crew4 ``` @@ -38,7 +39,8 @@ Each input creates its own kickoff, flowing through all stages of the pipeline. ## Creating a Pipeline -When creating a pipeline, you define a series of stages, each consisting of either a single crew or a list of crews for parallel execution. The pipeline ensures that each stage is executed in order, with the output of one stage feeding into the next. +When creating a pipeline, you define a series of stages, each consisting of either a single crew or a list of crews for parallel execution. +The pipeline ensures that each stage is executed in order, with the output of one stage feeding into the next. ### Example: Assembling a Pipeline @@ -79,8 +81,8 @@ my_pipeline = Pipeline( ## Pipeline Output -!!! note "Understanding Pipeline Outputs" -The output of a pipeline in the crewAI framework is encapsulated within the `PipelineKickoffResult` class. This class provides a structured way to access the results of the pipeline's execution, including various formats such as raw strings, JSON, and Pydantic models. +The output of a pipeline in the CrewAI framework is encapsulated within the `PipelineKickoffResult` class. +This class provides a structured way to access the results of the pipeline's execution, including various formats such as raw strings, JSON, and Pydantic models. ### Pipeline Output Attributes @@ -117,13 +119,17 @@ The output of a pipeline in the crewAI framework is encapsulated within the `Pip ### Accessing Pipeline Outputs -Once a pipeline has been executed, its output can be accessed through the `PipelineOutput` object returned by the `process_runs` method. The `PipelineOutput` class provides access to individual `PipelineRunResult` objects, each representing a single run through the pipeline. +Once a pipeline has been executed, its output can be accessed through the `PipelineOutput` object returned by the `process_runs` method. +The `PipelineOutput` class provides access to individual `PipelineRunResult` objects, each representing a single run through the pipeline. #### Example ```python # Define input data for the pipeline -input_data = [{"initial_query": "Latest advancements in AI"}, {"initial_query": "Future of robotics"}] +input_data = [ + {"initial_query": "Latest advancements in AI"}, + {"initial_query": "Future of robotics"} +] # Execute the pipeline pipeline_output = await my_pipeline.process_runs(input_data) @@ -191,11 +197,13 @@ my_pipeline = Pipeline( ### Routers in Pipelines -Routers are a powerful feature in crewAI pipelines that allow for dynamic decision-making and branching within your workflow. They enable you to direct the flow of execution based on specific conditions or criteria, making your pipelines more flexible and adaptive. +Routers are a powerful feature in crewAI pipelines that allow for dynamic decision-making and branching within your workflow. +They enable you to direct the flow of execution based on specific conditions or criteria, making your pipelines more flexible and adaptive. #### What is a Router? -A router in crewAI is a special component that can be included as a stage in your pipeline. It evaluates the input data and determines which path the execution should take next. This allows for conditional branching in your pipeline, where different crews or sub-pipelines can be executed based on the router's decision. +A router in crewAI is a special component that can be included as a stage in your pipeline. It evaluates the input data and determines which path the execution should take next. +This allows for conditional branching in your pipeline, where different crews or sub-pipelines can be executed based on the router's decision. #### Key Components of a Router @@ -251,7 +259,8 @@ inputs = [{"email": "..."}, {"email": "..."}] # List of email data main_pipeline.kickoff(inputs=inputs) ``` -In this example, the router decides between an urgent pipeline and a normal pipeline based on the urgency score of the email. If the urgency score is greater than 7, it routes to the urgent pipeline; otherwise, it uses the normal pipeline. If the input doesn't include an urgency score, it defaults to just the classification crew. +In this example, the router decides between an urgent pipeline and a normal pipeline based on the urgency score of the email. If the urgency score is greater than 7, +it routes to the urgent pipeline; otherwise, it uses the normal pipeline. If the input doesn't include an urgency score, it defaults to just the classification crew. #### Benefits of Using Routers @@ -265,4 +274,4 @@ In this example, the router decides between an urgent pipeline and a normal pipe The `Pipeline` class includes validation mechanisms to ensure the robustness of the pipeline structure: - Validates that stages contain only Crew instances or lists of Crew instances. -- Prevents double nesting of stages to maintain a clear structure. +- Prevents double nesting of stages to maintain a clear structure. \ No newline at end of file diff --git a/docs/core-concepts/Planning.md b/docs/concepts/planning.mdx similarity index 88% rename from docs/core-concepts/Planning.md rename to docs/concepts/planning.mdx index dcb53ac15..37055c7dc 100644 --- a/docs/core-concepts/Planning.md +++ b/docs/concepts/planning.mdx @@ -1,15 +1,20 @@ --- -title: crewAI Planning -description: Learn how to add planning to your crewAI Crew and improve their performance. +title: Planning +description: Learn how to add planning to your CrewAI Crew and improve their performance. +icon: brain --- ## Introduction -The planning feature in CrewAI allows you to add planning capability to your crew. When enabled, before each Crew iteration, all Crew information is sent to an AgentPlanner that will plan the tasks step by step, and this plan will be added to each task description. + +The planning feature in CrewAI allows you to add planning capability to your crew. When enabled, before each Crew iteration, +all Crew information is sent to an AgentPlanner that will plan the tasks step by step, and this plan will be added to each task description. ### Using the Planning Feature + Getting started with the planning feature is very easy, the only step required is to add `planning=True` to your Crew: -```python + +```python Code from crewai import Crew, Agent, Task, Process # Assemble your crew with planning capabilities @@ -20,6 +25,7 @@ my_crew = Crew( planning=True, ) ``` + From this point on, your crew will have planning enabled, and the tasks will be planned before each iteration. @@ -27,7 +33,11 @@ From this point on, your crew will have planning enabled, and the tasks will be Now you can define the LLM that will be used to plan the tasks. You can use any ChatOpenAI LLM model available. -```python +When running the base case example, you will see something like the output below, which represents the output of the `AgentPlanner` +responsible for creating the step-by-step logic to add to the Agents' tasks. + + +```python Code from crewai import Crew, Agent, Task, Process from langchain_openai import ChatOpenAI @@ -39,13 +49,12 @@ my_crew = Crew( planning=True, planning_llm=ChatOpenAI(model="gpt-4o") ) + +# Run the crew +my_crew.kickoff() ``` -### Example - -When running the base case example, you will see something like the following output, which represents the output of the AgentPlanner responsible for creating the step-by-step logic to add to the Agents' tasks. - -``` +```markdown Result [2024-07-15 16:49:11][INFO]: Planning the crew execution **Step-by-Step Plan for Task Execution** @@ -64,28 +73,35 @@ When running the base case example, you will see something like the following ou **Step-by-Step Plan:** 1. **Define Research Scope:** + - Determine the specific areas of AI LLMs to focus on, such as advancements in architecture, use cases, ethical considerations, and performance metrics. 2. **Identify Reliable Sources:** + - List reputable sources for AI research, including academic journals, industry reports, conferences (e.g., NeurIPS, ACL), AI research labs (e.g., OpenAI, Google AI), and online databases (e.g., IEEE Xplore, arXiv). 3. **Collect Data:** + - Search for the latest papers, articles, and reports published in 2023 and early 2024. - Use keywords like "Large Language Models 2024", "AI LLM advancements", "AI ethics 2024", etc. 4. **Analyze Findings:** + - Read and summarize the key points from each source. - Highlight new techniques, models, and applications introduced in the past year. 5. **Organize Information:** + - Categorize the information into relevant topics (e.g., new architectures, ethical implications, real-world applications). - Ensure each bullet point is concise but informative. 6. **Create the List:** + - Compile the 10 most relevant pieces of information into a bullet point list. - Review the list to ensure clarity and relevance. **Expected Output:** + A list with 10 bullet points of the most relevant information about AI LLMs. --- @@ -131,3 +147,5 @@ A list with 10 bullet points of the most relevant information about AI LLMs. **Expected Output:** A fully fledged report with the main topics, each with a full section of information. Formatted as markdown without '```'. +``` + \ No newline at end of file diff --git a/docs/core-concepts/Processes.md b/docs/concepts/processes.mdx similarity index 85% rename from docs/core-concepts/Processes.md rename to docs/concepts/processes.mdx index 6a7a1a64f..e109e6449 100644 --- a/docs/core-concepts/Processes.md +++ b/docs/concepts/processes.mdx @@ -1,11 +1,14 @@ --- -title: Managing Processes in CrewAI +title: Processes description: Detailed guide on workflow management through processes in CrewAI, with updated implementation details. +icon: bars-staggered --- ## Understanding Processes -!!! note "Core Concept" - In CrewAI, processes orchestrate the execution of tasks by agents, akin to project management in human teams. These processes ensure tasks are distributed and executed efficiently, in alignment with a predefined strategy. + + Processes orchestrate the execution of tasks by agents, akin to project management in human teams. + These processes ensure tasks are distributed and executed efficiently, in alignment with a predefined strategy. + ## Process Implementations @@ -45,15 +48,20 @@ crew = Crew( **Note:** Ensure `my_agents` and `my_tasks` are defined prior to creating a `Crew` object, and for the hierarchical process, either `manager_llm` or `manager_agent` is also required. ## Sequential Process + This method mirrors dynamic team workflows, progressing through tasks in a thoughtful and systematic manner. Task execution follows the predefined order in the task list, with the output of one task serving as context for the next. To customize task context, utilize the `context` parameter in the `Task` class to specify outputs that should be used as context for subsequent tasks. ## Hierarchical Process + Emulates a corporate hierarchy, CrewAI allows specifying a custom manager agent or automatically creates one, requiring the specification of a manager language model (`manager_llm`). This agent oversees task execution, including planning, delegation, and validation. Tasks are not pre-assigned; the manager allocates tasks to agents based on their capabilities, reviews outputs, and assesses task completion. ## Process Class: Detailed Overview + The `Process` class is implemented as an enumeration (`Enum`), ensuring type safety and restricting process values to the defined types (`sequential`, `hierarchical`). The consensual process is planned for future inclusion, emphasizing our commitment to continuous development and innovation. ## Conclusion -The structured collaboration facilitated by processes within CrewAI is crucial for enabling systematic teamwork among agents. This documentation has been updated to reflect the latest features, enhancements, and the planned integration of the Consensual Process, ensuring users have access to the most current and comprehensive information. \ No newline at end of file + +The structured collaboration facilitated by processes within CrewAI is crucial for enabling systematic teamwork among agents. +This documentation has been updated to reflect the latest features, enhancements, and the planned integration of the Consensual Process, ensuring users have access to the most current and comprehensive information. \ No newline at end of file diff --git a/docs/core-concepts/Tasks.md b/docs/concepts/tasks.mdx similarity index 89% rename from docs/core-concepts/Tasks.md rename to docs/concepts/tasks.mdx index 38d3a21a0..884c8fd27 100644 --- a/docs/core-concepts/Tasks.md +++ b/docs/concepts/tasks.mdx @@ -1,14 +1,17 @@ --- -title: crewAI Tasks -description: Detailed guide on managing and creating tasks within the crewAI framework, reflecting the latest codebase updates. +title: Tasks +description: Detailed guide on managing and creating tasks within the CrewAI framework, reflecting the latest codebase updates. +icon: list-check --- ## Overview of a Task -!!! note "What is a Task?" -In the crewAI framework, tasks are specific assignments completed by agents. They provide all necessary details for execution, such as a description, the agent responsible, required tools, and more, facilitating a wide range of action complexities. +In the CrewAI framework, a `Task` is a specific assignment completed by an `Agent`. -Tasks within crewAI can be collaborative, requiring multiple agents to work together. This is managed through the task properties and orchestrated by the Crew's process, enhancing teamwork and efficiency. +They provide all necessary details for execution, such as a description, the agent responsible, required tools, and more, facilitating a wide range of action complexities. + + +Tasks within CrewAI can be collaborative, requiring multiple agents to work together. This is managed through the task properties and orchestrated by the Crew's process, enhancing teamwork and efficiency. ## Task Attributes @@ -33,7 +36,7 @@ Tasks within crewAI can be collaborative, requiring multiple agents to work toge Creating a task involves defining its scope, responsible agent, and any additional attributes for flexibility: -```python +```python Code from crewai import Task task = Task( @@ -43,13 +46,14 @@ task = Task( ) ``` -!!! note "Task Assignment" -Directly specify an `agent` for assignment or let the `hierarchical` CrewAI's process decide based on roles, availability, etc. + + Directly specify an `agent` for assignment or let the `hierarchical` CrewAI's process decide based on roles, availability, etc. + ## Task Output -!!! note "Understanding Task Outputs" -The output of a task in the crewAI framework is encapsulated within the `TaskOutput` class. This class provides a structured way to access results of a task, including various formats such as raw output, JSON, and Pydantic models. +The output of a task in CrewAI framework is encapsulated within the `TaskOutput` class. This class provides a structured way to access results of a task, including various formats such as raw output, JSON, and Pydantic models. + By default, the `TaskOutput` will only include the `raw` output. A `TaskOutput` will only include the `pydantic` or `json_dict` output if the original `Task` object was configured with `output_pydantic` or `output_json`, respectively. ### Task Output Attributes @@ -78,7 +82,7 @@ Once a task has been executed, its output can be accessed through the `output` a #### Example -```python +```python Code # Example task task = Task( description='Find and summarize the latest AI news', @@ -110,11 +114,11 @@ if task_output.pydantic: ## Integrating Tools with Tasks -Leverage tools from the [crewAI Toolkit](https://github.com/joaomdmoura/crewai-tools) and [LangChain Tools](https://python.langchain.com/docs/integrations/tools) for enhanced task performance and agent interaction. +Leverage tools from the [CrewAI Toolkit](https://github.com/joaomdmoura/crewai-tools) and [LangChain Tools](https://python.langchain.com/docs/integrations/tools) for enhanced task performance and agent interaction. ## Creating a Task with Tools -```python +```python Code import os os.environ["OPENAI_API_KEY"] = "Your Key" os.environ["SERPER_API_KEY"] = "Your Key" # serper.dev API key @@ -155,11 +159,11 @@ This demonstrates how tasks with specific tools can override an agent's default ## Referring to Other Tasks -In crewAI, the output of one task is automatically relayed into the next one, but you can specifically define what tasks' output, including multiple, should be used as context for another task. +In CrewAI, the output of one task is automatically relayed into the next one, but you can specifically define what tasks' output, including multiple, should be used as context for another task. This is useful when you have a task that depends on the output of another task that is not performed immediately after it. This is done through the `context` attribute of the task: -```python +```python Code # ... research_ai_task = Task( @@ -194,7 +198,7 @@ You can define a task to be executed asynchronously. This means that the crew wi You can then use the `context` attribute to define in a future task that it should wait for the output of the asynchronous task to be completed. -```python +```python Code #... list_ideas = Task( @@ -225,7 +229,7 @@ write_article = Task( The callback function is executed after the task is completed, allowing for actions or notifications to be triggered based on the task's outcome. -```python +```python Code # ... def callback_function(output: TaskOutput): @@ -252,7 +256,7 @@ research_task = Task( Once a crew finishes running, you can access the output of a specific task by using the `output` attribute of the task object: -```python +```python Code # ... task1 = Task( description='Find and summarize the latest AI news', @@ -296,7 +300,7 @@ These validations help in maintaining the consistency and reliability of task ex You can now specify if a task should create directories when saving its output to a file. This is particularly useful for organizing outputs and ensuring that file paths are correctly structured. -```python +```python Code # ... save_output_task = Task( @@ -313,4 +317,7 @@ save_output_task = Task( ## Conclusion -Tasks are the driving force behind the actions of agents in crewAI. By properly defining tasks and their outcomes, you set the stage for your AI agents to work effectively, either independently or as a collaborative unit. Equipping tasks with appropriate tools, understanding the execution process, and following robust validation practices are crucial for maximizing CrewAI's potential, ensuring agents are effectively prepared for their assignments and that tasks are executed as intended. +Tasks are the driving force behind the actions of agents in CrewAI. +By properly defining tasks and their outcomes, you set the stage for your AI agents to work effectively, either independently or as a collaborative unit. +Equipping tasks with appropriate tools, understanding the execution process, and following robust validation practices are crucial for maximizing CrewAI's potential, +ensuring agents are effectively prepared for their assignments and that tasks are executed as intended. \ No newline at end of file diff --git a/docs/concepts/testing.mdx b/docs/concepts/testing.mdx new file mode 100644 index 000000000..ec6edda02 --- /dev/null +++ b/docs/concepts/testing.mdx @@ -0,0 +1,48 @@ +--- +title: Testing +description: Learn how to test your CrewAI Crew and evaluate their performance. +icon: vial +--- + +## Introduction + +Testing is a crucial part of the development process, and it is essential to ensure that your crew is performing as expected. With crewAI, you can easily test your crew and evaluate its performance using the built-in testing capabilities. + +### Using the Testing Feature + +We added the CLI command `crewai test` to make it easy to test your crew. This command will run your crew for a specified number of iterations and provide detailed performance metrics. The parameters are `n_iterations` and `model`, which are optional and default to 2 and `gpt-4o-mini` respectively. For now, the only provider available is OpenAI. + +```bash +crewai test +``` + +If you want to run more iterations or use a different model, you can specify the parameters like this: + +```bash +crewai test --n_iterations 5 --model gpt-4o +``` + +or using the short forms: + +```bash +crewai test -n 5 -m gpt-4o +``` + +When you run the `crewai test` command, the crew will be executed for the specified number of iterations, and the performance metrics will be displayed at the end of the run. + +A table of scores at the end will show the performance of the crew in terms of the following metrics: + +
**Tasks Scores (1-10 Higher is better)**
+ +| Tasks/Crew/Agents | Run 1 | Run 2 | Avg. Total | Agents | Additional Info | +|:------------------|:-----:|:-----:|:----------:|:------------------------------:|:---------------------------------| +| Task 1 | 9.0 | 9.5 | **9.2** | Professional Insights | | +| | | | | Researcher | | +| Task 2 | 9.0 | 10.0 | **9.5** | Company Profile Investigator | | +| Task 3 | 9.0 | 9.0 | **9.0** | Automation Insights | | +| | | | | Specialist | | +| Task 4 | 9.0 | 9.0 | **9.0** | Final Report Compiler | Automation Insights Specialist | +| Crew | 9.00 | 9.38 | **9.2** | | | +| Execution Time (s) | 126 | 145 | **135** | | | + +The example above shows the test results for two runs of the crew with two tasks, with the average total score for each task and the crew as a whole. diff --git a/docs/core-concepts/Tools.md b/docs/concepts/tools.mdx similarity index 85% rename from docs/core-concepts/Tools.md rename to docs/concepts/tools.mdx index 45aa77c6a..12ab96c6e 100644 --- a/docs/core-concepts/Tools.md +++ b/docs/concepts/tools.mdx @@ -1,14 +1,18 @@ --- -title: crewAI Tools -description: Understanding and leveraging tools within the crewAI framework for agent collaboration and task execution. +title: Tools +description: Understanding and leveraging tools within the CrewAI framework for agent collaboration and task execution. +icon: screwdriver-wrench --- ## Introduction -CrewAI tools empower agents with capabilities ranging from web searching and data analysis to collaboration and delegating tasks among coworkers. This documentation outlines how to create, integrate, and leverage these tools within the CrewAI framework, including a new focus on collaboration tools. +CrewAI tools empower agents with capabilities ranging from web searching and data analysis to collaboration and delegating tasks among coworkers. +This documentation outlines how to create, integrate, and leverage these tools within the CrewAI framework, including a new focus on collaboration tools. ## What is a Tool? -!!! note "Definition" - A tool in CrewAI is a skill or function that agents can utilize to perform various actions. This includes tools from the [crewAI Toolkit](https://github.com/joaomdmoura/crewai-tools) and [LangChain Tools](https://python.langchain.com/docs/integrations/tools), enabling everything from simple searches to complex interactions and effective teamwork among agents. + +A tool in CrewAI is a skill or function that agents can utilize to perform various actions. +This includes tools from the [CrewAI Toolkit](https://github.com/joaomdmoura/crewai-tools) and [LangChain Tools](https://python.langchain.com/docs/integrations/tools), +enabling everything from simple searches to complex interactions and effective teamwork among agents. ## Key Characteristics of Tools @@ -18,7 +22,7 @@ CrewAI tools empower agents with capabilities ranging from web searching and dat - **Error Handling**: Incorporates robust error handling mechanisms to ensure smooth operation. - **Caching Mechanism**: Features intelligent caching to optimize performance and reduce redundant operations. -## Using crewAI Tools +## Using CrewAI Tools To enhance your agents' capabilities with crewAI tools, begin by installing our extra tools package: @@ -28,7 +32,7 @@ pip install 'crewai[tools]' Here's an example demonstrating their use: -```python +```python Code import os from crewai import Agent, Task, Crew # Importing crewAI tools @@ -92,7 +96,7 @@ crew = Crew( crew.kickoff() ``` -## Available crewAI Tools +## Available CrewAI Tools - **Error Handling**: All tools are built with error handling capabilities, allowing agents to gracefully manage exceptions and continue their tasks. - **Caching Mechanism**: All tools support caching, enabling agents to efficiently reuse previously obtained results, reducing the load on external resources and speeding up the execution time. You can also define finer control over the caching mechanism using the `cache_function` attribute on the tool. @@ -134,20 +138,21 @@ Here is a list of the available tools and their descriptions: ## Creating your own Tools -!!! example "Custom Tool Creation" - Developers can craft custom tools tailored for their agent’s needs or utilize pre-built options: + + Developers can craft `custom tools` tailored for their agent’s needs or utilize pre-built options. + -To create your own crewAI tools you will need to install our extra tools package: +To create your own CrewAI tools you will need to install our extra tools package: ```bash pip install 'crewai[tools]' ``` -Once you do that there are two main ways for one to create a crewAI tool: +Once you do that there are two main ways for one to create a CrewAI tool: ### Subclassing `BaseTool` -```python +```python Code from crewai_tools import BaseTool class MyCustomTool(BaseTool): @@ -161,7 +166,7 @@ class MyCustomTool(BaseTool): ### Utilizing the `tool` Decorator -```python +```python Code from crewai_tools import tool @tool("Name of my tool") def my_tool(question: str) -> str: @@ -171,10 +176,12 @@ def my_tool(question: str) -> str: ``` ### Custom Caching Mechanism -!!! note "Caching" - Tools can optionally implement a `cache_function` to fine-tune caching behavior. This function determines when to cache results based on specific conditions, offering granular control over caching logic. -```python + + Tools can optionally implement a `cache_function` to fine-tune caching behavior. This function determines when to cache results based on specific conditions, offering granular control over caching logic. + + +```python Code from crewai_tools import tool @tool @@ -200,4 +207,7 @@ writer1 = Agent( ``` ## Conclusion -Tools are pivotal in extending the capabilities of CrewAI agents, enabling them to undertake a broad spectrum of tasks and collaborate effectively. When building solutions with CrewAI, leverage both custom and existing tools to empower your agents and enhance the AI ecosystem. Consider utilizing error handling, caching mechanisms, and the flexibility of tool arguments to optimize your agents' performance and capabilities. \ No newline at end of file + +Tools are pivotal in extending the capabilities of CrewAI agents, enabling them to undertake a broad spectrum of tasks and collaborate effectively. +When building solutions with CrewAI, leverage both custom and existing tools to empower your agents and enhance the AI ecosystem. Consider utilizing error handling, +caching mechanisms, and the flexibility of tool arguments to optimize your agents' performance and capabilities. \ No newline at end of file diff --git a/docs/core-concepts/Training-Crew.md b/docs/concepts/training.mdx similarity index 71% rename from docs/core-concepts/Training-Crew.md rename to docs/concepts/training.mdx index 351155bf7..549763fde 100644 --- a/docs/core-concepts/Training-Crew.md +++ b/docs/concepts/training.mdx @@ -1,14 +1,19 @@ --- -title: crewAI Train -description: Learn how to train your crewAI agents by giving them feedback early on and get consistent results. +title: Training +description: Learn how to train your CrewAI agents by giving them feedback early on and get consistent results. +icon: dumbbell --- ## Introduction -The training feature in CrewAI allows you to train your AI agents using the command-line interface (CLI). By running the command `crewai train -n `, you can specify the number of iterations for the training process. -During training, CrewAI utilizes techniques to optimize the performance of your agents along with human feedback. This helps the agents improve their understanding, decision-making, and problem-solving abilities. +The training feature in CrewAI allows you to train your AI agents using the command-line interface (CLI). +By running the command `crewai train -n `, you can specify the number of iterations for the training process. + +During training, CrewAI utilizes techniques to optimize the performance of your agents along with human feedback. +This helps the agents improve their understanding, decision-making, and problem-solving abilities. ### Training Your Crew Using the CLI + To use the training feature, follow these steps: 1. Open your terminal or command prompt. @@ -18,29 +23,36 @@ To use the training feature, follow these steps: ```shell crewai train -n (optional) ``` - -!!! note "Replace `` with the desired number of training iterations and `` with the appropriate filename ending with `.pkl`." + + Replace `` with the desired number of training iterations and `` with the appropriate filename ending with `.pkl`. + ### Training Your Crew Programmatically + To train your crew programmatically, use the following steps: 1. Define the number of iterations for training. 2. Specify the input parameters for the training process. 3. Execute the training command within a try-except block to handle potential errors. -```python +```python Code n_iterations = 2 inputs = {"topic": "CrewAI Training"} filename = "your_model.pkl" try: - YourCrewName_Crew().crew().train(n_iterations=n_iterations, inputs=inputs, filename=filename) + YourCrewName_Crew().crew().train( + n_iterations=n_iterations, + inputs=inputs, + filename=filename + ) except Exception as e: raise Exception(f"An error occurred while training the crew: {e}") ``` -### Key Points to Note: +### Key Points to Note + - **Positive Integer Requirement:** Ensure that the number of iterations (`n_iterations`) is a positive integer. The code will raise a `ValueError` if this condition is not met. - **Filename Requirement:** Ensure that the filename ends with `.pkl`. The code will raise a `ValueError` if this condition is not met. - **Error Handling:** The code handles subprocess errors and unexpected exceptions, providing error messages to the user. @@ -51,4 +63,5 @@ Once the training is complete, your agents will be equipped with enhanced capabi Remember to regularly update and retrain your agents to ensure they stay up-to-date with the latest information and advancements in the field. -Happy training with CrewAI! \ No newline at end of file +Happy training with CrewAI! πŸš€ + \ No newline at end of file diff --git a/docs/core-concepts/Collaboration.md b/docs/core-concepts/Collaboration.md deleted file mode 100644 index 0f28288bb..000000000 --- a/docs/core-concepts/Collaboration.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: How Agents Collaborate in CrewAI -description: Exploring the dynamics of agent collaboration within the CrewAI framework, focusing on the newly integrated features for enhanced functionality. ---- - -## Collaboration Fundamentals -!!! note "Core of Agent Interaction" - Collaboration in CrewAI is fundamental, enabling agents to combine their skills, share information, and assist each other in task execution, embodying a truly cooperative ecosystem. - -- **Information Sharing**: Ensures all agents are well-informed and can contribute effectively by sharing data and findings. -- **Task Assistance**: Allows agents to seek help from peers with the required expertise for specific tasks. -- **Resource Allocation**: Optimizes task execution through the efficient distribution and sharing of resources among agents. - -## Enhanced Attributes for Improved Collaboration -The `Crew` class has been enriched with several attributes to support advanced functionalities: - -- **Language Model Management (`manager_llm`, `function_calling_llm`)**: Manages language models for executing tasks and tools, facilitating sophisticated agent-tool interactions. Note that while `manager_llm` is mandatory for hierarchical processes to ensure proper execution flow, `function_calling_llm` is optional, with a default value provided for streamlined tool interaction. -- **Custom Manager Agent (`manager_agent`)**: Allows specifying a custom agent as the manager instead of using the default manager provided by CrewAI. -- **Process Flow (`process`)**: Defines the execution logic (e.g., sequential, hierarchical) to streamline task distribution and execution. -- **Verbose Logging (`verbose`)**: Offers detailed logging capabilities for monitoring and debugging purposes. It supports both integer and boolean types to indicate the verbosity level. For example, setting `verbose` to 1 might enable basic logging, whereas setting it to True enables more detailed logs. -- **Rate Limiting (`max_rpm`)**: Ensures efficient utilization of resources by limiting requests per minute. Guidelines for setting `max_rpm` should consider the complexity of tasks and the expected load on resources. -- **Internationalization / Customization Support (`language`, `prompt_file`)**: Facilitates full customization of the inner prompts, enhancing global usability. Supported languages and the process for utilizing the `prompt_file` attribute for customization should be clearly documented. [Example of file](https://github.com/joaomdmoura/crewAI/blob/main/src/crewai/translations/en.json) -- **Execution and Output Handling (`full_output`)**: Distinguishes between full and final outputs for nuanced control over task results. Examples showcasing the difference in outputs can aid in understanding the practical implications of this attribute. -- **Callback and Telemetry (`step_callback`, `task_callback`)**: Integrates callbacks for step-wise and task-level execution monitoring, alongside telemetry for performance analytics. The purpose and usage of `task_callback` alongside `step_callback` for granular monitoring should be clearly explained. -- **Crew Sharing (`share_crew`)**: Enables sharing of crew information with CrewAI for continuous improvement and training models. The privacy implications and benefits of this feature, including how it contributes to model improvement, should be outlined. -- **Usage Metrics (`usage_metrics`)**: Stores all metrics for the language model (LLM) usage during all tasks' execution, providing insights into operational efficiency and areas for improvement. Detailed information on accessing and interpreting these metrics for performance analysis should be provided. -- **Memory Usage (`memory`)**: Indicates whether the crew should use memory to store memories of its execution, enhancing task execution and agent learning. -- **Memory Provider (`memory_provider`)**: Specifies the memory provider to be used by the crew for storing memories. -- **Embedder Configuration (`embedder`)**: Specifies the configuration for the embedder to be used by the crew for understanding and generating language. This attribute supports customization of the language model provider. -- **Cache Management (`cache`)**: Determines whether the crew should use a cache to store the results of tool executions, optimizing performance. -- **Output Logging (`output_log_file`)**: Specifies the file path for logging the output of the crew's execution. -- **Planning Mode (`planning`)**: Allows crews to plan their actions before executing tasks by setting `planning=True` when creating the `Crew` instance. This feature enhances coordination and efficiency. -- **Replay Feature**: Introduces a new CLI for listing tasks from the last run and replaying from a specific task, enhancing task management and troubleshooting. - -## Delegation: Dividing to Conquer -Delegation enhances functionality by allowing agents to intelligently assign tasks or seek help, thereby amplifying the crew's overall capability. - -## Implementing Collaboration and Delegation -Setting up a crew involves defining the roles and capabilities of each agent. CrewAI seamlessly manages their interactions, ensuring efficient collaboration and delegation, with enhanced customization and monitoring features to adapt to various operational needs. - -## Example Scenario -Consider a crew with a researcher agent tasked with data gathering and a writer agent responsible for compiling reports. The integration of advanced language model management and process flow attributes allows for more sophisticated interactions, such as the writer delegating complex research tasks to the researcher or querying specific information, thereby facilitating a seamless workflow. - -## Conclusion -The integration of advanced attributes and functionalities into the CrewAI framework significantly enriches the agent collaboration ecosystem. These enhancements not only simplify interactions but also offer unprecedented flexibility and control, paving the way for sophisticated AI-driven solutions capable of tackling complex tasks through intelligent collaboration and delegation. \ No newline at end of file diff --git a/docs/core-concepts/LLMs.md b/docs/core-concepts/LLMs.md deleted file mode 100644 index 7ae3e6948..000000000 --- a/docs/core-concepts/LLMs.md +++ /dev/null @@ -1,155 +0,0 @@ -# Large Language Models (LLMs) in crewAI - -## Introduction -Large Language Models (LLMs) are the backbone of intelligent agents in the crewAI framework. This guide will help you understand, configure, and optimize LLM usage for your crewAI projects. - -## Table of Contents -- [Key Concepts](#key-concepts) -- [Configuring LLMs for Agents](#configuring-llms-for-agents) - - [1. Default Configuration](#1-default-configuration) - - [2. String Identifier](#2-string-identifier) - - [3. LLM Instance](#3-llm-instance) - - [4. Custom LLM Objects](#4-custom-llm-objects) -- [Connecting to OpenAI-Compatible LLMs](#connecting-to-openai-compatible-llms) -- [LLM Configuration Options](#llm-configuration-options) -- [Using Ollama (Local LLMs)](#using-ollama-local-llms) -- [Changing the Base API URL](#changing-the-base-api-url) -- [Best Practices](#best-practices) -- [Troubleshooting](#troubleshooting) - -## Key Concepts -- **LLM**: Large Language Model, the AI powering agent intelligence -- **Agent**: A crewAI entity that uses an LLM to perform tasks -- **Provider**: A service that offers LLM capabilities (e.g., OpenAI, Anthropic, Ollama, [more providers](https://docs.litellm.ai/docs/providers)) - -## Configuring LLMs for Agents - -crewAI offers flexible options for setting up LLMs: - -### 1. Default Configuration -By default, crewAI uses the `gpt-4o-mini` model. It uses environment variables if no LLM is specified: -- `OPENAI_MODEL_NAME` (defaults to "gpt-4o-mini" if not set) -- `OPENAI_API_BASE` -- `OPENAI_API_KEY` - -### 2. String Identifier -```python -agent = Agent(llm="gpt-4o", ...) -``` - -### 3. LLM Instance -List of [more providers](https://docs.litellm.ai/docs/providers). -```python -from crewai import LLM - -llm = LLM(model="gpt-4", temperature=0.7) -agent = Agent(llm=llm, ...) -``` - -### 4. Custom LLM Objects -Pass a custom LLM implementation or object from another library. - -## Connecting to OpenAI-Compatible LLMs - -You can connect to OpenAI-compatible LLMs using either environment variables or by setting specific attributes on the LLM class: - -1. Using environment variables: -```python -import os - -os.environ["OPENAI_API_KEY"] = "your-api-key" -os.environ["OPENAI_API_BASE"] = "https://api.your-provider.com/v1" -``` - -2. Using LLM class attributes: -```python -llm = LLM( - model="custom-model-name", - api_key="your-api-key", - base_url="https://api.your-provider.com/v1" -) -agent = Agent(llm=llm, ...) -``` - -## LLM Configuration Options - -When configuring an LLM for your agent, you have access to a wide range of parameters: - -| Parameter | Type | Description | -|-----------|------|-------------| -| `model` | str | The name of the model to use (e.g., "gpt-4", "gpt-3.5-turbo", "ollama/llama3.1", [more providers](https://docs.litellm.ai/docs/providers)) | -| `timeout` | float, int | Maximum time (in seconds) to wait for a response | -| `temperature` | float | Controls randomness in output (0.0 to 1.0) | -| `top_p` | float | Controls diversity of output (0.0 to 1.0) | -| `n` | int | Number of completions to generate | -| `stop` | str, List[str] | Sequence(s) to stop generation | -| `max_tokens` | int | Maximum number of tokens to generate | -| `presence_penalty` | float | Penalizes new tokens based on their presence in the text so far | -| `frequency_penalty` | float | Penalizes new tokens based on their frequency in the text so far | -| `logit_bias` | Dict[int, float] | Modifies likelihood of specified tokens appearing in the completion | -| `response_format` | Dict[str, Any] | Specifies the format of the response (e.g., {"type": "json_object"}) | -| `seed` | int | Sets a random seed for deterministic results | -| `logprobs` | bool | Whether to return log probabilities of the output tokens | -| `top_logprobs` | int | Number of most likely tokens to return the log probabilities for | -| `base_url` | str | The base URL for the API endpoint | -| `api_version` | str | The version of the API to use | -| `api_key` | str | Your API key for authentication | - -Example: -```python -llm = LLM( - model="gpt-4", - temperature=0.8, - max_tokens=150, - top_p=0.9, - frequency_penalty=0.1, - presence_penalty=0.1, - stop=["END"], - seed=42, - base_url="https://api.openai.com/v1", - api_key="your-api-key-here" -) -agent = Agent(llm=llm, ...) -``` - -## Using Ollama (Local LLMs) - -crewAI supports using Ollama for running open-source models locally: - -1. Install Ollama: [ollama.ai](https://ollama.ai/) -2. Run a model: `ollama run llama2` -3. Configure agent: -```python -agent = Agent( - llm=LLM(model="ollama/llama3.1", base_url="http://localhost:11434"), - ... -) -``` - -## Changing the Base API URL - -You can change the base API URL for any LLM provider by setting the `base_url` parameter: - -```python -llm = LLM( - model="custom-model-name", - base_url="https://api.your-provider.com/v1", - api_key="your-api-key" -) -agent = Agent(llm=llm, ...) -``` - -This is particularly useful when working with OpenAI-compatible APIs or when you need to specify a different endpoint for your chosen provider. - -## Best Practices -1. **Choose the right model**: Balance capability and cost. -2. **Optimize prompts**: Clear, concise instructions improve output. -3. **Manage tokens**: Monitor and limit token usage for efficiency. -4. **Use appropriate temperature**: Lower for factual tasks, higher for creative ones. -5. **Implement error handling**: Gracefully manage API errors and rate limits. - -## Troubleshooting -- **API Errors**: Check your API key, network connection, and rate limits. -- **Unexpected Outputs**: Refine your prompts and adjust temperature or top_p. -- **Performance Issues**: Consider using a more powerful model or optimizing your queries. -- **Timeout Errors**: Increase the `timeout` parameter or optimize your input. \ No newline at end of file diff --git a/docs/core-concepts/Testing.md b/docs/core-concepts/Testing.md deleted file mode 100644 index b00d5f07d..000000000 --- a/docs/core-concepts/Testing.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: crewAI Testing -description: Learn how to test your crewAI Crew and evaluate their performance. ---- - -## Introduction - -Testing is a crucial part of the development process, and it is essential to ensure that your crew is performing as expected. With crewAI, you can easily test your crew and evaluate its performance using the built-in testing capabilities. - -### Using the Testing Feature - -We added the CLI command `crewai test` to make it easy to test your crew. This command will run your crew for a specified number of iterations and provide detailed performance metrics. The parameters are `n_iterations` and `model`, which are optional and default to 2 and `gpt-4o-mini` respectively. For now, the only provider available is OpenAI. - -```bash -crewai test -``` - -If you want to run more iterations or use a different model, you can specify the parameters like this: - -```bash -crewai test --n_iterations 5 --model gpt-4o -``` - -or using the short forms: - -```bash -crewai test -n 5 -m gpt-4o -``` - -When you run the `crewai test` command, the crew will be executed for the specified number of iterations, and the performance metrics will be displayed at the end of the run. - -A table of scores at the end will show the performance of the crew in terms of the following metrics: - -``` - Tasks Scores - (1-10 Higher is better) -┏━━━━━━━━━━━━━━━━━━━━┯━━━━━━━┯━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Tasks/Crew/Agents β”‚ Run 1 β”‚ Run 2 β”‚ Avg. Total β”‚ Agents β”‚ ┃ -┠────────────────────┼───────┼───────┼────────────┼────────────────────────────────┼─────────────────────────────────┨ -┃ Task 1 β”‚ 9.0 β”‚ 9.5 β”‚ 9.2 β”‚ - Professional Insights β”‚ ┃ -┃ β”‚ β”‚ β”‚ β”‚ Researcher β”‚ ┃ -┃ β”‚ β”‚ β”‚ β”‚ β”‚ ┃ -┃ Task 2 β”‚ 9.0 β”‚ 10.0 β”‚ 9.5 β”‚ - Company Profile Investigator β”‚ ┃ -┃ β”‚ β”‚ β”‚ β”‚ β”‚ ┃ -┃ Task 3 β”‚ 9.0 β”‚ 9.0 β”‚ 9.0 β”‚ - Automation Insights β”‚ ┃ -┃ β”‚ β”‚ β”‚ β”‚ Specialist β”‚ ┃ -┃ β”‚ β”‚ β”‚ β”‚ β”‚ ┃ -┃ Task 4 β”‚ 9.0 β”‚ 9.0 β”‚ 9.0 β”‚ - Final Report Compiler β”‚ ┃ -┃ β”‚ β”‚ β”‚ β”‚ β”‚ - Automation Insights ┃ -┃ β”‚ β”‚ β”‚ β”‚ β”‚ Specialist ┃ -┃ Crew β”‚ 9.00 β”‚ 9.38 β”‚ 9.2 β”‚ β”‚ ┃ -┃ Execution Time (s) β”‚ 126 β”‚ 145 β”‚ 135 β”‚ β”‚ ┃ -┗━━━━━━━━━━━━━━━━━━━━┷━━━━━━━┷━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ -``` - -The example above shows the test results for two runs of the crew with two tasks, with the average total score for each task and the crew as a whole. diff --git a/docs/examples/example.mdx b/docs/examples/example.mdx new file mode 100644 index 000000000..f92da4a2c --- /dev/null +++ b/docs/examples/example.mdx @@ -0,0 +1,62 @@ +--- +title: CrewAI Examples +description: A collection of examples that show how to use CrewAI framework to automate workflows. +icon: rocket-launch +--- + + + + Automate marketing strategy creation with CrewAI. + + + Create a surprise trip itinerary with CrewAI. + + + Match a profile to jobpositions with CrewAI. + + + Create a job posting with CrewAI. + + + Create a game with CrewAI. + + + Find job candidates with CrewAI. + + diff --git a/docs/favicon.svg b/docs/favicon.svg new file mode 100644 index 000000000..495491f39 --- /dev/null +++ b/docs/favicon.svg @@ -0,0 +1,18 @@ + + + + + + + + diff --git a/docs/getting-started/Create-a-New-CrewAI-Pipeline-Template-Method.md b/docs/getting-started/Create-a-New-CrewAI-Pipeline-Template-Method.md deleted file mode 100644 index 558cbd61d..000000000 --- a/docs/getting-started/Create-a-New-CrewAI-Pipeline-Template-Method.md +++ /dev/null @@ -1,163 +0,0 @@ -# Creating a CrewAI Pipeline Project - -Welcome to the comprehensive guide for creating a new CrewAI pipeline project. This document will walk you through the steps to create, customize, and run your CrewAI pipeline project, ensuring you have everything you need to get started. - -To learn more about CrewAI pipelines, visit the [CrewAI documentation](https://docs.crewai.com/core-concepts/Pipeline/). - -## Prerequisites - -Before getting started with CrewAI pipelines, make sure that you have installed CrewAI via pip: - -```shell -$ pip install crewai crewai-tools -``` - -The same prerequisites for virtual environments and Code IDEs apply as in regular CrewAI projects. - -## Creating a New Pipeline Project - -To create a new CrewAI pipeline project, you have two options: - -1. For a basic pipeline template: - -```shell -$ crewai create pipeline -``` - -2. For a pipeline example that includes a router: - -```shell -$ crewai create pipeline --router -``` - -These commands will create a new project folder with the following structure: - -``` -/ -β”œβ”€β”€ README.md -β”œβ”€β”€ poetry.lock -β”œβ”€β”€ pyproject.toml -β”œβ”€β”€ src/ -β”‚ └── / -β”‚ β”œβ”€β”€ __init__.py -β”‚ β”œβ”€β”€ main.py -β”‚ β”œβ”€β”€ crews/ -β”‚ β”‚ β”œβ”€β”€ crew1/ -β”‚ β”‚ β”‚ β”œβ”€β”€ crew1.py -β”‚ β”‚ β”‚ └── config/ -β”‚ β”‚ β”‚ β”œβ”€β”€ agents.yaml -β”‚ β”‚ β”‚ └── tasks.yaml -β”‚ β”‚ β”œβ”€β”€ crew2/ -β”‚ β”‚ β”‚ β”œβ”€β”€ crew2.py -β”‚ β”‚ β”‚ └── config/ -β”‚ β”‚ β”‚ β”œβ”€β”€ agents.yaml -β”‚ β”‚ β”‚ └── tasks.yaml -β”‚ β”œβ”€β”€ pipelines/ -β”‚ β”‚ β”œβ”€β”€ __init__.py -β”‚ β”‚ β”œβ”€β”€ pipeline1.py -β”‚ β”‚ └── pipeline2.py -β”‚ └── tools/ -β”‚ β”œβ”€β”€ __init__.py -β”‚ └── custom_tool.py -└── tests/ -``` - -## Customizing Your Pipeline Project - -To customize your pipeline project, you can: - -1. Modify the crew files in `src//crews/` to define your agents and tasks for each crew. -2. Modify the pipeline files in `src//pipelines/` to define your pipeline structure. -3. Modify `src//main.py` to set up and run your pipelines. -4. Add your environment variables into the `.env` file. - -## Example 1: Defining a Two-Stage Sequential Pipeline - -Here's an example of how to define a pipeline with sequential stages in `src//pipelines/pipeline.py`: - -```python -from crewai import Pipeline -from crewai.project import PipelineBase -from ..crews.research_crew.research_crew import ResearchCrew -from ..crews.write_x_crew.write_x_crew import WriteXCrew - -@PipelineBase -class SequentialPipeline: - def __init__(self): - # Initialize crews - self.research_crew = ResearchCrew().crew() - self.write_x_crew = WriteXCrew().crew() - - def create_pipeline(self): - return Pipeline( - stages=[ - self.research_crew, - self.write_x_crew - ] - ) - - async def kickoff(self, inputs): - pipeline = self.create_pipeline() - results = await pipeline.kickoff(inputs) - return results -``` - -## Example 2: Defining a Two-Stage Pipeline with Parallel Execution - -```python -from crewai import Pipeline -from crewai.project import PipelineBase -from ..crews.research_crew.research_crew import ResearchCrew -from ..crews.write_x_crew.write_x_crew import WriteXCrew -from ..crews.write_linkedin_crew.write_linkedin_crew import WriteLinkedInCrew - -@PipelineBase -class ParallelExecutionPipeline: - def __init__(self): - # Initialize crews - self.research_crew = ResearchCrew().crew() - self.write_x_crew = WriteXCrew().crew() - self.write_linkedin_crew = WriteLinkedInCrew().crew() - - def create_pipeline(self): - return Pipeline( - stages=[ - self.research_crew, - [self.write_x_crew, self.write_linkedin_crew] # Parallel execution - ] - ) - - async def kickoff(self, inputs): - pipeline = self.create_pipeline() - results = await pipeline.kickoff(inputs) - return results -``` - -### Annotations - -The main annotation you'll use for pipelines is `@PipelineBase`. This annotation is used to decorate your pipeline classes, similar to how `@CrewBase` is used for crews. - -## Installing Dependencies - -To install the dependencies for your project, use Poetry: - -```shell -$ cd -$ crewai install -``` - -## Running Your Pipeline Project - -To run your pipeline project, use the following command: - -```shell -$ crewai run -``` - -This will initialize your pipeline and begin task execution as defined in your `main.py` file. - -## Deploying Your Pipeline Project - -Pipelines can be deployed in the same way as regular CrewAI projects. The easiest way is through [CrewAI+](https://www.crewai.com/crewaiplus), where you can deploy your pipeline in a few clicks. - -Remember, when working with pipelines, you're orchestrating multiple crews to work together in a sequence or parallel fashion. This allows for more complex workflows and information processing tasks. \ No newline at end of file diff --git a/docs/getting-started/Installing-CrewAI.md b/docs/getting-started/Installing-CrewAI.md deleted file mode 100644 index 8bf58ee01..000000000 --- a/docs/getting-started/Installing-CrewAI.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Installing crewAI -description: A comprehensive guide to installing crewAI and its dependencies, including the latest updates and installation methods. ---- - -# Installing crewAI - -Welcome to crewAI! This guide will walk you through the installation process for crewAI and its dependencies. crewAI is a flexible and powerful AI framework that enables you to create and manage AI agents, tools, and tasks efficiently. Let's get started! - -## Installation - -To install crewAI, you need to have Python >=3.10 and <=3.13 installed on your system: - -```shell -# Install the main crewAI package -pip install crewai - -# Install the main crewAI package and the tools package -# that includes a series of helpful tools for your agents -pip install 'crewai[tools]' - -# Alternatively, you can also use: -pip install crewai crewai-tools -``` \ No newline at end of file diff --git a/docs/getting-started/Start-a-New-CrewAI-Project-Template-Method.md b/docs/getting-started/Start-a-New-CrewAI-Project-Template-Method.md deleted file mode 100644 index dc0e539f2..000000000 --- a/docs/getting-started/Start-a-New-CrewAI-Project-Template-Method.md +++ /dev/null @@ -1,236 +0,0 @@ ---- - -title: Starting a New CrewAI Project - Using Template - -description: A comprehensive guide to starting a new CrewAI project, including the latest updates and project setup methods. ---- - -# Starting Your CrewAI Project - -Welcome to the ultimate guide for starting a new CrewAI project. This document will walk you through the steps to create, customize, and run your CrewAI project, ensuring you have everything you need to get started. - -Before we start, there are a couple of things to note: - -1. CrewAI is a Python package and requires Python >=3.10 and <=3.13 to run. -2. The preferred way of setting up CrewAI is using the `crewai create crew` command. This will create a new project folder and install a skeleton template for you to work on. - -## Prerequisites - -Before getting started with CrewAI, make sure that you have installed it via pip: - -```shell -$ pip install 'crewai[tools]' -``` - -## Creating a New Project - -In this example, we will be using poetry as our virtual environment manager. - -To create a new CrewAI project, run the following CLI command: - -```shell -$ crewai create crew -``` - -This command will create a new project folder with the following structure: - -```shell -my_project/ -β”œβ”€β”€ .gitignore -β”œβ”€β”€ pyproject.toml -β”œβ”€β”€ README.md -└── src/ - └── my_project/ - β”œβ”€β”€ __init__.py - β”œβ”€β”€ main.py - β”œβ”€β”€ crew.py - β”œβ”€β”€ tools/ - β”‚ β”œβ”€β”€ custom_tool.py - β”‚ └── __init__.py - └── config/ - β”œβ”€β”€ agents.yaml - └── tasks.yaml -``` - -You can now start developing your project by editing the files in the `src/my_project` folder. The `main.py` file is the entry point of your project, and the `crew.py` file is where you define your agents and tasks. - -## Customizing Your Project - -To customize your project, you can: -- Modify `src/my_project/config/agents.yaml` to define your agents. -- Modify `src/my_project/config/tasks.yaml` to define your tasks. -- Modify `src/my_project/crew.py` to add your own logic, tools, and specific arguments. -- Modify `src/my_project/main.py` to add custom inputs for your agents and tasks. -- Add your environment variables into the `.env` file. - -### Example: Defining Agents and Tasks - -#### agents.yaml - -```yaml -researcher: - role: > - Job Candidate Researcher - goal: > - Find potential candidates for the job - backstory: > - You are adept at finding the right candidates by exploring various online - resources. Your skill in identifying suitable candidates ensures the best - match for job positions. -``` - -#### tasks.yaml - -```yaml -research_candidates_task: - description: > - Conduct thorough research to find potential candidates for the specified job. - Utilize various online resources and databases to gather a comprehensive list of potential candidates. - Ensure that the candidates meet the job requirements provided. - - Job Requirements: - {job_requirements} - expected_output: > - A list of 10 potential candidates with their contact information and brief profiles highlighting their suitability. - agent: researcher # THIS NEEDS TO MATCH THE AGENT NAME IN THE AGENTS.YAML FILE AND THE AGENT DEFINED IN THE crew.py FILE - context: # THESE NEED TO MATCH THE TASK NAMES DEFINED ABOVE AND THE TASKS.YAML FILE AND THE TASK DEFINED IN THE crew.py FILE - - researcher -``` - -### Referencing Variables: - -Your defined functions with the same name will be used. For example, you can reference the agent for specific tasks from `tasks.yaml` file. Ensure your annotated agent and function name are the same; otherwise, your task won't recognize the reference properly. - -#### Example References - -`agents.yaml` - -```yaml -email_summarizer: - role: > - Email Summarizer - goal: > - Summarize emails into a concise and clear summary - backstory: > - You will create a 5 bullet point summary of the report - llm: mixtal_llm -``` - -`tasks.yaml` - -```yaml -email_summarizer_task: - description: > - Summarize the email into a 5 bullet point summary - expected_output: > - A 5 bullet point summary of the email - agent: email_summarizer - context: - - reporting_task - - research_task -``` - -Use the annotations to properly reference the agent and task in the `crew.py` file. - -### Annotations include: - -* `@agent` -* `@task` -* `@crew` -* `@tool` -* `@callback` -* `@output_json` -* `@output_pydantic` -* `@cache_handler` - -`crew.py` - -```python -# ... -@agent -def email_summarizer(self) -> Agent: - return Agent( - config=self.agents_config["email_summarizer"], - ) - -@task -def email_summarizer_task(self) -> Task: - return Task( - config=self.tasks_config["email_summarizer_task"], - ) -# ... -``` - -## Installing Dependencies - -To install the dependencies for your project, you can use Poetry. First, navigate to your project directory: - -```shell -$ cd my_project -$ crewai install -``` - -This will install the dependencies specified in the `pyproject.toml` file. - -## Interpolating Variables - -Any variable interpolated in your `agents.yaml` and `tasks.yaml` files like `{variable}` will be replaced by the value of the variable in the `main.py` file. - -#### tasks.yaml - -```yaml -research_task: - description: > - Conduct a thorough research about the customer and competitors in the context - of {customer_domain}. - Make sure you find any interesting and relevant information given the - current year is 2024. - expected_output: > - A complete report on the customer and their customers and competitors, - including their demographics, preferences, market positioning and audience engagement. -``` - -#### main.py - -```python -# main.py -def run(): - inputs = { - "customer_domain": "crewai.com" - } - MyProjectCrew(inputs).crew().kickoff(inputs=inputs) -``` - -## Running Your Project - -To run your project, use the following command: - -```shell -$ crewai run -``` - -This will initialize your crew of AI agents and begin task execution as defined in your configuration in the `main.py` file. - -### Replay Tasks from Latest Crew Kickoff - -CrewAI now includes a replay feature that allows you to list the tasks from the last run and replay from a specific one. To use this feature, run: - -```shell -$ crewai replay -``` - -Replace `` with the ID of the task you want to replay. - -### Reset Crew Memory - -If you need to reset the memory of your crew before running it again, you can do so by calling the reset memory feature: - -```shell -$ crewai reset-memory -``` - -This will clear the crew's memory, allowing for a fresh start. - -## Deploying Your Project - -The easiest way to deploy your crew is through [CrewAI+](https://www.crewai.com/crewaiplus), where you can deploy your crew in a few clicks. diff --git a/docs/how-to/AgentOps-Observability.md b/docs/how-to/AgentOps-Observability.md deleted file mode 100644 index 4f517d007..000000000 --- a/docs/how-to/AgentOps-Observability.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: Agent Monitoring with AgentOps -description: Understanding and logging your agent performance with AgentOps. ---- - -# Intro -Observability is a key aspect of developing and deploying conversational AI agents. It allows developers to understand how their agents are performing, how their agents are interacting with users, and how their agents use external tools and APIs. AgentOps is a product independent of CrewAI that provides a comprehensive observability solution for agents. - -## AgentOps - -[AgentOps](https://agentops.ai/?=crew) provides session replays, metrics, and monitoring for agents. - -At a high level, AgentOps gives you the ability to monitor cost, token usage, latency, agent failures, session-wide statistics, and more. For more info, check out the [AgentOps Repo](https://github.com/AgentOps-AI/agentops). - -### Overview -AgentOps provides monitoring for agents in development and production. It provides a dashboard for tracking agent performance, session replays, and custom reporting. - -Additionally, AgentOps provides session drilldowns for viewing Crew agent interactions, LLM calls, and tool usage in real-time. This feature is useful for debugging and understanding how agents interact with users as well as other agents. - -![Overview of a select series of agent session runs](..%2Fassets%2Fagentops-overview.png) -![Overview of session drilldowns for examining agent runs](..%2Fassets%2Fagentops-session.png) -![Viewing a step-by-step agent replay execution graph](..%2Fassets%2Fagentops-replay.png) - -### Features -- **LLM Cost Management and Tracking**: Track spend with foundation model providers. -- **Replay Analytics**: Watch step-by-step agent execution graphs. -- **Recursive Thought Detection**: Identify when agents fall into infinite loops. -- **Custom Reporting**: Create custom analytics on agent performance. -- **Analytics Dashboard**: Monitor high-level statistics about agents in development and production. -- **Public Model Testing**: Test your agents against benchmarks and leaderboards. -- **Custom Tests**: Run your agents against domain-specific tests. -- **Time Travel Debugging**: Restart your sessions from checkpoints. -- **Compliance and Security**: Create audit logs and detect potential threats such as profanity and PII leaks. -- **Prompt Injection Detection**: Identify potential code injection and secret leaks. - -### Using AgentOps - -1. **Create an API Key:** - Create a user API key here: [Create API Key](https://app.agentops.ai/account) - -2. **Configure Your Environment:** - Add your API key to your environment variables - - ```bash - AGENTOPS_API_KEY= - ``` - -3. **Install AgentOps:** - Install AgentOps with: - ```bash - pip install crewai[agentops] - ``` - or - ```bash - pip install agentops - ``` - - Before using `Crew` in your script, include these lines: - - ```python - import agentops - agentops.init() - ``` - - This will initiate an AgentOps session as well as automatically track Crew agents. For further info on how to outfit more complex agentic systems, check out the [AgentOps documentation](https://docs.agentops.ai) or join the [Discord](https://discord.gg/j4f3KbeH). - -### Crew + AgentOps Examples -- [Job Posting](https://github.com/joaomdmoura/crewAI-examples/tree/main/job-posting) -- [Markdown Validator](https://github.com/joaomdmoura/crewAI-examples/tree/main/markdown_validator) -- [Instagram Post](https://github.com/joaomdmoura/crewAI-examples/tree/main/instagram_post) - -### Further Information - -To get started, create an [AgentOps account](https://agentops.ai/?=crew). - -For feature requests or bug reports, please reach out to the AgentOps team on the [AgentOps Repo](https://github.com/AgentOps-AI/agentops). - -#### Extra links - -🐦 Twitter -  β€’   -πŸ“’ Discord -  β€’   -πŸ–‡οΈ AgentOps Dashboard -  β€’   -πŸ“™ Documentation diff --git a/docs/how-to/Customize-Prompts.md b/docs/how-to/Customize-Prompts.md deleted file mode 100644 index 85cb530b2..000000000 --- a/docs/how-to/Customize-Prompts.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: Initial Support to Bring Your Own Prompts in CrewAI -description: Enhancing customization and internationalization by allowing users to bring their own prompts in CrewAI. - ---- - -# Initial Support to Bring Your Own Prompts in CrewAI - -CrewAI now supports the ability to bring your own prompts, enabling extensive customization and internationalization. This feature allows users to tailor the inner workings of their agents to better suit specific needs, including support for multiple languages. - -## Internationalization and Customization Support - -### Custom Prompts with `prompt_file` - -The `prompt_file` attribute facilitates full customization of the agent prompts, enhancing the global usability of CrewAI. Users can specify their prompt templates, ensuring that the agents communicate in a manner that aligns with specific project requirements or language preferences. - -#### Example of a Custom Prompt File - -The custom prompts can be defined in a JSON file, similar to the example provided [here](https://github.com/joaomdmoura/crewAI/blob/main/src/crewai/translations/en.json). - -### Supported Languages - -CrewAI's custom prompt support includes internationalization, allowing prompts to be written in different languages. This is particularly useful for global teams or projects that require multilingual support. - -## How to Use the `prompt_file` Attribute - -To utilize the `prompt_file` attribute, include it in your crew definition. Below is an example demonstrating how to set up agents and tasks with custom prompts. - -### Example - -```python -import os -from crewai import Agent, Task, Crew - -# Define your agents -researcher = Agent( - role="Researcher", - goal="Make the best research and analysis on content about AI and AI agents", - backstory="You're an expert researcher, specialized in technology, software engineering, AI and startups. You work as a freelancer and is now working on doing research and analysis for a new customer.", - allow_delegation=False, -) - -writer = Agent( - role="Senior Writer", - goal="Write the best content about AI and AI agents.", - backstory="You're a senior writer, specialized in technology, software engineering, AI and startups. You work as a freelancer and are now working on writing content for a new customer.", - allow_delegation=False, -) - -# Define your tasks -tasks = [ - Task( - description="Say Hi", - expected_output="The word: Hi", - agent=researcher, - ) -] - -# Instantiate your crew with custom prompts -crew = Crew( - agents=[researcher], - tasks=tasks, - prompt_file="prompt.json", # Path to your custom prompt file -) - -# Get your crew to work! -crew.kickoff() -``` - -## Advanced Customization Features - -### `language` Attribute - -In addition to `prompt_file`, the `language` attribute can be used to specify the language for the agent's prompts. This ensures that the prompts are generated in the desired language, further enhancing the internationalization capabilities of CrewAI. - -### Creating Custom Prompt Files - -Custom prompt files should be structured in JSON format and include all necessary prompt templates. Below is a simplified example of a prompt JSON file: - -```json -{ - "system": "You are a system template.", - "prompt": "Here is your prompt template.", - "response": "Here is your response template." -} -``` - -### Benefits of Custom Prompts - -- **Enhanced Flexibility**: Tailor agent communication to specific project needs. -- **Improved Usability**: Supports multiple languages, making it suitable for global projects. -- **Consistency**: Ensures uniform prompt structures across different agents and tasks. - -By incorporating these updates, CrewAI provides users with the ability to fully customize and internationalize their agent prompts, making the platform more versatile and user-friendly. \ No newline at end of file diff --git a/docs/how-to/Customizing-Agents.md b/docs/how-to/Customizing-Agents.md deleted file mode 100644 index 8aa86b792..000000000 --- a/docs/how-to/Customizing-Agents.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: Customizing Agents in CrewAI -description: A comprehensive guide to tailoring agents for specific roles, tasks, and advanced customizations within the CrewAI framework. ---- - -## Customizable Attributes -Crafting an efficient CrewAI team hinges on the ability to dynamically tailor your AI agents to meet the unique requirements of any project. This section covers the foundational attributes you can customize. - -### Key Attributes for Customization -- **Role**: Specifies the agent's job within the crew, such as 'Analyst' or 'Customer Service Rep'. -- **Goal**: Defines what the agent aims to achieve, in alignment with its role and the overarching objectives of the crew. -- **Backstory**: Provides depth to the agent's persona, enriching its motivations and engagements within the crew. -- **Tools** *(Optional)*: Represents the capabilities or methods the agent uses to perform tasks, from simple functions to intricate integrations. -- **Cache** *(Optional)*: Determines whether the agent should use a cache for tool usage. -- **Max RPM**: Sets the maximum number of requests per minute (`max_rpm`). This attribute is optional and can be set to `None` for no limit, allowing for unlimited queries to external services if needed. -- **Verbose** *(Optional)*: Enables detailed logging of an agent's actions, useful for debugging and optimization. Specifically, it provides insights into agent execution processes, aiding in the optimization of performance. -- **Allow Delegation** *(Optional)*: `allow_delegation` controls whether the agent is allowed to delegate tasks to other agents. This attribute is now set to `False` by default. -- **Max Iter** *(Optional)*: The `max_iter` attribute allows users to define the maximum number of iterations an agent can perform for a single task, preventing infinite loops or excessively long executions. The default value is set to 25, providing a balance between thoroughness and efficiency. -- **Max Execution Time** *(Optional)*: `max_execution_time` Sets the maximum execution time for an agent to complete a task. -- **System Template** *(Optional)*: `system_template` defines the system format for the agent. -- **Prompt Template** *(Optional)*: `prompt_template` defines the prompt format for the agent. -- **Response Template** *(Optional)*: `response_template` defines the response format for the agent. -- **Use System Prompt** *(Optional)*: `use_system_prompt` controls whether the agent will use a system prompt for task execution. Agents can now operate without system prompts. -- **Respect Context Window**: `respect_context_window` renames the sliding context window attribute and enables it by default to maintain context size. -- **Max Retry Limit**: `max_retry_limit` defines the maximum number of retries for an agent to execute a task when an error occurs. - -## Advanced Customization Options -Beyond the basic attributes, CrewAI allows for deeper customization to enhance an agent's behavior and capabilities significantly. - -### Language Model Customization -Agents can be customized with specific language models (`llm`) and function-calling language models (`function_calling_llm`), offering advanced control over their processing and decision-making abilities. It's important to note that setting the `function_calling_llm` allows for overriding the default crew function-calling language model, providing a greater degree of customization. - -## Performance and Debugging Settings -Adjusting an agent's performance and monitoring its operations are crucial for efficient task execution. - -### Verbose Mode and RPM Limit -- **Verbose Mode**: Enables detailed logging of an agent's actions, useful for debugging and optimization. Specifically, it provides insights into agent execution processes, aiding in the optimization of performance. -- **RPM Limit**: Sets the maximum number of requests per minute (`max_rpm`). This attribute is optional and can be set to `None` for no limit, allowing for unlimited queries to external services if needed. - -### Maximum Iterations for Task Execution -The `max_iter` attribute allows users to define the maximum number of iterations an agent can perform for a single task, preventing infinite loops or excessively long executions. The default value is set to 25, providing a balance between thoroughness and efficiency. Once the agent approaches this number, it will try its best to give a good answer. - -## Customizing Agents and Tools -Agents are customized by defining their attributes and tools during initialization. Tools are critical for an agent's functionality, enabling them to perform specialized tasks. The `tools` attribute should be an array of tools the agent can utilize, and it's initialized as an empty list by default. Tools can be added or modified post-agent initialization to adapt to new requirements. - -```shell -pip install 'crewai[tools]' -``` - -### Example: Assigning Tools to an Agent -```python -import os -from crewai import Agent -from crewai_tools import SerperDevTool - -# Set API keys for tool initialization -os.environ["OPENAI_API_KEY"] = "Your Key" -os.environ["SERPER_API_KEY"] = "Your Key" - -# Initialize a search tool -search_tool = SerperDevTool() - -# Initialize the agent with advanced options -agent = Agent( - role='Research Analyst', - goal='Provide up-to-date market analysis', - backstory='An expert analyst with a keen eye for market trends.', - tools=[search_tool], - memory=True, # Enable memory - verbose=True, - max_rpm=None, # No limit on requests per minute - max_iter=25, # Default value for maximum iterations -) -``` - -## Delegation and Autonomy -Controlling an agent's ability to delegate tasks or ask questions is vital for tailoring its autonomy and collaborative dynamics within the CrewAI framework. By default, the `allow_delegation` attribute is now set to `False`, disabling agents to seek assistance or delegate tasks as needed. This default behavior can be changed to promote collaborative problem-solving and efficiency within the CrewAI ecosystem. If needed, delegation can be enabled to suit specific operational requirements. - -### Example: Disabling Delegation for an Agent -```python -agent = Agent( - role='Content Writer', - goal='Write engaging content on market trends', - backstory='A seasoned writer with expertise in market analysis.', - allow_delegation=True # Enabling delegation -) -``` - -## Conclusion -Customizing agents in CrewAI by setting their roles, goals, backstories, and tools, alongside advanced options like language model customization, memory, performance settings, and delegation preferences, equips a nuanced and capable AI team ready for complex challenges. \ No newline at end of file diff --git a/docs/how-to/Force-Tool-Ouput-as-Result.md b/docs/how-to/Force-Tool-Ouput-as-Result.md deleted file mode 100644 index d4e9a3f9d..000000000 --- a/docs/how-to/Force-Tool-Ouput-as-Result.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Forcing Tool Output as Result -description: Learn how to force tool output as the result in an Agent's task in CrewAI. ---- - -## Introduction -In CrewAI, you can force the output of a tool as the result of an agent's task. This feature is useful when you want to ensure that the tool output is captured and returned as the task result, avoiding any agent modification during the task execution. - -## Forcing Tool Output as Result -To force the tool output as the result of an agent's task, you need to set the `result_as_answer` parameter to `True` when adding a tool to the agent. This parameter ensures that the tool output is captured and returned as the task result, without any modifications by the agent. - -Here's an example of how to force the tool output as the result of an agent's task: - -```python -# ... -from crewai.agent import Agent -from my_tool import MyCustomTool - -# Create a coding agent with the custom tool -coding_agent = Agent( - role="Data Scientist", - goal="Produce amazing reports on AI", - backstory="You work with data and AI", - tools=[MyCustomTool(result_as_answer=True)], - ) - -# Assuming the tool's execution and result population occurs within the system -task_result = coding_agent.execute_task(task) -``` - -## Workflow in Action - -1. **Task Execution**: The agent executes the task using the tool provided. -2. **Tool Output**: The tool generates the output, which is captured as the task result. -3. **Agent Interaction**: The agent may reflect and take learnings from the tool but the output is not modified. -4. **Result Return**: The tool output is returned as the task result without any modifications. diff --git a/docs/how-to/LLM-Connections.md b/docs/how-to/LLM-Connections.md deleted file mode 100644 index 620ddddf9..000000000 --- a/docs/how-to/LLM-Connections.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: Connect CrewAI to LLMs -description: Comprehensive guide on integrating CrewAI with various Large Language Models (LLMs) using LiteLLM, including supported providers and configuration options. ---- - -## Connect CrewAI to LLMs - -CrewAI uses LiteLLM to connect to a wide variety of Language Models (LLMs). This integration provides extensive versatility, allowing you to use models from numerous providers with a simple, unified interface. - -!!! note "Default LLM" - By default, CrewAI uses the `gpt-4o-mini` model. This is determined by the `OPENAI_MODEL_NAME` environment variable, which defaults to "gpt-4o-mini" if not set. You can easily configure your agents to use a different model or provider as described in this guide. - -## Supported Providers - -LiteLLM supports a wide range of providers, including but not limited to: - -- OpenAI -- Anthropic -- Google (Vertex AI, Gemini) -- Azure OpenAI -- AWS (Bedrock, SageMaker) -- Cohere -- Hugging Face -- Ollama -- Mistral AI -- Replicate -- Together AI -- AI21 -- Cloudflare Workers AI -- DeepInfra -- Groq -- And many more! - -For a complete and up-to-date list of supported providers, please refer to the [LiteLLM Providers documentation](https://docs.litellm.ai/docs/providers). - -## Changing the LLM - -To use a different LLM with your CrewAI agents, you have several options: - -### 1. Using a String Identifier - -Pass the model name as a string when initializing the agent: - -```python -from crewai import Agent - -# Using OpenAI's GPT-4 -openai_agent = Agent( - role='OpenAI Expert', - goal='Provide insights using GPT-4', - backstory="An AI assistant powered by OpenAI's latest model.", - llm='gpt-4' -) - -# Using Anthropic's Claude -claude_agent = Agent( - role='Anthropic Expert', - goal='Analyze data using Claude', - backstory="An AI assistant leveraging Anthropic's language model.", - llm='claude-2' -) -``` - -### 2. Using the LLM Class - -For more detailed configuration, use the LLM class: - -```python -from crewai import Agent, LLM - -llm = LLM( - model="gpt-4", - temperature=0.7, - base_url="https://api.openai.com/v1", - api_key="your-api-key-here" -) - -agent = Agent( - role='Customized LLM Expert', - goal='Provide tailored responses', - backstory="An AI assistant with custom LLM settings.", - llm=llm -) -``` - -## Configuration Options - -When configuring an LLM for your agent, you have access to a wide range of parameters: - -| Parameter | Type | Description | -|-----------|------|-------------| -| `model` | str | The name of the model to use (e.g., "gpt-4", "claude-2") | -| `temperature` | float | Controls randomness in output (0.0 to 1.0) | -| `max_tokens` | int | Maximum number of tokens to generate | -| `top_p` | float | Controls diversity of output (0.0 to 1.0) | -| `frequency_penalty` | float | Penalizes new tokens based on their frequency in the text so far | -| `presence_penalty` | float | Penalizes new tokens based on their presence in the text so far | -| `stop` | str, List[str] | Sequence(s) to stop generation | -| `base_url` | str | The base URL for the API endpoint | -| `api_key` | str | Your API key for authentication | - -For a complete list of parameters and their descriptions, refer to the LLM class documentation. - -## Connecting to OpenAI-Compatible LLMs - -You can connect to OpenAI-compatible LLMs using either environment variables or by setting specific attributes on the LLM class: - -### Using Environment Variables - -```python -import os - -os.environ["OPENAI_API_KEY"] = "your-api-key" -os.environ["OPENAI_API_BASE"] = "https://api.your-provider.com/v1" -os.environ["OPENAI_MODEL_NAME"] = "your-model-name" -``` - -### Using LLM Class Attributes - -```python -llm = LLM( - model="custom-model-name", - api_key="your-api-key", - base_url="https://api.your-provider.com/v1" -) -agent = Agent(llm=llm, ...) -``` - -## Using Local Models with Ollama - -For local models like those provided by Ollama: - -1. [Download and install Ollama](https://ollama.com/download) -2. Pull the desired model (e.g., `ollama pull llama2`) -3. Configure your agent: - -```python -agent = Agent( - role='Local AI Expert', - goal='Process information using a local model', - backstory="An AI assistant running on local hardware.", - llm=LLM(model="ollama/llama2", base_url="http://localhost:11434") -) -``` - -## Changing the Base API URL - -You can change the base API URL for any LLM provider by setting the `base_url` parameter: - -```python -llm = LLM( - model="custom-model-name", - base_url="https://api.your-provider.com/v1", - api_key="your-api-key" -) -agent = Agent(llm=llm, ...) -``` - -This is particularly useful when working with OpenAI-compatible APIs or when you need to specify a different endpoint for your chosen provider. - -## Conclusion - -By leveraging LiteLLM, CrewAI offers seamless integration with a vast array of LLMs. This flexibility allows you to choose the most suitable model for your specific needs, whether you prioritize performance, cost-efficiency, or local deployment. Remember to consult the [LiteLLM documentation](https://docs.litellm.ai/docs/) for the most up-to-date information on supported models and configuration options. diff --git a/docs/how-to/Langtrace-Observability.md b/docs/how-to/Langtrace-Observability.md deleted file mode 100644 index 168f7e340..000000000 --- a/docs/how-to/Langtrace-Observability.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: CrewAI Agent Monitoring with Langtrace -description: How to monitor cost, latency, and performance of CrewAI Agents using Langtrace, an external observability tool. ---- - -# Langtrace Overview - -Langtrace is an open-source, external tool that helps you set up observability and evaluations for Large Language Models (LLMs), LLM frameworks, and Vector Databases. While not built directly into CrewAI, Langtrace can be used alongside CrewAI to gain deep visibility into the cost, latency, and performance of your CrewAI Agents. This integration allows you to log hyperparameters, monitor performance regressions, and establish a process for continuous improvement of your Agents. - -![Overview of a select series of agent session runs](..%2Fassets%2Flangtrace1.png) -![Overview of agent traces](..%2Fassets%2Flangtrace2.png) -![Overview of llm traces in details](..%2Fassets%2Flangtrace3.png) - -## Setup Instructions - -1. Sign up for [Langtrace](https://langtrace.ai/) by visiting [https://langtrace.ai/signup](https://langtrace.ai/signup). -2. Create a project, set the project type to crewAI & generate an API key. -3. Install Langtrace in your CrewAI project using the following commands: - -```bash -# Install the SDK -pip install langtrace-python-sdk -``` - -## Using Langtrace with CrewAI - -To integrate Langtrace with your CrewAI project, follow these steps: - -1. Import and initialize Langtrace at the beginning of your script, before any CrewAI imports: - -```python -from langtrace_python_sdk import langtrace -langtrace.init(api_key='') - -# Now import CrewAI modules -from crewai import Agent, Task, Crew -``` - -### Features and Their Application to CrewAI - -1. **LLM Token and Cost Tracking** - - - Monitor the token usage and associated costs for each CrewAI agent interaction. - -2. **Trace Graph for Execution Steps** - - - Visualize the execution flow of your CrewAI tasks, including latency and logs. - - Useful for identifying bottlenecks in your agent workflows. - -3. **Dataset Curation with Manual Annotation** - - - Create datasets from your CrewAI task outputs for future training or evaluation. - -4. **Prompt Versioning and Management** - - - Keep track of different versions of prompts used in your CrewAI agents. - - Useful for A/B testing and optimizing agent performance. - -5. **Prompt Playground with Model Comparisons** - - - Test and compare different prompts and models for your CrewAI agents before deployment. - -6. **Testing and Evaluations** - - Set up automated tests for your CrewAI agents and tasks. diff --git a/docs/how-to/Replay-tasks-from-latest-Crew-Kickoff.md b/docs/how-to/Replay-tasks-from-latest-Crew-Kickoff.md deleted file mode 100644 index 136f32047..000000000 --- a/docs/how-to/Replay-tasks-from-latest-Crew-Kickoff.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Replay Tasks from Latest Crew Kickoff -description: Replay tasks from the latest crew.kickoff(...) - ---- - -## Introduction -CrewAI provides the ability to replay from a task specified from the latest crew kickoff. This feature is particularly useful when you've finished a kickoff and may want to retry certain tasks or don't need to refetch data over and your agents already have the context saved from the kickoff execution so you just need to replay the tasks you want to. - -## Note: -You must run `crew.kickoff()` before you can replay a task. Currently, only the latest kickoff is supported, so if you use `kickoff_for_each`, it will only allow you to replay from the most recent crew run. - -Here's an example of how to replay from a task: - -### Replaying from Specific Task Using the CLI -To use the replay feature, follow these steps: - -1. Open your terminal or command prompt. -2. Navigate to the directory where your CrewAI project is located. -3. Run the following commands: - -To view the latest kickoff task_ids use: -```shell -crewai log-tasks-outputs -``` - -Once you have your `task_id` to replay, use: -```shell -crewai replay -t -``` - -**Note:** Ensure `crewai` is installed and configured correctly in your development environment. - -### Replaying from a Task Programmatically -To replay from a task programmatically, use the following steps: - -1. Specify the `task_id` and input parameters for the replay process. -2. Execute the replay command within a try-except block to handle potential errors. - -```python - def replay(): - """ - Replay the crew execution from a specific task. - """ - task_id = '' - inputs = {"topic": "CrewAI Training"} # This is optional; you can pass in the inputs you want to replay; otherwise, it uses the previous kickoff's inputs. - try: - YourCrewName_Crew().crew().replay(task_id=task_id, inputs=inputs) - - except subprocess.CalledProcessError as e: - raise Exception(f"An error occurred while replaying the crew: {e}") - - except Exception as e: - raise Exception(f"An unexpected error occurred: {e}") -``` - -## Conclusion -With the above enhancements and detailed functionality, replaying specific tasks in CrewAI has been made more efficient and robust. Ensure you follow the commands and steps precisely to make the most of these features. \ No newline at end of file diff --git a/docs/how-to/agentops-observability.mdx b/docs/how-to/agentops-observability.mdx new file mode 100644 index 000000000..605cfda14 --- /dev/null +++ b/docs/how-to/agentops-observability.mdx @@ -0,0 +1,126 @@ +--- +title: Agent Monitoring with AgentOps +description: Understanding and logging your agent performance with AgentOps. +icon: paperclip +--- + +# Introduction + +Observability is a key aspect of developing and deploying conversational AI agents. It allows developers to understand how their agents are performing, +how their agents are interacting with users, and how their agents use external tools and APIs. +AgentOps is a product independent of CrewAI that provides a comprehensive observability solution for agents. + +## AgentOps + +[AgentOps](https://agentops.ai/?=crew) provides session replays, metrics, and monitoring for agents. + +At a high level, AgentOps gives you the ability to monitor cost, token usage, latency, agent failures, session-wide statistics, and more. +For more info, check out the [AgentOps Repo](https://github.com/AgentOps-AI/agentops). + +### Overview + +AgentOps provides monitoring for agents in development and production. +It provides a dashboard for tracking agent performance, session replays, and custom reporting. + +Additionally, AgentOps provides session drilldowns for viewing Crew agent interactions, LLM calls, and tool usage in real-time. +This feature is useful for debugging and understanding how agents interact with users as well as other agents. + +![Overview of a select series of agent session runs](images/agentops-overview.png) +![Overview of session drilldowns for examining agent runs](images/agentops-session.png) +![Viewing a step-by-step agent replay execution graph](images/agentops-replay.png) + +### Features + +- **LLM Cost Management and Tracking**: Track spend with foundation model providers. +- **Replay Analytics**: Watch step-by-step agent execution graphs. +- **Recursive Thought Detection**: Identify when agents fall into infinite loops. +- **Custom Reporting**: Create custom analytics on agent performance. +- **Analytics Dashboard**: Monitor high-level statistics about agents in development and production. +- **Public Model Testing**: Test your agents against benchmarks and leaderboards. +- **Custom Tests**: Run your agents against domain-specific tests. +- **Time Travel Debugging**: Restart your sessions from checkpoints. +- **Compliance and Security**: Create audit logs and detect potential threats such as profanity and PII leaks. +- **Prompt Injection Detection**: Identify potential code injection and secret leaks. + +### Using AgentOps + + + + Create a user API key here: [Create API Key](https://app.agentops.ai/account) + + + Add your API key to your environment variables: + ```bash + AGENTOPS_API_KEY= + ``` + + + Install AgentOps with: + ```bash + pip install crewai[agentops] + ``` + or + ```bash + pip install agentops + ``` + + + Before using `Crew` in your script, include these lines: + + ```python + import agentops + agentops.init() + ``` + + This will initiate an AgentOps session as well as automatically track Crew agents. For further info on how to outfit more complex agentic systems, + check out the [AgentOps documentation](https://docs.agentops.ai) or join the [Discord](https://discord.gg/j4f3KbeH). + + + +### Crew + AgentOps Examples + + + + Example of a Crew agent that generates job posts. + + + Example of a Crew agent that validates Markdown files. + + + Example of a Crew agent that generates Instagram posts. + + + +### Further Information + +To get started, create an [AgentOps account](https://agentops.ai/?=crew). + +For feature requests or bug reports, please reach out to the AgentOps team on the [AgentOps Repo](https://github.com/AgentOps-AI/agentops). + +#### Extra links + +🐦 Twitter +  β€’   +πŸ“’ Discord +  β€’   +πŸ–‡οΈ AgentOps Dashboard +  β€’   +πŸ“™ Documentation \ No newline at end of file diff --git a/docs/how-to/Coding-Agents.md b/docs/how-to/coding-agents.mdx similarity index 62% rename from docs/how-to/Coding-Agents.md rename to docs/how-to/coding-agents.mdx index 5ef72a79e..b2d504a4b 100644 --- a/docs/how-to/Coding-Agents.md +++ b/docs/how-to/coding-agents.mdx @@ -1,17 +1,20 @@ --- title: Coding Agents -description: Learn how to enable your crewAI Agents to write and execute code, and explore advanced features for enhanced functionality. +description: Learn how to enable your CrewAI Agents to write and execute code, and explore advanced features for enhanced functionality. +icon: rectangle-code --- ## Introduction -crewAI Agents now have the powerful ability to write and execute code, significantly enhancing their problem-solving capabilities. This feature is particularly useful for tasks that require computational or programmatic solutions. +CrewAI Agents now have the powerful ability to write and execute code, significantly enhancing their problem-solving capabilities. This feature is particularly useful for tasks that require computational or programmatic solutions. ## Enabling Code Execution -To enable code execution for an agent, set the `allow_code_execution` parameter to `True` when creating the agent. Here's an example: +To enable code execution for an agent, set the `allow_code_execution` parameter to `True` when creating the agent. -```python +Here's an example: + +```python Code from crewai import Agent coding_agent = Agent( @@ -22,31 +25,45 @@ coding_agent = Agent( ) ``` -**Note**: The `allow_code_execution` parameter defaults to `False`. + +Note that `allow_code_execution` parameter defaults to `False`. + ## Important Considerations -1. **Model Selection**: It is strongly recommended to use more capable models like Claude 3.5 Sonnet and GPT-4 when enabling code execution. These models have a better understanding of programming concepts and are more likely to generate correct and efficient code. +1. **Model Selection**: It is strongly recommended to use more capable models like Claude 3.5 Sonnet and GPT-4 when enabling code execution. +These models have a better understanding of programming concepts and are more likely to generate correct and efficient code. -2. **Error Handling**: The code execution feature includes error handling. If executed code raises an exception, the agent will receive the error message and can attempt to correct the code or provide alternative solutions. The `max_retry_limit` parameter, which defaults to 2, controls the maximum number of retries for a task. +2. **Error Handling**: The code execution feature includes error handling. If executed code raises an exception, the agent will receive the error message and can attempt to correct the code or +provide alternative solutions. The `max_retry_limit` parameter, which defaults to 2, controls the maximum number of retries for a task. -3. **Dependencies**: To use the code execution feature, you need to install the `crewai_tools` package. If not installed, the agent will log an info message: "Coding tools not available. Install crewai_tools." +3. **Dependencies**: To use the code execution feature, you need to install the `crewai_tools` package. If not installed, the agent will log an info message: +"Coding tools not available. Install crewai_tools." ## Code Execution Process When an agent with code execution enabled encounters a task requiring programming: -1. The agent analyzes the task and determines that code execution is necessary. -2. It formulates the Python code needed to solve the problem. -3. The code is sent to the internal code execution tool (`CodeInterpreterTool`). -4. The tool executes the code in a controlled environment and returns the result. -5. The agent interprets the result and incorporates it into its response or uses it for further problem-solving. + + + The agent analyzes the task and determines that code execution is necessary. + + + It formulates the Python code needed to solve the problem. + + + The code is sent to the internal code execution tool (`CodeInterpreterTool`). + + + The agent interprets the result and incorporates it into its response or uses it for further problem-solving. + + ## Example Usage Here's a detailed example of creating an agent with code execution capabilities and using it in a task: -```python +```python Code from crewai import Agent, Task, Crew # Create an agent with code execution enabled @@ -75,4 +92,4 @@ result = analysis_crew.kickoff() print(result) ``` -In this example, the `coding_agent` can write and execute Python code to perform data analysis tasks. +In this example, the `coding_agent` can write and execute Python code to perform data analysis tasks. \ No newline at end of file diff --git a/docs/how-to/Conditional-Tasks.md b/docs/how-to/conditional-tasks.mdx similarity index 91% rename from docs/how-to/Conditional-Tasks.md rename to docs/how-to/conditional-tasks.mdx index 58c5dea6f..41b7475bf 100644 --- a/docs/how-to/Conditional-Tasks.md +++ b/docs/how-to/conditional-tasks.mdx @@ -1,15 +1,17 @@ --- title: Conditional Tasks description: Learn how to use conditional tasks in a crewAI kickoff +icon: diagram-subtask --- ## Introduction -Conditional Tasks in crewAI allow for dynamic workflow adaptation based on the outcomes of previous tasks. This powerful feature enables crews to make decisions and execute tasks selectively, enhancing the flexibility and efficiency of your AI-driven processes. +Conditional Tasks in crewAI allow for dynamic workflow adaptation based on the outcomes of previous tasks. +This powerful feature enables crews to make decisions and execute tasks selectively, enhancing the flexibility and efficiency of your AI-driven processes. ## Example Usage -```python +```python Code from typing import List from pydantic import BaseModel from crewai import Agent, Crew diff --git a/docs/how-to/Create-Custom-Tools.md b/docs/how-to/create-custom-tools.mdx similarity index 68% rename from docs/how-to/Create-Custom-Tools.md rename to docs/how-to/create-custom-tools.mdx index 7dc1e8f07..31fd09e3f 100644 --- a/docs/how-to/Create-Custom-Tools.md +++ b/docs/how-to/create-custom-tools.mdx @@ -1,10 +1,14 @@ --- -title: Creating and Utilizing Tools in crewAI -description: Comprehensive guide on crafting, using, and managing custom tools within the crewAI framework, including new functionalities and error handling. +title: Create Custom Tools +description: Comprehensive guide on crafting, using, and managing custom tools within the CrewAI framework, including new functionalities and error handling. +icon: hammer --- -## Creating and Utilizing Tools in crewAI -This guide provides detailed instructions on creating custom tools for the crewAI framework and how to efficiently manage and utilize these tools, incorporating the latest functionalities such as tool delegation, error handling, and dynamic tool calling. It also highlights the importance of collaboration tools, enabling agents to perform a wide range of actions. +## Creating and Utilizing Tools in CrewAI + +This guide provides detailed instructions on creating custom tools for the CrewAI framework and how to efficiently manage and utilize these tools, +incorporating the latest functionalities such as tool delegation, error handling, and dynamic tool calling. It also highlights the importance of collaboration tools, +enabling agents to perform a wide range of actions. ### Prerequisites @@ -18,7 +22,7 @@ pip install 'crewai[tools]' To create a personalized tool, inherit from `BaseTool` and define the necessary attributes and the `_run` method. -```python +```python Code from crewai_tools import BaseTool class MyCustomTool(BaseTool): @@ -32,9 +36,10 @@ class MyCustomTool(BaseTool): ### Using the `tool` Decorator -Alternatively, you can use the tool decorator `@tool`. This approach allows you to define the tool's attributes and functionality directly within a function, offering a concise and efficient way to create specialized tools tailored to your needs. +Alternatively, you can use the tool decorator `@tool`. This approach allows you to define the tool's attributes and functionality directly within a function, +offering a concise and efficient way to create specialized tools tailored to your needs. -```python +```python Code from crewai_tools import tool @tool("Tool Name") @@ -48,7 +53,7 @@ def my_simple_tool(question: str) -> str: To optimize tool performance with caching, define custom caching strategies using the `cache_function` attribute. -```python +```python Code @tool("Tool with Caching") def cached_tool(argument: str) -> str: """Tool functionality description.""" @@ -61,4 +66,5 @@ def my_cache_strategy(arguments: dict, result: str) -> bool: cached_tool.cache_function = my_cache_strategy ``` -By adhering to these guidelines and incorporating new functionalities and collaboration tools into your tool creation and management processes, you can leverage the full capabilities of the crewAI framework, enhancing both the development experience and the efficiency of your AI agents. \ No newline at end of file +By adhering to these guidelines and incorporating new functionalities and collaboration tools into your tool creation and management processes, +you can leverage the full capabilities of the CrewAI framework, enhancing both the development experience and the efficiency of your AI agents. diff --git a/docs/how-to/Your-Own-Manager-Agent.md b/docs/how-to/custom-manager-agent.mdx similarity index 90% rename from docs/how-to/Your-Own-Manager-Agent.md rename to docs/how-to/custom-manager-agent.mdx index f6dd15dc8..07f424fb1 100644 --- a/docs/how-to/Your-Own-Manager-Agent.md +++ b/docs/how-to/custom-manager-agent.mdx @@ -1,12 +1,13 @@ --- -title: Setting a Specific Agent as Manager in CrewAI +title: Create Your Own Manager Agent description: Learn how to set a custom agent as the manager in CrewAI, providing more control over task management and coordination. - +icon: user-shield --- # Setting a Specific Agent as Manager in CrewAI -CrewAI allows users to set a specific agent as the manager of the crew, providing more control over the management and coordination of tasks. This feature enables the customization of the managerial role to better fit your project's requirements. +CrewAI allows users to set a specific agent as the manager of the crew, providing more control over the management and coordination of tasks. +This feature enables the customization of the managerial role to better fit your project's requirements. ## Using the `manager_agent` Attribute @@ -16,7 +17,7 @@ The `manager_agent` attribute allows you to define a custom agent to manage the ### Example -```python +```python Code import os from crewai import Agent, Task, Crew, Process @@ -71,7 +72,7 @@ result = crew.kickoff() If you're using the hierarchical process and don't want to set a custom manager agent, you can specify the language model for the manager: -```python +```python Code from langchain_openai import ChatOpenAI manager_llm = ChatOpenAI(model_name="gpt-4") @@ -84,4 +85,6 @@ crew = Crew( ) ``` -Note: Either `manager_agent` or `manager_llm` must be set when using the hierarchical process. \ No newline at end of file + +Either `manager_agent` or `manager_llm` must be set when using the hierarchical process. + \ No newline at end of file diff --git a/docs/how-to/customizing-agents.mdx b/docs/how-to/customizing-agents.mdx new file mode 100644 index 000000000..527ebf8cd --- /dev/null +++ b/docs/how-to/customizing-agents.mdx @@ -0,0 +1,111 @@ +--- +title: Customize Agents +description: A comprehensive guide to tailoring agents for specific roles, tasks, and advanced customizations within the CrewAI framework. +icon: user-pen +--- + +## Customizable Attributes + +Crafting an efficient CrewAI team hinges on the ability to dynamically tailor your AI agents to meet the unique requirements of any project. This section covers the foundational attributes you can customize. + +### Key Attributes for Customization + +| Attribute | Description | +|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Role** | Specifies the agent's job within the crew, such as 'Analyst' or 'Customer Service Rep'. | +| **Goal** | Defines the agent’s objectives, aligned with its role and the crew’s overarching mission. | +| **Backstory** | Provides depth to the agent's persona, enhancing motivations and engagements within the crew. | +| **Tools** *(Optional)* | Represents the capabilities or methods the agent uses for tasks, from simple functions to complex integrations. | +| **Cache** *(Optional)* | Determines if the agent should use a cache for tool usage. | +| **Max RPM** | Sets the maximum requests per minute (`max_rpm`). Can be set to `None` for unlimited requests to external services. | +| **Verbose** *(Optional)* | Enables detailed logging for debugging and optimization, providing insights into execution processes. | +| **Allow Delegation** *(Optional)* | Controls task delegation to other agents, default is `False`. | +| **Max Iter** *(Optional)* | Limits the maximum number of iterations (`max_iter`) for a task to prevent infinite loops, with a default of 25. | +| **Max Execution Time** *(Optional)* | Sets the maximum time allowed for an agent to complete a task. | +| **System Template** *(Optional)* | Defines the system format for the agent. | +| **Prompt Template** *(Optional)* | Defines the prompt format for the agent. | +| **Response Template** *(Optional)* | Defines the response format for the agent. | +| **Use System Prompt** *(Optional)* | Controls whether the agent will use a system prompt during task execution. | +| **Respect Context Window** | Enables a sliding context window by default, maintaining context size. | +| **Max Retry Limit** | Sets the maximum number of retries (`max_retry_limit`) for an agent in case of errors. | + +## Advanced Customization Options + +Beyond the basic attributes, CrewAI allows for deeper customization to enhance an agent's behavior and capabilities significantly. + +### Language Model Customization + +Agents can be customized with specific language models (`llm`) and function-calling language models (`function_calling_llm`), offering advanced control over their processing and decision-making abilities. +It's important to note that setting the `function_calling_llm` allows for overriding the default crew function-calling language model, providing a greater degree of customization. + +## Performance and Debugging Settings + +Adjusting an agent's performance and monitoring its operations are crucial for efficient task execution. + +### Verbose Mode and RPM Limit + +- **Verbose Mode**: Enables detailed logging of an agent's actions, useful for debugging and optimization. Specifically, it provides insights into agent execution processes, aiding in the optimization of performance. +- **RPM Limit**: Sets the maximum number of requests per minute (`max_rpm`). This attribute is optional and can be set to `None` for no limit, allowing for unlimited queries to external services if needed. + +### Maximum Iterations for Task Execution + +The `max_iter` attribute allows users to define the maximum number of iterations an agent can perform for a single task, preventing infinite loops or excessively long executions. +The default value is set to 25, providing a balance between thoroughness and efficiency. Once the agent approaches this number, it will try its best to give a good answer. + +## Customizing Agents and Tools + +Agents are customized by defining their attributes and tools during initialization. Tools are critical for an agent's functionality, enabling them to perform specialized tasks. +The `tools` attribute should be an array of tools the agent can utilize, and it's initialized as an empty list by default. Tools can be added or modified post-agent initialization to adapt to new requirements. + +```shell +pip install 'crewai[tools]' +``` + +### Example: Assigning Tools to an Agent + +```python Code +import os +from crewai import Agent +from crewai_tools import SerperDevTool + +# Set API keys for tool initialization +os.environ["OPENAI_API_KEY"] = "Your Key" +os.environ["SERPER_API_KEY"] = "Your Key" + +# Initialize a search tool +search_tool = SerperDevTool() + +# Initialize the agent with advanced options +agent = Agent( + role='Research Analyst', + goal='Provide up-to-date market analysis', + backstory='An expert analyst with a keen eye for market trends.', + tools=[search_tool], + memory=True, # Enable memory + verbose=True, + max_rpm=None, # No limit on requests per minute + max_iter=25, # Default value for maximum iterations +) +``` + +## Delegation and Autonomy + +Controlling an agent's ability to delegate tasks or ask questions is vital for tailoring its autonomy and collaborative dynamics within the CrewAI framework. By default, +the `allow_delegation` attribute is now set to `False`, disabling agents to seek assistance or delegate tasks as needed. This default behavior can be changed to promote collaborative problem-solving and +efficiency within the CrewAI ecosystem. If needed, delegation can be enabled to suit specific operational requirements. + +### Example: Disabling Delegation for an Agent + +```python Code +agent = Agent( + role='Content Writer', + goal='Write engaging content on market trends', + backstory='A seasoned writer with expertise in market analysis.', + allow_delegation=True # Enabling delegation +) +``` + +## Conclusion + +Customizing agents in CrewAI by setting their roles, goals, backstories, and tools, alongside advanced options like language model customization, memory, performance settings, and delegation preferences, +equips a nuanced and capable AI team ready for complex challenges. \ No newline at end of file diff --git a/docs/how-to/force-tool-output-as-result.mdx b/docs/how-to/force-tool-output-as-result.mdx new file mode 100644 index 000000000..8e03a44c4 --- /dev/null +++ b/docs/how-to/force-tool-output-as-result.mdx @@ -0,0 +1,50 @@ +--- +title: Force Tool Output as Result +description: Learn how to force tool output as the result in an Agent's task in CrewAI. +icon: wrench-simple +--- + +## Introduction + +In CrewAI, you can force the output of a tool as the result of an agent's task. +This feature is useful when you want to ensure that the tool output is captured and returned as the task result, avoiding any agent modification during the task execution. + +## Forcing Tool Output as Result + +To force the tool output as the result of an agent's task, you need to set the `result_as_answer` parameter to `True` when adding a tool to the agent. +This parameter ensures that the tool output is captured and returned as the task result, without any modifications by the agent. + +Here's an example of how to force the tool output as the result of an agent's task: + +```python Code +from crewai.agent import Agent +from my_tool import MyCustomTool + +# Create a coding agent with the custom tool +coding_agent = Agent( + role="Data Scientist", + goal="Produce amazing reports on AI", + backstory="You work with data and AI", + tools=[MyCustomTool(result_as_answer=True)], + ) + +# Assuming the tool's execution and result population occurs within the system +task_result = coding_agent.execute_task(task) +``` + +## Workflow in Action + + + + The agent executes the task using the tool provided. + + + The tool generates the output, which is captured as the task result. + + + The agent may reflect and take learnings from the tool but the output is not modified. + + + The tool output is returned as the task result without any modifications. + + \ No newline at end of file diff --git a/docs/how-to/Hierarchical.md b/docs/how-to/hierarchical-process.mdx similarity index 80% rename from docs/how-to/Hierarchical.md rename to docs/how-to/hierarchical-process.mdx index 5b46aa459..95efa7c3f 100644 --- a/docs/how-to/Hierarchical.md +++ b/docs/how-to/hierarchical-process.mdx @@ -1,18 +1,26 @@ --- -title: Implementing the Hierarchical Process in CrewAI +title: Hierarchical Process description: A comprehensive guide to understanding and applying the hierarchical process within your CrewAI projects, updated to reflect the latest coding practices and functionalities. +icon: sitemap --- ## Introduction -The hierarchical process in CrewAI introduces a structured approach to task management, simulating traditional organizational hierarchies for efficient task delegation and execution. This systematic workflow enhances project outcomes by ensuring tasks are handled with optimal efficiency and accuracy. -!!! note "Complexity and Efficiency" +The hierarchical process in CrewAI introduces a structured approach to task management, simulating traditional organizational hierarchies for efficient task delegation and execution. +This systematic workflow enhances project outcomes by ensuring tasks are handled with optimal efficiency and accuracy. + + The hierarchical process is designed to leverage advanced models like GPT-4, optimizing token usage while handling complex tasks with greater efficiency. + ## Hierarchical Process Overview -By default, tasks in CrewAI are managed through a sequential process. However, adopting a hierarchical approach allows for a clear hierarchy in task management, where a 'manager' agent coordinates the workflow, delegates tasks, and validates outcomes for streamlined and effective execution. This manager agent can now be either automatically created by CrewAI or explicitly set by the user. + +By default, tasks in CrewAI are managed through a sequential process. However, adopting a hierarchical approach allows for a clear hierarchy in task management, +where a 'manager' agent coordinates the workflow, delegates tasks, and validates outcomes for streamlined and effective execution. This manager agent can now be either +automatically created by CrewAI or explicitly set by the user. ### Key Features + - **Task Delegation**: A manager agent allocates tasks among crew members based on their roles and capabilities. - **Result Validation**: The manager evaluates outcomes to ensure they meet the required standards. - **Efficient Workflow**: Emulates corporate structures, providing an organized approach to task management. @@ -25,15 +33,21 @@ By default, tasks in CrewAI are managed through a sequential process. However, a ## Implementing the Hierarchical Process -To utilize the hierarchical process, it's essential to explicitly set the process attribute to `Process.hierarchical`, as the default behavior is `Process.sequential`. Define a crew with a designated manager and establish a clear chain of command. -!!! note "Tools and Agent Assignment" - Assign tools at the agent level to facilitate task delegation and execution by the designated agents under the manager's guidance. Tools can also be specified at the task level for precise control over tool availability during task execution. +To utilize the hierarchical process, it's essential to explicitly set the process attribute to `Process.hierarchical`, as the default behavior is `Process.sequential`. +Define a crew with a designated manager and establish a clear chain of command. -!!! note "Manager LLM Requirement" - Configuring the `manager_llm` parameter is crucial for the hierarchical process. The system requires a manager LLM to be set up for proper function, ensuring tailored decision-making. + + Assign tools at the agent level to facilitate task delegation and execution by the designated agents under the manager's guidance. + Tools can also be specified at the task level for precise control over tool availability during task execution. + -```python + + Configuring the `manager_llm` parameter is crucial for the hierarchical process. + The system requires a manager LLM to be set up for proper function, ensuring tailored decision-making. + + +```python Code from langchain_openai import ChatOpenAI from crewai import Crew, Process, Agent @@ -75,9 +89,12 @@ project_crew = Crew( ``` ### Workflow in Action + 1. **Task Assignment**: The manager assigns tasks strategically, considering each agent's capabilities and available tools. 2. **Execution and Review**: Agents complete their tasks with the option for asynchronous execution and callback functions for streamlined workflows. 3. **Sequential Task Progression**: Despite being a hierarchical process, tasks follow a logical order for smooth progression, facilitated by the manager's oversight. ## Conclusion -Adopting the hierarchical process in CrewAI, with the correct configurations and understanding of the system's capabilities, facilitates an organized and efficient approach to project management. Utilize the advanced features and customizations to tailor the workflow to your specific needs, ensuring optimal task execution and project success. \ No newline at end of file + +Adopting the hierarchical process in CrewAI, with the correct configurations and understanding of the system's capabilities, facilitates an organized and efficient approach to project management. +Utilize the advanced features and customizations to tailor the workflow to your specific needs, ensuring optimal task execution and project success. \ No newline at end of file diff --git a/docs/how-to/Human-Input-on-Execution.md b/docs/how-to/human-input-on-execution.mdx similarity index 88% rename from docs/how-to/Human-Input-on-Execution.md rename to docs/how-to/human-input-on-execution.mdx index 543d48e68..de8c8a0a8 100644 --- a/docs/how-to/Human-Input-on-Execution.md +++ b/docs/how-to/human-input-on-execution.mdx @@ -1,15 +1,18 @@ --- title: Human Input on Execution description: Integrating CrewAI with human input during execution in complex decision-making processes and leveraging the full capabilities of the agent's attributes and tools. +icon: user-check --- -# Human Input in Agent Execution +## Human input in agent execution -Human input is critical in several agent execution scenarios, allowing agents to request additional information or clarification when necessary. This feature is especially useful in complex decision-making processes or when agents require more details to complete a task effectively. +Human input is critical in several agent execution scenarios, allowing agents to request additional information or clarification when necessary. +This feature is especially useful in complex decision-making processes or when agents require more details to complete a task effectively. -## Using Human Input with CrewAI +## Using human input with CrewAI -To integrate human input into agent execution, set the `human_input` flag in the task definition. When enabled, the agent prompts the user for input before delivering its final answer. This input can provide extra context, clarify ambiguities, or validate the agent's output. +To integrate human input into agent execution, set the `human_input` flag in the task definition. When enabled, the agent prompts the user for input before delivering its final answer. +This input can provide extra context, clarify ambiguities, or validate the agent's output. ### Example: @@ -17,7 +20,7 @@ To integrate human input into agent execution, set the `human_input` flag in the pip install crewai ``` -```python +```python Code import os from crewai import Agent, Task, Crew from crewai_tools import SerperDevTool diff --git a/docs/how-to/Kickoff-async.md b/docs/how-to/kickoff-async.mdx similarity index 94% rename from docs/how-to/Kickoff-async.md rename to docs/how-to/kickoff-async.mdx index 8d0e6800b..099c7ebc6 100644 --- a/docs/how-to/Kickoff-async.md +++ b/docs/how-to/kickoff-async.mdx @@ -1,11 +1,13 @@ --- -title: Kickoff Async +title: Kickoff Crew Asynchronously description: Kickoff a Crew Asynchronously +icon: rocket-launch --- ## Introduction -CrewAI provides the ability to kickoff a crew asynchronously, allowing you to start the crew execution in a non-blocking manner. This feature is particularly useful when you want to run multiple crews concurrently or when you need to perform other tasks while the crew is executing. +CrewAI provides the ability to kickoff a crew asynchronously, allowing you to start the crew execution in a non-blocking manner. +This feature is particularly useful when you want to run multiple crews concurrently or when you need to perform other tasks while the crew is executing. ## Asynchronous Crew Execution @@ -13,7 +15,7 @@ To kickoff a crew asynchronously, use the `kickoff_async()` method. This method ### Method Signature -```python +```python Code def kickoff_async(self, inputs: dict) -> CrewOutput: ``` @@ -37,7 +39,7 @@ def kickoff_async(self, inputs: dict) -> CrewOutput: Here's an example of how to kickoff a crew asynchronously using asyncio and awaiting the result: -```python +```python Code import asyncio from crewai import Crew, Agent, Task @@ -74,7 +76,7 @@ asyncio.run(async_crew_execution()) In this example, we'll show how to kickoff multiple crews asynchronously and wait for all of them to complete using `asyncio.gather()`: -```python +```python Code import asyncio from crewai import Crew, Agent, Task diff --git a/docs/how-to/Kickoff-for-each.md b/docs/how-to/kickoff-for-each.mdx similarity index 79% rename from docs/how-to/Kickoff-for-each.md rename to docs/how-to/kickoff-for-each.mdx index ea1d27441..4a83f7a5f 100644 --- a/docs/how-to/Kickoff-for-each.md +++ b/docs/how-to/kickoff-for-each.mdx @@ -1,17 +1,22 @@ --- -title: Kickoff For Each -description: Kickoff a Crew for a List +title: Kickoff Crew for Each +description: Kickoff Crew for Each Item in a List +icon: at --- ## Introduction -CrewAI provides the ability to kickoff a crew for each item in a list, allowing you to execute the crew for each item in the list. This feature is particularly useful when you need to perform the same set of tasks for multiple items. + +CrewAI provides the ability to kickoff a crew for each item in a list, allowing you to execute the crew for each item in the list. +This feature is particularly useful when you need to perform the same set of tasks for multiple items. ## Kicking Off a Crew for Each Item -To kickoff a crew for each item in a list, use the `kickoff_for_each()` method. This method executes the crew for each item in the list, allowing you to process multiple items efficiently. + +To kickoff a crew for each item in a list, use the `kickoff_for_each()` method. +This method executes the crew for each item in the list, allowing you to process multiple items efficiently. Here's an example of how to kickoff a crew for each item in a list: -```python +```python Code from crewai import Crew, Agent, Task # Create an agent with code execution enabled diff --git a/docs/how-to/langtrace-observability.mdx b/docs/how-to/langtrace-observability.mdx new file mode 100644 index 000000000..fddb2cd65 --- /dev/null +++ b/docs/how-to/langtrace-observability.mdx @@ -0,0 +1,72 @@ +--- +title: Agent Monitoring with Langtrace +description: How to monitor cost, latency, and performance of CrewAI Agents using Langtrace, an external observability tool. +icon: chart-line +--- + +# Langtrace Overview + +Langtrace is an open-source, external tool that helps you set up observability and evaluations for Large Language Models (LLMs), LLM frameworks, and Vector Databases. +While not built directly into CrewAI, Langtrace can be used alongside CrewAI to gain deep visibility into the cost, latency, and performance of your CrewAI Agents. +This integration allows you to log hyperparameters, monitor performance regressions, and establish a process for continuous improvement of your Agents. + +![Overview of a select series of agent session runs](images/langtrace1.png) +![Overview of agent traces](images/langtrace2.png) +![Overview of llm traces in details](images/langtrace3.png) + +## Setup Instructions + + + + Sign up by visiting [https://langtrace.ai/signup](https://langtrace.ai/signup). + + + Set the project type to `CrewAI` and generate an API key. + + + Use the following command: + + ```bash + pip install langtrace-python-sdk + ``` + + + Import and initialize Langtrace at the beginning of your script, before any CrewAI imports: + + ```python + from langtrace_python_sdk import langtrace + langtrace.init(api_key='') + + # Now import CrewAI modules + from crewai import Agent, Task, Crew + ``` + + + +### Features and Their Application to CrewAI + +1. **LLM Token and Cost Tracking** + + - Monitor the token usage and associated costs for each CrewAI agent interaction. + +2. **Trace Graph for Execution Steps** + + - Visualize the execution flow of your CrewAI tasks, including latency and logs. + - Useful for identifying bottlenecks in your agent workflows. + +3. **Dataset Curation with Manual Annotation** + + - Create datasets from your CrewAI task outputs for future training or evaluation. + +4. **Prompt Versioning and Management** + + - Keep track of different versions of prompts used in your CrewAI agents. + - Useful for A/B testing and optimizing agent performance. + +5. **Prompt Playground with Model Comparisons** + + - Test and compare different prompts and models for your CrewAI agents before deployment. + +6. **Testing and Evaluations** + + - Set up automated tests for your CrewAI agents and tasks. \ No newline at end of file diff --git a/docs/how-to/llm-connections.mdx b/docs/how-to/llm-connections.mdx new file mode 100644 index 000000000..542a9c110 --- /dev/null +++ b/docs/how-to/llm-connections.mdx @@ -0,0 +1,182 @@ +--- +title: Connect to any LLM +description: Comprehensive guide on integrating CrewAI with various Large Language Models (LLMs) using LiteLLM, including supported providers and configuration options. +icon: brain-circuit +--- + +## Connect CrewAI to LLMs + +CrewAI uses LiteLLM to connect to a wide variety of Language Models (LLMs). This integration provides extensive versatility, allowing you to use models from numerous providers with a simple, unified interface. + + + By default, CrewAI uses the `gpt-4o-mini` model. This is determined by the `OPENAI_MODEL_NAME` environment variable, which defaults to "gpt-4o-mini" if not set. + You can easily configure your agents to use a different model or provider as described in this guide. + + +## Supported Providers + +LiteLLM supports a wide range of providers, including but not limited to: + +- OpenAI +- Anthropic +- Google (Vertex AI, Gemini) +- Azure OpenAI +- AWS (Bedrock, SageMaker) +- Cohere +- Hugging Face +- Ollama +- Mistral AI +- Replicate +- Together AI +- AI21 +- Cloudflare Workers AI +- DeepInfra +- Groq +- And many more! + +For a complete and up-to-date list of supported providers, please refer to the [LiteLLM Providers documentation](https://docs.litellm.ai/docs/providers). + +## Changing the LLM + +To use a different LLM with your CrewAI agents, you have several options: + + + + Pass the model name as a string when initializing the agent: + + ```python Code + from crewai import Agent + + # Using OpenAI's GPT-4 + openai_agent = Agent( + role='OpenAI Expert', + goal='Provide insights using GPT-4', + backstory="An AI assistant powered by OpenAI's latest model.", + llm='gpt-4' + ) + + # Using Anthropic's Claude + claude_agent = Agent( + role='Anthropic Expert', + goal='Analyze data using Claude', + backstory="An AI assistant leveraging Anthropic's language model.", + llm='claude-2' + ) + ``` + + + + For more detailed configuration, use the LLM class: + + ```python Code + from crewai import Agent, LLM + + llm = LLM( + model="gpt-4", + temperature=0.7, + base_url="https://api.openai.com/v1", + api_key="your-api-key-here" + ) + + agent = Agent( + role='Customized LLM Expert', + goal='Provide tailored responses', + backstory="An AI assistant with custom LLM settings.", + llm=llm + ) + ``` + + + + +## Configuration Options + +When configuring an LLM for your agent, you have access to a wide range of parameters: + +| Parameter | Type | Description | +|:----------|:-----:|:-------------| +| **model** | `str` | The name of the model to use (e.g., "gpt-4", "claude-2") | +| **temperature** | `float` | Controls randomness in output (0.0 to 1.0) | +| **max_tokens** | `int` | Maximum number of tokens to generate | +| **top_p** | `float` | Controls diversity of output (0.0 to 1.0) | +| **frequency_penalty** | `float` | Penalizes new tokens based on their frequency in the text so far | +| **presence_penalty** | `float` | Penalizes new tokens based on their presence in the text so far | +| **stop** | `str`, `List[str]` | Sequence(s) to stop generation | +| **base_url** | `str` | The base URL for the API endpoint | +| **api_key** | `str` | Your API key for authentication | + +For a complete list of parameters and their descriptions, refer to the LLM class documentation. + +## Connecting to OpenAI-Compatible LLMs + +You can connect to OpenAI-compatible LLMs using either environment variables or by setting specific attributes on the LLM class: + + + + + ```python Code + import os + + os.environ["OPENAI_API_KEY"] = "your-api-key" + os.environ["OPENAI_API_BASE"] = "https://api.your-provider.com/v1" + os.environ["OPENAI_MODEL_NAME"] = "your-model-name" + ``` + + + + + ```python Code + llm = LLM( + model="custom-model-name", + api_key="your-api-key", + base_url="https://api.your-provider.com/v1" + ) + agent = Agent(llm=llm, ...) + ``` + + + + +## Using Local Models with Ollama + +For local models like those provided by Ollama: + + + + [Click here to download and install Ollama](https://ollama.com/download) + + + For example, run `ollama pull llama3.2` to download the model. + + + + ```python Code + agent = Agent( + role='Local AI Expert', + goal='Process information using a local model', + backstory="An AI assistant running on local hardware.", + llm=LLM(model="ollama/llama3.2", base_url="http://localhost:11434") + ) + ``` + + + + +## Changing the Base API URL + +You can change the base API URL for any LLM provider by setting the `base_url` parameter: + +```python Code +llm = LLM( + model="custom-model-name", + base_url="https://api.your-provider.com/v1", + api_key="your-api-key" +) +agent = Agent(llm=llm, ...) +``` + +This is particularly useful when working with OpenAI-compatible APIs or when you need to specify a different endpoint for your chosen provider. + +## Conclusion + +By leveraging LiteLLM, CrewAI offers seamless integration with a vast array of LLMs. This flexibility allows you to choose the most suitable model for your specific needs, whether you prioritize performance, cost-efficiency, or local deployment. Remember to consult the [LiteLLM documentation](https://docs.litellm.ai/docs/) for the most up-to-date information on supported models and configuration options. \ No newline at end of file diff --git a/docs/how-to/replay-tasks-from-latest-crew-kickoff.mdx b/docs/how-to/replay-tasks-from-latest-crew-kickoff.mdx new file mode 100644 index 000000000..782f2d04f --- /dev/null +++ b/docs/how-to/replay-tasks-from-latest-crew-kickoff.mdx @@ -0,0 +1,80 @@ +--- +title: Replay Tasks from Latest Crew Kickoff +description: Replay tasks from the latest crew.kickoff(...) +icon: arrow-right +--- + +## Introduction + +CrewAI provides the ability to replay from a task specified from the latest crew kickoff. This feature is particularly useful when you've finished a kickoff and may want to retry certain tasks or don't need to refetch data over and your agents already have the context saved from the kickoff execution so you just need to replay the tasks you want to. + + + You must run `crew.kickoff()` before you can replay a task. + Currently, only the latest kickoff is supported, so if you use `kickoff_for_each`, it will only allow you to replay from the most recent crew run. + + +Here's an example of how to replay from a task: + +### Replaying from Specific Task Using the CLI + +To use the replay feature, follow these steps: + + + + + + + + To view the latest kickoff task_ids use: + + ```shell + crewai log-tasks-outputs + ``` + + Once you have your `task_id` to replay, use: + + ```shell + crewai replay -t + ``` + + + + + Ensure `crewai` is installed and configured correctly in your development environment. + + +### Replaying from a Task Programmatically + +To replay from a task programmatically, use the following steps: + + + + Specify the `task_id` and input parameters for the replay process. + + + Execute the replay command within a try-except block to handle potential errors. + + ```python Code + def replay(): + """ + Replay the crew execution from a specific task. + """ + task_id = '' + inputs = {"topic": "CrewAI Training"} # This is optional; you can pass in the inputs you want to replay; otherwise, it uses the previous kickoff's inputs. + try: + YourCrewName_Crew().crew().replay(task_id=task_id, inputs=inputs) + + except subprocess.CalledProcessError as e: + raise Exception(f"An error occurred while replaying the crew: {e}") + + except Exception as e: + raise Exception(f"An unexpected error occurred: {e}") + ``` + + + + +## Conclusion + +With the above enhancements and detailed functionality, replaying specific tasks in CrewAI has been made more efficient and robust. +Ensure you follow the commands and steps precisely to make the most of these features. \ No newline at end of file diff --git a/docs/how-to/Sequential.md b/docs/how-to/sequential-process.mdx similarity index 79% rename from docs/how-to/Sequential.md rename to docs/how-to/sequential-process.mdx index ef58894ba..3957a7d5c 100644 --- a/docs/how-to/Sequential.md +++ b/docs/how-to/sequential-process.mdx @@ -1,23 +1,30 @@ --- -title: Using the Sequential Processes in crewAI -description: A comprehensive guide to utilizing the sequential processes for task execution in crewAI projects. +title: Sequential Processes +description: A comprehensive guide to utilizing the sequential processes for task execution in CrewAI projects. +icon: forward --- ## Introduction -CrewAI offers a flexible framework for executing tasks in a structured manner, supporting both sequential and hierarchical processes. This guide outlines how to effectively implement these processes to ensure efficient task execution and project completion. + +CrewAI offers a flexible framework for executing tasks in a structured manner, supporting both sequential and hierarchical processes. +This guide outlines how to effectively implement these processes to ensure efficient task execution and project completion. ## Sequential Process Overview -The sequential process ensures tasks are executed one after the other, following a linear progression. This approach is ideal for projects requiring tasks to be completed in a specific order. + +The sequential process ensures tasks are executed one after the other, following a linear progression. +This approach is ideal for projects requiring tasks to be completed in a specific order. ### Key Features + - **Linear Task Flow**: Ensures orderly progression by handling tasks in a predetermined sequence. - **Simplicity**: Best suited for projects with clear, step-by-step tasks. - **Easy Monitoring**: Facilitates easy tracking of task completion and project progress. ## Implementing the Sequential Process + To use the sequential process, assemble your crew and define tasks in the order they need to be executed. -```python +```python Code from crewai import Crew, Process, Agent, Task, TaskOutput, CrewOutput # Define your agents @@ -38,9 +45,21 @@ writer = Agent( ) # Define your tasks -research_task = Task(description='Gather relevant data...', agent=researcher, expected_output='Raw Data') -analysis_task = Task(description='Analyze the data...', agent=analyst, expected_output='Data Insights') -writing_task = Task(description='Compose the report...', agent=writer, expected_output='Final Report') +research_task = Task( + description='Gather relevant data...', + agent=researcher, + expected_output='Raw Data' +) +analysis_task = Task( + description='Analyze the data...', + agent=analyst, + expected_output='Data Insights' +) +writing_task = Task( + description='Compose the report...', + agent=writer, + expected_output='Final Report' +) # Form the crew with a sequential process report_crew = Crew( @@ -58,9 +77,11 @@ crew_output: CrewOutput = result.output ``` ### Note: + Each task in a sequential process **must** have an agent assigned. Ensure that every `Task` includes an `agent` parameter. ### Workflow in Action + 1. **Initial Task**: In a sequential process, the first agent completes their task and signals completion. 2. **Subsequent Tasks**: Agents pick up their tasks based on the process type, with outcomes of preceding tasks or directives guiding their execution. 3. **Completion**: The process concludes once the final task is executed, leading to project completion. @@ -68,28 +89,39 @@ Each task in a sequential process **must** have an agent assigned. Ensure that e ## Advanced Features ### Task Delegation -In sequential processes, if an agent has `allow_delegation` set to `True`, they can delegate tasks to other agents in the crew. This feature is automatically set up when there are multiple agents in the crew. + +In sequential processes, if an agent has `allow_delegation` set to `True`, they can delegate tasks to other agents in the crew. +This feature is automatically set up when there are multiple agents in the crew. ### Asynchronous Execution -Tasks can be executed asynchronously, allowing for parallel processing when appropriate. To create an asynchronous task, set `async_execution=True` when defining the task. + +Tasks can be executed asynchronously, allowing for parallel processing when appropriate. +To create an asynchronous task, set `async_execution=True` when defining the task. ### Memory and Caching + CrewAI supports both memory and caching features: + - **Memory**: Enable by setting `memory=True` when creating the Crew. This allows agents to retain information across tasks. - **Caching**: By default, caching is enabled. Set `cache=False` to disable it. ### Callbacks + You can set callbacks at both the task and step level: + - `task_callback`: Executed after each task completion. - `step_callback`: Executed after each step in an agent's execution. ### Usage Metrics + CrewAI tracks token usage across all tasks and agents. You can access these metrics after execution. ## Best Practices for Sequential Processes + 1. **Order Matters**: Arrange tasks in a logical sequence where each task builds upon the previous one. 2. **Clear Task Descriptions**: Provide detailed descriptions for each task to guide the agents effectively. 3. **Appropriate Agent Selection**: Match agents' skills and roles to the requirements of each task. 4. **Use Context**: Leverage the context from previous tasks to inform subsequent ones. -This updated documentation ensures that details accurately reflect the latest changes in the codebase and clearly describes how to leverage new features and configurations. The content is kept simple and direct to ensure easy understanding. \ No newline at end of file +This updated documentation ensures that details accurately reflect the latest changes in the codebase and clearly describes how to leverage new features and configurations. +The content is kept simple and direct to ensure easy understanding. \ No newline at end of file diff --git a/docs/assets/agentops-overview.png b/docs/images/agentops-overview.png similarity index 100% rename from docs/assets/agentops-overview.png rename to docs/images/agentops-overview.png diff --git a/docs/assets/agentops-replay.png b/docs/images/agentops-replay.png similarity index 100% rename from docs/assets/agentops-replay.png rename to docs/images/agentops-replay.png diff --git a/docs/assets/agentops-session.png b/docs/images/agentops-session.png similarity index 100% rename from docs/assets/agentops-session.png rename to docs/images/agentops-session.png diff --git a/docs/assets/langtrace1.png b/docs/images/langtrace1.png similarity index 100% rename from docs/assets/langtrace1.png rename to docs/images/langtrace1.png diff --git a/docs/assets/langtrace2.png b/docs/images/langtrace2.png similarity index 100% rename from docs/assets/langtrace2.png rename to docs/images/langtrace2.png diff --git a/docs/assets/langtrace3.png b/docs/images/langtrace3.png similarity index 100% rename from docs/assets/langtrace3.png rename to docs/images/langtrace3.png diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 93f2105c1..000000000 --- a/docs/index.md +++ /dev/null @@ -1,228 +0,0 @@ - - -# crewAI Documentation - -Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks. - -
- - - - -
diff --git a/docs/installation.mdx b/docs/installation.mdx new file mode 100644 index 000000000..b5d3ef901 --- /dev/null +++ b/docs/installation.mdx @@ -0,0 +1,125 @@ +--- +title: Installation & Setup +description: +icon: wrench +--- + +## Install CrewAI + +This guide will walk you through the installation process for CrewAI and its dependencies. +CrewAI is a flexible and powerful AI framework that enables you to create and manage AI agents, tools, and tasks efficiently. +Let's get started! πŸš€ + + + Make sure you have `Python >=3.10 <=3.13` installed on your system before you proceed. + + + + + First, if you haven't already, install [Poetry](https://python-poetry.org/). + CrewAI uses Poetry for dependency management and package handling, offering a seamless setup and execution experience. + + ```shell Terminal + pip install poetry + ``` + + + + Then, install the main CrewAI package: + + ```shell Terminal + pip install crewai + ``` + + You can also install the main CrewAI package and the tools package that include a series of helpful tools for your agents: + + ```shell Terminal + pip install 'crewai[tools]' + ``` + + Alternatively, you can also use: + + ```shell Terminal + pip install crewai crewai-tools + ``` + + + + To upgrade CrewAI and CrewAI Tools to the latest version, run the following command: + + ```shell Terminal + pip install --upgrade crewai crewai-tools + ``` + + + + To verify that `crewai` and `crewai-tools` are installed correctly, run the following command: + + ```shell Terminal + pip freeze | grep crewai + ``` + + You should see the version number of `crewai` and `crewai-tools`. + + ```markdown Version + crewai==X.X.X + crewai-tools==X.X.X + ``` + + If you see the version number, then the installation was successful! πŸŽ‰ + + + +## Create a new CrewAI project + +The next step is to create a new CrewAI project. +We recommend using the YAML Template scaffolding to get started as it provides a structured approach to defining agents and tasks. + + + + To create a new CrewAI project, run the following CLI (Command Line Interface) command: + + ```shell Terminal + crewai create crew + ``` + + This command creates a new project folder with the following structure: + | File/Directory | Description | + |:------------------------|:-------------------------------------------------| + | `my_project/` | Root directory of the project | + | β”œβ”€β”€ `.gitignore` | Specifies files and directories to ignore in Git | + | β”œβ”€β”€ `pyproject.toml` | Project configuration and dependencies | + | β”œβ”€β”€ `README.md` | Project documentation | + | β”œβ”€β”€ `.env` | Environment variables | + | └── `src/` | Source code directory | + |     β””── `my_project/` | Main application package | + |         β”œβ”€β”€ `__init__.py` | Marks the directory as a Python package | + |         β”œβ”€β”€ `main.py` | Main application script | + |         β”œβ”€β”€ `crew.py` | Crew-related functionalities | + |         β”œβ”€β”€ `tools/` | Custom tools directory | + |         β”‚ β”œβ”€β”€ `custom_tool.py` | Custom tool implementation | + |         β”‚ └── `__init__.py` | Marks tools directory as a package | + |         β””── `config/` | Configuration files directory | + |             β”œβ”€β”€ `agents.yaml` | Agent configurations | + |             β””── `tasks.yaml` | Task configurations | + + You can now start developing your crew by editing the files in the `src/my_project` folder. + The `main.py` file is the entry point of the project, the `crew.py` file is where you define your crew, the `agents.yaml` file is where you define your agents, + and the `tasks.yaml` file is where you define your tasks. + + + To customize your project, you can: + - Modify `src/my_project/config/agents.yaml` to define your agents. + - Modify `src/my_project/config/tasks.yaml` to define your tasks. + - Modify `src/my_project/crew.py` to add your own logic, tools, and specific arguments. + - Modify `src/my_project/main.py` to add custom inputs for your agents and tasks. + - Add your environment variables into the `.env` file. + + + +## Next steps + +Now that you have installed `crewai` and `crewai-tools`, you're ready to spin up your first crew! + +- πŸ‘¨β€πŸ’» Build your first agent with CrewAI by following the [Quickstart](/quickstart) guide. +- πŸ’¬ Join the [Community](https://community.crewai.com) to get help and share your feedback. diff --git a/docs/introduction.mdx b/docs/introduction.mdx new file mode 100644 index 000000000..4e2bdca31 --- /dev/null +++ b/docs/introduction.mdx @@ -0,0 +1,49 @@ +--- +title: Introduction +description: Welcome to CrewAI docs! +icon: handshake +--- + +# What is CrewAI? + +**CrewAI is a cutting-edge Python framework for orchestrating role-playing, autonomous AI agents.** + +By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks. + + + CrewAI Mindmap + + +## Why CrewAI? +- πŸ€Όβ€β™€οΈ **Role-Playing Agents**: Agents can take on different roles and personas to better understand and interact with complex systems. +- πŸ€– **Autonomous Decision Making**: Agents can make decisions autonomously based on the given context and available tools. +- 🀝 **Seamless Collaboration**: Agents can work together seamlessly, sharing information and resources to achieve common goals. +- 🧠 **Complex Task Tackling**: CrewAI is designed to tackle complex tasks, such as multi-step workflows, decision making, and problem solving. + +# Get Started with CrewAI + + + + Getting started with CrewAI + + + Join the CrewAI community and get help with your project! + + + +## Next Step + +- [Install CrewAI](/installation) + diff --git a/docs/mint.json b/docs/mint.json new file mode 100644 index 000000000..e57397ce4 --- /dev/null +++ b/docs/mint.json @@ -0,0 +1,165 @@ +{ + "name": "CrewAI", + "theme": "venus", + "logo": { + "dark": "crew_only_logo.png", + "light": "crew_only_logo.png" + }, + "favicon": "favicon.svg", + "colors": { + "primary": "#EB6658", + "light": "#F3A78B", + "dark": "#C94C3C", + "anchors": { + "from": "#737373", + "to": "#EB6658" + } + }, + "seo": { + "indexHiddenPages": false + }, + "modeToggle": { + "default": "dark", + "isHidden": false + }, + "feedback": { + "suggestEdit": true, + "raiseIssue": true, + "thumbsRating": true + }, + "topbarCtaButton": { + "type": "github", + "url": "https://github.com/crewAIInc/crewAI" + }, + "primaryTab": { + "name": "Get Started" + }, + "tabs": [ + { + "name": "Examples", + "url": "examples" + } + ], + "anchors": [ + { + "name": "Community", + "icon": "discourse", + "url": "https://community.crewai.com" + }, + { + "name": "Changelog", + "icon": "timeline", + "url": "https://github.com/crewAIInc/crewAI/releases" + } + ], + "navigation": [ + { + "group": "Get Started", + "pages": [ + "introduction", + "installation", + "quickstart" + ] + }, + { + "group": "Core Concepts", + "pages": [ + "concepts/agents", + "concepts/tasks", + "concepts/tools", + "concepts/processes", + "concepts/crews", + "concepts/collaboration", + "concepts/pipeline", + "concepts/training", + "concepts/memory", + "concepts/planning", + "concepts/testing", + "concepts/flows", + "concepts/cli", + "concepts/llms", + "concepts/langchain-tools", + "concepts/llamaindex-tools" + ] + }, + { + "group": "How to Guides", + "pages": [ + "how-to/create-custom-tools", + "how-to/sequential-process", + "how-to/hierarchical-process", + "how-to/custom-manager-agent", + "how-to/llm-connections", + "how-to/customizing-agents", + "how-to/coding-agents", + "how-to/force-tool-output-as-result", + "how-to/human-input-on-execution", + "how-to/kickoff-async", + "how-to/kickoff-for-each", + "how-to/replay-tasks-from-latest-crew-kickoff", + "how-to/conditional-tasks", + "how-to/agentops-observability", + "how-to/langtrace-observability" + ] + }, + { + "group": "Examples", + "pages": [ + "examples/example" + ] + }, + { + "group": "Tools", + "pages": [ + "tools/browserbaseloadtool", + "tools/codedocssearchtool", + "tools/codeinterpretertool", + "tools/composiotool", + "tools/csvsearchtool", + "tools/dalletool", + "tools/directorysearchtool", + "tools/directoryreadtool", + "tools/docxsearchtool", + "tools/exasearchtool", + "tools/filereadtool", + "tools/filewritetool", + "tools/firecrawlcrawlwebsitetool", + "tools/firecrawlscrapewebsitetool", + "tools/firecrawlsearchtool", + "tools/githubsearchtool", + "tools/serperdevtool", + "tools/jsonsearchtool", + "tools/mdxsearchtool", + "tools/mysqltool", + "tools/nl2sqltool", + "tools/pdfsearchtool", + "tools/pgsearchtool", + "tools/scrapewebsitetool", + "tools/seleniumscrapingtool", + "tools/spidertool", + "tools/txtsearchtool", + "tools/visiontool", + "tools/websitesearchtool", + "tools/xmlsearchtool", + "tools/youtubechannelsearchtool", + "tools/youtubevideosearchtool" + ] + }, + { + "group": "Telemetry", + "pages": [ + "telemetry" + ] + } + ], + "search": { + "prompt": "Search CrewAI docs" + }, + "footerSocials": { + "website": "https://crewai.com", + "x": "https://x.com/crewAIInc", + "github": "https://github.com/crewAIInc/crewAI", + "linkedin": "https://www.linkedin.com/company/crewai-inc", + "youtube": "https://youtube.com/@crewAIInc" + } +} \ No newline at end of file diff --git a/docs/postcss.config.js b/docs/postcss.config.js deleted file mode 100644 index db13d1479..000000000 --- a/docs/postcss.config.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = { - plugins: [require('tailwindcss'), require('autoprefixer')] -} \ No newline at end of file diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx new file mode 100644 index 000000000..2f39066b8 --- /dev/null +++ b/docs/quickstart.mdx @@ -0,0 +1,264 @@ +--- +title: Quickstart +description: Build your first AI agent with CrewAI in under 5 minutes. +icon: rocket +--- + +## Build your first CrewAI Agent + +Let's create a simple crew that will help us `research` and `report` on the `latest AI developments` for a given topic or subject. + +Before we proceed, make sure you have `crewai` and `crewai-tools` installed. +If you haven't installed them yet, you can do so by following the [installation guide](/installation). + +Follow the steps below to get crewing! πŸš£β€β™‚οΈ + + + + Create a new crew project by running the following command in your terminal. + This will create a new directory called `latest-ai-development` with the basic structure for your crew. + + ```shell Terminal + crewai create crew latest-ai-development + ``` + + + + + You can also modify the agents as needed to fit your use case or copy and paste as is to your project. + + ```yaml agents.yaml + # src/latest_ai_development/config/agents.yaml + researcher: + role: > + {topic} Senior Data Researcher + goal: > + Uncover cutting-edge developments in {topic} + backstory: > + You're a seasoned researcher with a knack for uncovering the latest + developments in {topic}. Known for your ability to find the most relevant + information and present it in a clear and concise manner. + + reporting_analyst: + role: > + {topic} Reporting Analyst + goal: > + Create detailed reports based on {topic} data analysis and research findings + backstory: > + You're a meticulous analyst with a keen eye for detail. You're known for + your ability to turn complex data into clear and concise reports, making + it easy for others to understand and act on the information you provide. + ``` + + + ```yaml tasks.yaml + # src/latest_ai_development/config/tasks.yaml + research_task: + description: > + Conduct a thorough research about {topic} + Make sure you find any interesting and relevant information given + the current year is 2024. + expected_output: > + A list with 10 bullet points of the most relevant information about {topic} + agent: researcher + + reporting_task: + description: > + Review the context you got and expand each topic into a full section for a report. + Make sure the report is detailed and contains any and all relevant information. + expected_output: > + A fully fledge reports with the mains topics, each with a full section of information. + Formatted as markdown without '```' + agent: reporting_analyst + output_file: report.md + ``` + + + ```python crew.py + # src/latest_ai_development/crew.py + from crewai import Agent, Crew, Process, Task + from crewai.project import CrewBase, agent, crew, task + from crewai_tools import SerperDevTool + + @CrewBase + class LatestAiDevelopmentCrew(): + """LatestAiDevelopment crew""" + + @agent + def researcher(self) -> Agent: + return Agent( + config=self.agents_config['researcher'], + verbose=True, + tools=[SerperDevTool()] + ) + + @agent + def reporting_analyst(self) -> Agent: + return Agent( + config=self.agents_config['reporting_analyst'], + verbose=True + ) + + @task + def research_task(self) -> Task: + return Task( + config=self.tasks_config['research_task'], + ) + + @task + def reporting_task(self) -> Task: + return Task( + config=self.tasks_config['reporting_task'], + output_file='output/report.md' # This is the file that will be contain the final report. + ) + + @crew + def crew(self) -> Crew: + """Creates the LatestAiDevelopment crew""" + return Crew( + agents=self.agents, # Automatically created by the @agent decorator + tasks=self.tasks, # Automatically created by the @task decorator + process=Process.sequential, + verbose=True, + ) + ``` + + + For example, you can pass the `topic` input to your crew to customize the research and reporting to medical llms or any other topic. + ```python main.py + #!/usr/bin/env python + # src/latest_ai_development/main.py + import sys + from latest_ai_development.crew import LatestAiDevelopmentCrew + + def run(): + """ + Run the crew. + """ + inputs = { + 'topic': 'AI Agents' + } + LatestAiDevelopmentCrew().crew().kickoff(inputs=inputs) + ``` + + + Before running your crew, make sure you have the following keys set as environment variables in your `.env` file: + - An [OpenAI API key](https://platform.openai.com/account/api-keys) (or other LLM API key): `OPENAI_API_KEY=sk-...` + - A [Serper.dev](https://serper.dev/) API key: `SERPER_API_KEY=YOUR_KEY_HERE` + + + Lock the dependencies and install them by using the CLI command but first, navigate to your project directory: + + ```shell Terminal + cd latest-ai-development + crewai install + ``` + + + + To run your crew, execute the following command in the root of your project: + + ```bash Terminal + crewai run + ``` + + + + You should see the output in the console and the `report.md` file should be created in the root of your project with the final report. + + Here's an example of what the report should look like: + + + ```markdown output/report.md + # Comprehensive Report on the Rise and Impact of AI Agents in 2024 + + ## 1. Introduction to AI Agents + In 2024, Artificial Intelligence (AI) agents are at the forefront of innovation across various industries. As intelligent systems that can perform tasks typically requiring human cognition, AI agents are paving the way for significant advancements in operational efficiency, decision-making, and overall productivity within sectors like Human Resources (HR) and Finance. This report aims to detail the rise of AI agents, their frameworks, applications, and potential implications on the workforce. + + ## 2. Benefits of AI Agents + AI agents bring numerous advantages that are transforming traditional work environments. Key benefits include: + + - **Task Automation**: AI agents can carry out repetitive tasks such as data entry, scheduling, and payroll processing without human intervention, greatly reducing the time and resources spent on these activities. + - **Improved Efficiency**: By quickly processing large datasets and performing analyses that would take humans significantly longer, AI agents enhance operational efficiency. This allows teams to focus on strategic tasks that require higher-level thinking. + - **Enhanced Decision-Making**: AI agents can analyze trends and patterns in data, provide insights, and even suggest actions, helping stakeholders make informed decisions based on factual data rather than intuition alone. + + ## 3. Popular AI Agent Frameworks + Several frameworks have emerged to facilitate the development of AI agents, each with its own unique features and capabilities. Some of the most popular frameworks include: + + - **Autogen**: A framework designed to streamline the development of AI agents through automation of code generation. + - **Semantic Kernel**: Focuses on natural language processing and understanding, enabling agents to comprehend user intentions better. + - **Promptflow**: Provides tools for developers to create conversational agents that can navigate complex interactions seamlessly. + - **Langchain**: Specializes in leveraging various APIs to ensure agents can access and utilize external data effectively. + - **CrewAI**: Aimed at collaborative environments, CrewAI strengthens teamwork by facilitating communication through AI-driven insights. + - **MemGPT**: Combines memory-optimized architectures with generative capabilities, allowing for more personalized interactions with users. + + These frameworks empower developers to build versatile and intelligent agents that can engage users, perform advanced analytics, and execute various tasks aligned with organizational goals. + + ## 4. AI Agents in Human Resources + AI agents are revolutionizing HR practices by automating and optimizing key functions: + + - **Recruiting**: AI agents can screen resumes, schedule interviews, and even conduct initial assessments, thus accelerating the hiring process while minimizing biases. + - **Succession Planning**: AI systems analyze employee performance data and potential, helping organizations identify future leaders and plan appropriate training. + - **Employee Engagement**: Chatbots powered by AI can facilitate feedback loops between employees and management, promoting an open culture and addressing concerns promptly. + + As AI continues to evolve, HR departments leveraging these agents can realize substantial improvements in both efficiency and employee satisfaction. + + ## 5. AI Agents in Finance + The finance sector is seeing extensive integration of AI agents that enhance financial practices: + + - **Expense Tracking**: Automated systems manage and monitor expenses, flagging anomalies and offering recommendations based on spending patterns. + - **Risk Assessment**: AI models assess credit risk and uncover potential fraud by analyzing transaction data and behavioral patterns. + - **Investment Decisions**: AI agents provide stock predictions and analytics based on historical data and current market conditions, empowering investors with informative insights. + + The incorporation of AI agents into finance is fostering a more responsive and risk-aware financial landscape. + + ## 6. Market Trends and Investments + The growth of AI agents has attracted significant investment, especially amidst the rising popularity of chatbots and generative AI technologies. Companies and entrepreneurs are eager to explore the potential of these systems, recognizing their ability to streamline operations and improve customer engagement. + + Conversely, corporations like Microsoft are taking strides to integrate AI agents into their product offerings, with enhancements to their Copilot 365 applications. This strategic move emphasizes the importance of AI literacy in the modern workplace and indicates the stabilizing of AI agents as essential business tools. + + ## 7. Future Predictions and Implications + Experts predict that AI agents will transform essential aspects of work life. As we look toward the future, several anticipated changes include: + + - Enhanced integration of AI agents across all business functions, creating interconnected systems that leverage data from various departmental silos for comprehensive decision-making. + - Continued advancement of AI technologies, resulting in smarter, more adaptable agents capable of learning and evolving from user interactions. + - Increased regulatory scrutiny to ensure ethical use, especially concerning data privacy and employee surveillance as AI agents become more prevalent. + + To stay competitive and harness the full potential of AI agents, organizations must remain vigilant about latest developments in AI technology and consider continuous learning and adaptation in their strategic planning. + + ## 8. Conclusion + The emergence of AI agents is undeniably reshaping the workplace landscape in 2024. With their ability to automate tasks, enhance efficiency, and improve decision-making, AI agents are critical in driving operational success. Organizations must embrace and adapt to AI developments to thrive in an increasingly digital business environment. + ``` + + + + + +In addition to the [sequential process](../how-to/sequential-process), you can use the [hierarchical process](../how-to/hierarchical-process), +which automatically assigns a manager to the defined crew to properly coordinate the planning and execution of tasks through delegation and validation of results. +You can learn more about the core concepts [here](/concepts). + + +### Replay Tasks from Latest Crew Kickoff + +CrewAI now includes a replay feature that allows you to list the tasks from the last run and replay from a specific one. To use this feature, run: + +```shell +crewai replay +``` + +Replace `` with the ID of the task you want to replay. + +### Reset Crew Memory + +If you need to reset the memory of your crew before running it again, you can do so by calling the reset memory feature: + +```shell +crewai reset-memory +``` + +This will clear the crew's memory, allowing for a fresh start. + +## Deploying Your Project + +The easiest way to deploy your crew is through [CrewAI Enterprise](https://www.crewai.com/crewaiplus), where you can deploy your crew in a few clicks. diff --git a/docs/snippets/snippet-intro.mdx b/docs/snippets/snippet-intro.mdx new file mode 100644 index 000000000..c57e7c756 --- /dev/null +++ b/docs/snippets/snippet-intro.mdx @@ -0,0 +1,4 @@ +One of the core principles of software development is DRY (Don't Repeat +Yourself). This is a principle that apply to documentation as +well. If you find yourself repeating the same content in multiple places, you +should consider creating a custom snippet to keep your content in sync. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css deleted file mode 100644 index 29b1e5fd6..000000000 --- a/docs/stylesheets/extra.css +++ /dev/null @@ -1,3 +0,0 @@ -.md-typeset .admonition-title { - margin-bottom: 10px; -} \ No newline at end of file diff --git a/docs/stylesheets/output.css b/docs/stylesheets/output.css deleted file mode 100644 index a5d1b09c4..000000000 --- a/docs/stylesheets/output.css +++ /dev/null @@ -1,565 +0,0 @@ -/* -! tailwindcss v3.4.1 | MIT License | https://tailwindcss.com -*/ - -/* -1. Prevent padding and border from affecting element width. (https://github.com/mozdevs/cssremedy/issues/4) -2. Allow adding a border to an element by just adding a border-width. (https://github.com/tailwindcss/tailwindcss/pull/116) -*/ - -*, -::before, -::after { - box-sizing: border-box; - /* 1 */ - border-width: 0; - /* 2 */ - border-style: solid; - /* 2 */ - border-color: #e5e7eb; - /* 2 */ -} - -::before, -::after { - --tw-content: ''; -} - -/* -1. Use a consistent sensible line-height in all browsers. -2. Prevent adjustments of font size after orientation changes in iOS. -3. Use a more readable tab size. -4. Use the user's configured `sans` font-family by default. -5. Use the user's configured `sans` font-feature-settings by default. -6. Use the user's configured `sans` font-variation-settings by default. -7. Disable tap highlights on iOS -*/ - -html, -:host { - line-height: 1.5; - /* 1 */ - -webkit-text-size-adjust: 100%; - /* 2 */ - -moz-tab-size: 4; - /* 3 */ - -o-tab-size: 4; - tab-size: 4; - /* 3 */ - font-family: ui-sans-serif, system-ui, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; - /* 4 */ - font-feature-settings: normal; - /* 5 */ - font-variation-settings: normal; - /* 6 */ - -webkit-tap-highlight-color: transparent; - /* 7 */ -} - -/* -1. Remove the margin in all browsers. -2. Inherit line-height from `html` so users can set them as a class directly on the `html` element. -*/ - -body { - margin: 0; - /* 1 */ - line-height: inherit; - /* 2 */ -} - -/* -1. Add the correct height in Firefox. -2. Correct the inheritance of border color in Firefox. (https://bugzilla.mozilla.org/show_bug.cgi?id=190655) -3. Ensure horizontal rules are visible by default. -*/ - -hr { - height: 0; - /* 1 */ - color: inherit; - /* 2 */ - border-top-width: 1px; - /* 3 */ -} - -/* -Add the correct text decoration in Chrome, Edge, and Safari. -*/ - -abbr:where([title]) { - -webkit-text-decoration: underline dotted; - text-decoration: underline dotted; -} - -/* -Remove the default font size and weight for headings. -*/ - -h1, -h2, -h3, -h4, -h5, -h6 { - font-size: inherit; - font-weight: inherit; -} - -/* -Reset links to optimize for opt-in styling instead of opt-out. -*/ - -a { - color: inherit; - text-decoration: inherit; -} - -/* -Add the correct font weight in Edge and Safari. -*/ - -b, -strong { - font-weight: bolder; -} - -/* -1. Use the user's configured `mono` font-family by default. -2. Use the user's configured `mono` font-feature-settings by default. -3. Use the user's configured `mono` font-variation-settings by default. -4. Correct the odd `em` font sizing in all browsers. -*/ - -code, -kbd, -samp, -pre { - font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace; - /* 1 */ - font-feature-settings: normal; - /* 2 */ - font-variation-settings: normal; - /* 3 */ - font-size: 1em; - /* 4 */ -} - -/* -Add the correct font size in all browsers. -*/ - -small { - font-size: 80%; -} - -/* -Prevent `sub` and `sup` elements from affecting the line height in all browsers. -*/ - -sub, -sup { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; -} - -sub { - bottom: -0.25em; -} - -sup { - top: -0.5em; -} - -/* -1. Remove text indentation from table contents in Chrome and Safari. (https://bugs.chromium.org/p/chromium/issues/detail?id=999088, https://bugs.webkit.org/show_bug.cgi?id=201297) -2. Correct table border color inheritance in all Chrome and Safari. (https://bugs.chromium.org/p/chromium/issues/detail?id=935729, https://bugs.webkit.org/show_bug.cgi?id=195016) -3. Remove gaps between table borders by default. -*/ - -table { - text-indent: 0; - /* 1 */ - border-color: inherit; - /* 2 */ - border-collapse: collapse; - /* 3 */ -} - -/* -1. Change the font styles in all browsers. -2. Remove the margin in Firefox and Safari. -3. Remove default padding in all browsers. -*/ - -button, -input, -optgroup, -select, -textarea { - font-family: inherit; - /* 1 */ - font-feature-settings: inherit; - /* 1 */ - font-variation-settings: inherit; - /* 1 */ - font-size: 100%; - /* 1 */ - font-weight: inherit; - /* 1 */ - line-height: inherit; - /* 1 */ - color: inherit; - /* 1 */ - margin: 0; - /* 2 */ - padding: 0; - /* 3 */ -} - -/* -Remove the inheritance of text transform in Edge and Firefox. -*/ - -button, -select { - text-transform: none; -} - -/* -1. Correct the inability to style clickable types in iOS and Safari. -2. Remove default button styles. -*/ - -button, -[type='button'], -[type='reset'], -[type='submit'] { - -webkit-appearance: button; - /* 1 */ - background-color: transparent; - /* 2 */ - background-image: none; - /* 2 */ -} - -/* -Use the modern Firefox focus style for all focusable elements. -*/ - -:-moz-focusring { - outline: auto; -} - -/* -Remove the additional `:invalid` styles in Firefox. (https://github.com/mozilla/gecko-dev/blob/2f9eacd9d3d995c937b4251a5557d95d494c9be1/layout/style/res/forms.css#L728-L737) -*/ - -:-moz-ui-invalid { - box-shadow: none; -} - -/* -Add the correct vertical alignment in Chrome and Firefox. -*/ - -progress { - vertical-align: baseline; -} - -/* -Correct the cursor style of increment and decrement buttons in Safari. -*/ - -::-webkit-inner-spin-button, -::-webkit-outer-spin-button { - height: auto; -} - -/* -1. Correct the odd appearance in Chrome and Safari. -2. Correct the outline style in Safari. -*/ - -[type='search'] { - -webkit-appearance: textfield; - /* 1 */ - outline-offset: -2px; - /* 2 */ -} - -/* -Remove the inner padding in Chrome and Safari on macOS. -*/ - -::-webkit-search-decoration { - -webkit-appearance: none; -} - -/* -1. Correct the inability to style clickable types in iOS and Safari. -2. Change font properties to `inherit` in Safari. -*/ - -::-webkit-file-upload-button { - -webkit-appearance: button; - /* 1 */ - font: inherit; - /* 2 */ -} - -/* -Add the correct display in Chrome and Safari. -*/ - -summary { - display: list-item; -} - -/* -Removes the default spacing and border for appropriate elements. -*/ - -blockquote, -dl, -dd, -h1, -h2, -h3, -h4, -h5, -h6, -hr, -figure, -p, -pre { - margin: 0; -} - -fieldset { - margin: 0; - padding: 0; -} - -legend { - padding: 0; -} - -ol, -ul, -menu { - list-style: none; - margin: 0; - padding: 0; -} - -/* -Reset default styling for dialogs. -*/ - -dialog { - padding: 0; -} - -/* -Prevent resizing textareas horizontally by default. -*/ - -textarea { - resize: vertical; -} - -/* -1. Reset the default placeholder opacity in Firefox. (https://github.com/tailwindlabs/tailwindcss/issues/3300) -2. Set the default placeholder color to the user's configured gray 400 color. -*/ - -input::-moz-placeholder, textarea::-moz-placeholder { - opacity: 1; - /* 1 */ - color: #9ca3af; - /* 2 */ -} - -input::placeholder, -textarea::placeholder { - opacity: 1; - /* 1 */ - color: #9ca3af; - /* 2 */ -} - -/* -Set the default cursor for buttons. -*/ - -button, -[role="button"] { - cursor: pointer; -} - -/* -Make sure disabled buttons don't get the pointer cursor. -*/ - -:disabled { - cursor: default; -} - -/* -1. Make replaced elements `display: block` by default. (https://github.com/mozdevs/cssremedy/issues/14) -2. Add `vertical-align: middle` to align replaced elements more sensibly by default. (https://github.com/jensimmons/cssremedy/issues/14#issuecomment-634934210) - This can trigger a poorly considered lint error in some tools but is included by design. -*/ - -img, -svg, -video, -canvas, -audio, -iframe, -embed, -object { - display: block; - /* 1 */ - vertical-align: middle; - /* 2 */ -} - -/* -Constrain images and videos to the parent width and preserve their intrinsic aspect ratio. (https://github.com/mozdevs/cssremedy/issues/14) -*/ - -img, -video { - max-width: 100%; - height: auto; -} - -/* Make elements with the HTML hidden attribute stay hidden by default */ - -[hidden] { - display: none; -} - -*, ::before, ::after { - --tw-border-spacing-x: 0; - --tw-border-spacing-y: 0; - --tw-translate-x: 0; - --tw-translate-y: 0; - --tw-rotate: 0; - --tw-skew-x: 0; - --tw-skew-y: 0; - --tw-scale-x: 1; - --tw-scale-y: 1; - --tw-pan-x: ; - --tw-pan-y: ; - --tw-pinch-zoom: ; - --tw-scroll-snap-strictness: proximity; - --tw-gradient-from-position: ; - --tw-gradient-via-position: ; - --tw-gradient-to-position: ; - --tw-ordinal: ; - --tw-slashed-zero: ; - --tw-numeric-figure: ; - --tw-numeric-spacing: ; - --tw-numeric-fraction: ; - --tw-ring-inset: ; - --tw-ring-offset-width: 0px; - --tw-ring-offset-color: #fff; - --tw-ring-color: rgb(59 130 246 / 0.5); - --tw-ring-offset-shadow: 0 0 #0000; - --tw-ring-shadow: 0 0 #0000; - --tw-shadow: 0 0 #0000; - --tw-shadow-colored: 0 0 #0000; - --tw-blur: ; - --tw-brightness: ; - --tw-contrast: ; - --tw-grayscale: ; - --tw-hue-rotate: ; - --tw-invert: ; - --tw-saturate: ; - --tw-sepia: ; - --tw-drop-shadow: ; - --tw-backdrop-blur: ; - --tw-backdrop-brightness: ; - --tw-backdrop-contrast: ; - --tw-backdrop-grayscale: ; - --tw-backdrop-hue-rotate: ; - --tw-backdrop-invert: ; - --tw-backdrop-opacity: ; - --tw-backdrop-saturate: ; - --tw-backdrop-sepia: ; -} - -::backdrop { - --tw-border-spacing-x: 0; - --tw-border-spacing-y: 0; - --tw-translate-x: 0; - --tw-translate-y: 0; - --tw-rotate: 0; - --tw-skew-x: 0; - --tw-skew-y: 0; - --tw-scale-x: 1; - --tw-scale-y: 1; - --tw-pan-x: ; - --tw-pan-y: ; - --tw-pinch-zoom: ; - --tw-scroll-snap-strictness: proximity; - --tw-gradient-from-position: ; - --tw-gradient-via-position: ; - --tw-gradient-to-position: ; - --tw-ordinal: ; - --tw-slashed-zero: ; - --tw-numeric-figure: ; - --tw-numeric-spacing: ; - --tw-numeric-fraction: ; - --tw-ring-inset: ; - --tw-ring-offset-width: 0px; - --tw-ring-offset-color: #fff; - --tw-ring-color: rgb(59 130 246 / 0.5); - --tw-ring-offset-shadow: 0 0 #0000; - --tw-ring-shadow: 0 0 #0000; - --tw-shadow: 0 0 #0000; - --tw-shadow-colored: 0 0 #0000; - --tw-blur: ; - --tw-brightness: ; - --tw-contrast: ; - --tw-grayscale: ; - --tw-hue-rotate: ; - --tw-invert: ; - --tw-saturate: ; - --tw-sepia: ; - --tw-drop-shadow: ; - --tw-backdrop-blur: ; - --tw-backdrop-brightness: ; - --tw-backdrop-contrast: ; - --tw-backdrop-grayscale: ; - --tw-backdrop-hue-rotate: ; - --tw-backdrop-invert: ; - --tw-backdrop-opacity: ; - --tw-backdrop-saturate: ; - --tw-backdrop-sepia: ; -} - -.mb-10 { - margin-bottom: 2.5rem; -} - -.transform { - transform: translate(var(--tw-translate-x), var(--tw-translate-y)) rotate(var(--tw-rotate)) skewX(var(--tw-skew-x)) skewY(var(--tw-skew-y)) scaleX(var(--tw-scale-x)) scaleY(var(--tw-scale-y)); -} - -.leading-3 { - line-height: .75rem; -} - -.transition { - transition-property: color, background-color, border-color, text-decoration-color, fill, stroke, opacity, box-shadow, transform, filter, -webkit-backdrop-filter; - transition-property: color, background-color, border-color, text-decoration-color, fill, stroke, opacity, box-shadow, transform, filter, backdrop-filter; - transition-property: color, background-color, border-color, text-decoration-color, fill, stroke, opacity, box-shadow, transform, filter, backdrop-filter, -webkit-backdrop-filter; - transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1); - transition-duration: 150ms; -} \ No newline at end of file diff --git a/docs/stylesheets/tailwind.css b/docs/stylesheets/tailwind.css deleted file mode 100644 index 5be59b4cd..000000000 --- a/docs/stylesheets/tailwind.css +++ /dev/null @@ -1,3 +0,0 @@ -@import 'tailwindcss/base'; -@import 'tailwindcss/components'; -@import 'tailwindcss/utilities'; \ No newline at end of file diff --git a/docs/tailwind.config.js b/docs/tailwind.config.js deleted file mode 100644 index aa69556d0..000000000 --- a/docs/tailwind.config.js +++ /dev/null @@ -1,9 +0,0 @@ -/** @type {import('tailwindcss').Config} */ -module.exports = { - content: ["./**/*.md"], - theme: { - extend: {}, - }, - plugins: [], -} - diff --git a/docs/telemetry/Telemetry.md b/docs/telemetry.mdx similarity index 71% rename from docs/telemetry/Telemetry.md rename to docs/telemetry.mdx index 51b1ad8e9..b181ad827 100644 --- a/docs/telemetry/Telemetry.md +++ b/docs/telemetry.mdx @@ -1,20 +1,28 @@ --- title: Telemetry description: Understanding the telemetry data collected by CrewAI and how it contributes to the enhancement of the library. +icon: signal-stream --- ## Telemetry -!!! note "Personal Information" + By default, we collect no data that would be considered personal information under GDPR and other privacy regulations. We do collect Tool's names and Agent's roles, so be advised not to include any personal information in the tool's names or the Agent's roles. - Because no personal information is collected, it's not necessary to worry about data residency. - When `share_crew` is enabled, additional data is collected which may contain personal information if included by the user. Users should exercise caution when enabling this feature to ensure compliance with privacy regulations. + Because no personal information is collected, it's not necessary to worry about data residency. + When `share_crew` is enabled, additional data is collected which may contain personal information if included by the user. + Users should exercise caution when enabling this feature to ensure compliance with privacy regulations. + -CrewAI utilizes anonymous telemetry to gather usage statistics with the primary goal of enhancing the library. Our focus is on improving and developing the features, integrations, and tools most utilized by our users. +CrewAI utilizes anonymous telemetry to gather usage statistics with the primary goal of enhancing the library. +Our focus is on improving and developing the features, integrations, and tools most utilized by our users. -It's pivotal to understand that by default, **NO personal data is collected** concerning prompts, task descriptions, agents' backstories or goals, usage of tools, API calls, responses, any data processed by the agents, or secrets and environment variables. -When the `share_crew` feature is enabled, detailed data including task descriptions, agents' backstories or goals, and other specific attributes are collected to provide deeper insights. This expanded data collection may include personal information if users have incorporated it into their crews or tasks. Users should carefully consider the content of their crews and tasks before enabling `share_crew`. Users can disable telemetry by setting the environment variable OTEL_SDK_DISABLED to true. +It's pivotal to understand that by default, **NO personal data is collected** concerning prompts, task descriptions, agents' backstories or goals, +usage of tools, API calls, responses, any data processed by the agents, or secrets and environment variables. +When the `share_crew` feature is enabled, detailed data including task descriptions, agents' backstories or goals, and other specific attributes are collected +to provide deeper insights. This expanded data collection may include personal information if users have incorporated it into their crews or tasks. +Users should carefully consider the content of their crews and tasks before enabling `share_crew`. +Users can disable telemetry by setting the environment variable `OTEL_SDK_DISABLED` to `true`. ### Data Explanation: | Defaulted | Data | Reason and Specifics | @@ -34,10 +42,17 @@ When the `share_crew` feature is enabled, detailed data including task descripti | No | Crew and Task Inputs and Outputs | Includes: input parameters and output results as non-identifiable data. Users should ensure no personal info is included. | | No | Comprehensive Crew Execution Data | Includes: detailed logs of crew operations, all agents and tasks data, final output. All non-personal and technical in nature. | -Note: "No" in the "Defaulted" column indicates that this data is only collected when `share_crew` is set to `true`. + + "No" in the "Defaulted" column indicates that this data is only collected when `share_crew` is set to `true`. + ### Opt-In Further Telemetry Sharing -Users can choose to share their complete telemetry data by enabling the `share_crew` attribute to `True` in their crew configurations. Enabling `share_crew` results in the collection of detailed crew and task execution data, including `goal`, `backstory`, `context`, and `output` of tasks. This enables a deeper insight into usage patterns. -!!! warning "Potential Personal Information" - If you enable `share_crew`, the collected data may include personal information if it has been incorporated into crew configurations, task descriptions, or outputs. Users should carefully review their data and ensure compliance with GDPR and other applicable privacy regulations before enabling this feature. \ No newline at end of file +Users can choose to share their complete telemetry data by enabling the `share_crew` attribute to `True` in their crew configurations. +Enabling `share_crew` results in the collection of detailed crew and task execution data, including `goal`, `backstory`, `context`, and `output` of tasks. +This enables a deeper insight into usage patterns. + + + If you enable `share_crew`, the collected data may include personal information if it has been incorporated into crew configurations, task descriptions, or outputs. + Users should carefully review their data and ensure compliance with GDPR and other applicable privacy regulations before enabling this feature. + \ No newline at end of file diff --git a/docs/tools/BrowserbaseLoadTool.md b/docs/tools/BrowserbaseLoadTool.md deleted file mode 100644 index bd562da0d..000000000 --- a/docs/tools/BrowserbaseLoadTool.md +++ /dev/null @@ -1,38 +0,0 @@ -# BrowserbaseLoadTool - -## Description - -[Browserbase](https://browserbase.com) is a developer platform to reliably run, manage, and monitor headless browsers. - - Power your AI data retrievals with: - - [Serverless Infrastructure](https://docs.browserbase.com/under-the-hood) providing reliable browsers to extract data from complex UIs - - [Stealth Mode](https://docs.browserbase.com/features/stealth-mode) with included fingerprinting tactics and automatic captcha solving - - [Session Debugger](https://docs.browserbase.com/features/sessions) to inspect your Browser Session with networks timeline and logs - - [Live Debug](https://docs.browserbase.com/guides/session-debug-connection/browser-remote-control) to quickly debug your automation - -## Installation - -- Get an API key and Project ID from [browserbase.com](https://browserbase.com) and set it in environment variables (`BROWSERBASE_API_KEY`, `BROWSERBASE_PROJECT_ID`). -- Install the [Browserbase SDK](http://github.com/browserbase/python-sdk) along with `crewai[tools]` package: - -``` -pip install browserbase 'crewai[tools]' -``` - -## Example - -Utilize the BrowserbaseLoadTool as follows to allow your agent to load websites: - -```python -from crewai_tools import BrowserbaseLoadTool - -tool = BrowserbaseLoadTool() -``` - -## Arguments - -- `api_key` Optional. Browserbase API key. Default is `BROWSERBASE_API_KEY` env variable. -- `project_id` Optional. Browserbase Project ID. Default is `BROWSERBASE_PROJECT_ID` env variable. -- `text_content` Retrieve only text content. Default is `False`. -- `session_id` Optional. Provide an existing Session ID. -- `proxy` Optional. Enable/Disable Proxies." diff --git a/docs/tools/CSVSearchTool.md b/docs/tools/CSVSearchTool.md deleted file mode 100644 index 27db139e7..000000000 --- a/docs/tools/CSVSearchTool.md +++ /dev/null @@ -1,62 +0,0 @@ -# CSVSearchTool - -!!! note "Experimental" - We are still working on improving tools, so there might be unexpected behavior or changes in the future. - -## Description - -This tool is used to perform a RAG (Retrieval-Augmented Generation) search within a CSV file's content. It allows users to semantically search for queries in the content of a specified CSV file. This feature is particularly useful for extracting information from large CSV datasets where traditional search methods might be inefficient. All tools with "Search" in their name, including CSVSearchTool, are RAG tools designed for searching different sources of data. - -## Installation - -Install the crewai_tools package - -```shell -pip install 'crewai[tools]' -``` - -## Example - -```python -from crewai_tools import CSVSearchTool - -# Initialize the tool with a specific CSV file. This setup allows the agent to only search the given CSV file. -tool = CSVSearchTool(csv='path/to/your/csvfile.csv') - -# OR - -# Initialize the tool without a specific CSV file. Agent will need to provide the CSV path at runtime. -tool = CSVSearchTool() -``` - -## Arguments - -- `csv` : The path to the CSV file you want to search. This is a mandatory argument if the tool was initialized without a specific CSV file; otherwise, it is optional. - -## Custom model and embeddings - -By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: - -```python -tool = CSVSearchTool( - config=dict( - llm=dict( - provider="ollama", # or google, openai, anthropic, llama2, ... - config=dict( - model="llama2", - # temperature=0.5, - # top_p=1, - # stream=true, - ), - ), - embedder=dict( - provider="google", # or openai, ollama, ... - config=dict( - model="models/embedding-001", - task_type="retrieval_document", - # title="Embeddings", - ), - ), - ) -) -``` diff --git a/docs/tools/CodeDocsSearchTool.md b/docs/tools/CodeDocsSearchTool.md deleted file mode 100644 index 9454b6d8f..000000000 --- a/docs/tools/CodeDocsSearchTool.md +++ /dev/null @@ -1,65 +0,0 @@ -# CodeDocsSearchTool - -!!! note "Experimental" - We are still working on improving tools, so there might be unexpected behavior or changes in the future. - -## Description - -The CodeDocsSearchTool is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within code documentation. It enables users to efficiently find specific information or topics within code documentation. By providing a `docs_url` during initialization, the tool narrows down the search to that particular documentation site. Alternatively, without a specific `docs_url`, it searches across a wide array of code documentation known or discovered throughout its execution, making it versatile for various documentation search needs. - -## Installation - -To start using the CodeDocsSearchTool, first, install the crewai_tools package via pip: - -``` -pip install 'crewai[tools]' -``` - -## Example - -Utilize the CodeDocsSearchTool as follows to conduct searches within code documentation: - -```python -from crewai_tools import CodeDocsSearchTool - -# To search any code documentation content if the URL is known or discovered during its execution: -tool = CodeDocsSearchTool() - -# OR - -# To specifically focus your search on a given documentation site by providing its URL: -tool = CodeDocsSearchTool(docs_url='https://docs.example.com/reference') -``` -Note: Substitute 'https://docs.example.com/reference' with your target documentation URL and 'How to use search tool' with the search query relevant to your needs. - -## Arguments - -- `docs_url`: Optional. Specifies the URL of the code documentation to be searched. Providing this during the tool's initialization focuses the search on the specified documentation content. - -## Custom model and embeddings - -By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: - -```python -tool = CodeDocsSearchTool( - config=dict( - llm=dict( - provider="ollama", # or google, openai, anthropic, llama2, ... - config=dict( - model="llama2", - # temperature=0.5, - # top_p=1, - # stream=true, - ), - ), - embedder=dict( - provider="google", # or openai, ollama, ... - config=dict( - model="models/embedding-001", - task_type="retrieval_document", - # title="Embeddings", - ), - ), - ) -) -``` diff --git a/docs/tools/DirectoryReadTool.md b/docs/tools/DirectoryReadTool.md deleted file mode 100644 index fd5cdcaa2..000000000 --- a/docs/tools/DirectoryReadTool.md +++ /dev/null @@ -1,37 +0,0 @@ -```markdown -# DirectoryReadTool - -!!! note "Experimental" - We are still working on improving tools, so there might be unexpected behavior or changes in the future. - -## Description -The DirectoryReadTool is a powerful utility designed to provide a comprehensive listing of directory contents. It can recursively navigate through the specified directory, offering users a detailed enumeration of all files, including those within subdirectories. This tool is crucial for tasks that require a thorough inventory of directory structures or for validating the organization of files within directories. - -## Installation -To utilize the DirectoryReadTool in your project, install the `crewai_tools` package. If this package is not yet part of your environment, you can install it using pip with the command below: - -```shell -pip install 'crewai[tools]' -``` - -This command installs the latest version of the `crewai_tools` package, granting access to the DirectoryReadTool among other utilities. - -## Example -Employing the DirectoryReadTool is straightforward. The following code snippet demonstrates how to set it up and use the tool to list the contents of a specified directory: - -```python -from crewai_tools import DirectoryReadTool - -# Initialize the tool so the agent can read any directory's content it learns about during execution -tool = DirectoryReadTool() - -# OR - -# Initialize the tool with a specific directory, so the agent can only read the content of the specified directory -tool = DirectoryReadTool(directory='/path/to/your/directory') -``` - -## Arguments -The DirectoryReadTool requires minimal configuration for use. The essential argument for this tool is as follows: - -- `directory`: **Optional**. An argument that specifies the path to the directory whose contents you wish to list. It accepts both absolute and relative paths, guiding the tool to the desired directory for content listing. \ No newline at end of file diff --git a/docs/tools/EXASearchTool.md b/docs/tools/EXASearchTool.md deleted file mode 100644 index fe32a86b7..000000000 --- a/docs/tools/EXASearchTool.md +++ /dev/null @@ -1,36 +0,0 @@ -# EXASearchTool Documentation - -## Description - -The EXASearchTool is designed to perform a semantic search for a specified query from a text's content across the internet. It utilizes the [exa.ai](https://exa.ai/) API to fetch and display the most relevant search results based on the query provided by the user. - -## Installation - -To incorporate this tool into your project, follow the installation instructions below: - -```shell -pip install 'crewai[tools]' -``` - -## Example - -The following example demonstrates how to initialize the tool and execute a search with a given query: - -```python -from crewai_tools import EXASearchTool - -# Initialize the tool for internet searching capabilities -tool = EXASearchTool() -``` - -## Steps to Get Started - -To effectively use the EXASearchTool, follow these steps: - -1. **Package Installation**: Confirm that the `crewai[tools]` package is installed in your Python environment. -2. **API Key Acquisition**: Acquire a [exa.ai](https://exa.ai/) API key by registering for a free account at [exa.ai](https://exa.ai/). -3. **Environment Configuration**: Store your obtained API key in an environment variable named `EXA_API_KEY` to facilitate its use by the tool. - -## Conclusion - -By integrating the EXASearchTool into Python projects, users gain the ability to conduct real-time, relevant searches across the internet directly from their applications. By adhering to the setup and usage guidelines provided, incorporating this tool into projects is streamlined and straightforward. diff --git a/docs/tools/PGSearchTool.md b/docs/tools/PGSearchTool.md deleted file mode 100644 index 515cb2206..000000000 --- a/docs/tools/PGSearchTool.md +++ /dev/null @@ -1,60 +0,0 @@ -# PGSearchTool - -!!! note "Under Development" - The PGSearchTool is currently under development. This document outlines the intended functionality and interface. As development progresses, please be aware that some features may not be available or could change. - -## Description -The PGSearchTool is envisioned as a powerful tool for facilitating semantic searches within PostgreSQL database tables. By leveraging advanced Retrieve and Generate (RAG) technology, it aims to provide an efficient means for querying database table content, specifically tailored for PostgreSQL databases. The tool's goal is to simplify the process of finding relevant data through semantic search queries, offering a valuable resource for users needing to conduct advanced queries on extensive datasets within a PostgreSQL environment. - -## Installation -The `crewai_tools` package, which will include the PGSearchTool upon its release, can be installed using the following command: - -```shell -pip install 'crewai[tools]' -``` - -(Note: The PGSearchTool is not yet available in the current version of the `crewai_tools` package. This installation command will be updated once the tool is released.) - -## Example Usage -Below is a proposed example showcasing how to use the PGSearchTool for conducting a semantic search on a table within a PostgreSQL database: - -```python -from crewai_tools import PGSearchTool - -# Initialize the tool with the database URI and the target table name -tool = PGSearchTool(db_uri='postgresql://user:password@localhost:5432/mydatabase', table_name='employees') -``` - -## Arguments -The PGSearchTool is designed to require the following arguments for its operation: - -- `db_uri`: A string representing the URI of the PostgreSQL database to be queried. This argument will be mandatory and must include the necessary authentication details and the location of the database. -- `table_name`: A string specifying the name of the table within the database on which the semantic search will be performed. This argument will also be mandatory. - -## Custom Model and Embeddings - -The tool intends to use OpenAI for both embeddings and summarization by default. Users will have the option to customize the model using a config dictionary as follows: - -```python -tool = PGSearchTool( - config=dict( - llm=dict( - provider="ollama", # or google, openai, anthropic, llama2, ... - config=dict( - model="llama2", - # temperature=0.5, - # top_p=1, - # stream=true, - ), - ), - embedder=dict( - provider="google", # or openai, ollama, ... - config=dict( - model="models/embedding-001", - task_type="retrieval_document", - # title="Embeddings", - ), - ), - ) -) -``` diff --git a/docs/tools/ScrapeWebsiteTool.md b/docs/tools/ScrapeWebsiteTool.md deleted file mode 100644 index ae8be244a..000000000 --- a/docs/tools/ScrapeWebsiteTool.md +++ /dev/null @@ -1,31 +0,0 @@ -# ScrapeWebsiteTool - -!!! note "Experimental" - We are still working on improving tools, so there might be unexpected behavior or changes in the future. - -## Description -A tool designed to extract and read the content of a specified website. It is capable of handling various types of web pages by making HTTP requests and parsing the received HTML content. This tool can be particularly useful for web scraping tasks, data collection, or extracting specific information from websites. - -## Installation -Install the crewai_tools package -```shell -pip install 'crewai[tools]' -``` - -## Example -```python -from crewai_tools import ScrapeWebsiteTool - -# To enable scrapping any website it finds during it's execution -tool = ScrapeWebsiteTool() - -# Initialize the tool with the website URL, so the agent can only scrap the content of the specified website -tool = ScrapeWebsiteTool(website_url='https://www.example.com') - -# Extract the text from the site -text = tool.run() -print(text) -``` - -## Arguments -- `website_url` : Mandatory website URL to read the file. This is the primary input for the tool, specifying which website's content should be scraped and read. diff --git a/docs/tools/SeleniumScrapingTool.md b/docs/tools/SeleniumScrapingTool.md deleted file mode 100644 index 54925a716..000000000 --- a/docs/tools/SeleniumScrapingTool.md +++ /dev/null @@ -1,44 +0,0 @@ -# SeleniumScrapingTool - -!!! note "Experimental" - This tool is currently in development. As we refine its capabilities, users may encounter unexpected behavior. Your feedback is invaluable to us for making improvements. - -## Description -The SeleniumScrapingTool is crafted for high-efficiency web scraping tasks. It allows for precise extraction of content from web pages by using CSS selectors to target specific elements. Its design caters to a wide range of scraping needs, offering flexibility to work with any provided website URL. - -## Installation -To get started with the SeleniumScrapingTool, install the crewai_tools package using pip: - -``` -pip install 'crewai[tools]' -``` - -## Usage Examples -Below are some scenarios where the SeleniumScrapingTool can be utilized: - -```python -from crewai_tools import SeleniumScrapingTool - -# Example 1: Initialize the tool without any parameters to scrape the current page it navigates to -tool = SeleniumScrapingTool() - -# Example 2: Scrape the entire webpage of a given URL -tool = SeleniumScrapingTool(website_url='https://example.com') - -# Example 3: Target and scrape a specific CSS element from a webpage -tool = SeleniumScrapingTool(website_url='https://example.com', css_element='.main-content') - -# Example 4: Perform scraping with additional parameters for a customized experience -tool = SeleniumScrapingTool(website_url='https://example.com', css_element='.main-content', cookie={'name': 'user', 'value': 'John Doe'}, wait_time=10) -``` - -## Arguments -The following parameters can be used to customize the SeleniumScrapingTool's scraping process: - -- `website_url`: **Mandatory**. Specifies the URL of the website from which content is to be scraped. -- `css_element`: **Mandatory**. The CSS selector for a specific element to target on the website. This enables focused scraping of a particular part of a webpage. -- `cookie`: **Optional**. A dictionary that contains cookie information. Useful for simulating a logged-in session, thereby providing access to content that might be restricted to non-logged-in users. -- `wait_time`: **Optional**. Specifies the delay (in seconds) before the content is scraped. This delay allows for the website and any dynamic content to fully load, ensuring a successful scrape. - -!!! attention - Since the SeleniumScrapingTool is under active development, the parameters and functionality may evolve over time. Users are encouraged to keep the tool updated and report any issues or suggestions for enhancements. \ No newline at end of file diff --git a/docs/tools/SpiderTool.md b/docs/tools/SpiderTool.md deleted file mode 100644 index 603f224fc..000000000 --- a/docs/tools/SpiderTool.md +++ /dev/null @@ -1,81 +0,0 @@ -# SpiderTool - -## Description - -[Spider](https://spider.cloud/?ref=crewai) is the [fastest](https://github.com/spider-rs/spider/blob/main/benches/BENCHMARKS.md#benchmark-results) open source scraper and crawler that returns LLM-ready data. It converts any website into pure HTML, markdown, metadata or text while enabling you to crawl with custom actions using AI. - -## Installation - -To use the Spider API you need to download the [Spider SDK](https://pypi.org/project/spider-client/) and the crewai[tools] SDK too: - -```python -pip install spider-client 'crewai[tools]' -``` - -## Example - -This example shows you how you can use the Spider tool to enable your agent to scrape and crawl websites. The data returned from the Spider API is already LLM-ready, so no need to do any cleaning there. - -```python -from crewai_tools import SpiderTool - -def main(): - spider_tool = SpiderTool() - - searcher = Agent( - role="Web Research Expert", - goal="Find related information from specific URL's", - backstory="An expert web researcher that uses the web extremely well", - tools=[spider_tool], - verbose=True, - ) - - return_metadata = Task( - description="Scrape https://spider.cloud with a limit of 1 and enable metadata", - expected_output="Metadata and 10 word summary of spider.cloud", - agent=searcher - ) - - crew = Crew( - agents=[searcher], - tasks=[ - return_metadata, - ], - verbose=2 - ) - - crew.kickoff() - -if __name__ == "__main__": - main() -``` - -## Arguments - -- `api_key` (string, optional): Specifies Spider API key. If not specified, it looks for `SPIDER_API_KEY` in environment variables. -- `params` (object, optional): Optional parameters for the request. Defaults to `{"return_format": "markdown"}` to return the website's content in a format that fits LLMs better. - - `request` (string): The request type to perform. Possible values are `http`, `chrome`, and `smart`. Use `smart` to perform an HTTP request by default until JavaScript rendering is needed for the HTML. - - `limit` (int): The maximum number of pages allowed to crawl per website. Remove the value or set it to `0` to crawl all pages. - - `depth` (int): The crawl limit for maximum depth. If `0`, no limit will be applied. - - `cache` (bool): Use HTTP caching for the crawl to speed up repeated runs. Default is `true`. - - `budget` (object): Object that has paths with a counter for limiting the amount of pages example `{"*":1}` for only crawling the root page. - - `locale` (string): The locale to use for request, example `en-US`. - - `cookies` (string): Add HTTP cookies to use for request. - - `stealth` (bool): Use stealth mode for headless chrome request to help prevent being blocked. The default is `true` on chrome. - - `headers` (object): Forward HTTP headers to use for all request. The object is expected to be a map of key value pairs. - - `metadata` (bool): Boolean to store metadata about the pages and content found. This could help improve AI interopt. Defaults to `false` unless you have the website already stored with the configuration enabled. - - `viewport` (object): Configure the viewport for chrome. Defaults to `800x600`. - - `encoding` (string): The type of encoding to use like `UTF-8`, `SHIFT_JIS`, or etc. - - `subdomains` (bool): Allow subdomains to be included. Default is `false`. - - `user_agent` (string): Add a custom HTTP user agent to the request. By default this is set to a random agent. - - `store_data` (bool): Boolean to determine if storage should be used. If set this takes precedence over `storageless`. Defaults to `false`. - - `gpt_config` (object): Use AI to generate actions to perform during the crawl. You can pass an array for the `"prompt"` to chain steps. - - `fingerprint` (bool): Use advanced fingerprint for chrome. - - `storageless` (bool): Boolean to prevent storing any type of data for the request including storage and AI vectors embedding. Defaults to `false` unless you have the website already stored. - - `readability` (bool): Use [readability](https://github.com/mozilla/readability) to pre-process the content for reading. This may drastically improve the content for LLM usage. - `return_format` (string): The format to return the data in. Possible values are `markdown`, `raw`, `text`, and `html2text`. Use `raw` to return the default format of the page like HTML etc. - - `proxy_enabled` (bool): Enable high performance premium proxies for the request to prevent being blocked at the network level. - - `query_selector` (string): The CSS query selector to use when extracting content from the markup. - - `full_resources` (bool): Crawl and download all the resources for a website. - - `request_timeout` (int): The timeout to use for request. Timeouts can be from `5-60`. The default is `30` seconds. - - `run_in_background` (bool): Run the request in the background. Useful if storing data and wanting to trigger crawls to the dashboard. This has no effect if storageless is set. diff --git a/docs/tools/TXTSearchTool.md b/docs/tools/TXTSearchTool.md deleted file mode 100644 index e13fb543f..000000000 --- a/docs/tools/TXTSearchTool.md +++ /dev/null @@ -1,62 +0,0 @@ -# TXTSearchTool - -!!! note "Experimental" - We are still working on improving tools, so there might be unexpected behavior or changes in the future. - -## Description -This tool is used to perform a RAG (Retrieval-Augmented Generation) search within the content of a text file. It allows for semantic searching of a query within a specified text file's content, making it an invaluable resource for quickly extracting information or finding specific sections of text based on the query provided. - -## Installation -To use the TXTSearchTool, you first need to install the crewai_tools package. This can be done using pip, a package manager for Python. Open your terminal or command prompt and enter the following command: - -```shell -pip install 'crewai[tools]' -``` - -This command will download and install the TXTSearchTool along with any necessary dependencies. - -## Example -The following example demonstrates how to use the TXTSearchTool to search within a text file. This example shows both the initialization of the tool with a specific text file and the subsequent search within that file's content. - -```python -from crewai_tools import TXTSearchTool - -# Initialize the tool to search within any text file's content the agent learns about during its execution -tool = TXTSearchTool() - -# OR - -# Initialize the tool with a specific text file, so the agent can search within the given text file's content -tool = TXTSearchTool(txt='path/to/text/file.txt') -``` - -## Arguments -- `txt` (str): **Optional**. The path to the text file you want to search. This argument is only required if the tool was not initialized with a specific text file; otherwise, the search will be conducted within the initially provided text file. - -## Custom model and embeddings - -By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: - -```python -tool = TXTSearchTool( - config=dict( - llm=dict( - provider="ollama", # or google, openai, anthropic, llama2, ... - config=dict( - model="llama2", - # temperature=0.5, - # top_p=1, - # stream=true, - ), - ), - embedder=dict( - provider="google", # or openai, ollama, ... - config=dict( - model="models/embedding-001", - task_type="retrieval_document", - # title="Embeddings", - ), - ), - ) -) -``` diff --git a/docs/tools/VisionTool.md b/docs/tools/VisionTool.md deleted file mode 100644 index 5ed7f7d3c..000000000 --- a/docs/tools/VisionTool.md +++ /dev/null @@ -1,30 +0,0 @@ -# Vision Tool - -## Description - -This tool is used to extract text from images. When passed to the agent it will extract the text from the image and then use it to generate a response, report or any other output. The URL or the PATH of the image should be passed to the Agent. - - -## Installation -Install the crewai_tools package -```shell -pip install 'crewai[tools]' -``` - -## Usage - -In order to use the VisionTool, the OpenAI API key should be set in the environment variable `OPENAI_API_KEY`. - -```python -from crewai_tools import VisionTool - -vision_tool = VisionTool() - -@agent -def researcher(self) -> Agent: - return Agent( - config=self.agents_config["researcher"], - allow_delegation=False, - tools=[vision_tool] - ) -``` \ No newline at end of file diff --git a/docs/tools/browserbaseloadtool.mdx b/docs/tools/browserbaseloadtool.mdx new file mode 100644 index 000000000..329c3a0ad --- /dev/null +++ b/docs/tools/browserbaseloadtool.mdx @@ -0,0 +1,50 @@ +--- +title: Browserbase Web Loader +description: Browserbase is a developer platform to reliably run, manage, and monitor headless browsers. +icon: browser +--- + +# `BrowserbaseLoadTool` + +## Description + +[Browserbase](https://browserbase.com) is a developer platform to reliably run, manage, and monitor headless browsers. + +Power your AI data retrievals with: + + - [Serverless Infrastructure](https://docs.browserbase.com/under-the-hood) providing reliable browsers to extract data from complex UIs + - [Stealth Mode](https://docs.browserbase.com/features/stealth-mode) with included fingerprinting tactics and automatic captcha solving + - [Session Debugger](https://docs.browserbase.com/features/sessions) to inspect your Browser Session with networks timeline and logs + - [Live Debug](https://docs.browserbase.com/guides/session-debug-connection/browser-remote-control) to quickly debug your automation + +## Installation + +- Get an API key and Project ID from [browserbase.com](https://browserbase.com) and set it in environment variables (`BROWSERBASE_API_KEY`, `BROWSERBASE_PROJECT_ID`). +- Install the [Browserbase SDK](http://github.com/browserbase/python-sdk) along with `crewai[tools]` package: + +```shell +pip install browserbase 'crewai[tools]' +``` + +## Example + +Utilize the BrowserbaseLoadTool as follows to allow your agent to load websites: + +```python Code +from crewai_tools import BrowserbaseLoadTool + +# Initialize the tool with the Browserbase API key and Project ID +tool = BrowserbaseLoadTool() +``` + +## Arguments + +The following parameters can be used to customize the `BrowserbaseLoadTool`'s behavior: + +| Argument | Type | Description | +|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------| +| **api_key** | `string` | _Optional_. Browserbase API key. Default is `BROWSERBASE_API_KEY` env variable. | +| **project_id** | `string` | _Optional_. Browserbase Project ID. Default is `BROWSERBASE_PROJECT_ID` env variable. | +| **text_content** | `bool` | _Optional_. Retrieve only text content. Default is `False`. | +| **session_id** | `string` | _Optional_. Provide an existing Session ID. | +| **proxy** | `bool` | _Optional_. Enable/Disable Proxies. Default is `False`. | \ No newline at end of file diff --git a/docs/tools/codedocssearchtool.mdx b/docs/tools/codedocssearchtool.mdx new file mode 100644 index 000000000..83ab9270d --- /dev/null +++ b/docs/tools/codedocssearchtool.mdx @@ -0,0 +1,84 @@ +--- +title: Code Docs RAG Search +description: The `CodeDocsSearchTool` is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within code documentation. +icon: code +--- + +# `CodeDocsSearchTool` + + + **Experimental**: We are still working on improving tools, so there might be unexpected behavior or changes in the future. + + +## Description + +The CodeDocsSearchTool is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within code documentation. +It enables users to efficiently find specific information or topics within code documentation. By providing a `docs_url` during initialization, +the tool narrows down the search to that particular documentation site. Alternatively, without a specific `docs_url`, +it searches across a wide array of code documentation known or discovered throughout its execution, making it versatile for various documentation search needs. + +## Installation + +To start using the CodeDocsSearchTool, first, install the crewai_tools package via pip: + +```shell +pip install 'crewai[tools]' +``` + +## Example + +Utilize the CodeDocsSearchTool as follows to conduct searches within code documentation: + +```python Code +from crewai_tools import CodeDocsSearchTool + +# To search any code documentation content +# if the URL is known or discovered during its execution: +tool = CodeDocsSearchTool() + +# OR + +# To specifically focus your search on a given documentation site +# by providing its URL: +tool = CodeDocsSearchTool(docs_url='https://docs.example.com/reference') +``` + + Substitute 'https://docs.example.com/reference' with your target documentation URL + and 'How to use search tool' with the search query relevant to your needs. + + +## Arguments + +The following parameters can be used to customize the `CodeDocsSearchTool`'s behavior: + +| Argument | Type | Description | +|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------| +| **docs_url** | `string` | _Optional_. Specifies the URL of the code documentation to be searched. | + +## Custom model and embeddings + +By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: + +```python Code +tool = CodeDocsSearchTool( + config=dict( + llm=dict( + provider="ollama", # or google, openai, anthropic, llama2, ... + config=dict( + model="llama2", + # temperature=0.5, + # top_p=1, + # stream=true, + ), + ), + embedder=dict( + provider="google", # or openai, ollama, ... + config=dict( + model="models/embedding-001", + task_type="retrieval_document", + # title="Embeddings", + ), + ), + ) +) +``` \ No newline at end of file diff --git a/docs/tools/CodeInterpreterTool.md b/docs/tools/codeinterpretertool.mdx similarity index 54% rename from docs/tools/CodeInterpreterTool.md rename to docs/tools/codeinterpretertool.mdx index 94fe6bd96..3bdfefb73 100644 --- a/docs/tools/CodeInterpreterTool.md +++ b/docs/tools/codeinterpretertool.mdx @@ -1,25 +1,37 @@ -# CodeInterpreterTool +--- +title: Code Interpreter +description: The `CodeInterpreterTool` is a powerful tool designed for executing Python 3 code within a secure, isolated environment. +icon: code-simple +--- + +# `CodeInterpreterTool` ## Description + This tool enables the Agent to execute Python 3 code that it has generated autonomously. The code is run in a secure, isolated environment, ensuring safety regardless of the content. -This functionality is particularly valuable as it allows the Agent to create code, execute it within the same ecosystem, obtain the results, and utilize that information to inform subsequent decisions and actions. +This functionality is particularly valuable as it allows the Agent to create code, execute it within the same ecosystem, +obtain the results, and utilize that information to inform subsequent decisions and actions. ## Requirements - Docker ## Installation -Install the crewai_tools package + +Install the `crewai_tools` package + ```shell pip install 'crewai[tools]' ``` ## Example -Remember that when using this tool, the code must be generated by the Agent itself. The code must be a Python3 code. And it will take some time for the first time to run because it needs to build the Docker image. +Remember that when using this tool, the code must be generated by the Agent itself. +The code must be a Python3 code. And it will take some time for the first time to run +because it needs to build the Docker image. -```python +```python Code from crewai import Agent from crewai_tools import CodeInterpreterTool @@ -31,7 +43,7 @@ Agent( We also provide a simple way to use it directly from the Agent. -```python +```python Code from crewai import Agent agent = Agent( diff --git a/docs/tools/ComposioTool.md b/docs/tools/composiotool.mdx similarity index 81% rename from docs/tools/ComposioTool.md rename to docs/tools/composiotool.mdx index 929796de8..0ba1fcf60 100644 --- a/docs/tools/ComposioTool.md +++ b/docs/tools/composiotool.mdx @@ -1,8 +1,14 @@ -# ComposioTool Documentation +--- +title: Composio Tool +description: The `ComposioTool` is a wrapper around the composio set of tools and gives your agent access to a wide variety of tools from the Composio SDK. +icon: gear-code +--- + +# `ComposioTool` ## Description -This tools is a wrapper around the composio set of tools and gives your agent access to a wide variety of tools from the composio SDK. +This tools is a wrapper around the composio set of tools and gives your agent access to a wide variety of tools from the Composio SDK. ## Installation @@ -21,7 +27,7 @@ The following example demonstrates how to initialize the tool and execute a gith 1. Initialize Composio tools -```python +```python Code from composio import App from crewai_tools import ComposioTool from crewai import Agent, Task @@ -32,19 +38,19 @@ tools = [ComposioTool.from_action(action=Action.GITHUB_ACTIVITY_STAR_REPO_FOR_AU If you don't know what action you want to use, use `from_app` and `tags` filter to get relevant actions -```python +```python Code tools = ComposioTool.from_app(App.GITHUB, tags=["important"]) ``` or use `use_case` to search relevant actions -```python +```python Code tools = ComposioTool.from_app(App.GITHUB, use_case="Star a github repository") ``` 2. Define agent -```python +```python Code crewai_agent = Agent( role="Github Agent", goal="You take action on Github using Github APIs", @@ -59,7 +65,7 @@ crewai_agent = Agent( 3. Execute task -```python +```python Code task = Task( description="Star a repo ComposioHQ/composio on GitHub", agent=crewai_agent, @@ -69,4 +75,4 @@ task = Task( task.execute() ``` -* More detailed list of tools can be found [here](https://app.composio.dev) +* More detailed list of tools can be found [here](https://app.composio.dev) \ No newline at end of file diff --git a/docs/tools/csvsearchtool.mdx b/docs/tools/csvsearchtool.mdx new file mode 100644 index 000000000..af39c58cb --- /dev/null +++ b/docs/tools/csvsearchtool.mdx @@ -0,0 +1,77 @@ +--- +title: CSV RAG Search +description: The `CSVSearchTool` is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within a CSV file's content. +icon: file-csv +--- + +# `CSVSearchTool` + + + **Experimental**: We are still working on improving tools, so there might be unexpected behavior or changes in the future. + + +## Description + +This tool is used to perform a RAG (Retrieval-Augmented Generation) search within a CSV file's content. It allows users to semantically search for queries in the content of a specified CSV file. +This feature is particularly useful for extracting information from large CSV datasets where traditional search methods might be inefficient. All tools with "Search" in their name, including CSVSearchTool, +are RAG tools designed for searching different sources of data. + +## Installation + +Install the crewai_tools package + +```shell +pip install 'crewai[tools]' +``` + +## Example + +```python Code +from crewai_tools import CSVSearchTool + +# Initialize the tool with a specific CSV file. +# This setup allows the agent to only search the given CSV file. +tool = CSVSearchTool(csv='path/to/your/csvfile.csv') + +# OR + +# Initialize the tool without a specific CSV file. +# Agent will need to provide the CSV path at runtime. +tool = CSVSearchTool() +``` + +## Arguments + +The following parameters can be used to customize the `CSVSearchTool`'s behavior: + +| Argument | Type | Description | +|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------| +| **csv** | `string` | _Optional_. The path to the CSV file you want to search. This is a mandatory argument if the tool was initialized without a specific CSV file; otherwise, it is optional. | + +## Custom model and embeddings + +By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: + +```python Code +tool = CSVSearchTool( + config=dict( + llm=dict( + provider="ollama", # or google, openai, anthropic, llama2, ... + config=dict( + model="llama2", + # temperature=0.5, + # top_p=1, + # stream=true, + ), + ), + embedder=dict( + provider="google", # or openai, ollama, ... + config=dict( + model="models/embedding-001", + task_type="retrieval_document", + # title="Embeddings", + ), + ), + ) +) +``` \ No newline at end of file diff --git a/docs/tools/DALL-ETool.md b/docs/tools/dalletool.mdx similarity index 64% rename from docs/tools/DALL-ETool.md rename to docs/tools/dalletool.mdx index 8f65e78e5..839592750 100644 --- a/docs/tools/DALL-ETool.md +++ b/docs/tools/dalletool.mdx @@ -1,9 +1,18 @@ -# DALL-E Tool +--- +title: DALL-E Tool +description: The `DallETool` is a powerful tool designed for generating images from textual descriptions. +icon: image +--- + +# `DallETool` ## Description -This tool is used to give the Agent the ability to generate images using the DALL-E model. It is a transformer-based model that generates images from textual descriptions. This tool allows the Agent to generate images based on the text input provided by the user. + +This tool is used to give the Agent the ability to generate images using the DALL-E model. It is a transformer-based model that generates images from textual descriptions. +This tool allows the Agent to generate images based on the text input provided by the user. ## Installation + Install the crewai_tools package ```shell pip install 'crewai[tools]' @@ -13,7 +22,7 @@ pip install 'crewai[tools]' Remember that when using this tool, the text must be generated by the Agent itself. The text must be a description of the image you want to generate. -```python +```python Code from crewai_tools import DallETool Agent( @@ -24,7 +33,7 @@ Agent( If needed you can also tweak the parameters of the DALL-E model by passing them as arguments to the `DallETool` class. For example: -```python +```python Code from crewai_tools import DallETool dalle_tool = DallETool(model="dall-e-3", @@ -38,4 +47,5 @@ Agent( ) ``` -The parameters are based on the `client.images.generate` method from the OpenAI API. For more information on the parameters, please refer to the [OpenAI API documentation](https://platform.openai.com/docs/guides/images/introduction?lang=python). +The parameters are based on the `client.images.generate` method from the OpenAI API. For more information on the parameters, +please refer to the [OpenAI API documentation](https://platform.openai.com/docs/guides/images/introduction?lang=python). \ No newline at end of file diff --git a/docs/tools/directoryreadtool.mdx b/docs/tools/directoryreadtool.mdx new file mode 100644 index 000000000..d246dfaa5 --- /dev/null +++ b/docs/tools/directoryreadtool.mdx @@ -0,0 +1,53 @@ +--- +title: Directory Read +description: The `DirectoryReadTool` is a powerful utility designed to provide a comprehensive listing of directory contents. +icon: folder-tree +--- + +# `DirectoryReadTool` + + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + + +## Description + +The DirectoryReadTool is a powerful utility designed to provide a comprehensive listing of directory contents. +It can recursively navigate through the specified directory, offering users a detailed enumeration of all files, including those within subdirectories. +This tool is crucial for tasks that require a thorough inventory of directory structures or for validating the organization of files within directories. + +## Installation + +To utilize the DirectoryReadTool in your project, install the `crewai_tools` package. If this package is not yet part of your environment, you can install it using pip with the command below: + +```shell +pip install 'crewai[tools]' +``` + +This command installs the latest version of the `crewai_tools` package, granting access to the DirectoryReadTool among other utilities. + +## Example + +Employing the DirectoryReadTool is straightforward. The following code snippet demonstrates how to set it up and use the tool to list the contents of a specified directory: + +```python Code +from crewai_tools import DirectoryReadTool + +# Initialize the tool so the agent can read any directory's content +# it learns about during execution +tool = DirectoryReadTool() + +# OR + +# Initialize the tool with a specific directory, +# so the agent can only read the content of the specified directory +tool = DirectoryReadTool(directory='/path/to/your/directory') +``` + +## Arguments + +The following parameters can be used to customize the `DirectoryReadTool`'s behavior: + +| Argument | Type | Description | +|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------| +| **directory** | `string` | _Optional_. An argument that specifies the path to the directory whose contents you wish to list. It accepts both absolute and relative paths, guiding the tool to the desired directory for content listing. | diff --git a/docs/tools/DirectorySearchTool.md b/docs/tools/directorysearchtool.mdx similarity index 81% rename from docs/tools/DirectorySearchTool.md rename to docs/tools/directorysearchtool.mdx index 80cf673eb..e684fef39 100644 --- a/docs/tools/DirectorySearchTool.md +++ b/docs/tools/directorysearchtool.mdx @@ -1,12 +1,21 @@ -# DirectorySearchTool +--- +title: Directory RAG Search +description: The `DirectorySearchTool` is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within a directory's content. +icon: address-book +--- -!!! note "Experimental" - The DirectorySearchTool is under continuous development. Features and functionalities might evolve, and unexpected behavior may occur as we refine the tool. +# `DirectorySearchTool` + + + **Experimental**: The DirectorySearchTool is under continuous development. Features and functionalities might evolve, and unexpected behavior may occur as we refine the tool. + ## Description + The DirectorySearchTool enables semantic search within the content of specified directories, leveraging the Retrieval-Augmented Generation (RAG) methodology for efficient navigation through files. Designed for flexibility, it allows users to dynamically specify search directories at runtime or set a fixed directory during initial setup. ## Installation + To use the DirectorySearchTool, begin by installing the crewai_tools package. Execute the following command in your terminal: ```shell @@ -14,9 +23,10 @@ pip install 'crewai[tools]' ``` ## Initialization and Usage + Import the DirectorySearchTool from the `crewai_tools` package to start. You can initialize the tool without specifying a directory, enabling the setting of the search directory at runtime. Alternatively, the tool can be initialized with a predefined directory. -```python +```python Code from crewai_tools import DirectorySearchTool # For dynamic directory specification at runtime @@ -27,12 +37,14 @@ tool = DirectorySearchTool(directory='/path/to/directory') ``` ## Arguments + - `directory`: A string argument that specifies the search directory. This is optional during initialization but required for searches if not set initially. ## Custom Model and Embeddings + The DirectorySearchTool uses OpenAI for embeddings and summarization by default. Customization options for these settings include changing the model provider and configuration, enhancing flexibility for advanced users. -```python +```python Code tool = DirectorySearchTool( config=dict( llm=dict( diff --git a/docs/tools/DOCXSearchTool.md b/docs/tools/docxsearchtool.mdx similarity index 50% rename from docs/tools/DOCXSearchTool.md rename to docs/tools/docxsearchtool.mdx index 238ed81c0..c3a501dc6 100644 --- a/docs/tools/DOCXSearchTool.md +++ b/docs/tools/docxsearchtool.mdx @@ -1,12 +1,24 @@ -# DOCXSearchTool +--- +title: DOCX RAG Search +description: The `DOCXSearchTool` is a RAG tool designed for semantic searching within DOCX documents. +icon: file-word +--- -!!! note "Experimental" +# `DOCXSearchTool` + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + ## Description -The DOCXSearchTool is a RAG tool designed for semantic searching within DOCX documents. It enables users to effectively search and extract relevant information from DOCX files using query-based searches. This tool is invaluable for data analysis, information management, and research tasks, streamlining the process of finding specific information within large document collections. + +The `DOCXSearchTool` is a RAG tool designed for semantic searching within DOCX documents. +It enables users to effectively search and extract relevant information from DOCX files using query-based searches. +This tool is invaluable for data analysis, information management, and research tasks, +streamlining the process of finding specific information within large document collections. ## Installation + Install the crewai_tools package by running the following command in your terminal: ```shell @@ -14,9 +26,10 @@ pip install 'crewai[tools]' ``` ## Example + The following example demonstrates initializing the DOCXSearchTool to search within any DOCX file's content or with a specific DOCX file path. -```python +```python Code from crewai_tools import DOCXSearchTool # Initialize the tool to search within any DOCX file's content @@ -24,18 +37,24 @@ tool = DOCXSearchTool() # OR -# Initialize the tool with a specific DOCX file, so the agent can only search the content of the specified DOCX file +# Initialize the tool with a specific DOCX file, +# so the agent can only search the content of the specified DOCX file tool = DOCXSearchTool(docx='path/to/your/document.docx') ``` ## Arguments -- `docx`: An optional file path to a specific DOCX document you wish to search. If not provided during initialization, the tool allows for later specification of any DOCX file's content path for searching. + +The following parameters can be used to customize the `DOCXSearchTool`'s behavior: + +| Argument | Type | Description | +|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------| +| **docx** | `string` | _Optional_. An argument that specifies the path to the DOCX file you want to search. If not provided during initialization, the tool allows for later specification of any DOCX file's content path for searching. | ## Custom model and embeddings By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: -```python +```python Code tool = DOCXSearchTool( config=dict( llm=dict( @@ -57,4 +76,4 @@ tool = DOCXSearchTool( ), ) ) -``` +``` \ No newline at end of file diff --git a/docs/tools/exasearchtool.mdx b/docs/tools/exasearchtool.mdx new file mode 100644 index 000000000..ec93c5566 --- /dev/null +++ b/docs/tools/exasearchtool.mdx @@ -0,0 +1,52 @@ +--- +title: EXA Search Web Loader +description: The `EXASearchTool` is designed to perform a semantic search for a specified query from a text's content across the internet. +icon: globe-pointer +--- + +# `EXASearchTool` + +## Description + +The EXASearchTool is designed to perform a semantic search for a specified query from a text's content across the internet. +It utilizes the [exa.ai](https://exa.ai/) API to fetch and display the most relevant search results based on the query provided by the user. + +## Installation + +To incorporate this tool into your project, follow the installation instructions below: + +```shell +pip install 'crewai[tools]' +``` + +## Example + +The following example demonstrates how to initialize the tool and execute a search with a given query: + +```python Code +from crewai_tools import EXASearchTool + +# Initialize the tool for internet searching capabilities +tool = EXASearchTool() +``` + +## Steps to Get Started + +To effectively use the EXASearchTool, follow these steps: + + + + Confirm that the `crewai[tools]` package is installed in your Python environment. + + + Acquire a [exa.ai](https://exa.ai/) API key by registering for a free account at [exa.ai](https://exa.ai/). + + + Store your obtained API key in an environment variable named `EXA_API_KEY` to facilitate its use by the tool. + + + +## Conclusion + +By integrating the `EXASearchTool` into Python projects, users gain the ability to conduct real-time, relevant searches across the internet directly from their applications. +By adhering to the setup and usage guidelines provided, incorporating this tool into projects is streamlined and straightforward. diff --git a/docs/tools/FileReadTool.md b/docs/tools/filereadtool.mdx similarity index 63% rename from docs/tools/FileReadTool.md rename to docs/tools/filereadtool.mdx index dc4a2a356..90650c63c 100644 --- a/docs/tools/FileReadTool.md +++ b/docs/tools/filereadtool.mdx @@ -1,12 +1,24 @@ -# FileReadTool +--- +title: File Read +description: The `FileReadTool` is designed to read files from the local file system. +icon: folders +--- -!!! note "Experimental" +# `FileReadTool` + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + ## Description -The FileReadTool conceptually represents a suite of functionalities within the crewai_tools package aimed at facilitating file reading and content retrieval. This suite includes tools for processing batch text files, reading runtime configuration files, and importing data for analytics. It supports a variety of text-based file formats such as `.txt`, `.csv`, `.json`, and more. Depending on the file type, the suite offers specialized functionality, such as converting JSON content into a Python dictionary for ease of use. + +The FileReadTool conceptually represents a suite of functionalities within the crewai_tools package aimed at facilitating file reading and content retrieval. +This suite includes tools for processing batch text files, reading runtime configuration files, and importing data for analytics. +It supports a variety of text-based file formats such as `.txt`, `.csv`, `.json`, and more. Depending on the file type, the suite offers specialized functionality, +such as converting JSON content into a Python dictionary for ease of use. ## Installation + To utilize the functionalities previously attributed to the FileReadTool, install the crewai_tools package: ```shell @@ -14,9 +26,10 @@ pip install 'crewai[tools]' ``` ## Usage Example + To get started with the FileReadTool: -```python +```python Code from crewai_tools import FileReadTool # Initialize the tool to read any files the agents knows or lean the path for @@ -29,4 +42,5 @@ file_read_tool = FileReadTool(file_path='path/to/your/file.txt') ``` ## Arguments + - `file_path`: The path to the file you want to read. It accepts both absolute and relative paths. Ensure the file exists and you have the necessary permissions to access it. \ No newline at end of file diff --git a/docs/tools/FileWriteTool.md b/docs/tools/filewritetool.mdx similarity index 58% rename from docs/tools/FileWriteTool.md rename to docs/tools/filewritetool.mdx index 3425af003..f5dffb2ad 100644 --- a/docs/tools/FileWriteTool.md +++ b/docs/tools/filewritetool.mdx @@ -1,9 +1,19 @@ -# FileWriterTool Documentation +--- +title: File Write +description: The `FileWriterTool` is designed to write content to files. +icon: file-pen +--- + +# `FileWriterTool` ## Description -The `FileWriterTool` is a component of the crewai_tools package, designed to simplify the process of writing content to files. It is particularly useful in scenarios such as generating reports, saving logs, creating configuration files, and more. This tool supports creating new directories if they don't exist, making it easier to organize your output. + +The `FileWriterTool` is a component of the crewai_tools package, designed to simplify the process of writing content to files. +It is particularly useful in scenarios such as generating reports, saving logs, creating configuration files, and more. +This tool supports creating new directories if they don't exist, making it easier to organize your output. ## Installation + Install the crewai_tools package to use the `FileWriterTool` in your projects: ```shell @@ -11,9 +21,10 @@ pip install 'crewai[tools]' ``` ## Example + To get started with the `FileWriterTool`: -```python +```python Code from crewai_tools import FileWriterTool # Initialize the tool @@ -25,9 +36,13 @@ print(result) ``` ## Arguments + - `filename`: The name of the file you want to create or overwrite. - `content`: The content to write into the file. - `directory` (optional): The path to the directory where the file will be created. Defaults to the current directory (`.`). If the directory does not exist, it will be created. ## Conclusion -By integrating the `FileWriterTool` into your crews, the agents can execute the process of writing content to files and creating directories. This tool is essential for tasks that require saving output data, creating structured file systems, and more. By adhering to the setup and usage guidelines provided, incorporating this tool into projects is straightforward and efficient. + +By integrating the `FileWriterTool` into your crews, the agents can execute the process of writing content to files and creating directories. +This tool is essential for tasks that require saving output data, creating structured file systems, and more. By adhering to the setup and usage guidelines provided, +incorporating this tool into projects is straightforward and efficient. \ No newline at end of file diff --git a/docs/tools/FirecrawlCrawlWebsiteTool.md b/docs/tools/firecrawlcrawlwebsitetool.mdx similarity index 89% rename from docs/tools/FirecrawlCrawlWebsiteTool.md rename to docs/tools/firecrawlcrawlwebsitetool.mdx index 46d011602..ddc28f92b 100644 --- a/docs/tools/FirecrawlCrawlWebsiteTool.md +++ b/docs/tools/firecrawlcrawlwebsitetool.mdx @@ -1,4 +1,10 @@ -# FirecrawlCrawlWebsiteTool +--- +title: Firecrawl Crawl Website +description: The `FirecrawlCrawlWebsiteTool` is designed to crawl and convert websites into clean markdown or structured data. +icon: fire-flame +--- + +# `FirecrawlCrawlWebsiteTool` ## Description @@ -9,7 +15,7 @@ - Get an API key from [firecrawl.dev](https://firecrawl.dev) and set it in environment variables (`FIRECRAWL_API_KEY`). - Install the [Firecrawl SDK](https://github.com/mendableai/firecrawl) along with `crewai[tools]` package: -``` +```shell pip install firecrawl-py 'crewai[tools]' ``` @@ -17,7 +23,7 @@ pip install firecrawl-py 'crewai[tools]' Utilize the FirecrawlScrapeFromWebsiteTool as follows to allow your agent to load websites: -```python +```python Code from crewai_tools import FirecrawlCrawlWebsiteTool tool = FirecrawlCrawlWebsiteTool(url='firecrawl.dev') @@ -39,4 +45,3 @@ tool = FirecrawlCrawlWebsiteTool(url='firecrawl.dev') - `mode`: Optional. The crawling mode to use. Fast mode crawls 4x faster on websites without a sitemap but may not be as accurate and shouldn't be used on heavily JavaScript-rendered websites. - `limit`: Optional. Maximum number of pages to crawl. - `timeout`: Optional. Timeout in milliseconds for the crawling operation. - diff --git a/docs/tools/FirecrawlScrapeWebsiteTool.md b/docs/tools/firecrawlscrapewebsitetool.mdx similarity index 85% rename from docs/tools/FirecrawlScrapeWebsiteTool.md rename to docs/tools/firecrawlscrapewebsitetool.mdx index 93570f06b..54b08642c 100644 --- a/docs/tools/FirecrawlScrapeWebsiteTool.md +++ b/docs/tools/firecrawlscrapewebsitetool.mdx @@ -1,4 +1,10 @@ -# FirecrawlScrapeWebsiteTool +--- +title: Firecrawl Scrape Website +description: The `FirecrawlScrapeWebsiteTool` is designed to scrape websites and convert them into clean markdown or structured data. +icon: fire-flame +--- + +# `FirecrawlScrapeWebsiteTool` ## Description @@ -9,7 +15,7 @@ - Get an API key from [firecrawl.dev](https://firecrawl.dev) and set it in environment variables (`FIRECRAWL_API_KEY`). - Install the [Firecrawl SDK](https://github.com/mendableai/firecrawl) along with `crewai[tools]` package: -``` +```shell pip install firecrawl-py 'crewai[tools]' ``` @@ -17,7 +23,7 @@ pip install firecrawl-py 'crewai[tools]' Utilize the FirecrawlScrapeWebsiteTool as follows to allow your agent to load websites: -```python +```python Code from crewai_tools import FirecrawlScrapeWebsiteTool tool = FirecrawlScrapeWebsiteTool(url='firecrawl.dev') @@ -35,4 +41,3 @@ tool = FirecrawlScrapeWebsiteTool(url='firecrawl.dev') - `extractionPrompt`: Optional. A prompt describing what information to extract from the page - `extractionSchema`: Optional. The schema for the data to be extracted - `timeout`: Optional. Timeout in milliseconds for the request - diff --git a/docs/tools/FirecrawlSearchTool.md b/docs/tools/firecrawlsearchtool.mdx similarity index 85% rename from docs/tools/FirecrawlSearchTool.md rename to docs/tools/firecrawlsearchtool.mdx index effb3f3d4..545489f2c 100644 --- a/docs/tools/FirecrawlSearchTool.md +++ b/docs/tools/firecrawlsearchtool.mdx @@ -1,4 +1,10 @@ -# FirecrawlSearchTool +--- +title: Firecrawl Search +description: The `FirecrawlSearchTool` is designed to search websites and convert them into clean markdown or structured data. +icon: fire-flame +--- + +# `FirecrawlSearchTool` ## Description @@ -9,7 +15,7 @@ - Get an API key from [firecrawl.dev](https://firecrawl.dev) and set it in environment variables (`FIRECRAWL_API_KEY`). - Install the [Firecrawl SDK](https://github.com/mendableai/firecrawl) along with `crewai[tools]` package: -``` +```shell pip install firecrawl-py 'crewai[tools]' ``` @@ -17,7 +23,7 @@ pip install firecrawl-py 'crewai[tools]' Utilize the FirecrawlSearchTool as follows to allow your agent to load websites: -```python +```python Code from crewai_tools import FirecrawlSearchTool tool = FirecrawlSearchTool(query='what is firecrawl?') diff --git a/docs/tools/GitHubSearchTool.md b/docs/tools/githubsearchtool.mdx similarity index 81% rename from docs/tools/GitHubSearchTool.md rename to docs/tools/githubsearchtool.mdx index 3995054a4..6fd0e686a 100644 --- a/docs/tools/GitHubSearchTool.md +++ b/docs/tools/githubsearchtool.mdx @@ -1,12 +1,21 @@ -# GithubSearchTool +--- +title: Github Search +description: The `GithubSearchTool` is designed to search websites and convert them into clean markdown or structured data. +icon: github +--- -!!! note "Experimental" +# `GithubSearchTool` + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + ## Description + The GithubSearchTool is a Retrieval-Augmented Generation (RAG) tool specifically designed for conducting semantic searches within GitHub repositories. Utilizing advanced semantic search capabilities, it sifts through code, pull requests, issues, and repositories, making it an essential tool for developers, researchers, or anyone in need of precise information from GitHub. ## Installation + To use the GithubSearchTool, first ensure the crewai_tools package is installed in your Python environment: ```shell @@ -16,8 +25,10 @@ pip install 'crewai[tools]' This command installs the necessary package to run the GithubSearchTool along with any other tools included in the crewai_tools package. ## Example + Here’s how you can use the GithubSearchTool to perform semantic searches within a GitHub repository: -```python + +```python Code from crewai_tools import GithubSearchTool # Initialize the tool for semantic searches within a specific GitHub repository @@ -35,14 +46,17 @@ tool = GithubSearchTool( ``` ## Arguments + - `github_repo` : The URL of the GitHub repository where the search will be conducted. This is a mandatory field and specifies the target repository for your search. -- `content_types` : Specifies the types of content to include in your search. You must provide a list of content types from the following options: `code` for searching within the code, `repo` for searching within the repository's general information, `pr` for searching within pull requests, and `issue` for searching within issues. This field is mandatory and allows tailoring the search to specific content types within the GitHub repository. +- `content_types` : Specifies the types of content to include in your search. You must provide a list of content types from the following options: `code` for searching within the code, +`repo` for searching within the repository's general information, `pr` for searching within pull requests, and `issue` for searching within issues. +This field is mandatory and allows tailoring the search to specific content types within the GitHub repository. ## Custom model and embeddings By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: -```python +```python Code tool = GithubSearchTool( config=dict( llm=dict( @@ -64,4 +78,4 @@ tool = GithubSearchTool( ), ) ) -``` +``` \ No newline at end of file diff --git a/docs/tools/JSONSearchTool.md b/docs/tools/jsonsearchtool.mdx similarity index 87% rename from docs/tools/JSONSearchTool.md rename to docs/tools/jsonsearchtool.mdx index 55ad14c4c..38267ff73 100644 --- a/docs/tools/JSONSearchTool.md +++ b/docs/tools/jsonsearchtool.mdx @@ -1,12 +1,22 @@ -# JSONSearchTool +--- +title: JSON RAG Search +description: The `JSONSearchTool` is designed to search JSON files and return the most relevant results. +icon: file-code +--- -!!! note "Experimental Status" - The JSONSearchTool is currently in an experimental phase. This means the tool is under active development, and users might encounter unexpected behavior or changes. We highly encourage feedback on any issues or suggestions for improvements. +# `JSONSearchTool` + + + The JSONSearchTool is currently in an experimental phase. This means the tool is under active development, and users might encounter unexpected behavior or changes. + We highly encourage feedback on any issues or suggestions for improvements. + ## Description + The JSONSearchTool is designed to facilitate efficient and precise searches within JSON file contents. It utilizes a RAG (Retrieve and Generate) search mechanism, allowing users to specify a JSON path for targeted searches within a particular JSON file. This capability significantly improves the accuracy and relevance of search results. ## Installation + To install the JSONSearchTool, use the following pip command: ```shell @@ -14,9 +24,10 @@ pip install 'crewai[tools]' ``` ## Usage Examples + Here are updated examples on how to utilize the JSONSearchTool effectively for searching within JSON files. These examples take into account the current implementation and usage patterns identified in the codebase. -```python +```python Code from crewai.json_tools import JSONSearchTool # Updated import path # General JSON content search @@ -29,12 +40,14 @@ tool = JSONSearchTool(json_path='./path/to/your/file.json') ``` ## Arguments + - `json_path` (str, optional): Specifies the path to the JSON file to be searched. This argument is not required if the tool is initialized for a general search. When provided, it confines the search to the specified JSON file. ## Configuration Options + The JSONSearchTool supports extensive customization through a configuration dictionary. This allows users to select different models for embeddings and summarization based on their requirements. -```python +```python Code tool = JSONSearchTool( config={ "llm": { diff --git a/docs/tools/MDXSearchTool.md b/docs/tools/mdxsearchtool.mdx similarity index 91% rename from docs/tools/MDXSearchTool.md rename to docs/tools/mdxsearchtool.mdx index ee9a43a75..fbf5dc340 100644 --- a/docs/tools/MDXSearchTool.md +++ b/docs/tools/mdxsearchtool.mdx @@ -1,12 +1,21 @@ -# MDXSearchTool +--- +title: MDX RAG Search +description: The `MDXSearchTool` is designed to search MDX files and return the most relevant results. +icon: markdown +--- -!!! note "Experimental" +# `MDXSearchTool` + + The MDXSearchTool is in continuous development. Features may be added or removed, and functionality could change unpredictably as we refine the tool. + ## Description + The MDX Search Tool is a component of the `crewai_tools` package aimed at facilitating advanced markdown language extraction. It enables users to effectively search and extract relevant information from MD files using query-based searches. This tool is invaluable for data analysis, information management, and research tasks, streamlining the process of finding specific information within large document collections. ## Installation + Before using the MDX Search Tool, ensure the `crewai_tools` package is installed. If it is not, you can install it with the following command: ```shell @@ -14,9 +23,10 @@ pip install 'crewai[tools]' ``` ## Usage Example + To use the MDX Search Tool, you must first set up the necessary environment variables. Then, integrate the tool into your crewAI project to begin your market research. Below is a basic example of how to do this: -```python +```python Code from crewai_tools import MDXSearchTool # Initialize the tool to search any MDX content it learns about during execution @@ -29,13 +39,14 @@ tool = MDXSearchTool(mdx='path/to/your/document.mdx') ``` ## Parameters + - mdx: **Optional**. Specifies the MDX file path for the search. It can be provided during initialization. ## Customization of Model and Embeddings The tool defaults to using OpenAI for embeddings and summarization. For customization, utilize a configuration dictionary as shown below: -```python +```python Code tool = MDXSearchTool( config=dict( llm=dict( @@ -59,4 +70,4 @@ tool = MDXSearchTool( ), ) ) -``` +``` \ No newline at end of file diff --git a/docs/tools/MySQLTool.md b/docs/tools/mysqltool.mdx similarity index 71% rename from docs/tools/MySQLTool.md rename to docs/tools/mysqltool.mdx index b31d7120b..99caf1d37 100644 --- a/docs/tools/MySQLTool.md +++ b/docs/tools/mysqltool.mdx @@ -1,9 +1,20 @@ -# MySQLSearchTool +--- +title: MySQL RAG Search +description: The `MySQLSearchTool` is designed to search MySQL databases and return the most relevant results. +icon: database +--- + +# `MySQLSearchTool` ## Description -This tool is designed to facilitate semantic searches within MySQL database tables. Leveraging the RAG (Retrieve and Generate) technology, the MySQLSearchTool provides users with an efficient means of querying database table content, specifically tailored for MySQL databases. It simplifies the process of finding relevant data through semantic search queries, making it an invaluable resource for users needing to perform advanced queries on extensive datasets within a MySQL database. + +This tool is designed to facilitate semantic searches within MySQL database tables. Leveraging the RAG (Retrieve and Generate) technology, +the MySQLSearchTool provides users with an efficient means of querying database table content, specifically tailored for MySQL databases. +It simplifies the process of finding relevant data through semantic search queries, making it an invaluable resource for users needing +to perform advanced queries on extensive datasets within a MySQL database. ## Installation + To install the `crewai_tools` package and utilize the MySQLSearchTool, execute the following command in your terminal: ```shell @@ -11,17 +22,21 @@ pip install 'crewai[tools]' ``` ## Example + Below is an example showcasing how to use the MySQLSearchTool to conduct a semantic search on a table within a MySQL database: -```python +```python Code from crewai_tools import MySQLSearchTool # Initialize the tool with the database URI and the target table name -tool = MySQLSearchTool(db_uri='mysql://user:password@localhost:3306/mydatabase', table_name='employees') - +tool = MySQLSearchTool( + db_uri='mysql://user:password@localhost:3306/mydatabase', + table_name='employees' +) ``` ## Arguments + The MySQLSearchTool requires the following arguments for its operation: - `db_uri`: A string representing the URI of the MySQL database to be queried. This argument is mandatory and must include the necessary authentication details and the location of the database. @@ -31,7 +46,7 @@ The MySQLSearchTool requires the following arguments for its operation: By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: -```python +```python Code tool = MySQLSearchTool( config=dict( llm=dict( @@ -53,4 +68,4 @@ tool = MySQLSearchTool( ), ) ) -``` +``` \ No newline at end of file diff --git a/docs/tools/NL2SQLTool.md b/docs/tools/nl2sqltool.mdx similarity index 89% rename from docs/tools/NL2SQLTool.md rename to docs/tools/nl2sqltool.mdx index c442d1f96..ebf535847 100644 --- a/docs/tools/NL2SQLTool.md +++ b/docs/tools/nl2sqltool.mdx @@ -1,10 +1,17 @@ -# NL2SQL Tool +--- +title: NL2SQL Tool +description: The `NL2SQLTool` is designed to convert natural language to SQL queries. +icon: language +--- + +# `NL2SQLTool` ## Description This tool is used to convert natural language to SQL queries. When passsed to the agent it will generate queries and then use them to interact with the database. -This enables multiple workflows like having an Agent to access the database fetch information based on the goal and then use the information to generate a response, report or any other output. Along with that proivdes the ability for the Agent to update the database based on its goal. +This enables multiple workflows like having an Agent to access the database fetch information based on the goal and then use the information to generate a response, report or any other output. +Along with that proivdes the ability for the Agent to update the database based on its goal. **Attention**: Make sure that the Agent has access to a Read-Replica or that is okay for the Agent to run insert/update queries on the database. @@ -14,7 +21,9 @@ This enables multiple workflows like having an Agent to access the database fetc - Any DB compatible library (e.g. psycopg2, mysql-connector-python) ## Installation + Install the crewai_tools package + ```shell pip install 'crewai[tools]' ``` @@ -24,7 +33,7 @@ pip install 'crewai[tools]' In order to use the NL2SQLTool, you need to pass the database URI to the tool. The URI should be in the format `dialect+driver://username:password@host:port/database`. -```python +```python Code from crewai_tools import NL2SQLTool # psycopg2 was installed to run this example with PostgreSQL @@ -43,7 +52,8 @@ def researcher(self) -> Agent: The primary task goal was: -"Retrieve the average, maximum, and minimum monthly revenue for each city, but only include cities that have more than one user. Also, count the number of user in each city and sort the results by the average monthly revenue in descending order" +"Retrieve the average, maximum, and minimum monthly revenue for each city, but only include cities that have more than one user. Also, count the number of user in each city and +sort the results by the average monthly revenue in descending order" So the Agent tried to get information from the DB, the first one is wrong so the Agent tries again and gets the correct information and passes to the next agent. @@ -69,6 +79,6 @@ This is a simple example of how the NL2SQLTool can be used to interact with the The Tool provides endless possibilities on the logic of the Agent and how it can interact with the database. -``` +```md DB -> Agent -> ... -> Agent -> DB -``` +``` \ No newline at end of file diff --git a/docs/tools/PDFSearchTool.md b/docs/tools/pdfsearchtool.mdx similarity index 84% rename from docs/tools/PDFSearchTool.md rename to docs/tools/pdfsearchtool.mdx index 6a7423f67..0937165eb 100644 --- a/docs/tools/PDFSearchTool.md +++ b/docs/tools/pdfsearchtool.mdx @@ -1,12 +1,22 @@ -# PDFSearchTool +--- +title: PDF RAG Search +description: The `PDFSearchTool` is designed to search PDF files and return the most relevant results. +icon: file-pdf +--- -!!! note "Experimental" +# `PDFSearchTool` + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + ## Description -The PDFSearchTool is a RAG tool designed for semantic searches within PDF content. It allows for inputting a search query and a PDF document, leveraging advanced search techniques to find relevant content efficiently. This capability makes it especially useful for extracting specific information from large PDF files quickly. + +The PDFSearchTool is a RAG tool designed for semantic searches within PDF content. It allows for inputting a search query and a PDF document, leveraging advanced search techniques to find relevant content efficiently. +This capability makes it especially useful for extracting specific information from large PDF files quickly. ## Installation + To get started with the PDFSearchTool, first, ensure the crewai_tools package is installed with the following command: ```shell @@ -16,7 +26,7 @@ pip install 'crewai[tools]' ## Example Here's how to use the PDFSearchTool to search within a PDF document: -```python +```python Code from crewai_tools import PDFSearchTool # Initialize the tool allowing for any PDF content search if the path is provided during execution @@ -29,13 +39,14 @@ tool = PDFSearchTool(pdf='path/to/your/document.pdf') ``` ## Arguments + - `pdf`: **Optional** The PDF path for the search. Can be provided at initialization or within the `run` method's arguments. If provided at initialization, the tool confines its search to the specified document. ## Custom model and embeddings By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: -```python +```python Code tool = PDFSearchTool( config=dict( llm=dict( @@ -57,4 +68,4 @@ tool = PDFSearchTool( ), ) ) -``` +``` \ No newline at end of file diff --git a/docs/tools/pgsearchtool.mdx b/docs/tools/pgsearchtool.mdx new file mode 100644 index 000000000..c93233c7d --- /dev/null +++ b/docs/tools/pgsearchtool.mdx @@ -0,0 +1,82 @@ +--- +title: PG RAG Search +description: The `PGSearchTool` is designed to search PostgreSQL databases and return the most relevant results. +icon: database +--- + +# `PGSearchTool` + + + The PGSearchTool is currently under development. This document outlines the intended functionality and interface. + As development progresses, please be aware that some features may not be available or could change. + + +## Description + +The PGSearchTool is envisioned as a powerful tool for facilitating semantic searches within PostgreSQL database tables. By leveraging advanced Retrieve and Generate (RAG) technology, +it aims to provide an efficient means for querying database table content, specifically tailored for PostgreSQL databases. +The tool's goal is to simplify the process of finding relevant data through semantic search queries, offering a valuable resource for users needing to conduct advanced queries on +extensive datasets within a PostgreSQL environment. + +## Installation + +The `crewai_tools` package, which will include the PGSearchTool upon its release, can be installed using the following command: + +```shell +pip install 'crewai[tools]' +``` + + + The PGSearchTool is not yet available in the current version of the `crewai_tools` package. This installation command will be updated once the tool is released. + + +## Example Usage + +Below is a proposed example showcasing how to use the PGSearchTool for conducting a semantic search on a table within a PostgreSQL database: + +```python Code +from crewai_tools import PGSearchTool + +# Initialize the tool with the database URI and the target table name +tool = PGSearchTool( + db_uri='postgresql://user:password@localhost:5432/mydatabase', + table_name='employees' +) +``` + +## Arguments + +The PGSearchTool is designed to require the following arguments for its operation: + +| Argument | Type | Description | +|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------| +| **db_uri** | `string` | **Mandatory**. A string representing the URI of the PostgreSQL database to be queried. This argument will be mandatory and must include the necessary authentication details and the location of the database. | +| **table_name** | `string` | **Mandatory**. A string specifying the name of the table within the database on which the semantic search will be performed. This argument will also be mandatory. | + +## Custom Model and Embeddings + +The tool intends to use OpenAI for both embeddings and summarization by default. Users will have the option to customize the model using a config dictionary as follows: + +```python Code +tool = PGSearchTool( + config=dict( + llm=dict( + provider="ollama", # or google, openai, anthropic, llama2, ... + config=dict( + model="llama2", + # temperature=0.5, + # top_p=1, + # stream=true, + ), + ), + embedder=dict( + provider="google", # or openai, ollama, ... + config=dict( + model="models/embedding-001", + task_type="retrieval_document", + # title="Embeddings", + ), + ), + ) +) +``` \ No newline at end of file diff --git a/docs/tools/scrapewebsitetool.mdx b/docs/tools/scrapewebsitetool.mdx new file mode 100644 index 000000000..36ae2a133 --- /dev/null +++ b/docs/tools/scrapewebsitetool.mdx @@ -0,0 +1,47 @@ +--- +title: Scrape Website +description: The `ScrapeWebsiteTool` is designed to extract and read the content of a specified website. +icon: magnifying-glass-location +--- + +# `ScrapeWebsiteTool` + + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + + +## Description + +A tool designed to extract and read the content of a specified website. It is capable of handling various types of web pages by making HTTP requests and parsing the received HTML content. +This tool can be particularly useful for web scraping tasks, data collection, or extracting specific information from websites. + +## Installation + +Install the crewai_tools package + +```shell +pip install 'crewai[tools]' +``` + +## Example + +```python +from crewai_tools import ScrapeWebsiteTool + +# To enable scrapping any website it finds during it's execution +tool = ScrapeWebsiteTool() + +# Initialize the tool with the website URL, +# so the agent can only scrap the content of the specified website +tool = ScrapeWebsiteTool(website_url='https://www.example.com') + +# Extract the text from the site +text = tool.run() +print(text) +``` + +## Arguments + +| Argument | Type | Description | +|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------| +| **website_url** | `string` | **Mandatory** website URL to read the file. This is the primary input for the tool, specifying which website's content should be scraped and read. | diff --git a/docs/tools/seleniumscrapingtool.mdx b/docs/tools/seleniumscrapingtool.mdx new file mode 100644 index 000000000..0681f222c --- /dev/null +++ b/docs/tools/seleniumscrapingtool.mdx @@ -0,0 +1,76 @@ +--- +title: Selenium Scraper +description: The `SeleniumScrapingTool` is designed to extract and read the content of a specified website using Selenium. +icon: clipboard-user +--- + +# `SeleniumScrapingTool` + + + This tool is currently in development. As we refine its capabilities, users may encounter unexpected behavior. + Your feedback is invaluable to us for making improvements. + + +## Description + +The SeleniumScrapingTool is crafted for high-efficiency web scraping tasks. +It allows for precise extraction of content from web pages by using CSS selectors to target specific elements. +Its design caters to a wide range of scraping needs, offering flexibility to work with any provided website URL. + +## Installation + +To get started with the SeleniumScrapingTool, install the crewai_tools package using pip: + +```shell +pip install 'crewai[tools]' +``` + +## Usage Examples + +Below are some scenarios where the SeleniumScrapingTool can be utilized: + +```python Code +from crewai_tools import SeleniumScrapingTool + +# Example 1: +# Initialize the tool without any parameters to scrape +# the current page it navigates to +tool = SeleniumScrapingTool() + +# Example 2: +# Scrape the entire webpage of a given URL +tool = SeleniumScrapingTool(website_url='https://example.com') + +# Example 3: +# Target and scrape a specific CSS element from a webpage +tool = SeleniumScrapingTool( + website_url='https://example.com', + css_element='.main-content' +) + +# Example 4: +# Perform scraping with additional parameters for a customized experience +tool = SeleniumScrapingTool( + website_url='https://example.com', + css_element='.main-content', + cookie={'name': 'user', 'value': 'John Doe'}, + wait_time=10 +) +``` + +## Arguments + +The following parameters can be used to customize the SeleniumScrapingTool's scraping process: + +| Argument | Type | Description | +|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------| +| **website_url** | `string` | **Mandatory**. Specifies the URL of the website from which content is to be scraped. | +| **css_element** | `string` | **Mandatory**. The CSS selector for a specific element to target on the website, enabling focused scraping of a particular part of a webpage. | +| **cookie** | `object` | **Optional**. A dictionary containing cookie information, useful for simulating a logged-in session to access restricted content. | +| **wait_time** | `int` | **Optional**. Specifies the delay (in seconds) before scraping, allowing the website and any dynamic content to fully load. | + + + + Since the `SeleniumScrapingTool` is under active development, the parameters and functionality may evolve over time. + Users are encouraged to keep the tool updated and report any issues or suggestions for enhancements. + diff --git a/docs/tools/SerperDevTool.md b/docs/tools/serperdevtool.mdx similarity index 84% rename from docs/tools/SerperDevTool.md rename to docs/tools/serperdevtool.mdx index 9fbdb8f3b..5756044c6 100644 --- a/docs/tools/SerperDevTool.md +++ b/docs/tools/serperdevtool.mdx @@ -1,21 +1,33 @@ -# SerperDevTool Documentation +--- +title: Google Serper Search +description: The `SerperDevTool` is designed to search the internet and return the most relevant results. +icon: google +--- -!!! note "Experimental" +# `SerperDevTool` + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + ## Description -This tool is designed to perform a semantic search for a specified query from a text's content across the internet. It utilizes the [serper.dev](https://serper.dev) API to fetch and display the most relevant search results based on the query provided by the user. + +This tool is designed to perform a semantic search for a specified query from a text's content across the internet. It utilizes the [serper.dev](https://serper.dev) API +to fetch and display the most relevant search results based on the query provided by the user. ## Installation + To incorporate this tool into your project, follow the installation instructions below: + ```shell pip install 'crewai[tools]' ``` ## Example + The following example demonstrates how to initialize the tool and execute a search with a given query: -```python +```python Code from crewai_tools import SerperDevTool # Initialize the tool for internet searching capabilities @@ -23,6 +35,7 @@ tool = SerperDevTool() ``` ## Steps to Get Started + To effectively use the `SerperDevTool`, follow these steps: 1. **Package Installation**: Confirm that the `crewai[tools]` package is installed in your Python environment. @@ -43,9 +56,10 @@ The `SerperDevTool` comes with several parameters that will be passed to the API The values for `country`, `location`, `locale` and `search_url` can be found on the [Serper Playground](https://serper.dev/playground). ## Example with Parameters + Here is an example demonstrating how to use the tool with additional parameters: -```python +```python Code from crewai_tools import SerperDevTool tool = SerperDevTool( @@ -68,7 +82,7 @@ print(tool.run(search_query="ChatGPT")) ``` -```python +```python Code from crewai_tools import SerperDevTool tool = SerperDevTool( @@ -90,8 +104,9 @@ print(tool.run(search_query="Jeux Olympiques")) # Link: https://tickets.paris2024.org/ # Snippet: Achetez vos billets exclusivement sur le site officiel de la billetterie de Paris 2024 pour participer au plus grand Γ©vΓ©nement sportif au monde. # --- - ``` ## Conclusion -By integrating the `SerperDevTool` into Python projects, users gain the ability to conduct real-time, relevant searches across the internet directly from their applications. The updated parameters allow for more customized and localized search results. By adhering to the setup and usage guidelines provided, incorporating this tool into projects is streamlined and straightforward. + +By integrating the `SerperDevTool` into Python projects, users gain the ability to conduct real-time, relevant searches across the internet directly from their applications. +The updated parameters allow for more customized and localized search results. By adhering to the setup and usage guidelines provided, incorporating this tool into projects is streamlined and straightforward. diff --git a/docs/tools/spidertool.mdx b/docs/tools/spidertool.mdx new file mode 100644 index 000000000..4953e9cd6 --- /dev/null +++ b/docs/tools/spidertool.mdx @@ -0,0 +1,92 @@ +--- +title: Spider Scraper +description: The `SpiderTool` is designed to extract and read the content of a specified website using Spider. +icon: spider-web +--- + +# `SpiderTool` + +## Description + +[Spider](https://spider.cloud/?ref=crewai) is the [fastest](https://github.com/spider-rs/spider/blob/main/benches/BENCHMARKS.md#benchmark-results) +open source scraper and crawler that returns LLM-ready data. +It converts any website into pure HTML, markdown, metadata or text while enabling you to crawl with custom actions using AI. + +## Installation + +To use the `SpiderTool` you need to download the [Spider SDK](https://pypi.org/project/spider-client/) +and the `crewai[tools]` SDK too: + +```shell +pip install spider-client 'crewai[tools]' +``` + +## Example + +This example shows you how you can use the `SpiderTool` to enable your agent to scrape and crawl websites. +The data returned from the Spider API is already LLM-ready, so no need to do any cleaning there. + +```python Code +from crewai_tools import SpiderTool + +def main(): + spider_tool = SpiderTool() + + searcher = Agent( + role="Web Research Expert", + goal="Find related information from specific URL's", + backstory="An expert web researcher that uses the web extremely well", + tools=[spider_tool], + verbose=True, + ) + + return_metadata = Task( + description="Scrape https://spider.cloud with a limit of 1 and enable metadata", + expected_output="Metadata and 10 word summary of spider.cloud", + agent=searcher + ) + + crew = Crew( + agents=[searcher], + tasks=[ + return_metadata, + ], + verbose=2 + ) + + crew.kickoff() + +if __name__ == "__main__": + main() +``` + +## Arguments +| Argument | Type | Description | +|:------------------|:---------|:-----------------------------------------------------------------------------------------------------------------------------------------------------| +| **api_key** | `string` | Specifies Spider API key. If not specified, it looks for `SPIDER_API_KEY` in environment variables. | +| **params** | `object` | Optional parameters for the request. Defaults to `{"return_format": "markdown"}` to optimize content for LLMs. | +| **request** | `string` | Type of request to perform (`http`, `chrome`, `smart`). `smart` defaults to HTTP, switching to JavaScript rendering if needed. | +| **limit** | `int` | Max pages to crawl per website. Set to `0` or omit for unlimited. | +| **depth** | `int` | Max crawl depth. Set to `0` for no limit. | +| **cache** | `bool` | Enables HTTP caching to speed up repeated runs. Default is `true`. | +| **budget** | `object` | Sets path-based limits for crawled pages, e.g., `{"*":1}` for root page only. | +| **locale** | `string` | Locale for the request, e.g., `en-US`. | +| **cookies** | `string` | HTTP cookies for the request. | +| **stealth** | `bool` | Enables stealth mode for Chrome requests to avoid detection. Default is `true`. | +| **headers** | `object` | HTTP headers as a map of key-value pairs for all requests. | +| **metadata** | `bool` | Stores metadata about pages and content, aiding AI interoperability. Defaults to `false`. | +| **viewport** | `object` | Sets Chrome viewport dimensions. Default is `800x600`. | +| **encoding** | `string` | Specifies encoding type, e.g., `UTF-8`, `SHIFT_JIS`. | +| **subdomains** | `bool` | Includes subdomains in the crawl. Default is `false`. | +| **user_agent** | `string` | Custom HTTP user agent. Defaults to a random agent. | +| **store_data** | `bool` | Enables data storage for the request. Overrides `storageless` when set. Default is `false`. | +| **gpt_config** | `object` | Allows AI to generate crawl actions, with optional chaining steps via an array for `"prompt"`. | +| **fingerprint** | `bool` | Enables advanced fingerprinting for Chrome. | +| **storageless** | `bool` | Prevents all data storage, including AI embeddings. Default is `false`. | +| **readability** | `bool` | Pre-processes content for reading via [Mozilla’s readability](https://github.com/mozilla/readability). Improves content for LLMs. | +| **return_format** | `string` | Format to return data: `markdown`, `raw`, `text`, `html2text`. Use `raw` for default page format. | +| **proxy_enabled** | `bool` | Enables high-performance proxies to avoid network-level blocking. | +| **query_selector** | `string` | CSS query selector for content extraction from markup. | +| **full_resources** | `bool` | Downloads all resources linked to the website. | +| **request_timeout** | `int` | Timeout in seconds for requests (5-60). Default is `30`. | +| **run_in_background** | `bool` | Runs the request in the background, useful for data storage and triggering dashboard crawls. No effect if `storageless` is set. | \ No newline at end of file diff --git a/docs/tools/txtsearchtool.mdx b/docs/tools/txtsearchtool.mdx new file mode 100644 index 000000000..b7db23faa --- /dev/null +++ b/docs/tools/txtsearchtool.mdx @@ -0,0 +1,82 @@ +--- +title: TXT RAG Search +description: The `TXTSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a text file. +icon: file-lines +--- + +# `TXTSearchTool` + + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + + +## Description + +This tool is used to perform a RAG (Retrieval-Augmented Generation) search within the content of a text file. +It allows for semantic searching of a query within a specified text file's content, +making it an invaluable resource for quickly extracting information or finding specific sections of text based on the query provided. + +## Installation + +To use the `TXTSearchTool`, you first need to install the `crewai_tools` package. +This can be done using pip, a package manager for Python. +Open your terminal or command prompt and enter the following command: + +```shell +pip install 'crewai[tools]' +``` + +This command will download and install the TXTSearchTool along with any necessary dependencies. + +## Example + +The following example demonstrates how to use the TXTSearchTool to search within a text file. +This example shows both the initialization of the tool with a specific text file and the subsequent search within that file's content. + +```python Code +from crewai_tools import TXTSearchTool + +# Initialize the tool to search within any text file's content +# the agent learns about during its execution +tool = TXTSearchTool() + +# OR + +# Initialize the tool with a specific text file, +# so the agent can search within the given text file's content +tool = TXTSearchTool(txt='path/to/text/file.txt') +``` + +## Arguments +- `txt` (str): **Optional**. The path to the text file you want to search. +This argument is only required if the tool was not initialized with a specific text file; +otherwise, the search will be conducted within the initially provided text file. + +## Custom model and embeddings + +By default, the tool uses OpenAI for both embeddings and summarization. +To customize the model, you can use a config dictionary as follows: + +```python Code +tool = TXTSearchTool( + config=dict( + llm=dict( + provider="ollama", # or google, openai, anthropic, llama2, ... + config=dict( + model="llama2", + # temperature=0.5, + # top_p=1, + # stream=true, + ), + ), + embedder=dict( + provider="google", # or openai, ollama, ... + config=dict( + model="models/embedding-001", + task_type="retrieval_document", + # title="Embeddings", + ), + ), + ) +) +``` \ No newline at end of file diff --git a/docs/tools/visiontool.mdx b/docs/tools/visiontool.mdx new file mode 100644 index 000000000..83856e34b --- /dev/null +++ b/docs/tools/visiontool.mdx @@ -0,0 +1,50 @@ +--- +title: Vision Tool +description: The `VisionTool` is designed to extract text from images. +icon: eye +--- + +# `VisionTool` + +## Description + +This tool is used to extract text from images. When passed to the agent it will extract the text from the image and then use it to generate a response, report or any other output. +The URL or the PATH of the image should be passed to the Agent. + + +## Installation + +Install the crewai_tools package +```shell +pip install 'crewai[tools]' +``` + +## Usage + +In order to use the VisionTool, the OpenAI API key should be set in the environment variable `OPENAI_API_KEY`. + +```python Code +from crewai_tools import VisionTool + +vision_tool = VisionTool() + +@agent +def researcher(self) -> Agent: + ''' + This agent uses the VisionTool to extract text from images. + ''' + return Agent( + config=self.agents_config["researcher"], + allow_delegation=False, + tools=[vision_tool] + ) +``` + +## Arguments + +The VisionTool requires the following arguments: + +| Argument | Type | Description | +|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------| +| **image_path** | `string` | **Mandatory**. The path to the image file from which text needs to be extracted. | + diff --git a/docs/tools/WebsiteSearchTool.md b/docs/tools/websitesearchtool.mdx similarity index 67% rename from docs/tools/WebsiteSearchTool.md rename to docs/tools/websitesearchtool.mdx index a8a0a4562..961e9fddd 100644 --- a/docs/tools/WebsiteSearchTool.md +++ b/docs/tools/websitesearchtool.mdx @@ -1,12 +1,24 @@ -# WebsiteSearchTool +--- +title: Website RAG Search +description: The `WebsiteSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a website. +icon: globe-stand +--- -!!! note "Experimental Status" +# `WebsiteSearchTool` + + The WebsiteSearchTool is currently in an experimental phase. We are actively working on incorporating this tool into our suite of offerings and will update the documentation accordingly. + ## Description -The WebsiteSearchTool is designed as a concept for conducting semantic searches within the content of websites. It aims to leverage advanced machine learning models like Retrieval-Augmented Generation (RAG) to navigate and extract information from specified URLs efficiently. This tool intends to offer flexibility, allowing users to perform searches across any website or focus on specific websites of interest. Please note, the current implementation details of the WebsiteSearchTool are under development, and its functionalities as described may not yet be accessible. + +The WebsiteSearchTool is designed as a concept for conducting semantic searches within the content of websites. +It aims to leverage advanced machine learning models like Retrieval-Augmented Generation (RAG) to navigate and extract information from specified URLs efficiently. +This tool intends to offer flexibility, allowing users to perform searches across any website or focus on specific websites of interest. +Please note, the current implementation details of the WebsiteSearchTool are under development, and its functionalities as described may not yet be accessible. ## Installation + To prepare your environment for when the WebsiteSearchTool becomes available, you can install the foundational package with: ```shell @@ -16,26 +28,31 @@ pip install 'crewai[tools]' This command installs the necessary dependencies to ensure that once the tool is fully integrated, users can start using it immediately. ## Example Usage + Below are examples of how the WebsiteSearchTool could be utilized in different scenarios. Please note, these examples are illustrative and represent planned functionality: -```python +```python Code from crewai_tools import WebsiteSearchTool -# Example of initiating tool that agents can use to search across any discovered websites +# Example of initiating tool that agents can use +# to search across any discovered websites tool = WebsiteSearchTool() -# Example of limiting the search to the content of a specific website, so now agents can only search within that website +# Example of limiting the search to the content of a specific website, +# so now agents can only search within that website tool = WebsiteSearchTool(website='https://example.com') ``` ## Arguments + - `website`: An optional argument intended to specify the website URL for focused searches. This argument is designed to enhance the tool's flexibility by allowing targeted searches when necessary. ## Customization Options + By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: -```python +```python Code tool = WebsiteSearchTool( config=dict( llm=dict( diff --git a/docs/tools/XMLSearchTool.md b/docs/tools/xmlsearchtool.mdx similarity index 52% rename from docs/tools/XMLSearchTool.md rename to docs/tools/xmlsearchtool.mdx index 05fc32cda..717e6bc2b 100644 --- a/docs/tools/XMLSearchTool.md +++ b/docs/tools/xmlsearchtool.mdx @@ -1,12 +1,23 @@ -# XMLSearchTool +--- +title: XML RAG Search +description: The `XMLSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a XML file. +icon: file-xml +--- -!!! note "Experimental" +# `XMLSearchTool` + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + ## Description -The XMLSearchTool is a cutting-edge RAG tool engineered for conducting semantic searches within XML files. Ideal for users needing to parse and extract information from XML content efficiently, this tool supports inputting a search query and an optional XML file path. By specifying an XML path, users can target their search more precisely to the content of that file, thereby obtaining more relevant search outcomes. + +The XMLSearchTool is a cutting-edge RAG tool engineered for conducting semantic searches within XML files. +Ideal for users needing to parse and extract information from XML content efficiently, this tool supports inputting a search query and an optional XML file path. +By specifying an XML path, users can target their search more precisely to the content of that file, thereby obtaining more relevant search outcomes. ## Installation + To start using the XMLSearchTool, you must first install the crewai_tools package. This can be easily done with the following command: ```shell @@ -14,28 +25,34 @@ pip install 'crewai[tools]' ``` ## Example -Here are two examples demonstrating how to use the XMLSearchTool. The first example shows searching within a specific XML file, while the second example illustrates initiating a search without predefining an XML path, providing flexibility in search scope. -```python +Here are two examples demonstrating how to use the XMLSearchTool. +The first example shows searching within a specific XML file, while the second example illustrates initiating a search without predefining an XML path, providing flexibility in search scope. + +```python Code from crewai_tools import XMLSearchTool -# Allow agents to search within any XML file's content as it learns about their paths during execution +# Allow agents to search within any XML file's content +#as it learns about their paths during execution tool = XMLSearchTool() # OR -# Initialize the tool with a specific XML file path for exclusive search within that document +# Initialize the tool with a specific XML file path +#for exclusive search within that document tool = XMLSearchTool(xml='path/to/your/xmlfile.xml') ``` ## Arguments -- `xml`: This is the path to the XML file you wish to search. It is an optional parameter during the tool's initialization but must be provided either at initialization or as part of the `run` method's arguments to execute a search. + +- `xml`: This is the path to the XML file you wish to search. +It is an optional parameter during the tool's initialization but must be provided either at initialization or as part of the `run` method's arguments to execute a search. ## Custom model and embeddings By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: -```python +```python Code tool = XMLSearchTool( config=dict( llm=dict( @@ -57,4 +74,4 @@ tool = XMLSearchTool( ), ) ) -``` +``` \ No newline at end of file diff --git a/docs/tools/YoutubeChannelSearchTool.md b/docs/tools/youtubechannelsearchtool.mdx similarity index 68% rename from docs/tools/YoutubeChannelSearchTool.md rename to docs/tools/youtubechannelsearchtool.mdx index bcf9b7eb6..f14badaac 100644 --- a/docs/tools/YoutubeChannelSearchTool.md +++ b/docs/tools/youtubechannelsearchtool.mdx @@ -1,12 +1,24 @@ -# YoutubeChannelSearchTool +--- +title: YouTube Channel RAG Search +description: The `YoutubeChannelSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a Youtube channel. +icon: youtube +--- -!!! note "Experimental" +# `YoutubeChannelSearchTool` + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + ## Description -This tool is designed to perform semantic searches within a specific Youtube channel's content. Leveraging the RAG (Retrieval-Augmented Generation) methodology, it provides relevant search results, making it invaluable for extracting information or finding specific content without the need to manually sift through videos. It streamlines the search process within Youtube channels, catering to researchers, content creators, and viewers seeking specific information or topics. + +This tool is designed to perform semantic searches within a specific Youtube channel's content. +Leveraging the RAG (Retrieval-Augmented Generation) methodology, it provides relevant search results, +making it invaluable for extracting information or finding specific content without the need to manually sift through videos. +It streamlines the search process within Youtube channels, catering to researchers, content creators, and viewers seeking specific information or topics. ## Installation + To utilize the YoutubeChannelSearchTool, the `crewai_tools` package must be installed. Execute the following command in your shell to install: ```shell @@ -14,9 +26,11 @@ pip install 'crewai[tools]' ``` ## Example -To begin using the YoutubeChannelSearchTool, follow the example below. This demonstrates initializing the tool with a specific Youtube channel handle and conducting a search within that channel's content. -```python +To begin using the YoutubeChannelSearchTool, follow the example below. +This demonstrates initializing the tool with a specific Youtube channel handle and conducting a search within that channel's content. + +```python Code from crewai_tools import YoutubeChannelSearchTool # Initialize the tool to search within any Youtube channel's content the agent learns about during its execution @@ -29,13 +43,14 @@ tool = YoutubeChannelSearchTool(youtube_channel_handle='@exampleChannel') ``` ## Arguments + - `youtube_channel_handle` : A mandatory string representing the Youtube channel handle. This parameter is crucial for initializing the tool to specify the channel you want to search within. The tool is designed to only search within the content of the provided channel handle. ## Custom model and embeddings By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: -```python +```python Code tool = YoutubeChannelSearchTool( config=dict( llm=dict( @@ -57,4 +72,4 @@ tool = YoutubeChannelSearchTool( ), ) ) -``` +``` \ No newline at end of file diff --git a/docs/tools/YoutubeVideoSearchTool.md b/docs/tools/youtubevideosearchtool.mdx similarity index 54% rename from docs/tools/YoutubeVideoSearchTool.md rename to docs/tools/youtubevideosearchtool.mdx index 593cc5091..99237e92b 100644 --- a/docs/tools/YoutubeVideoSearchTool.md +++ b/docs/tools/youtubevideosearchtool.mdx @@ -1,32 +1,49 @@ -# YoutubeVideoSearchTool +--- +title: YouTube Video RAG Search +description: The `YoutubeVideoSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a Youtube video. +icon: youtube +--- -!!! note "Experimental" +# `YoutubeVideoSearchTool` + + We are still working on improving tools, so there might be unexpected behavior or changes in the future. + ## Description -This tool is part of the `crewai_tools` package and is designed to perform semantic searches within Youtube video content, utilizing Retrieval-Augmented Generation (RAG) techniques. It is one of several "Search" tools in the package that leverage RAG for different sources. The YoutubeVideoSearchTool allows for flexibility in searches; users can search across any Youtube video content without specifying a video URL, or they can target their search to a specific Youtube video by providing its URL. +This tool is part of the `crewai_tools` package and is designed to perform semantic searches within Youtube video content, utilizing Retrieval-Augmented Generation (RAG) techniques. +It is one of several "Search" tools in the package that leverage RAG for different sources. +The YoutubeVideoSearchTool allows for flexibility in searches; users can search across any Youtube video content without specifying a video URL, +or they can target their search to a specific Youtube video by providing its URL. ## Installation -To utilize the YoutubeVideoSearchTool, you must first install the `crewai_tools` package. This package contains the YoutubeVideoSearchTool among other utilities designed to enhance your data analysis and processing tasks. Install the package by executing the following command in your terminal: +To utilize the `YoutubeVideoSearchTool`, you must first install the `crewai_tools` package. +This package contains the `YoutubeVideoSearchTool` among other utilities designed to enhance your data analysis and processing tasks. +Install the package by executing the following command in your terminal: -``` +```shell pip install 'crewai[tools]' ``` ## Example -To integrate the YoutubeVideoSearchTool into your Python projects, follow the example below. This demonstrates how to use the tool both for general Youtube content searches and for targeted searches within a specific video's content. +To integrate the YoutubeVideoSearchTool into your Python projects, follow the example below. +This demonstrates how to use the tool both for general Youtube content searches and for targeted searches within a specific video's content. -```python +```python Code from crewai_tools import YoutubeVideoSearchTool -# General search across Youtube content without specifying a video URL, so the agent can search within any Youtube video content it learns about irs url during its operation +# General search across Youtube content without specifying a video URL, +# so the agent can search within any Youtube video content +# it learns about its url during its operation tool = YoutubeVideoSearchTool() # Targeted search within a specific Youtube video's content -tool = YoutubeVideoSearchTool(youtube_video_url='https://youtube.com/watch?v=example') +tool = YoutubeVideoSearchTool( + youtube_video_url='https://youtube.com/watch?v=example' +) ``` ## Arguments @@ -39,7 +56,7 @@ The YoutubeVideoSearchTool accepts the following initialization arguments: By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows: -```python +```python Code tool = YoutubeVideoSearchTool( config=dict( llm=dict( @@ -61,4 +78,4 @@ tool = YoutubeVideoSearchTool( ), ) ) -``` +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index fbdfffb0c..1b6c1f959 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -209,7 +209,7 @@ extra: provider: google property: G-N3Q505TMQ6 social: - - icon: fontawesome/brands/twitter + - icon: fontawesome/brands/x-twitter link: https://x.com/crewAIInc - icon: fontawesome/brands/github link: https://github.com/crewAIInc/crewAI diff --git a/poetry.lock b/poetry.lock index 7d711d4de..094b84664 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2,20 +2,20 @@ [[package]] name = "agentops" -version = "0.3.12" +version = "0.3.13" description = "Observability and DevTool Platform for AI Agents" optional = true python-versions = ">=3.7" files = [ - {file = "agentops-0.3.12-py3-none-any.whl", hash = "sha256:4767def30de5dd97397728efcb50398a4f6d6823c1b534846f0a9b0cb85a6d45"}, - {file = "agentops-0.3.12.tar.gz", hash = "sha256:11ce3048656b5d146d02a4890dd50c8d2801ca5ad5caccab17d573cd8eea6e83"}, + {file = "agentops-0.3.13-py3-none-any.whl", hash = "sha256:81bfdfedd990fbc3064ee42a67422ddbee07b6cd96c5fca7e124eb8c1e0cebdc"}, + {file = "agentops-0.3.13.tar.gz", hash = "sha256:319b7325fb79004ce996191aa21f0982489be22cc1acc2f3f6d02cdff1db2429"}, ] [package.dependencies] packaging = "23.2" psutil = "5.9.8" -PyYAML = "6.0.1" -requests = "2.31.0" +PyYAML = ">=5.3,<7.0" +requests = ">=2.0.0,<3.0.0" termcolor = "2.4.0" [package.extras] @@ -35,102 +35,102 @@ files = [ [[package]] name = "aiohttp" -version = "3.10.8" +version = "3.10.10" description = "Async http client/server framework (asyncio)" optional = false python-versions = ">=3.8" files = [ - {file = "aiohttp-3.10.8-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a1ba7bc139592339ddeb62c06486d0fa0f4ca61216e14137a40d626c81faf10c"}, - {file = "aiohttp-3.10.8-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:85e4d7bd05d18e4b348441e7584c681eff646e3bf38f68b2626807f3add21aa2"}, - {file = "aiohttp-3.10.8-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:69de056022e7abf69cb9fec795515973cc3eeaff51e3ea8d72a77aa933a91c52"}, - {file = "aiohttp-3.10.8-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ee3587506898d4a404b33bd19689286ccf226c3d44d7a73670c8498cd688e42c"}, - {file = "aiohttp-3.10.8-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:fe285a697c851734285369614443451462ce78aac2b77db23567507484b1dc6f"}, - {file = "aiohttp-3.10.8-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:10c7932337285a6bfa3a5fe1fd4da90b66ebfd9d0cbd1544402e1202eb9a8c3e"}, - {file = "aiohttp-3.10.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cd9716ef0224fe0d0336997eb242f40619f9f8c5c57e66b525a1ebf9f1d8cebe"}, - {file = "aiohttp-3.10.8-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ceacea31f8a55cdba02bc72c93eb2e1b77160e91f8abd605969c168502fd71eb"}, - {file = "aiohttp-3.10.8-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:9721554bfa9e15f6e462da304374c2f1baede3cb06008c36c47fa37ea32f1dc4"}, - {file = "aiohttp-3.10.8-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:22cdeb684d8552490dd2697a5138c4ecb46f844892df437aaf94f7eea99af879"}, - {file = "aiohttp-3.10.8-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:e56bb7e31c4bc79956b866163170bc89fd619e0581ce813330d4ea46921a4881"}, - {file = "aiohttp-3.10.8-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:3a95d2686bc4794d66bd8de654e41b5339fab542b2bca9238aa63ed5f4f2ce82"}, - {file = "aiohttp-3.10.8-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:d82404a0e7b10e0d7f022cf44031b78af8a4f99bd01561ac68f7c24772fed021"}, - {file = "aiohttp-3.10.8-cp310-cp310-win32.whl", hash = "sha256:4e10b04542d27e21538e670156e88766543692a0a883f243ba8fad9ddea82e53"}, - {file = "aiohttp-3.10.8-cp310-cp310-win_amd64.whl", hash = "sha256:680dbcff5adc7f696ccf8bf671d38366a1f620b5616a1d333d0cb33956065395"}, - {file = "aiohttp-3.10.8-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:33a68011a38020ed4ff41ae0dbf4a96a202562ecf2024bdd8f65385f1d07f6ef"}, - {file = "aiohttp-3.10.8-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6c7efa6616a95e3bd73b8a69691012d2ef1f95f9ea0189e42f338fae080c2fc6"}, - {file = "aiohttp-3.10.8-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:ddb9b9764cfb4459acf01c02d2a59d3e5066b06a846a364fd1749aa168efa2be"}, - {file = "aiohttp-3.10.8-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3c7f270f4ca92760f98a42c45a58674fff488e23b144ec80b1cc6fa2effed377"}, - {file = "aiohttp-3.10.8-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6984dda9d79064361ab58d03f6c1e793ea845c6cfa89ffe1a7b9bb400dfd56bd"}, - {file = "aiohttp-3.10.8-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3f6d47e392c27206701565c8df4cac6ebed28fdf6dcaea5b1eea7a4631d8e6db"}, - {file = "aiohttp-3.10.8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a72f89aea712c619b2ca32c6f4335c77125ede27530ad9705f4f349357833695"}, - {file = "aiohttp-3.10.8-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c36074b26f3263879ba8e4dbd33db2b79874a3392f403a70b772701363148b9f"}, - {file = "aiohttp-3.10.8-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:e32148b4a745e70a255a1d44b5664de1f2e24fcefb98a75b60c83b9e260ddb5b"}, - {file = "aiohttp-3.10.8-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:5aa1a073514cf59c81ad49a4ed9b5d72b2433638cd53160fd2f3a9cfa94718db"}, - {file = "aiohttp-3.10.8-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:d3a79200a9d5e621c4623081ddb25380b713c8cf5233cd11c1aabad990bb9381"}, - {file = "aiohttp-3.10.8-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:e45fdfcb2d5bcad83373e4808825b7512953146d147488114575780640665027"}, - {file = "aiohttp-3.10.8-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:f78e2a78432c537ae876a93013b7bc0027ba5b93ad7b3463624c4b6906489332"}, - {file = "aiohttp-3.10.8-cp311-cp311-win32.whl", hash = "sha256:f8179855a4e4f3b931cb1764ec87673d3fbdcca2af496c8d30567d7b034a13db"}, - {file = "aiohttp-3.10.8-cp311-cp311-win_amd64.whl", hash = "sha256:ef9b484604af05ca745b6108ca1aaa22ae1919037ae4f93aaf9a37ba42e0b835"}, - {file = "aiohttp-3.10.8-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:ab2d6523575fc98896c80f49ac99e849c0b0e69cc80bf864eed6af2ae728a52b"}, - {file = "aiohttp-3.10.8-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:f5d5d5401744dda50b943d8764508d0e60cc2d3305ac1e6420935861a9d544bc"}, - {file = "aiohttp-3.10.8-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:de23085cf90911600ace512e909114385026b16324fa203cc74c81f21fd3276a"}, - {file = "aiohttp-3.10.8-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4618f0d2bf523043866a9ff8458900d8eb0a6d4018f251dae98e5f1fb699f3a8"}, - {file = "aiohttp-3.10.8-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:21c1925541ca84f7b5e0df361c0a813a7d6a56d3b0030ebd4b220b8d232015f9"}, - {file = "aiohttp-3.10.8-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:497a7d20caea8855c5429db3cdb829385467217d7feb86952a6107e033e031b9"}, - {file = "aiohttp-3.10.8-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c887019dbcb4af58a091a45ccf376fffe800b5531b45c1efccda4bedf87747ea"}, - {file = "aiohttp-3.10.8-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40d2d719c3c36a7a65ed26400e2b45b2d9ed7edf498f4df38b2ae130f25a0d01"}, - {file = "aiohttp-3.10.8-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:57359785f27394a8bcab0da6dcd46706d087dfebf59a8d0ad2e64a4bc2f6f94f"}, - {file = "aiohttp-3.10.8-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:a961ee6f2cdd1a2be4735333ab284691180d40bad48f97bb598841bfcbfb94ec"}, - {file = "aiohttp-3.10.8-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:fe3d79d6af839ffa46fdc5d2cf34295390894471e9875050eafa584cb781508d"}, - {file = "aiohttp-3.10.8-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:9a281cba03bdaa341c70b7551b2256a88d45eead149f48b75a96d41128c240b3"}, - {file = "aiohttp-3.10.8-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:c6769d71bfb1ed60321363a9bc05e94dcf05e38295ef41d46ac08919e5b00d19"}, - {file = "aiohttp-3.10.8-cp312-cp312-win32.whl", hash = "sha256:a3081246bab4d419697ee45e555cef5cd1def7ac193dff6f50be761d2e44f194"}, - {file = "aiohttp-3.10.8-cp312-cp312-win_amd64.whl", hash = "sha256:ab1546fc8e00676febc81c548a876c7bde32f881b8334b77f84719ab2c7d28dc"}, - {file = "aiohttp-3.10.8-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:b1a012677b8e0a39e181e218de47d6741c5922202e3b0b65e412e2ce47c39337"}, - {file = "aiohttp-3.10.8-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:2df786c96c57cd6b87156ba4c5f166af7b88f3fc05f9d592252fdc83d8615a3c"}, - {file = "aiohttp-3.10.8-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:8885ca09d3a9317219c0831276bfe26984b17b2c37b7bf70dd478d17092a4772"}, - {file = "aiohttp-3.10.8-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4dbf252ac19860e0ab56cd480d2805498f47c5a2d04f5995d8d8a6effd04b48c"}, - {file = "aiohttp-3.10.8-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3b2036479b6b94afaaca7d07b8a68dc0e67b0caf5f6293bb6a5a1825f5923000"}, - {file = "aiohttp-3.10.8-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:365783e1b7c40b59ed4ce2b5a7491bae48f41cd2c30d52647a5b1ee8604c68ad"}, - {file = "aiohttp-3.10.8-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:270e653b5a4b557476a1ed40e6b6ce82f331aab669620d7c95c658ef976c9c5e"}, - {file = "aiohttp-3.10.8-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8960fabc20bfe4fafb941067cda8e23c8c17c98c121aa31c7bf0cdab11b07842"}, - {file = "aiohttp-3.10.8-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:f21e8f2abed9a44afc3d15bba22e0dfc71e5fa859bea916e42354c16102b036f"}, - {file = "aiohttp-3.10.8-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:fecd55e7418fabd297fd836e65cbd6371aa4035a264998a091bbf13f94d9c44d"}, - {file = "aiohttp-3.10.8-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:badb51d851358cd7535b647bb67af4854b64f3c85f0d089c737f75504d5910ec"}, - {file = "aiohttp-3.10.8-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:e860985f30f3a015979e63e7ba1a391526cdac1b22b7b332579df7867848e255"}, - {file = "aiohttp-3.10.8-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:71462f8eeca477cbc0c9700a9464e3f75f59068aed5e9d4a521a103692da72dc"}, - {file = "aiohttp-3.10.8-cp313-cp313-win32.whl", hash = "sha256:177126e971782769b34933e94fddd1089cef0fe6b82fee8a885e539f5b0f0c6a"}, - {file = "aiohttp-3.10.8-cp313-cp313-win_amd64.whl", hash = "sha256:98a4eb60e27033dee9593814ca320ee8c199489fbc6b2699d0f710584db7feb7"}, - {file = "aiohttp-3.10.8-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:ffef3d763e4c8fc97e740da5b4d0f080b78630a3914f4e772a122bbfa608c1db"}, - {file = "aiohttp-3.10.8-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:597128cb7bc5f068181b49a732961f46cb89f85686206289d6ccb5e27cb5fbe2"}, - {file = "aiohttp-3.10.8-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:f23a6c1d09de5de89a33c9e9b229106cb70dcfdd55e81a3a3580eaadaa32bc92"}, - {file = "aiohttp-3.10.8-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:da57af0c54a302b7c655fa1ccd5b1817a53739afa39924ef1816e7b7c8a07ccb"}, - {file = "aiohttp-3.10.8-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1e7a6af57091056a79a35104d6ec29d98ec7f1fb7270ad9c6fff871b678d1ff8"}, - {file = "aiohttp-3.10.8-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:32710d6b3b6c09c60c794d84ca887a3a2890131c0b02b3cefdcc6709a2260a7c"}, - {file = "aiohttp-3.10.8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4b91f4f62ad39a8a42d511d66269b46cb2fb7dea9564c21ab6c56a642d28bff5"}, - {file = "aiohttp-3.10.8-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:471a8c47344b9cc309558b3fcc469bd2c12b49322b4b31eb386c4a2b2d44e44a"}, - {file = "aiohttp-3.10.8-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:fc0e7f91705445d79beafba9bb3057dd50830e40fe5417017a76a214af54e122"}, - {file = "aiohttp-3.10.8-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:85431c9131a9a0f65260dc7a65c800ca5eae78c4c9931618f18c8e0933a0e0c1"}, - {file = "aiohttp-3.10.8-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:b91557ee0893da52794b25660d4f57bb519bcad8b7df301acd3898f7197c5d81"}, - {file = "aiohttp-3.10.8-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:4954e6b06dd0be97e1a5751fc606be1f9edbdc553c5d9b57d72406a8fbd17f9d"}, - {file = "aiohttp-3.10.8-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:a087c84b4992160ffef7afd98ef24177c8bd4ad61c53607145a8377457385100"}, - {file = "aiohttp-3.10.8-cp38-cp38-win32.whl", hash = "sha256:e1f0f7b27171b2956a27bd8f899751d0866ddabdd05cbddf3520f945130a908c"}, - {file = "aiohttp-3.10.8-cp38-cp38-win_amd64.whl", hash = "sha256:c4916070e12ae140110aa598031876c1bf8676a36a750716ea0aa5bd694aa2e7"}, - {file = "aiohttp-3.10.8-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:5284997e3d88d0dfb874c43e51ae8f4a6f4ca5b90dcf22995035187253d430db"}, - {file = "aiohttp-3.10.8-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9443d9ebc5167ce1fbb552faf2d666fb22ef5716a8750be67efd140a7733738c"}, - {file = "aiohttp-3.10.8-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:b667e2a03407d79a76c618dc30cedebd48f082d85880d0c9c4ec2faa3e10f43e"}, - {file = "aiohttp-3.10.8-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:98fae99d5c2146f254b7806001498e6f9ffb0e330de55a35e72feb7cb2fa399b"}, - {file = "aiohttp-3.10.8-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8296edd99d0dd9d0eb8b9e25b3b3506eef55c1854e9cc230f0b3f885f680410b"}, - {file = "aiohttp-3.10.8-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1ce46dfb49cfbf9e92818be4b761d4042230b1f0e05ffec0aad15b3eb162b905"}, - {file = "aiohttp-3.10.8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7c38cfd355fd86c39b2d54651bd6ed7d63d4fe3b5553f364bae3306e2445f847"}, - {file = "aiohttp-3.10.8-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:713dff3f87ceec3bde4f3f484861464e722cf7533f9fa6b824ec82bb5a9010a7"}, - {file = "aiohttp-3.10.8-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:21a72f4a9c69a8567a0aca12042f12bba25d3139fd5dd8eeb9931f4d9e8599cd"}, - {file = "aiohttp-3.10.8-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:6d1ad868624f6cea77341ef2877ad4e71f7116834a6cd7ec36ec5c32f94ee6ae"}, - {file = "aiohttp-3.10.8-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:a78ba86d5a08207d1d1ad10b97aed6ea48b374b3f6831d02d0b06545ac0f181e"}, - {file = "aiohttp-3.10.8-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:aff048793d05e1ce05b62e49dccf81fe52719a13f4861530706619506224992b"}, - {file = "aiohttp-3.10.8-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:d088ca05381fd409793571d8e34eca06daf41c8c50a05aeed358d2d340c7af81"}, - {file = "aiohttp-3.10.8-cp39-cp39-win32.whl", hash = "sha256:ee97c4e54f457c366e1f76fbbf3e8effee9de57dae671084a161c00f481106ce"}, - {file = "aiohttp-3.10.8-cp39-cp39-win_amd64.whl", hash = "sha256:d95ae4420669c871667aad92ba8cce6251d61d79c1a38504621094143f94a8b4"}, - {file = "aiohttp-3.10.8.tar.gz", hash = "sha256:21f8225f7dc187018e8433c9326be01477fb2810721e048b33ac49091b19fb4a"}, + {file = "aiohttp-3.10.10-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:be7443669ae9c016b71f402e43208e13ddf00912f47f623ee5994e12fc7d4b3f"}, + {file = "aiohttp-3.10.10-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7b06b7843929e41a94ea09eb1ce3927865387e3e23ebe108e0d0d09b08d25be9"}, + {file = "aiohttp-3.10.10-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:333cf6cf8e65f6a1e06e9eb3e643a0c515bb850d470902274239fea02033e9a8"}, + {file = "aiohttp-3.10.10-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:274cfa632350225ce3fdeb318c23b4a10ec25c0e2c880eff951a3842cf358ac1"}, + {file = "aiohttp-3.10.10-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d9e5e4a85bdb56d224f412d9c98ae4cbd032cc4f3161818f692cd81766eee65a"}, + {file = "aiohttp-3.10.10-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2b606353da03edcc71130b52388d25f9a30a126e04caef1fd637e31683033abd"}, + {file = "aiohttp-3.10.10-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ab5a5a0c7a7991d90446a198689c0535be89bbd6b410a1f9a66688f0880ec026"}, + {file = "aiohttp-3.10.10-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:578a4b875af3e0daaf1ac6fa983d93e0bbfec3ead753b6d6f33d467100cdc67b"}, + {file = "aiohttp-3.10.10-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:8105fd8a890df77b76dd3054cddf01a879fc13e8af576805d667e0fa0224c35d"}, + {file = "aiohttp-3.10.10-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:3bcd391d083f636c06a68715e69467963d1f9600f85ef556ea82e9ef25f043f7"}, + {file = "aiohttp-3.10.10-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:fbc6264158392bad9df19537e872d476f7c57adf718944cc1e4495cbabf38e2a"}, + {file = "aiohttp-3.10.10-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:e48d5021a84d341bcaf95c8460b152cfbad770d28e5fe14a768988c461b821bc"}, + {file = "aiohttp-3.10.10-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:2609e9ab08474702cc67b7702dbb8a80e392c54613ebe80db7e8dbdb79837c68"}, + {file = "aiohttp-3.10.10-cp310-cp310-win32.whl", hash = "sha256:84afcdea18eda514c25bc68b9af2a2b1adea7c08899175a51fe7c4fb6d551257"}, + {file = "aiohttp-3.10.10-cp310-cp310-win_amd64.whl", hash = "sha256:9c72109213eb9d3874f7ac8c0c5fa90e072d678e117d9061c06e30c85b4cf0e6"}, + {file = "aiohttp-3.10.10-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:c30a0eafc89d28e7f959281b58198a9fa5e99405f716c0289b7892ca345fe45f"}, + {file = "aiohttp-3.10.10-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:258c5dd01afc10015866114e210fb7365f0d02d9d059c3c3415382ab633fcbcb"}, + {file = "aiohttp-3.10.10-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:15ecd889a709b0080f02721255b3f80bb261c2293d3c748151274dfea93ac871"}, + {file = "aiohttp-3.10.10-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f3935f82f6f4a3820270842e90456ebad3af15810cf65932bd24da4463bc0a4c"}, + {file = "aiohttp-3.10.10-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:413251f6fcf552a33c981c4709a6bba37b12710982fec8e558ae944bfb2abd38"}, + {file = "aiohttp-3.10.10-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d1720b4f14c78a3089562b8875b53e36b51c97c51adc53325a69b79b4b48ebcb"}, + {file = "aiohttp-3.10.10-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:679abe5d3858b33c2cf74faec299fda60ea9de62916e8b67e625d65bf069a3b7"}, + {file = "aiohttp-3.10.10-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:79019094f87c9fb44f8d769e41dbb664d6e8fcfd62f665ccce36762deaa0e911"}, + {file = "aiohttp-3.10.10-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:fe2fb38c2ed905a2582948e2de560675e9dfbee94c6d5ccdb1301c6d0a5bf092"}, + {file = "aiohttp-3.10.10-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:a3f00003de6eba42d6e94fabb4125600d6e484846dbf90ea8e48a800430cc142"}, + {file = "aiohttp-3.10.10-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:1bbb122c557a16fafc10354b9d99ebf2f2808a660d78202f10ba9d50786384b9"}, + {file = "aiohttp-3.10.10-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:30ca7c3b94708a9d7ae76ff281b2f47d8eaf2579cd05971b5dc681db8caac6e1"}, + {file = "aiohttp-3.10.10-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:df9270660711670e68803107d55c2b5949c2e0f2e4896da176e1ecfc068b974a"}, + {file = "aiohttp-3.10.10-cp311-cp311-win32.whl", hash = "sha256:aafc8ee9b742ce75044ae9a4d3e60e3d918d15a4c2e08a6c3c3e38fa59b92d94"}, + {file = "aiohttp-3.10.10-cp311-cp311-win_amd64.whl", hash = "sha256:362f641f9071e5f3ee6f8e7d37d5ed0d95aae656adf4ef578313ee585b585959"}, + {file = "aiohttp-3.10.10-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:9294bbb581f92770e6ed5c19559e1e99255e4ca604a22c5c6397b2f9dd3ee42c"}, + {file = "aiohttp-3.10.10-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:a8fa23fe62c436ccf23ff930149c047f060c7126eae3ccea005f0483f27b2e28"}, + {file = "aiohttp-3.10.10-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5c6a5b8c7926ba5d8545c7dd22961a107526562da31a7a32fa2456baf040939f"}, + {file = "aiohttp-3.10.10-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:007ec22fbc573e5eb2fb7dec4198ef8f6bf2fe4ce20020798b2eb5d0abda6138"}, + {file = "aiohttp-3.10.10-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9627cc1a10c8c409b5822a92d57a77f383b554463d1884008e051c32ab1b3742"}, + {file = "aiohttp-3.10.10-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:50edbcad60d8f0e3eccc68da67f37268b5144ecc34d59f27a02f9611c1d4eec7"}, + {file = "aiohttp-3.10.10-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a45d85cf20b5e0d0aa5a8dca27cce8eddef3292bc29d72dcad1641f4ed50aa16"}, + {file = "aiohttp-3.10.10-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0b00807e2605f16e1e198f33a53ce3c4523114059b0c09c337209ae55e3823a8"}, + {file = "aiohttp-3.10.10-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:f2d4324a98062be0525d16f768a03e0bbb3b9fe301ceee99611dc9a7953124e6"}, + {file = "aiohttp-3.10.10-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:438cd072f75bb6612f2aca29f8bd7cdf6e35e8f160bc312e49fbecab77c99e3a"}, + {file = "aiohttp-3.10.10-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:baa42524a82f75303f714108fea528ccacf0386af429b69fff141ffef1c534f9"}, + {file = "aiohttp-3.10.10-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:a7d8d14fe962153fc681f6366bdec33d4356f98a3e3567782aac1b6e0e40109a"}, + {file = "aiohttp-3.10.10-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:c1277cd707c465cd09572a774559a3cc7c7a28802eb3a2a9472588f062097205"}, + {file = "aiohttp-3.10.10-cp312-cp312-win32.whl", hash = "sha256:59bb3c54aa420521dc4ce3cc2c3fe2ad82adf7b09403fa1f48ae45c0cbde6628"}, + {file = "aiohttp-3.10.10-cp312-cp312-win_amd64.whl", hash = "sha256:0e1b370d8007c4ae31ee6db7f9a2fe801a42b146cec80a86766e7ad5c4a259cf"}, + {file = "aiohttp-3.10.10-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:ad7593bb24b2ab09e65e8a1d385606f0f47c65b5a2ae6c551db67d6653e78c28"}, + {file = "aiohttp-3.10.10-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:1eb89d3d29adaf533588f209768a9c02e44e4baf832b08118749c5fad191781d"}, + {file = "aiohttp-3.10.10-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:3fe407bf93533a6fa82dece0e74dbcaaf5d684e5a51862887f9eaebe6372cd79"}, + {file = "aiohttp-3.10.10-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:50aed5155f819873d23520919e16703fc8925e509abbb1a1491b0087d1cd969e"}, + {file = "aiohttp-3.10.10-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4f05e9727ce409358baa615dbeb9b969db94324a79b5a5cea45d39bdb01d82e6"}, + {file = "aiohttp-3.10.10-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3dffb610a30d643983aeb185ce134f97f290f8935f0abccdd32c77bed9388b42"}, + {file = "aiohttp-3.10.10-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:aa6658732517ddabe22c9036479eabce6036655ba87a0224c612e1ae6af2087e"}, + {file = "aiohttp-3.10.10-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:741a46d58677d8c733175d7e5aa618d277cd9d880301a380fd296975a9cdd7bc"}, + {file = "aiohttp-3.10.10-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:e00e3505cd80440f6c98c6d69269dcc2a119f86ad0a9fd70bccc59504bebd68a"}, + {file = "aiohttp-3.10.10-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:ffe595f10566f8276b76dc3a11ae4bb7eba1aac8ddd75811736a15b0d5311414"}, + {file = "aiohttp-3.10.10-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:bdfcf6443637c148c4e1a20c48c566aa694fa5e288d34b20fcdc58507882fed3"}, + {file = "aiohttp-3.10.10-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:d183cf9c797a5291e8301790ed6d053480ed94070637bfaad914dd38b0981f67"}, + {file = "aiohttp-3.10.10-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:77abf6665ae54000b98b3c742bc6ea1d1fb31c394bcabf8b5d2c1ac3ebfe7f3b"}, + {file = "aiohttp-3.10.10-cp313-cp313-win32.whl", hash = "sha256:4470c73c12cd9109db8277287d11f9dd98f77fc54155fc71a7738a83ffcc8ea8"}, + {file = "aiohttp-3.10.10-cp313-cp313-win_amd64.whl", hash = "sha256:486f7aabfa292719a2753c016cc3a8f8172965cabb3ea2e7f7436c7f5a22a151"}, + {file = "aiohttp-3.10.10-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:1b66ccafef7336a1e1f0e389901f60c1d920102315a56df85e49552308fc0486"}, + {file = "aiohttp-3.10.10-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:acd48d5b80ee80f9432a165c0ac8cbf9253eaddb6113269a5e18699b33958dbb"}, + {file = "aiohttp-3.10.10-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:3455522392fb15ff549d92fbf4b73b559d5e43dc522588f7eb3e54c3f38beee7"}, + {file = "aiohttp-3.10.10-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:45c3b868724137f713a38376fef8120c166d1eadd50da1855c112fe97954aed8"}, + {file = "aiohttp-3.10.10-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:da1dee8948d2137bb51fbb8a53cce6b1bcc86003c6b42565f008438b806cccd8"}, + {file = "aiohttp-3.10.10-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c5ce2ce7c997e1971b7184ee37deb6ea9922ef5163c6ee5aa3c274b05f9e12fa"}, + {file = "aiohttp-3.10.10-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:28529e08fde6f12eba8677f5a8608500ed33c086f974de68cc65ab218713a59d"}, + {file = "aiohttp-3.10.10-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f7db54c7914cc99d901d93a34704833568d86c20925b2762f9fa779f9cd2e70f"}, + {file = "aiohttp-3.10.10-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:03a42ac7895406220124c88911ebee31ba8b2d24c98507f4a8bf826b2937c7f2"}, + {file = "aiohttp-3.10.10-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:7e338c0523d024fad378b376a79faff37fafb3c001872a618cde1d322400a572"}, + {file = "aiohttp-3.10.10-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:038f514fe39e235e9fef6717fbf944057bfa24f9b3db9ee551a7ecf584b5b480"}, + {file = "aiohttp-3.10.10-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:64f6c17757251e2b8d885d728b6433d9d970573586a78b78ba8929b0f41d045a"}, + {file = "aiohttp-3.10.10-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:93429602396f3383a797a2a70e5f1de5df8e35535d7806c9f91df06f297e109b"}, + {file = "aiohttp-3.10.10-cp38-cp38-win32.whl", hash = "sha256:c823bc3971c44ab93e611ab1a46b1eafeae474c0c844aff4b7474287b75fe49c"}, + {file = "aiohttp-3.10.10-cp38-cp38-win_amd64.whl", hash = "sha256:54ca74df1be3c7ca1cf7f4c971c79c2daf48d9aa65dea1a662ae18926f5bc8ce"}, + {file = "aiohttp-3.10.10-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:01948b1d570f83ee7bbf5a60ea2375a89dfb09fd419170e7f5af029510033d24"}, + {file = "aiohttp-3.10.10-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9fc1500fd2a952c5c8e3b29aaf7e3cc6e27e9cfc0a8819b3bce48cc1b849e4cc"}, + {file = "aiohttp-3.10.10-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f614ab0c76397661b90b6851a030004dac502e48260ea10f2441abd2207fbcc7"}, + {file = "aiohttp-3.10.10-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:00819de9e45d42584bed046314c40ea7e9aea95411b38971082cad449392b08c"}, + {file = "aiohttp-3.10.10-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:05646ebe6b94cc93407b3bf34b9eb26c20722384d068eb7339de802154d61bc5"}, + {file = "aiohttp-3.10.10-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:998f3bd3cfc95e9424a6acd7840cbdd39e45bc09ef87533c006f94ac47296090"}, + {file = "aiohttp-3.10.10-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d9010c31cd6fa59438da4e58a7f19e4753f7f264300cd152e7f90d4602449762"}, + {file = "aiohttp-3.10.10-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7ea7ffc6d6d6f8a11e6f40091a1040995cdff02cfc9ba4c2f30a516cb2633554"}, + {file = "aiohttp-3.10.10-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:ef9c33cc5cbca35808f6c74be11eb7f5f6b14d2311be84a15b594bd3e58b5527"}, + {file = "aiohttp-3.10.10-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:ce0cdc074d540265bfeb31336e678b4e37316849d13b308607efa527e981f5c2"}, + {file = "aiohttp-3.10.10-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:597a079284b7ee65ee102bc3a6ea226a37d2b96d0418cc9047490f231dc09fe8"}, + {file = "aiohttp-3.10.10-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:7789050d9e5d0c309c706953e5e8876e38662d57d45f936902e176d19f1c58ab"}, + {file = "aiohttp-3.10.10-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:e7f8b04d83483577fd9200461b057c9f14ced334dcb053090cea1da9c8321a91"}, + {file = "aiohttp-3.10.10-cp39-cp39-win32.whl", hash = "sha256:c02a30b904282777d872266b87b20ed8cc0d1501855e27f831320f471d54d983"}, + {file = "aiohttp-3.10.10-cp39-cp39-win_amd64.whl", hash = "sha256:edfe3341033a6b53a5c522c802deb2079eee5cbfbb0af032a55064bd65c73a23"}, + {file = "aiohttp-3.10.10.tar.gz", hash = "sha256:0631dd7c9f0822cc61c88586ca76d5b5ada26538097d0f1df510b082bad3411a"}, ] [package.dependencies] @@ -408,17 +408,17 @@ lxml = ["lxml"] [[package]] name = "boto3" -version = "1.35.30" +version = "1.35.38" description = "The AWS SDK for Python" optional = false python-versions = ">=3.8" files = [ - {file = "boto3-1.35.30-py3-none-any.whl", hash = "sha256:d89c3459db89c5408e83219ab849ffd0146bc4285e75cdc67c6e45d390a12df2"}, - {file = "boto3-1.35.30.tar.gz", hash = "sha256:d2851aec8e9dc6937977acbe9a5124ecc31b3ad5f50a10cd9ae52636da3f52fa"}, + {file = "boto3-1.35.38-py3-none-any.whl", hash = "sha256:234a475fe56b65e99b4f5cfff50adaac6b23d39558d6b55137bbf1e50dd0ef08"}, + {file = "boto3-1.35.38.tar.gz", hash = "sha256:90c8cddc4a08c8040057ad44c7468ff82fea9fe8b6517db5ff01a9b2900299cc"}, ] [package.dependencies] -botocore = ">=1.35.30,<1.36.0" +botocore = ">=1.35.38,<1.36.0" jmespath = ">=0.7.1,<2.0.0" s3transfer = ">=0.10.0,<0.11.0" @@ -427,13 +427,13 @@ crt = ["botocore[crt] (>=1.21.0,<2.0a0)"] [[package]] name = "botocore" -version = "1.35.30" +version = "1.35.38" description = "Low-level, data-driven core of boto 3." optional = false python-versions = ">=3.8" files = [ - {file = "botocore-1.35.30-py3-none-any.whl", hash = "sha256:3bb9f9dde001608671ea74681ac3cec06bbbb10cba8cb8c1387a25e843075ce0"}, - {file = "botocore-1.35.30.tar.gz", hash = "sha256:ab5350e8a50e48d371fa2d517d65c29a40c43788cb9a15387f93eac5a23df0fd"}, + {file = "botocore-1.35.38-py3-none-any.whl", hash = "sha256:2eb17d32fa2d3bb5d475132a83564d28e3acc2161534f24b75a54418a1d51359"}, + {file = "botocore-1.35.38.tar.gz", hash = "sha256:55d9305c44e5ba29476df456120fa4fb919f03f066afa82f2ae400485e7465f4"}, ] [package.dependencies] @@ -442,17 +442,17 @@ python-dateutil = ">=2.1,<3.0.0" urllib3 = {version = ">=1.25.4,<2.2.0 || >2.2.0,<3", markers = "python_version >= \"3.10\""} [package.extras] -crt = ["awscrt (==0.21.5)"] +crt = ["awscrt (==0.22.0)"] [[package]] name = "build" -version = "1.2.2" +version = "1.2.2.post1" description = "A simple, correct Python build frontend" optional = false python-versions = ">=3.8" files = [ - {file = "build-1.2.2-py3-none-any.whl", hash = "sha256:277ccc71619d98afdd841a0e96ac9fe1593b823af481d3b0cea748e8894e0613"}, - {file = "build-1.2.2.tar.gz", hash = "sha256:119b2fb462adef986483438377a13b2f42064a2a3a4161f24a0cca698a07ac8c"}, + {file = "build-1.2.2.post1-py3-none-any.whl", hash = "sha256:1d61c0887fa860c01971625baae8bdd338e517b836a2f70dd1f7aa3a6b2fc5b5"}, + {file = "build-1.2.2.post1.tar.gz", hash = "sha256:b36993e92ca9375a219c99e606a122ff365a760a2d4bba0caa09bd5278b608b7"}, ] [package.dependencies] @@ -645,101 +645,116 @@ files = [ [[package]] name = "charset-normalizer" -version = "3.3.2" +version = "3.4.0" description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." optional = false python-versions = ">=3.7.0" files = [ - {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"}, - {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:4f9fc98dad6c2eaa32fc3af1417d95b5e3d08aff968df0cd320066def971f9a6"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:0de7b687289d3c1b3e8660d0741874abe7888100efe14bd0f9fd7141bcbda92b"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:5ed2e36c3e9b4f21dd9422f6893dec0abf2cca553af509b10cd630f878d3eb99"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:40d3ff7fc90b98c637bda91c89d51264a3dcf210cade3a2c6f838c7268d7a4ca"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1110e22af8ca26b90bd6364fe4c763329b0ebf1ee213ba32b68c73de5752323d"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:86f4e8cca779080f66ff4f191a685ced73d2f72d50216f7112185dc02b90b9b7"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7f683ddc7eedd742e2889d2bfb96d69573fde1d92fcb811979cdb7165bb9c7d3"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:27623ba66c183eca01bf9ff833875b459cad267aeeb044477fedac35e19ba907"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:f606a1881d2663630ea5b8ce2efe2111740df4b687bd78b34a8131baa007f79b"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:0b309d1747110feb25d7ed6b01afdec269c647d382c857ef4663bbe6ad95a912"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:136815f06a3ae311fae551c3df1f998a1ebd01ddd424aa5603a4336997629e95"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:14215b71a762336254351b00ec720a8e85cada43b987da5a042e4ce3e82bd68e"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:79983512b108e4a164b9c8d34de3992f76d48cadc9554c9e60b43f308988aabe"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-win32.whl", hash = "sha256:c94057af19bc953643a33581844649a7fdab902624d2eb739738a30e2b3e60fc"}, + {file = "charset_normalizer-3.4.0-cp310-cp310-win_amd64.whl", hash = "sha256:55f56e2ebd4e3bc50442fbc0888c9d8c94e4e06a933804e2af3e89e2f9c1c749"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:0d99dd8ff461990f12d6e42c7347fd9ab2532fb70e9621ba520f9e8637161d7c"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c57516e58fd17d03ebe67e181a4e4e2ccab1168f8c2976c6a334d4f819fe5944"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:6dba5d19c4dfab08e58d5b36304b3f92f3bd5d42c1a3fa37b5ba5cdf6dfcbcee"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bf4475b82be41b07cc5e5ff94810e6a01f276e37c2d55571e3fe175e467a1a1c"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ce031db0408e487fd2775d745ce30a7cd2923667cf3b69d48d219f1d8f5ddeb6"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8ff4e7cdfdb1ab5698e675ca622e72d58a6fa2a8aa58195de0c0061288e6e3ea"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3710a9751938947e6327ea9f3ea6332a09bf0ba0c09cae9cb1f250bd1f1549bc"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:82357d85de703176b5587dbe6ade8ff67f9f69a41c0733cf2425378b49954de5"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:47334db71978b23ebcf3c0f9f5ee98b8d65992b65c9c4f2d34c2eaf5bcaf0594"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:8ce7fd6767a1cc5a92a639b391891bf1c268b03ec7e021c7d6d902285259685c"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:f1a2f519ae173b5b6a2c9d5fa3116ce16e48b3462c8b96dfdded11055e3d6365"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:63bc5c4ae26e4bc6be6469943b8253c0fd4e4186c43ad46e713ea61a0ba49129"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:bcb4f8ea87d03bc51ad04add8ceaf9b0f085ac045ab4d74e73bbc2dc033f0236"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-win32.whl", hash = "sha256:9ae4ef0b3f6b41bad6366fb0ea4fc1d7ed051528e113a60fa2a65a9abb5b1d99"}, + {file = "charset_normalizer-3.4.0-cp311-cp311-win_amd64.whl", hash = "sha256:cee4373f4d3ad28f1ab6290684d8e2ebdb9e7a1b74fdc39e4c211995f77bec27"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:0713f3adb9d03d49d365b70b84775d0a0d18e4ab08d12bc46baa6132ba78aaf6"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:de7376c29d95d6719048c194a9cf1a1b0393fbe8488a22008610b0361d834ecf"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:4a51b48f42d9358460b78725283f04bddaf44a9358197b889657deba38f329db"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b295729485b06c1a0683af02a9e42d2caa9db04a373dc38a6a58cdd1e8abddf1"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ee803480535c44e7f5ad00788526da7d85525cfefaf8acf8ab9a310000be4b03"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3d59d125ffbd6d552765510e3f31ed75ebac2c7470c7274195b9161a32350284"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8cda06946eac330cbe6598f77bb54e690b4ca93f593dee1568ad22b04f347c15"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:07afec21bbbbf8a5cc3651aa96b980afe2526e7f048fdfb7f1014d84acc8b6d8"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:6b40e8d38afe634559e398cc32b1472f376a4099c75fe6299ae607e404c033b2"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:b8dcd239c743aa2f9c22ce674a145e0a25cb1566c495928440a181ca1ccf6719"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:84450ba661fb96e9fd67629b93d2941c871ca86fc38d835d19d4225ff946a631"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:44aeb140295a2f0659e113b31cfe92c9061622cadbc9e2a2f7b8ef6b1e29ef4b"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:1db4e7fefefd0f548d73e2e2e041f9df5c59e178b4c72fbac4cc6f535cfb1565"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-win32.whl", hash = "sha256:5726cf76c982532c1863fb64d8c6dd0e4c90b6ece9feb06c9f202417a31f7dd7"}, + {file = "charset_normalizer-3.4.0-cp312-cp312-win_amd64.whl", hash = "sha256:b197e7094f232959f8f20541ead1d9862ac5ebea1d58e9849c1bf979255dfac9"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:dd4eda173a9fcccb5f2e2bd2a9f423d180194b1bf17cf59e3269899235b2a114"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:e9e3c4c9e1ed40ea53acf11e2a386383c3304212c965773704e4603d589343ed"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:92a7e36b000bf022ef3dbb9c46bfe2d52c047d5e3f3343f43204263c5addc250"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:54b6a92d009cbe2fb11054ba694bc9e284dad30a26757b1e372a1fdddaf21920"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ffd9493de4c922f2a38c2bf62b831dcec90ac673ed1ca182fe11b4d8e9f2a64"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:35c404d74c2926d0287fbd63ed5d27eb911eb9e4a3bb2c6d294f3cfd4a9e0c23"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4796efc4faf6b53a18e3d46343535caed491776a22af773f366534056c4e1fbc"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e7fdd52961feb4c96507aa649550ec2a0d527c086d284749b2f582f2d40a2e0d"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:92db3c28b5b2a273346bebb24857fda45601aef6ae1c011c0a997106581e8a88"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:ab973df98fc99ab39080bfb0eb3a925181454d7c3ac8a1e695fddfae696d9e90"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:4b67fdab07fdd3c10bb21edab3cbfe8cf5696f453afce75d815d9d7223fbe88b"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:aa41e526a5d4a9dfcfbab0716c7e8a1b215abd3f3df5a45cf18a12721d31cb5d"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:ffc519621dce0c767e96b9c53f09c5d215578e10b02c285809f76509a3931482"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-win32.whl", hash = "sha256:f19c1585933c82098c2a520f8ec1227f20e339e33aca8fa6f956f6691b784e67"}, + {file = "charset_normalizer-3.4.0-cp313-cp313-win_amd64.whl", hash = "sha256:707b82d19e65c9bd28b81dde95249b07bf9f5b90ebe1ef17d9b57473f8a64b7b"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:dbe03226baf438ac4fda9e2d0715022fd579cb641c4cf639fa40d53b2fe6f3e2"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dd9a8bd8900e65504a305bf8ae6fa9fbc66de94178c420791d0293702fce2df7"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b8831399554b92b72af5932cdbbd4ddc55c55f631bb13ff8fe4e6536a06c5c51"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a14969b8691f7998e74663b77b4c36c0337cb1df552da83d5c9004a93afdb574"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dcaf7c1524c0542ee2fc82cc8ec337f7a9f7edee2532421ab200d2b920fc97cf"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:425c5f215d0eecee9a56cdb703203dda90423247421bf0d67125add85d0c4455"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-musllinux_1_2_aarch64.whl", hash = "sha256:d5b054862739d276e09928de37c79ddeec42a6e1bfc55863be96a36ba22926f6"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-musllinux_1_2_i686.whl", hash = "sha256:f3e73a4255342d4eb26ef6df01e3962e73aa29baa3124a8e824c5d3364a65748"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-musllinux_1_2_ppc64le.whl", hash = "sha256:2f6c34da58ea9c1a9515621f4d9ac379871a8f21168ba1b5e09d74250de5ad62"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-musllinux_1_2_s390x.whl", hash = "sha256:f09cb5a7bbe1ecae6e87901a2eb23e0256bb524a79ccc53eb0b7629fbe7677c4"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-musllinux_1_2_x86_64.whl", hash = "sha256:0099d79bdfcf5c1f0c2c72f91516702ebf8b0b8ddd8905f97a8aecf49712c621"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-win32.whl", hash = "sha256:9c98230f5042f4945f957d006edccc2af1e03ed5e37ce7c373f00a5a4daa6149"}, + {file = "charset_normalizer-3.4.0-cp37-cp37m-win_amd64.whl", hash = "sha256:62f60aebecfc7f4b82e3f639a7d1433a20ec32824db2199a11ad4f5e146ef5ee"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:af73657b7a68211996527dbfeffbb0864e043d270580c5aef06dc4b659a4b578"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:cab5d0b79d987c67f3b9e9c53f54a61360422a5a0bc075f43cab5621d530c3b6"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:9289fd5dddcf57bab41d044f1756550f9e7cf0c8e373b8cdf0ce8773dc4bd417"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6b493a043635eb376e50eedf7818f2f322eabbaa974e948bd8bdd29eb7ef2a51"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9fa2566ca27d67c86569e8c85297aaf413ffab85a8960500f12ea34ff98e4c41"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a8e538f46104c815be19c975572d74afb53f29650ea2025bbfaef359d2de2f7f"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6fd30dc99682dc2c603c2b315bded2799019cea829f8bf57dc6b61efde6611c8"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:2006769bd1640bdf4d5641c69a3d63b71b81445473cac5ded39740a226fa88ab"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:dc15e99b2d8a656f8e666854404f1ba54765871104e50c8e9813af8a7db07f12"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:ab2e5bef076f5a235c3774b4f4028a680432cded7cad37bba0fd90d64b187d19"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:4ec9dd88a5b71abfc74e9df5ebe7921c35cbb3b641181a531ca65cdb5e8e4dea"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:43193c5cda5d612f247172016c4bb71251c784d7a4d9314677186a838ad34858"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:aa693779a8b50cd97570e5a0f343538a8dbd3e496fa5dcb87e29406ad0299654"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-win32.whl", hash = "sha256:7706f5850360ac01d80c89bcef1640683cc12ed87f42579dab6c5d3ed6888613"}, + {file = "charset_normalizer-3.4.0-cp38-cp38-win_amd64.whl", hash = "sha256:c3e446d253bd88f6377260d07c895816ebf33ffffd56c1c792b13bff9c3e1ade"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:980b4f289d1d90ca5efcf07958d3eb38ed9c0b7676bf2831a54d4f66f9c27dfa"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:f28f891ccd15c514a0981f3b9db9aa23d62fe1a99997512b0491d2ed323d229a"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:a8aacce6e2e1edcb6ac625fb0f8c3a9570ccc7bfba1f63419b3769ccf6a00ed0"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bd7af3717683bea4c87acd8c0d3d5b44d56120b26fd3f8a692bdd2d5260c620a"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5ff2ed8194587faf56555927b3aa10e6fb69d931e33953943bc4f837dfee2242"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e91f541a85298cf35433bf66f3fab2a4a2cff05c127eeca4af174f6d497f0d4b"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:309a7de0a0ff3040acaebb35ec45d18db4b28232f21998851cfa709eeff49d62"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:285e96d9d53422efc0d7a17c60e59f37fbf3dfa942073f666db4ac71e8d726d0"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:5d447056e2ca60382d460a604b6302d8db69476fd2015c81e7c35417cfabe4cd"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:20587d20f557fe189b7947d8e7ec5afa110ccf72a3128d61a2a387c3313f46be"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:130272c698667a982a5d0e626851ceff662565379baf0ff2cc58067b81d4f11d"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:ab22fbd9765e6954bc0bcff24c25ff71dcbfdb185fcdaca49e81bac68fe724d3"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:7782afc9b6b42200f7362858f9e73b1f8316afb276d316336c0ec3bd73312742"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-win32.whl", hash = "sha256:2de62e8801ddfff069cd5c504ce3bc9672b23266597d4e4f50eda28846c322f2"}, + {file = "charset_normalizer-3.4.0-cp39-cp39-win_amd64.whl", hash = "sha256:95c3c157765b031331dd4db3c775e58deaee050a3042fcad72cbc4189d7c8dca"}, + {file = "charset_normalizer-3.4.0-py3-none-any.whl", hash = "sha256:fe9f97feb71aa9896b81973a7bbada8c49501dc73e58a10fcef6663af95e5079"}, + {file = "charset_normalizer-3.4.0.tar.gz", hash = "sha256:223217c3d4f82c3ac5e29032b3f1c2eb0fb591b72161f86d93f5719079dae93e"}, ] [[package]] @@ -1077,13 +1092,13 @@ packaging = "*" [[package]] name = "distlib" -version = "0.3.8" +version = "0.3.9" description = "Distribution utilities" optional = false python-versions = "*" files = [ - {file = "distlib-0.3.8-py2.py3-none-any.whl", hash = "sha256:034db59a0b96f8ca18035f36290806a9a6e6bd9d1ff91e45a7f172eb17e51784"}, - {file = "distlib-0.3.8.tar.gz", hash = "sha256:1530ea13e350031b6312d8580ddb6b27a104275a31106523b8f123787f494f64"}, + {file = "distlib-0.3.9-py2.py3-none-any.whl", hash = "sha256:47f8c22fd27c27e25a65601af709b38e4f0a45ea4fc2e710f65755fa8caaaf87"}, + {file = "distlib-0.3.9.tar.gz", hash = "sha256:a60f20dea646b8a33f3e7772f74dc0b2d0772d2837ee1342a00645c81edf9403"}, ] [[package]] @@ -1229,12 +1244,13 @@ pgp = ["gpg"] [[package]] name = "durationpy" -version = "0.8" +version = "0.9" description = "Module for converting between datetime.timedelta and Go's Duration strings." optional = false python-versions = "*" files = [ - {file = "durationpy-0.8.tar.gz", hash = "sha256:e90941562e260bdb0e2244cd9eee9be5b3aa0efc0557fca754f36d18fe080f9d"}, + {file = "durationpy-0.9-py3-none-any.whl", hash = "sha256:e65359a7af5cedad07fb77a2dd3f390f8eb0b74cb845589fa6c057086834dd38"}, + {file = "durationpy-0.9.tar.gz", hash = "sha256:fd3feb0a69a0057d582ef643c355c40d2fa1c942191f914d12203b1a01ac722a"}, ] [[package]] @@ -1568,13 +1584,13 @@ dev = ["flake8", "markdown", "twine", "wheel"] [[package]] name = "google-api-core" -version = "2.20.0" +version = "2.21.0" description = "Google API client core library" optional = false python-versions = ">=3.7" files = [ - {file = "google_api_core-2.20.0-py3-none-any.whl", hash = "sha256:ef0591ef03c30bb83f79b3d0575c3f31219001fc9c5cf37024d08310aeffed8a"}, - {file = "google_api_core-2.20.0.tar.gz", hash = "sha256:f74dff1889ba291a4b76c5079df0711810e2d9da81abfdc99957bc961c1eb28f"}, + {file = "google_api_core-2.21.0-py3-none-any.whl", hash = "sha256:6869eacb2a37720380ba5898312af79a4d30b8bca1548fb4093e0697dc4bdf5d"}, + {file = "google_api_core-2.21.0.tar.gz", hash = "sha256:4a152fd11a9f774ea606388d423b68aa7e6d6a0ffe4c8266f74979613ec09f81"}, ] [package.dependencies] @@ -1593,6 +1609,7 @@ protobuf = ">=3.19.5,<3.20.0 || >3.20.0,<3.20.1 || >3.20.1,<4.21.0 || >4.21.0,<4 requests = ">=2.18.0,<3.0.0.dev0" [package.extras] +async-rest = ["google-auth[aiohttp] (>=2.35.0,<3.0.dev0)"] grpc = ["grpcio (>=1.33.2,<2.0dev)", "grpcio (>=1.49.1,<2.0dev)", "grpcio-status (>=1.33.2,<2.0.dev0)", "grpcio-status (>=1.49.1,<2.0.dev0)"] grpcgcp = ["grpcio-gcp (>=0.2.2,<1.0.dev0)"] grpcio-gcp = ["grpcio-gcp (>=0.2.2,<1.0.dev0)"] @@ -1622,13 +1639,13 @@ requests = ["requests (>=2.20.0,<3.0.0.dev0)"] [[package]] name = "google-cloud-aiplatform" -version = "1.68.0" +version = "1.70.0" description = "Vertex AI API client library" optional = false python-versions = ">=3.8" files = [ - {file = "google-cloud-aiplatform-1.68.0.tar.gz", hash = "sha256:d74e9f33707c7a14c6a32a7cfe9acd32b90975dfba9fac487d105c8ba5197f40"}, - {file = "google_cloud_aiplatform-1.68.0-py2.py3-none-any.whl", hash = "sha256:24dacc34457665ab6054bdf47e2475793dcf2d865b568420a909b452a477b3e6"}, + {file = "google-cloud-aiplatform-1.70.0.tar.gz", hash = "sha256:e8edef6dbc7911380d0ea55c47544e799f62b891cb1a83b504ca1c09fff9884b"}, + {file = "google_cloud_aiplatform-1.70.0-py2.py3-none-any.whl", hash = "sha256:690e6041f03d3aa85102ac3f316c958d6f43a99aefb7fb3f8938dee56d08abd9"}, ] [package.dependencies] @@ -1658,8 +1675,8 @@ metadata = ["numpy (>=1.15.0)", "pandas (>=1.0.0)"] pipelines = ["pyyaml (>=5.3.1,<7)"] prediction = ["docker (>=5.0.3)", "fastapi (>=0.71.0,<=0.114.0)", "httpx (>=0.23.0,<0.25.0)", "starlette (>=0.17.1)", "uvicorn[standard] (>=0.16.0)"] private-endpoints = ["requests (>=2.28.1)", "urllib3 (>=1.21.1,<1.27)"] -ray = ["google-cloud-bigquery", "google-cloud-bigquery-storage", "immutabledict", "pandas (>=1.0.0,<2.2.0)", "pyarrow (>=6.0.1)", "ray[default] (>=2.4,<2.5.dev0 || >2.9.0,!=2.9.1,!=2.9.2,<2.10.dev0 || >=2.33.dev0,<=2.33.0)", "ray[default] (>=2.5,<=2.33.0)", "setuptools (<70.0.0)"] -ray-testing = ["google-cloud-bigquery", "google-cloud-bigquery-storage", "immutabledict", "pandas (>=1.0.0,<2.2.0)", "pyarrow (>=6.0.1)", "pytest-xdist", "ray[default] (>=2.4,<2.5.dev0 || >2.9.0,!=2.9.1,!=2.9.2,<2.10.dev0 || >=2.33.dev0,<=2.33.0)", "ray[default] (>=2.5,<=2.33.0)", "ray[train]", "scikit-learn", "setuptools (<70.0.0)", "tensorflow", "torch (>=2.0.0,<2.1.0)", "xgboost", "xgboost-ray"] +ray = ["google-cloud-bigquery", "google-cloud-bigquery-storage", "immutabledict", "pandas (>=1.0.0)", "pyarrow (>=6.0.1)", "ray[default] (>=2.4,<2.5.dev0 || >2.9.0,!=2.9.1,!=2.9.2,<2.10.dev0 || >=2.33.dev0,<=2.33.0)", "ray[default] (>=2.5,<=2.33.0)", "setuptools (<70.0.0)"] +ray-testing = ["google-cloud-bigquery", "google-cloud-bigquery-storage", "immutabledict", "pandas (>=1.0.0)", "pyarrow (>=6.0.1)", "pytest-xdist", "ray[default] (>=2.4,<2.5.dev0 || >2.9.0,!=2.9.1,!=2.9.2,<2.10.dev0 || >=2.33.dev0,<=2.33.0)", "ray[default] (>=2.5,<=2.33.0)", "ray[train]", "scikit-learn", "setuptools (<70.0.0)", "tensorflow", "torch (>=2.0.0,<2.1.0)", "xgboost", "xgboost-ray"] reasoningengine = ["cloudpickle (>=3.0,<4.0)", "google-cloud-trace (<2)", "opentelemetry-exporter-gcp-trace (<2)", "opentelemetry-sdk (<2)", "pydantic (>=2.6.3,<3)"] tensorboard = ["tensorboard-plugin-profile (>=2.4.0,<3.0.0dev)", "tensorflow (>=2.3.0,<3.0.0dev)", "tensorflow (>=2.4.0,<3.0.0dev)", "werkzeug (>=2.0.0,<2.1.0dev)"] testing = ["bigframes", "docker (>=5.0.3)", "explainable-ai-sdk (>=1.0.0)", "fastapi (>=0.71.0,<=0.114.0)", "google-api-core (>=2.11,<3.0.0)", "google-cloud-bigquery", "google-cloud-bigquery-storage", "google-vizier (>=0.1.6)", "grpcio-testing", "httpx (>=0.23.0,<0.25.0)", "immutabledict", "ipython", "kfp (>=2.6.0,<3.0.0)", "lit-nlp (==0.4.0)", "mlflow (>=1.27.0,<=2.16.0)", "nltk", "numpy (>=1.15.0)", "pandas (>=1.0.0)", "pandas (>=1.0.0,<2.2.0)", "pyarrow (>=10.0.1)", "pyarrow (>=14.0.0)", "pyarrow (>=3.0.0,<8.0dev)", "pyarrow (>=6.0.1)", "pytest-asyncio", "pytest-xdist", "pyyaml (>=5.3.1,<7)", "ray[default] (>=2.4,<2.5.dev0 || >2.9.0,!=2.9.1,!=2.9.2,<2.10.dev0 || >=2.33.dev0,<=2.33.0)", "ray[default] (>=2.5,<=2.33.0)", "requests (>=2.28.1)", "requests-toolbelt (<1.0.0)", "scikit-learn", "sentencepiece (>=0.2.0)", "setuptools (<70.0.0)", "starlette (>=0.17.1)", "tensorboard-plugin-profile (>=2.4.0,<3.0.0dev)", "tensorflow (==2.13.0)", "tensorflow (==2.16.1)", "tensorflow (>=2.3.0,<3.0.0dev)", "tensorflow (>=2.3.0,<3.0.0dev)", "tensorflow (>=2.4.0,<3.0.0dev)", "torch (>=2.0.0,<2.1.0)", "torch (>=2.2.0)", "tqdm (>=4.23.0)", "urllib3 (>=1.21.1,<1.27)", "uvicorn[standard] (>=0.16.0)", "werkzeug (>=2.0.0,<2.1.0dev)", "xgboost"] @@ -2254,13 +2271,13 @@ files = [ [[package]] name = "huggingface-hub" -version = "0.25.1" +version = "0.25.2" description = "Client library to download and publish models, datasets and other repos on the huggingface.co hub" optional = false python-versions = ">=3.8.0" files = [ - {file = "huggingface_hub-0.25.1-py3-none-any.whl", hash = "sha256:a5158ded931b3188f54ea9028097312cb0acd50bffaaa2612014c3c526b44972"}, - {file = "huggingface_hub-0.25.1.tar.gz", hash = "sha256:9ff7cb327343211fbd06e2b149b8f362fd1e389454f3f14c6db75a4999ee20ff"}, + {file = "huggingface_hub-0.25.2-py3-none-any.whl", hash = "sha256:1897caf88ce7f97fe0110603d8f66ac264e3ba6accdf30cd66cc0fed5282ad25"}, + {file = "huggingface_hub-0.25.2.tar.gz", hash = "sha256:a1014ea111a5f40ccd23f7f7ba8ac46e20fa3b658ced1f86a00c75c06ec6423c"}, ] [package.dependencies] @@ -2433,13 +2450,13 @@ vertexai = ["google-cloud-aiplatform (>=1.52.0,<2.0.0)", "jsonref (>=1.1.0,<2.0. [[package]] name = "ipython" -version = "8.27.0" +version = "8.28.0" description = "IPython: Productive Interactive Computing" optional = false python-versions = ">=3.10" files = [ - {file = "ipython-8.27.0-py3-none-any.whl", hash = "sha256:f68b3cb8bde357a5d7adc9598d57e22a45dfbea19eb6b98286fa3b288c9cd55c"}, - {file = "ipython-8.27.0.tar.gz", hash = "sha256:0b99a2dc9f15fd68692e898e5568725c6d49c527d36a9fb5960ffbdeaa82ff7e"}, + {file = "ipython-8.28.0-py3-none-any.whl", hash = "sha256:530ef1e7bb693724d3cdc37287c80b07ad9b25986c007a53aa1857272dac3f35"}, + {file = "ipython-8.28.0.tar.gz", hash = "sha256:0d0d15ca1e01faeb868ef56bc7ee5a0de5bd66885735682e8a322ae289a13d1a"}, ] [package.dependencies] @@ -2719,13 +2736,13 @@ format-nongpl = ["fqdn", "idna", "isoduration", "jsonpointer (>1.13)", "rfc3339- [[package]] name = "jsonschema-specifications" -version = "2023.12.1" +version = "2024.10.1" description = "The JSON Schema meta-schemas and vocabularies, exposed as a Registry" optional = false -python-versions = ">=3.8" +python-versions = ">=3.9" files = [ - {file = "jsonschema_specifications-2023.12.1-py3-none-any.whl", hash = "sha256:87e4fdf3a94858b8a2ba2778d9ba57d8a9cafca7c7489c46ba0d30a8bc6a9c3c"}, - {file = "jsonschema_specifications-2023.12.1.tar.gz", hash = "sha256:48a76787b3e70f5ed53f1160d2b81f586e4ca6d1548c5de7085d1682674764cc"}, + {file = "jsonschema_specifications-2024.10.1-py3-none-any.whl", hash = "sha256:a09a0680616357d9a0ecf05c12ad234479f549239d0f5b55f3deea67475da9bf"}, + {file = "jsonschema_specifications-2024.10.1.tar.gz", hash = "sha256:0f38b83639958ce1152d02a7f062902c41c8fd20d558b0c34344292d417ae272"}, ] [package.dependencies] @@ -2958,13 +2975,13 @@ langchain-core = ">=0.2.38,<0.3.0" [[package]] name = "langsmith" -version = "0.1.129" +version = "0.1.133" description = "Client library to connect to the LangSmith LLM Tracing and Evaluation Platform." optional = false python-versions = "<4.0,>=3.8.1" files = [ - {file = "langsmith-0.1.129-py3-none-any.whl", hash = "sha256:31393fbbb17d6be5b99b9b22d530450094fab23c6c37281a6a6efb2143d05347"}, - {file = "langsmith-0.1.129.tar.gz", hash = "sha256:6c3ba66471bef41b9f87da247cc0b493268b3f54656f73648a256a205261b6a0"}, + {file = "langsmith-0.1.133-py3-none-any.whl", hash = "sha256:82e837a6039c483beadbe19c2ba7ebafbd402d3e8105234f5ef334425cff7b45"}, + {file = "langsmith-0.1.133.tar.gz", hash = "sha256:7bfd8bef166b9a64ee540a11bee4aa7bf43b1d9229f95b0fc19086454955185d"}, ] [package.dependencies] @@ -2975,16 +2992,17 @@ pydantic = [ {version = ">=2.7.4,<3.0.0", markers = "python_full_version >= \"3.12.4\""}, ] requests = ">=2,<3" +requests-toolbelt = ">=1.0.0,<2.0.0" [[package]] name = "litellm" -version = "1.48.7" +version = "1.49.0" description = "Library to easily interface with LLM API providers" optional = false python-versions = "!=2.7.*,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3.8" files = [ - {file = "litellm-1.48.7-py3-none-any.whl", hash = "sha256:4971a9e681188635c2ee6dc44fe35bb2774586e9018682adcccdbb516b839c64"}, - {file = "litellm-1.48.7.tar.gz", hash = "sha256:ff1fef7049e9afa09598f98d1e510a6d5f252ec65c0526b8bfaf13eadfcf65e5"}, + {file = "litellm-1.49.0-py3-none-any.whl", hash = "sha256:53711018b730f8a4262c11461b702b771e46e0c974f9c0bcd5b384b027308dd5"}, + {file = "litellm-1.49.0.tar.gz", hash = "sha256:f5ef51b571b14de318fccdd6728f4e705aad68250f9ed374c7fe6c4e95d6c008"}, ] [package.dependencies] @@ -2993,7 +3011,7 @@ click = "*" importlib-metadata = ">=6.8.0" jinja2 = ">=3.1.2,<4.0.0" jsonschema = ">=4.22.0,<5.0.0" -openai = ">=1.45.0" +openai = ">=1.51.0" pydantic = ">=2.0.0,<3.0.0" python-dotenv = ">=0.2.0" requests = ">=2.31.0,<3.0.0" @@ -3064,71 +3082,72 @@ testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"] [[package]] name = "markupsafe" -version = "2.1.5" +version = "3.0.1" description = "Safely add untrusted strings to HTML/XML markup." optional = false -python-versions = ">=3.7" +python-versions = ">=3.9" files = [ - {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-win32.whl", hash = "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-win_amd64.whl", hash = "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-win32.whl", hash = "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-win_amd64.whl", hash = "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-win32.whl", hash = "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-win_amd64.whl", hash = "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c8b29db45f8fe46ad280a7294f5c3ec36dbac9491f2d1c17345be8e69cc5928f"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ec6a563cff360b50eed26f13adc43e61bc0c04d94b8be985e6fb24b81f6dcfdf"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a549b9c31bec33820e885335b451286e2969a2d9e24879f83fe904a5ce59d70a"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4f11aa001c540f62c6166c7726f71f7573b52c68c31f014c25cc7901deea0b52"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:7b2e5a267c855eea6b4283940daa6e88a285f5f2a67f2220203786dfa59b37e9"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:2d2d793e36e230fd32babe143b04cec8a8b3eb8a3122d2aceb4a371e6b09b8df"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ce409136744f6521e39fd8e2a24c53fa18ad67aa5bc7c2cf83645cce5b5c4e50"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-win32.whl", hash = "sha256:4096e9de5c6fdf43fb4f04c26fb114f61ef0bf2e5604b6ee3019d51b69e8c371"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-win_amd64.whl", hash = "sha256:4275d846e41ecefa46e2015117a9f491e57a71ddd59bbead77e904dc02b1bed2"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-win32.whl", hash = "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-win_amd64.whl", hash = "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-win32.whl", hash = "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5"}, - {file = "MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:db842712984e91707437461930e6011e60b39136c7331e971952bb30465bc1a1"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:3ffb4a8e7d46ed96ae48805746755fadd0909fea2306f93d5d8233ba23dda12a"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:67c519635a4f64e495c50e3107d9b4075aec33634272b5db1cde839e07367589"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:48488d999ed50ba8d38c581d67e496f955821dc183883550a6fbc7f1aefdc170"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f31ae06f1328595d762c9a2bf29dafd8621c7d3adc130cbb46278079758779ca"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:80fcbf3add8790caddfab6764bde258b5d09aefbe9169c183f88a7410f0f6dea"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:3341c043c37d78cc5ae6e3e305e988532b072329639007fd408a476642a89fd6"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:cb53e2a99df28eee3b5f4fea166020d3ef9116fdc5764bc5117486e6d1211b25"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-win32.whl", hash = "sha256:db15ce28e1e127a0013dfb8ac243a8e392db8c61eae113337536edb28bdc1f97"}, + {file = "MarkupSafe-3.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:4ffaaac913c3f7345579db4f33b0020db693f302ca5137f106060316761beea9"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:26627785a54a947f6d7336ce5963569b5d75614619e75193bdb4e06e21d447ad"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:b954093679d5750495725ea6f88409946d69cfb25ea7b4c846eef5044194f583"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:973a371a55ce9ed333a3a0f8e0bcfae9e0d637711534bcb11e130af2ab9334e7"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:244dbe463d5fb6d7ce161301a03a6fe744dac9072328ba9fc82289238582697b"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d98e66a24497637dd31ccab090b34392dddb1f2f811c4b4cd80c230205c074a3"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:ad91738f14eb8da0ff82f2acd0098b6257621410dcbd4df20aaa5b4233d75a50"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:7044312a928a66a4c2a22644147bc61a199c1709712069a344a3fb5cfcf16915"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:a4792d3b3a6dfafefdf8e937f14906a51bd27025a36f4b188728a73382231d91"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-win32.whl", hash = "sha256:fa7d686ed9883f3d664d39d5a8e74d3c5f63e603c2e3ff0abcba23eac6542635"}, + {file = "MarkupSafe-3.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:9ba25a71ebf05b9bb0e2ae99f8bc08a07ee8e98c612175087112656ca0f5c8bf"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:8ae369e84466aa70f3154ee23c1451fda10a8ee1b63923ce76667e3077f2b0c4"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40f1e10d51c92859765522cbd79c5c8989f40f0419614bcdc5015e7b6bf97fc5"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5a4cb365cb49b750bdb60b846b0c0bc49ed62e59a76635095a179d440540c346"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ee3941769bd2522fe39222206f6dd97ae83c442a94c90f2b7a25d847d40f4729"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:62fada2c942702ef8952754abfc1a9f7658a4d5460fabe95ac7ec2cbe0d02abc"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:4c2d64fdba74ad16138300815cfdc6ab2f4647e23ced81f59e940d7d4a1469d9"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:fb532dd9900381d2e8f48172ddc5a59db4c445a11b9fab40b3b786da40d3b56b"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:0f84af7e813784feb4d5e4ff7db633aba6c8ca64a833f61d8e4eade234ef0c38"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-win32.whl", hash = "sha256:cbf445eb5628981a80f54087f9acdbf84f9b7d862756110d172993b9a5ae81aa"}, + {file = "MarkupSafe-3.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:a10860e00ded1dd0a65b83e717af28845bb7bd16d8ace40fe5531491de76b79f"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:e81c52638315ff4ac1b533d427f50bc0afc746deb949210bc85f05d4f15fd772"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:312387403cd40699ab91d50735ea7a507b788091c416dd007eac54434aee51da"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2ae99f31f47d849758a687102afdd05bd3d3ff7dbab0a8f1587981b58a76152a"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c97ff7fedf56d86bae92fa0a646ce1a0ec7509a7578e1ed238731ba13aabcd1c"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a7420ceda262dbb4b8d839a4ec63d61c261e4e77677ed7c66c99f4e7cb5030dd"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:45d42d132cff577c92bfba536aefcfea7e26efb975bd455db4e6602f5c9f45e7"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:4c8817557d0de9349109acb38b9dd570b03cc5014e8aabf1cbddc6e81005becd"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:6a54c43d3ec4cf2a39f4387ad044221c66a376e58c0d0e971d47c475ba79c6b5"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-win32.whl", hash = "sha256:c91b394f7601438ff79a4b93d16be92f216adb57d813a78be4446fe0f6bc2d8c"}, + {file = "MarkupSafe-3.0.1-cp313-cp313-win_amd64.whl", hash = "sha256:fe32482b37b4b00c7a52a07211b479653b7fe4f22b2e481b9a9b099d8a430f2f"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:17b2aea42a7280db02ac644db1d634ad47dcc96faf38ab304fe26ba2680d359a"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:852dc840f6d7c985603e60b5deaae1d89c56cb038b577f6b5b8c808c97580f1d"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0778de17cff1acaeccc3ff30cd99a3fd5c50fc58ad3d6c0e0c4c58092b859396"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:800100d45176652ded796134277ecb13640c1a537cad3b8b53da45aa96330453"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d06b24c686a34c86c8c1fba923181eae6b10565e4d80bdd7bc1c8e2f11247aa4"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:33d1c36b90e570ba7785dacd1faaf091203d9942bc036118fab8110a401eb1a8"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:beeebf760a9c1f4c07ef6a53465e8cfa776ea6a2021eda0d0417ec41043fe984"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:bbde71a705f8e9e4c3e9e33db69341d040c827c7afa6789b14c6e16776074f5a"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-win32.whl", hash = "sha256:82b5dba6eb1bcc29cc305a18a3c5365d2af06ee71b123216416f7e20d2a84e5b"}, + {file = "MarkupSafe-3.0.1-cp313-cp313t-win_amd64.whl", hash = "sha256:730d86af59e0e43ce277bb83970530dd223bf7f2a838e086b50affa6ec5f9295"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:4935dd7883f1d50e2ffecca0aa33dc1946a94c8f3fdafb8df5c330e48f71b132"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:e9393357f19954248b00bed7c56f29a25c930593a77630c719653d51e7669c2a"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:40621d60d0e58aa573b68ac5e2d6b20d44392878e0bfc159012a5787c4e35bc8"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f94190df587738280d544971500b9cafc9b950d32efcb1fba9ac10d84e6aa4e6"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b6a387d61fe41cdf7ea95b38e9af11cfb1a63499af2759444b99185c4ab33f5b"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:8ad4ad1429cd4f315f32ef263c1342166695fad76c100c5d979c45d5570ed58b"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:e24bfe89c6ac4c31792793ad9f861b8f6dc4546ac6dc8f1c9083c7c4f2b335cd"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:2a4b34a8d14649315c4bc26bbfa352663eb51d146e35eef231dd739d54a5430a"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-win32.whl", hash = "sha256:242d6860f1fd9191aef5fae22b51c5c19767f93fb9ead4d21924e0bcb17619d8"}, + {file = "MarkupSafe-3.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:93e8248d650e7e9d49e8251f883eed60ecbc0e8ffd6349e18550925e31bd029b"}, + {file = "markupsafe-3.0.1.tar.gz", hash = "sha256:3e683ee4f5d0fa2dde4db77ed8dd8a876686e3fc417655c2ece9a90576905344"}, ] [[package]] @@ -3272,13 +3291,13 @@ pyyaml = ">=5.1" [[package]] name = "mkdocs-material" -version = "9.5.39" +version = "9.5.40" description = "Documentation that simply works" optional = false python-versions = ">=3.8" files = [ - {file = "mkdocs_material-9.5.39-py3-none-any.whl", hash = "sha256:0f2f68c8db89523cb4a59705cd01b4acd62b2f71218ccb67e1e004e560410d2b"}, - {file = "mkdocs_material-9.5.39.tar.gz", hash = "sha256:25faa06142afa38549d2b781d475a86fb61de93189f532b88e69bf11e5e5c3be"}, + {file = "mkdocs_material-9.5.40-py3-none-any.whl", hash = "sha256:8e7a16ada34e79a7b6459ff2602584222f522c738b6a023d1bea853d5049da6f"}, + {file = "mkdocs_material-9.5.40.tar.gz", hash = "sha256:b69d70e667ec51fc41f65e006a3184dd00d95b2439d982cb1586e4c018943156"}, ] [package.dependencies] @@ -3759,20 +3778,21 @@ pyarrow = ["pyarrow (>=1.0.0)"] [[package]] name = "networkx" -version = "3.3" +version = "3.4" description = "Python package for creating and manipulating graphs and networks" optional = false python-versions = ">=3.10" files = [ - {file = "networkx-3.3-py3-none-any.whl", hash = "sha256:28575580c6ebdaf4505b22c6256a2b9de86b316dc63ba9e93abde3d78dfdbcf2"}, - {file = "networkx-3.3.tar.gz", hash = "sha256:0c127d8b2f4865f59ae9cb8aafcd60b5c70f3241ebd66f7defad7c4ab90126c9"}, + {file = "networkx-3.4-py3-none-any.whl", hash = "sha256:46dad0ec74a825a968e2b36c37ef5b91faa3868f017b2283d9cbff33112222ce"}, + {file = "networkx-3.4.tar.gz", hash = "sha256:1269b90f8f0d3a4095f016f49650f35ac169729f49b69d0572b2bb142748162b"}, ] [package.extras] -default = ["matplotlib (>=3.6)", "numpy (>=1.23)", "pandas (>=1.4)", "scipy (>=1.9,!=1.11.0,!=1.11.1)"] +default = ["matplotlib (>=3.7)", "numpy (>=1.24)", "pandas (>=2.0)", "scipy (>=1.10,!=1.11.0,!=1.11.1)"] developer = ["changelist (==0.5)", "mypy (>=1.1)", "pre-commit (>=3.2)", "rtoml"] -doc = ["myst-nb (>=1.0)", "numpydoc (>=1.7)", "pillow (>=9.4)", "pydata-sphinx-theme (>=0.14)", "sphinx (>=7)", "sphinx-gallery (>=0.14)", "texext (>=0.6.7)"] -extra = ["lxml (>=4.6)", "pydot (>=2.0)", "pygraphviz (>=1.12)", "sympy (>=1.10)"] +doc = ["intersphinx-registry", "myst-nb (>=1.1)", "numpydoc (>=1.8.0)", "pillow (>=9.4)", "pydata-sphinx-theme (>=0.15)", "sphinx (>=7.3)", "sphinx-gallery (>=0.16)", "texext (>=0.6.7)"] +example = ["cairocffi (>=1.7)", "contextily (>=1.6)", "igraph (>=0.11)", "momepy (>=0.7.2)", "osmnx (>=1.9)", "scikit-learn (>=1.5)", "seaborn (>=0.13)"] +extra = ["lxml (>=4.6)", "pydot (>=3.0.1)", "pygraphviz (>=1.14)", "sympy (>=1.10)"] test = ["pytest (>=7.2)", "pytest-cov (>=4.0)"] [[package]] @@ -3891,13 +3911,13 @@ sympy = "*" [[package]] name = "openai" -version = "1.51.0" +version = "1.51.2" description = "The official Python library for the openai API" optional = false python-versions = ">=3.7.1" files = [ - {file = "openai-1.51.0-py3-none-any.whl", hash = "sha256:d9affafb7e51e5a27dce78589d4964ce4d6f6d560307265933a94b2e3f3c5d2c"}, - {file = "openai-1.51.0.tar.gz", hash = "sha256:8dc4f9d75ccdd5466fc8c99a952186eddceb9fd6ba694044773f3736a847149d"}, + {file = "openai-1.51.2-py3-none-any.whl", hash = "sha256:5c5954711cba931423e471c37ff22ae0fd3892be9b083eee36459865fbbb83fa"}, + {file = "openai-1.51.2.tar.gz", hash = "sha256:c6a51fac62a1ca9df85a522e462918f6bb6bc51a8897032217e453a0730123a6"}, ] [package.dependencies] @@ -4452,13 +4472,13 @@ xmp = ["defusedxml"] [[package]] name = "pkginfo" -version = "1.11.1" +version = "1.11.2" description = "Query metadata from sdists / bdists / installed packages." optional = false python-versions = ">=3.8" files = [ - {file = "pkginfo-1.11.1-py3-none-any.whl", hash = "sha256:bfa76a714fdfc18a045fcd684dbfc3816b603d9d075febef17cb6582bea29573"}, - {file = "pkginfo-1.11.1.tar.gz", hash = "sha256:2e0dca1cf4c8e39644eed32408ea9966ee15e0d324c62ba899a393b3c6b467aa"}, + {file = "pkginfo-1.11.2-py3-none-any.whl", hash = "sha256:9ec518eefccd159de7ed45386a6bb4c6ca5fa2cb3bd9b71154fae44f6f1b36a3"}, + {file = "pkginfo-1.11.2.tar.gz", hash = "sha256:c6bc916b8298d159e31f2c216e35ee5b86da7da18874f879798d0a1983537c86"}, ] [package.extras] @@ -4578,13 +4598,13 @@ tests = ["pytest (>=5.4.1)", "pytest-cov (>=2.8.1)", "pytest-mypy (>=0.8.0)", "p [[package]] name = "posthog" -version = "3.6.6" +version = "3.7.0" description = "Integrate PostHog into any python application." optional = false python-versions = "*" files = [ - {file = "posthog-3.6.6-py2.py3-none-any.whl", hash = "sha256:38834fd7f0732582a20d4eb4674c8d5c088e464d14d1b3f8c176e389aecaa4ef"}, - {file = "posthog-3.6.6.tar.gz", hash = "sha256:1e04783293117109189ad7048f3eedbe21caff0e39bee5e2d47a93dd790fefac"}, + {file = "posthog-3.7.0-py2.py3-none-any.whl", hash = "sha256:3555161c3a9557b5666f96d8e1f17f410ea0f07db56e399e336a1656d4e5c722"}, + {file = "posthog-3.7.0.tar.gz", hash = "sha256:b095d4354ba23f8b346ab5daed8ecfc5108772f922006982dfe8b2d29ebc6e0e"}, ] [package.dependencies] @@ -4631,6 +4651,113 @@ files = [ [package.dependencies] wcwidth = "*" +[[package]] +name = "propcache" +version = "0.2.0" +description = "Accelerated property cache" +optional = false +python-versions = ">=3.8" +files = [ + {file = "propcache-0.2.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:c5869b8fd70b81835a6f187c5fdbe67917a04d7e52b6e7cc4e5fe39d55c39d58"}, + {file = "propcache-0.2.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:952e0d9d07609d9c5be361f33b0d6d650cd2bae393aabb11d9b719364521984b"}, + {file = "propcache-0.2.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:33ac8f098df0585c0b53009f039dfd913b38c1d2edafed0cedcc0c32a05aa110"}, + {file = "propcache-0.2.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:97e48e8875e6c13909c800fa344cd54cc4b2b0db1d5f911f840458a500fde2c2"}, + {file = "propcache-0.2.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:388f3217649d6d59292b722d940d4d2e1e6a7003259eb835724092a1cca0203a"}, + {file = "propcache-0.2.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f571aea50ba5623c308aa146eb650eebf7dbe0fd8c5d946e28343cb3b5aad577"}, + {file = "propcache-0.2.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3dfafb44f7bb35c0c06eda6b2ab4bfd58f02729e7c4045e179f9a861b07c9850"}, + {file = "propcache-0.2.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a3ebe9a75be7ab0b7da2464a77bb27febcb4fab46a34f9288f39d74833db7f61"}, + {file = "propcache-0.2.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:d2f0d0f976985f85dfb5f3d685697ef769faa6b71993b46b295cdbbd6be8cc37"}, + {file = "propcache-0.2.0-cp310-cp310-musllinux_1_2_armv7l.whl", hash = "sha256:a3dc1a4b165283bd865e8f8cb5f0c64c05001e0718ed06250d8cac9bec115b48"}, + {file = "propcache-0.2.0-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:9e0f07b42d2a50c7dd2d8675d50f7343d998c64008f1da5fef888396b7f84630"}, + {file = "propcache-0.2.0-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:e63e3e1e0271f374ed489ff5ee73d4b6e7c60710e1f76af5f0e1a6117cd26394"}, + {file = "propcache-0.2.0-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:56bb5c98f058a41bb58eead194b4db8c05b088c93d94d5161728515bd52b052b"}, + {file = "propcache-0.2.0-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:7665f04d0c7f26ff8bb534e1c65068409bf4687aa2534faf7104d7182debb336"}, + {file = "propcache-0.2.0-cp310-cp310-win32.whl", hash = "sha256:7cf18abf9764746b9c8704774d8b06714bcb0a63641518a3a89c7f85cc02c2ad"}, + {file = "propcache-0.2.0-cp310-cp310-win_amd64.whl", hash = "sha256:cfac69017ef97db2438efb854edf24f5a29fd09a536ff3a992b75990720cdc99"}, + {file = "propcache-0.2.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:63f13bf09cc3336eb04a837490b8f332e0db41da66995c9fd1ba04552e516354"}, + {file = "propcache-0.2.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:608cce1da6f2672a56b24a015b42db4ac612ee709f3d29f27a00c943d9e851de"}, + {file = "propcache-0.2.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:466c219deee4536fbc83c08d09115249db301550625c7fef1c5563a584c9bc87"}, + {file = "propcache-0.2.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fc2db02409338bf36590aa985a461b2c96fce91f8e7e0f14c50c5fcc4f229016"}, + {file = "propcache-0.2.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a6ed8db0a556343d566a5c124ee483ae113acc9a557a807d439bcecc44e7dfbb"}, + {file = "propcache-0.2.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:91997d9cb4a325b60d4e3f20967f8eb08dfcb32b22554d5ef78e6fd1dda743a2"}, + {file = "propcache-0.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4c7dde9e533c0a49d802b4f3f218fa9ad0a1ce21f2c2eb80d5216565202acab4"}, + {file = "propcache-0.2.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffcad6c564fe6b9b8916c1aefbb37a362deebf9394bd2974e9d84232e3e08504"}, + {file = "propcache-0.2.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:97a58a28bcf63284e8b4d7b460cbee1edaab24634e82059c7b8c09e65284f178"}, + {file = "propcache-0.2.0-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:945db8ee295d3af9dbdbb698cce9bbc5c59b5c3fe328bbc4387f59a8a35f998d"}, + {file = "propcache-0.2.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:39e104da444a34830751715f45ef9fc537475ba21b7f1f5b0f4d71a3b60d7fe2"}, + {file = "propcache-0.2.0-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:c5ecca8f9bab618340c8e848d340baf68bcd8ad90a8ecd7a4524a81c1764b3db"}, + {file = "propcache-0.2.0-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:c436130cc779806bdf5d5fae0d848713105472b8566b75ff70048c47d3961c5b"}, + {file = "propcache-0.2.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:191db28dc6dcd29d1a3e063c3be0b40688ed76434622c53a284e5427565bbd9b"}, + {file = "propcache-0.2.0-cp311-cp311-win32.whl", hash = "sha256:5f2564ec89058ee7c7989a7b719115bdfe2a2fb8e7a4543b8d1c0cc4cf6478c1"}, + {file = "propcache-0.2.0-cp311-cp311-win_amd64.whl", hash = "sha256:6e2e54267980349b723cff366d1e29b138b9a60fa376664a157a342689553f71"}, + {file = "propcache-0.2.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:2ee7606193fb267be4b2e3b32714f2d58cad27217638db98a60f9efb5efeccc2"}, + {file = "propcache-0.2.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:91ee8fc02ca52e24bcb77b234f22afc03288e1dafbb1f88fe24db308910c4ac7"}, + {file = "propcache-0.2.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:2e900bad2a8456d00a113cad8c13343f3b1f327534e3589acc2219729237a2e8"}, + {file = "propcache-0.2.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f52a68c21363c45297aca15561812d542f8fc683c85201df0bebe209e349f793"}, + {file = "propcache-0.2.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1e41d67757ff4fbc8ef2af99b338bfb955010444b92929e9e55a6d4dcc3c4f09"}, + {file = "propcache-0.2.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a64e32f8bd94c105cc27f42d3b658902b5bcc947ece3c8fe7bc1b05982f60e89"}, + {file = "propcache-0.2.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:55346705687dbd7ef0d77883ab4f6fabc48232f587925bdaf95219bae072491e"}, + {file = "propcache-0.2.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:00181262b17e517df2cd85656fcd6b4e70946fe62cd625b9d74ac9977b64d8d9"}, + {file = "propcache-0.2.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:6994984550eaf25dd7fc7bd1b700ff45c894149341725bb4edc67f0ffa94efa4"}, + {file = "propcache-0.2.0-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:56295eb1e5f3aecd516d91b00cfd8bf3a13991de5a479df9e27dd569ea23959c"}, + {file = "propcache-0.2.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:439e76255daa0f8151d3cb325f6dd4a3e93043e6403e6491813bcaaaa8733887"}, + {file = "propcache-0.2.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:f6475a1b2ecb310c98c28d271a30df74f9dd436ee46d09236a6b750a7599ce57"}, + {file = "propcache-0.2.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:3444cdba6628accf384e349014084b1cacd866fbb88433cd9d279d90a54e0b23"}, + {file = "propcache-0.2.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:4a9d9b4d0a9b38d1c391bb4ad24aa65f306c6f01b512e10a8a34a2dc5675d348"}, + {file = "propcache-0.2.0-cp312-cp312-win32.whl", hash = "sha256:69d3a98eebae99a420d4b28756c8ce6ea5a29291baf2dc9ff9414b42676f61d5"}, + {file = "propcache-0.2.0-cp312-cp312-win_amd64.whl", hash = "sha256:ad9c9b99b05f163109466638bd30ada1722abb01bbb85c739c50b6dc11f92dc3"}, + {file = "propcache-0.2.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:ecddc221a077a8132cf7c747d5352a15ed763b674c0448d811f408bf803d9ad7"}, + {file = "propcache-0.2.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:0e53cb83fdd61cbd67202735e6a6687a7b491c8742dfc39c9e01e80354956763"}, + {file = "propcache-0.2.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:92fe151145a990c22cbccf9ae15cae8ae9eddabfc949a219c9f667877e40853d"}, + {file = "propcache-0.2.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d6a21ef516d36909931a2967621eecb256018aeb11fc48656e3257e73e2e247a"}, + {file = "propcache-0.2.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3f88a4095e913f98988f5b338c1d4d5d07dbb0b6bad19892fd447484e483ba6b"}, + {file = "propcache-0.2.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5a5b3bb545ead161be780ee85a2b54fdf7092815995661947812dde94a40f6fb"}, + {file = "propcache-0.2.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:67aeb72e0f482709991aa91345a831d0b707d16b0257e8ef88a2ad246a7280bf"}, + {file = "propcache-0.2.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3c997f8c44ec9b9b0bcbf2d422cc00a1d9b9c681f56efa6ca149a941e5560da2"}, + {file = "propcache-0.2.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:2a66df3d4992bc1d725b9aa803e8c5a66c010c65c741ad901e260ece77f58d2f"}, + {file = "propcache-0.2.0-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:3ebbcf2a07621f29638799828b8d8668c421bfb94c6cb04269130d8de4fb7136"}, + {file = "propcache-0.2.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:1235c01ddaa80da8235741e80815ce381c5267f96cc49b1477fdcf8c047ef325"}, + {file = "propcache-0.2.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:3947483a381259c06921612550867b37d22e1df6d6d7e8361264b6d037595f44"}, + {file = "propcache-0.2.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:d5bed7f9805cc29c780f3aee05de3262ee7ce1f47083cfe9f77471e9d6777e83"}, + {file = "propcache-0.2.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:e4a91d44379f45f5e540971d41e4626dacd7f01004826a18cb048e7da7e96544"}, + {file = "propcache-0.2.0-cp313-cp313-win32.whl", hash = "sha256:f902804113e032e2cdf8c71015651c97af6418363bea8d78dc0911d56c335032"}, + {file = "propcache-0.2.0-cp313-cp313-win_amd64.whl", hash = "sha256:8f188cfcc64fb1266f4684206c9de0e80f54622c3f22a910cbd200478aeae61e"}, + {file = "propcache-0.2.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:53d1bd3f979ed529f0805dd35ddaca330f80a9a6d90bc0121d2ff398f8ed8861"}, + {file = "propcache-0.2.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:83928404adf8fb3d26793665633ea79b7361efa0287dfbd372a7e74311d51ee6"}, + {file = "propcache-0.2.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:77a86c261679ea5f3896ec060be9dc8e365788248cc1e049632a1be682442063"}, + {file = "propcache-0.2.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:218db2a3c297a3768c11a34812e63b3ac1c3234c3a086def9c0fee50d35add1f"}, + {file = "propcache-0.2.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:7735e82e3498c27bcb2d17cb65d62c14f1100b71723b68362872bca7d0913d90"}, + {file = "propcache-0.2.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:20a617c776f520c3875cf4511e0d1db847a076d720714ae35ffe0df3e440be68"}, + {file = "propcache-0.2.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:67b69535c870670c9f9b14a75d28baa32221d06f6b6fa6f77a0a13c5a7b0a5b9"}, + {file = "propcache-0.2.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4569158070180c3855e9c0791c56be3ceeb192defa2cdf6a3f39e54319e56b89"}, + {file = "propcache-0.2.0-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:db47514ffdbd91ccdc7e6f8407aac4ee94cc871b15b577c1c324236b013ddd04"}, + {file = "propcache-0.2.0-cp38-cp38-musllinux_1_2_armv7l.whl", hash = "sha256:2a60ad3e2553a74168d275a0ef35e8c0a965448ffbc3b300ab3a5bb9956c2162"}, + {file = "propcache-0.2.0-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:662dd62358bdeaca0aee5761de8727cfd6861432e3bb828dc2a693aa0471a563"}, + {file = "propcache-0.2.0-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:25a1f88b471b3bc911d18b935ecb7115dff3a192b6fef46f0bfaf71ff4f12418"}, + {file = "propcache-0.2.0-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:f60f0ac7005b9f5a6091009b09a419ace1610e163fa5deaba5ce3484341840e7"}, + {file = "propcache-0.2.0-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:74acd6e291f885678631b7ebc85d2d4aec458dd849b8c841b57ef04047833bed"}, + {file = "propcache-0.2.0-cp38-cp38-win32.whl", hash = "sha256:d9b6ddac6408194e934002a69bcaadbc88c10b5f38fb9307779d1c629181815d"}, + {file = "propcache-0.2.0-cp38-cp38-win_amd64.whl", hash = "sha256:676135dcf3262c9c5081cc8f19ad55c8a64e3f7282a21266d05544450bffc3a5"}, + {file = "propcache-0.2.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:25c8d773a62ce0451b020c7b29a35cfbc05de8b291163a7a0f3b7904f27253e6"}, + {file = "propcache-0.2.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:375a12d7556d462dc64d70475a9ee5982465fbb3d2b364f16b86ba9135793638"}, + {file = "propcache-0.2.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:1ec43d76b9677637a89d6ab86e1fef70d739217fefa208c65352ecf0282be957"}, + {file = "propcache-0.2.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f45eec587dafd4b2d41ac189c2156461ebd0c1082d2fe7013571598abb8505d1"}, + {file = "propcache-0.2.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bc092ba439d91df90aea38168e11f75c655880c12782facf5cf9c00f3d42b562"}, + {file = "propcache-0.2.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fa1076244f54bb76e65e22cb6910365779d5c3d71d1f18b275f1dfc7b0d71b4d"}, + {file = "propcache-0.2.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:682a7c79a2fbf40f5dbb1eb6bfe2cd865376deeac65acf9beb607505dced9e12"}, + {file = "propcache-0.2.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8e40876731f99b6f3c897b66b803c9e1c07a989b366c6b5b475fafd1f7ba3fb8"}, + {file = "propcache-0.2.0-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:363ea8cd3c5cb6679f1c2f5f1f9669587361c062e4899fce56758efa928728f8"}, + {file = "propcache-0.2.0-cp39-cp39-musllinux_1_2_armv7l.whl", hash = "sha256:140fbf08ab3588b3468932974a9331aff43c0ab8a2ec2c608b6d7d1756dbb6cb"}, + {file = "propcache-0.2.0-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:e70fac33e8b4ac63dfc4c956fd7d85a0b1139adcfc0d964ce288b7c527537fea"}, + {file = "propcache-0.2.0-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:b33d7a286c0dc1a15f5fc864cc48ae92a846df287ceac2dd499926c3801054a6"}, + {file = "propcache-0.2.0-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:f6d5749fdd33d90e34c2efb174c7e236829147a2713334d708746e94c4bde40d"}, + {file = "propcache-0.2.0-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:22aa8f2272d81d9317ff5756bb108021a056805ce63dd3630e27d042c8092798"}, + {file = "propcache-0.2.0-cp39-cp39-win32.whl", hash = "sha256:73e4b40ea0eda421b115248d7e79b59214411109a5bc47d0d48e4c73e3b8fcf9"}, + {file = "propcache-0.2.0-cp39-cp39-win_amd64.whl", hash = "sha256:9517d5e9e0731957468c29dbfd0f976736a0e55afaea843726e887f36fe017df"}, + {file = "propcache-0.2.0-py3-none-any.whl", hash = "sha256:2ccc28197af5313706511fab3a8b66dcd6da067a1331372c82ea1cb74285e036"}, + {file = "propcache-0.2.0.tar.gz", hash = "sha256:df81779732feb9d01e5d513fad0122efb3d53bbc75f61b2a4f29a020bc985e70"}, +] + [[package]] name = "proto-plus" version = "1.24.0" @@ -5132,13 +5259,13 @@ dev = ["build", "flake8", "mypy", "pytest", "twine"] [[package]] name = "pyright" -version = "1.1.382.post1" +version = "1.1.384" description = "Command line wrapper for pyright" optional = false python-versions = ">=3.7" files = [ - {file = "pyright-1.1.382.post1-py3-none-any.whl", hash = "sha256:21a4749dd1740e209f88d3a601e9f40748670d39481ea32b9d77edf7f3f1fb2e"}, - {file = "pyright-1.1.382.post1.tar.gz", hash = "sha256:66a5d4e83be9452853d73e9dd9e95ba0ac3061845270e4e331d0070a597d3445"}, + {file = "pyright-1.1.384-py3-none-any.whl", hash = "sha256:f0b6f4db2da38f27aeb7035c26192f034587875f751b847e9ad42ed0c704ac9e"}, + {file = "pyright-1.1.384.tar.gz", hash = "sha256:25e54d61f55cbb45f1195ff89c488832d7a45d59f3e132f178fdf9ef6cafc706"}, ] [package.dependencies] @@ -5212,6 +5339,25 @@ pytest = ">=7.0.0,<9" docs = ["sphinx (>=5.3)", "sphinx-rtd-theme (>=1.0)"] testing = ["coverage (>=6.2)", "hypothesis (>=5.7.1)"] +[[package]] +name = "pytest-subprocess" +version = "1.5.2" +description = "A plugin to fake subprocess for pytest" +optional = false +python-versions = ">=3.6" +files = [ + {file = "pytest_subprocess-1.5.2-py3-none-any.whl", hash = "sha256:23ac7732aa8bd45f1757265b1316eb72a7f55b41fb21e2ca22e149ba3629fa46"}, + {file = "pytest_subprocess-1.5.2.tar.gz", hash = "sha256:ad3ca8a35e798bf9c82d9f16d88700b30d98c5a28236117b86c5d6e581a8ed97"}, +] + +[package.dependencies] +pytest = ">=4.0.0" + +[package.extras] +dev = ["changelogd", "nox"] +docs = ["changelogd", "furo", "sphinx", "sphinx-autodoc-typehints", "sphinxcontrib-napoleon"] +test = ["Pygments (>=2.0)", "anyio", "coverage", "docutils (>=0.12)", "pytest (>=4.0)", "pytest-asyncio (>=0.15.1)", "pytest-rerunfailures", "pytest-timeout"] + [[package]] name = "pytest-vcr" version = "1.0.2" @@ -5295,25 +5441,29 @@ networkx = ">=1.11" [[package]] name = "pywin32" -version = "306" +version = "307" description = "Python for Window Extensions" optional = false python-versions = "*" files = [ - {file = "pywin32-306-cp310-cp310-win32.whl", hash = "sha256:06d3420a5155ba65f0b72f2699b5bacf3109f36acbe8923765c22938a69dfc8d"}, - {file = "pywin32-306-cp310-cp310-win_amd64.whl", hash = "sha256:84f4471dbca1887ea3803d8848a1616429ac94a4a8d05f4bc9c5dcfd42ca99c8"}, - {file = "pywin32-306-cp311-cp311-win32.whl", hash = "sha256:e65028133d15b64d2ed8f06dd9fbc268352478d4f9289e69c190ecd6818b6407"}, - {file = "pywin32-306-cp311-cp311-win_amd64.whl", hash = "sha256:a7639f51c184c0272e93f244eb24dafca9b1855707d94c192d4a0b4c01e1100e"}, - {file = "pywin32-306-cp311-cp311-win_arm64.whl", hash = "sha256:70dba0c913d19f942a2db25217d9a1b726c278f483a919f1abfed79c9cf64d3a"}, - {file = "pywin32-306-cp312-cp312-win32.whl", hash = "sha256:383229d515657f4e3ed1343da8be101000562bf514591ff383ae940cad65458b"}, - {file = "pywin32-306-cp312-cp312-win_amd64.whl", hash = "sha256:37257794c1ad39ee9be652da0462dc2e394c8159dfd913a8a4e8eb6fd346da0e"}, - {file = "pywin32-306-cp312-cp312-win_arm64.whl", hash = "sha256:5821ec52f6d321aa59e2db7e0a35b997de60c201943557d108af9d4ae1ec7040"}, - {file = "pywin32-306-cp37-cp37m-win32.whl", hash = "sha256:1c73ea9a0d2283d889001998059f5eaaba3b6238f767c9cf2833b13e6a685f65"}, - {file = "pywin32-306-cp37-cp37m-win_amd64.whl", hash = "sha256:72c5f621542d7bdd4fdb716227be0dd3f8565c11b280be6315b06ace35487d36"}, - {file = "pywin32-306-cp38-cp38-win32.whl", hash = "sha256:e4c092e2589b5cf0d365849e73e02c391c1349958c5ac3e9d5ccb9a28e017b3a"}, - {file = "pywin32-306-cp38-cp38-win_amd64.whl", hash = "sha256:e8ac1ae3601bee6ca9f7cb4b5363bf1c0badb935ef243c4733ff9a393b1690c0"}, - {file = "pywin32-306-cp39-cp39-win32.whl", hash = "sha256:e25fd5b485b55ac9c057f67d94bc203f3f6595078d1fb3b458c9c28b7153a802"}, - {file = "pywin32-306-cp39-cp39-win_amd64.whl", hash = "sha256:39b61c15272833b5c329a2989999dcae836b1eed650252ab1b7bfbe1d59f30f4"}, + {file = "pywin32-307-cp310-cp310-win32.whl", hash = "sha256:f8f25d893c1e1ce2d685ef6d0a481e87c6f510d0f3f117932781f412e0eba31b"}, + {file = "pywin32-307-cp310-cp310-win_amd64.whl", hash = "sha256:36e650c5e5e6b29b5d317385b02d20803ddbac5d1031e1f88d20d76676dd103d"}, + {file = "pywin32-307-cp310-cp310-win_arm64.whl", hash = "sha256:0c12d61e0274e0c62acee79e3e503c312426ddd0e8d4899c626cddc1cafe0ff4"}, + {file = "pywin32-307-cp311-cp311-win32.whl", hash = "sha256:fec5d27cc893178fab299de911b8e4d12c5954e1baf83e8a664311e56a272b75"}, + {file = "pywin32-307-cp311-cp311-win_amd64.whl", hash = "sha256:987a86971753ed7fdd52a7fb5747aba955b2c7fbbc3d8b76ec850358c1cc28c3"}, + {file = "pywin32-307-cp311-cp311-win_arm64.whl", hash = "sha256:fd436897c186a2e693cd0437386ed79f989f4d13d6f353f8787ecbb0ae719398"}, + {file = "pywin32-307-cp312-cp312-win32.whl", hash = "sha256:07649ec6b01712f36debf39fc94f3d696a46579e852f60157a729ac039df0815"}, + {file = "pywin32-307-cp312-cp312-win_amd64.whl", hash = "sha256:00d047992bb5dcf79f8b9b7c81f72e0130f9fe4b22df613f755ab1cc021d8347"}, + {file = "pywin32-307-cp312-cp312-win_arm64.whl", hash = "sha256:b53658acbfc6a8241d72cc09e9d1d666be4e6c99376bc59e26cdb6223c4554d2"}, + {file = "pywin32-307-cp313-cp313-win32.whl", hash = "sha256:ea4d56e48dc1ab2aa0a5e3c0741ad6e926529510516db7a3b6981a1ae74405e5"}, + {file = "pywin32-307-cp313-cp313-win_amd64.whl", hash = "sha256:576d09813eaf4c8168d0bfd66fb7cb3b15a61041cf41598c2db4a4583bf832d2"}, + {file = "pywin32-307-cp313-cp313-win_arm64.whl", hash = "sha256:b30c9bdbffda6a260beb2919f918daced23d32c79109412c2085cbc513338a0a"}, + {file = "pywin32-307-cp37-cp37m-win32.whl", hash = "sha256:5101472f5180c647d4525a0ed289ec723a26231550dbfd369ec19d5faf60e511"}, + {file = "pywin32-307-cp37-cp37m-win_amd64.whl", hash = "sha256:05de55a7c110478dc4b202230e98af5e0720855360d2b31a44bb4e296d795fba"}, + {file = "pywin32-307-cp38-cp38-win32.whl", hash = "sha256:13d059fb7f10792542082f5731d5d3d9645320fc38814759313e5ee97c3fac01"}, + {file = "pywin32-307-cp38-cp38-win_amd64.whl", hash = "sha256:7e0b2f93769d450a98ac7a31a087e07b126b6d571e8b4386a5762eb85325270b"}, + {file = "pywin32-307-cp39-cp39-win32.whl", hash = "sha256:55ee87f2f8c294e72ad9d4261ca423022310a6e79fb314a8ca76ab3f493854c6"}, + {file = "pywin32-307-cp39-cp39-win_amd64.whl", hash = "sha256:e9d5202922e74985b037c9ef46778335c102b74b95cec70f629453dbe7235d87"}, ] [[package]] @@ -5329,62 +5479,64 @@ files = [ [[package]] name = "pyyaml" -version = "6.0.1" +version = "6.0.2" description = "YAML parser and emitter for Python" optional = false -python-versions = ">=3.6" +python-versions = ">=3.8" files = [ - {file = "PyYAML-6.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a"}, - {file = "PyYAML-6.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f"}, - {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, - {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, - {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, - {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, - {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, - {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, - {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, - {file = "PyYAML-6.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab"}, - {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, - {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, - {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, - {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, - {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, - {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, - {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, - {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, - {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, - {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, - {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, - {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, - {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd"}, - {file = "PyYAML-6.0.1-cp36-cp36m-win32.whl", hash = "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585"}, - {file = "PyYAML-6.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa"}, - {file = "PyYAML-6.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3"}, - {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27"}, - {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3"}, - {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c"}, - {file = "PyYAML-6.0.1-cp37-cp37m-win32.whl", hash = "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba"}, - {file = "PyYAML-6.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867"}, - {file = "PyYAML-6.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595"}, - {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, - {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, - {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, - {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, - {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, - {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, - {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, - {file = "PyYAML-6.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859"}, - {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, - {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, - {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, - {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, - {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, - {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, - {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, + {file = "PyYAML-6.0.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:0a9a2848a5b7feac301353437eb7d5957887edbf81d56e903999a75a3d743086"}, + {file = "PyYAML-6.0.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:29717114e51c84ddfba879543fb232a6ed60086602313ca38cce623c1d62cfbf"}, + {file = "PyYAML-6.0.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8824b5a04a04a047e72eea5cec3bc266db09e35de6bdfe34c9436ac5ee27d237"}, + {file = "PyYAML-6.0.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7c36280e6fb8385e520936c3cb3b8042851904eba0e58d277dca80a5cfed590b"}, + {file = "PyYAML-6.0.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ec031d5d2feb36d1d1a24380e4db6d43695f3748343d99434e6f5f9156aaa2ed"}, + {file = "PyYAML-6.0.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:936d68689298c36b53b29f23c6dbb74de12b4ac12ca6cfe0e047bedceea56180"}, + {file = "PyYAML-6.0.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:23502f431948090f597378482b4812b0caae32c22213aecf3b55325e049a6c68"}, + {file = "PyYAML-6.0.2-cp310-cp310-win32.whl", hash = "sha256:2e99c6826ffa974fe6e27cdb5ed0021786b03fc98e5ee3c5bfe1fd5015f42b99"}, + {file = "PyYAML-6.0.2-cp310-cp310-win_amd64.whl", hash = "sha256:a4d3091415f010369ae4ed1fc6b79def9416358877534caf6a0fdd2146c87a3e"}, + {file = "PyYAML-6.0.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:cc1c1159b3d456576af7a3e4d1ba7e6924cb39de8f67111c735f6fc832082774"}, + {file = "PyYAML-6.0.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:1e2120ef853f59c7419231f3bf4e7021f1b936f6ebd222406c3b60212205d2ee"}, + {file = "PyYAML-6.0.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5d225db5a45f21e78dd9358e58a98702a0302f2659a3c6cd320564b75b86f47c"}, + {file = "PyYAML-6.0.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5ac9328ec4831237bec75defaf839f7d4564be1e6b25ac710bd1a96321cc8317"}, + {file = "PyYAML-6.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3ad2a3decf9aaba3d29c8f537ac4b243e36bef957511b4766cb0057d32b0be85"}, + {file = "PyYAML-6.0.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:ff3824dc5261f50c9b0dfb3be22b4567a6f938ccce4587b38952d85fd9e9afe4"}, + {file = "PyYAML-6.0.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:797b4f722ffa07cc8d62053e4cff1486fa6dc094105d13fea7b1de7d8bf71c9e"}, + {file = "PyYAML-6.0.2-cp311-cp311-win32.whl", hash = "sha256:11d8f3dd2b9c1207dcaf2ee0bbbfd5991f571186ec9cc78427ba5bd32afae4b5"}, + {file = "PyYAML-6.0.2-cp311-cp311-win_amd64.whl", hash = "sha256:e10ce637b18caea04431ce14fabcf5c64a1c61ec9c56b071a4b7ca131ca52d44"}, + {file = "PyYAML-6.0.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:c70c95198c015b85feafc136515252a261a84561b7b1d51e3384e0655ddf25ab"}, + {file = "PyYAML-6.0.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:ce826d6ef20b1bc864f0a68340c8b3287705cae2f8b4b1d932177dcc76721725"}, + {file = "PyYAML-6.0.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f71ea527786de97d1a0cc0eacd1defc0985dcf6b3f17bb77dcfc8c34bec4dc5"}, + {file = "PyYAML-6.0.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9b22676e8097e9e22e36d6b7bda33190d0d400f345f23d4065d48f4ca7ae0425"}, + {file = "PyYAML-6.0.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:80bab7bfc629882493af4aa31a4cfa43a4c57c83813253626916b8c7ada83476"}, + {file = "PyYAML-6.0.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:0833f8694549e586547b576dcfaba4a6b55b9e96098b36cdc7ebefe667dfed48"}, + {file = "PyYAML-6.0.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8b9c7197f7cb2738065c481a0461e50ad02f18c78cd75775628afb4d7137fb3b"}, + {file = "PyYAML-6.0.2-cp312-cp312-win32.whl", hash = "sha256:ef6107725bd54b262d6dedcc2af448a266975032bc85ef0172c5f059da6325b4"}, + {file = "PyYAML-6.0.2-cp312-cp312-win_amd64.whl", hash = "sha256:7e7401d0de89a9a855c839bc697c079a4af81cf878373abd7dc625847d25cbd8"}, + {file = "PyYAML-6.0.2-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:efdca5630322a10774e8e98e1af481aad470dd62c3170801852d752aa7a783ba"}, + {file = "PyYAML-6.0.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:50187695423ffe49e2deacb8cd10510bc361faac997de9efef88badc3bb9e2d1"}, + {file = "PyYAML-6.0.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0ffe8360bab4910ef1b9e87fb812d8bc0a308b0d0eef8c8f44e0254ab3b07133"}, + {file = "PyYAML-6.0.2-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:17e311b6c678207928d649faa7cb0d7b4c26a0ba73d41e99c4fff6b6c3276484"}, + {file = "PyYAML-6.0.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:70b189594dbe54f75ab3a1acec5f1e3faa7e8cf2f1e08d9b561cb41b845f69d5"}, + {file = "PyYAML-6.0.2-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:41e4e3953a79407c794916fa277a82531dd93aad34e29c2a514c2c0c5fe971cc"}, + {file = "PyYAML-6.0.2-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:68ccc6023a3400877818152ad9a1033e3db8625d899c72eacb5a668902e4d652"}, + {file = "PyYAML-6.0.2-cp313-cp313-win32.whl", hash = "sha256:bc2fa7c6b47d6bc618dd7fb02ef6fdedb1090ec036abab80d4681424b84c1183"}, + {file = "PyYAML-6.0.2-cp313-cp313-win_amd64.whl", hash = "sha256:8388ee1976c416731879ac16da0aff3f63b286ffdd57cdeb95f3f2e085687563"}, + {file = "PyYAML-6.0.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:24471b829b3bf607e04e88d79542a9d48bb037c2267d7927a874e6c205ca7e9a"}, + {file = "PyYAML-6.0.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d7fded462629cfa4b685c5416b949ebad6cec74af5e2d42905d41e257e0869f5"}, + {file = "PyYAML-6.0.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d84a1718ee396f54f3a086ea0a66d8e552b2ab2017ef8b420e92edbc841c352d"}, + {file = "PyYAML-6.0.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9056c1ecd25795207ad294bcf39f2db3d845767be0ea6e6a34d856f006006083"}, + {file = "PyYAML-6.0.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:82d09873e40955485746739bcb8b4586983670466c23382c19cffecbf1fd8706"}, + {file = "PyYAML-6.0.2-cp38-cp38-win32.whl", hash = "sha256:43fa96a3ca0d6b1812e01ced1044a003533c47f6ee8aca31724f78e93ccc089a"}, + {file = "PyYAML-6.0.2-cp38-cp38-win_amd64.whl", hash = "sha256:01179a4a8559ab5de078078f37e5c1a30d76bb88519906844fd7bdea1b7729ff"}, + {file = "PyYAML-6.0.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:688ba32a1cffef67fd2e9398a2efebaea461578b0923624778664cc1c914db5d"}, + {file = "PyYAML-6.0.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:a8786accb172bd8afb8be14490a16625cbc387036876ab6ba70912730faf8e1f"}, + {file = "PyYAML-6.0.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d8e03406cac8513435335dbab54c0d385e4a49e4945d2909a581c83647ca0290"}, + {file = "PyYAML-6.0.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f753120cb8181e736c57ef7636e83f31b9c0d1722c516f7e86cf15b7aa57ff12"}, + {file = "PyYAML-6.0.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3b1fdb9dc17f5a7677423d508ab4f243a726dea51fa5e70992e59a7411c89d19"}, + {file = "PyYAML-6.0.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:0b69e4ce7a131fe56b7e4d770c67429700908fc0752af059838b1cfb41960e4e"}, + {file = "PyYAML-6.0.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:a9f8c2e67970f13b16084e04f134610fd1d374bf477b17ec1599185cf611d725"}, + {file = "PyYAML-6.0.2-cp39-cp39-win32.whl", hash = "sha256:6395c297d42274772abc367baaa79683958044e5d3835486c16da75d2a694631"}, + {file = "PyYAML-6.0.2-cp39-cp39-win_amd64.whl", hash = "sha256:39693e1f8320ae4f43943590b49779ffb98acb81f788220ea932a6b6c51004d8"}, + {file = "pyyaml-6.0.2.tar.gz", hash = "sha256:d584d9ec91ad65861cc08d42e834324ef890a082e591037abe114850ff7bbc3e"}, ] [[package]] @@ -5403,13 +5555,13 @@ pyyaml = "*" [[package]] name = "qdrant-client" -version = "1.11.3" +version = "1.12.0" description = "Client library for the Qdrant vector search engine" optional = false python-versions = ">=3.8" files = [ - {file = "qdrant_client-1.11.3-py3-none-any.whl", hash = "sha256:fcf040b58203ed0827608c9ad957da671b1e31bf27e5e35b322c1b577b6ec133"}, - {file = "qdrant_client-1.11.3.tar.gz", hash = "sha256:5a155d8281a224ac18acef512eae2f5e9a0907975d52a7627ec66fa6586d0285"}, + {file = "qdrant_client-1.12.0-py3-none-any.whl", hash = "sha256:6db5ac1e244272f8b67e9dbc0da557816efef6f919cd8ee134469c751fe72c03"}, + {file = "qdrant_client-1.12.0.tar.gz", hash = "sha256:f443db39988aa6ff7c7a605770084ddaca8fdb5f8b22f77c10e661bdf0974cda"}, ] [package.dependencies] @@ -5679,13 +5831,13 @@ files = [ [[package]] name = "requests" -version = "2.31.0" +version = "2.32.3" description = "Python HTTP for Humans." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "requests-2.31.0-py3-none-any.whl", hash = "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f"}, - {file = "requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"}, + {file = "requests-2.32.3-py3-none-any.whl", hash = "sha256:70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6"}, + {file = "requests-2.32.3.tar.gz", hash = "sha256:55365417734eb18255590a9ff9eb97e9e1da868d4ccd6402399eaf68af20a760"}, ] [package.dependencies] @@ -5747,13 +5899,13 @@ py = ">=1.4.26,<2.0.0" [[package]] name = "rich" -version = "13.9.1" +version = "13.9.2" description = "Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal" optional = false python-versions = ">=3.8.0" files = [ - {file = "rich-13.9.1-py3-none-any.whl", hash = "sha256:b340e739f30aa58921dc477b8adaa9ecdb7cecc217be01d93730ee1bc8aa83be"}, - {file = "rich-13.9.1.tar.gz", hash = "sha256:097cffdf85db1babe30cc7deba5ab3a29e1b9885047dab24c57e9a7f8a9c1466"}, + {file = "rich-13.9.2-py3-none-any.whl", hash = "sha256:8c82a3d3f8dcfe9e734771313e606b39d8247bb6b826e196f4914b333b743cf1"}, + {file = "rich-13.9.2.tar.gz", hash = "sha256:51a2c62057461aaf7152b4d611168f93a9fc73068f8ded2790f29fe2b5366d0c"}, ] [package.dependencies] @@ -5892,13 +6044,13 @@ pyasn1 = ">=0.1.3" [[package]] name = "s3transfer" -version = "0.10.2" +version = "0.10.3" description = "An Amazon S3 Transfer Manager" optional = false python-versions = ">=3.8" files = [ - {file = "s3transfer-0.10.2-py3-none-any.whl", hash = "sha256:eca1c20de70a39daee580aef4986996620f365c4e0fda6a86100231d62f1bf69"}, - {file = "s3transfer-0.10.2.tar.gz", hash = "sha256:0711534e9356d3cc692fdde846b4a1e4b0cb6519971860796e6bc4c7aea00ef6"}, + {file = "s3transfer-0.10.3-py3-none-any.whl", hash = "sha256:263ed587a5803c6c708d3ce44dc4dfedaab4c1a32e8329bab818933d79ddcf5d"}, + {file = "s3transfer-0.10.3.tar.gz", hash = "sha256:4f50ed74ab84d474ce614475e0b8d5047ff080810aac5d01ea25231cfc944b0c"}, ] [package.dependencies] @@ -6351,111 +6503,111 @@ test = ["pytest", "ruff"] [[package]] name = "tokenizers" -version = "0.20.0" +version = "0.20.1" description = "" optional = false python-versions = ">=3.7" files = [ - {file = "tokenizers-0.20.0-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:6cff5c5e37c41bc5faa519d6f3df0679e4b37da54ea1f42121719c5e2b4905c0"}, - {file = "tokenizers-0.20.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:62a56bf75c27443432456f4ca5ca055befa95e25be8a28141cc495cac8ae4d6d"}, - {file = "tokenizers-0.20.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:68cc7de6a63f09c4a86909c2597b995aa66e19df852a23aea894929c74369929"}, - {file = "tokenizers-0.20.0-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:053c37ecee482cc958fdee53af3c6534286a86f5d35aac476f7c246830e53ae5"}, - {file = "tokenizers-0.20.0-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3d7074aaabc151a6363fa03db5493fc95b423b2a1874456783989e96d541c7b6"}, - {file = "tokenizers-0.20.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a11435780f2acd89e8fefe5e81cecf01776f6edb9b3ac95bcb76baee76b30b90"}, - {file = "tokenizers-0.20.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9a81cd2712973b007d84268d45fc3f6f90a79c31dfe7f1925e6732f8d2959987"}, - {file = "tokenizers-0.20.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d7dfd796ab9d909f76fb93080e1c7c8309f196ecb316eb130718cd5e34231c69"}, - {file = "tokenizers-0.20.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:8029ad2aa8cb00605c9374566034c1cc1b15130713e0eb5afcef6cface8255c9"}, - {file = "tokenizers-0.20.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:ca4d54260ebe97d59dfa9a30baa20d0c4dd9137d99a8801700055c561145c24e"}, - {file = "tokenizers-0.20.0-cp310-none-win32.whl", hash = "sha256:95ee16b57cec11b86a7940174ec5197d506439b0f415ab3859f254b1dffe9df0"}, - {file = "tokenizers-0.20.0-cp310-none-win_amd64.whl", hash = "sha256:0a61a11e93eeadbf02aea082ffc75241c4198e0608bbbac4f65a9026851dcf37"}, - {file = "tokenizers-0.20.0-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:6636b798b3c4d6c9b1af1a918bd07c867808e5a21c64324e95318a237e6366c3"}, - {file = "tokenizers-0.20.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5ec603e42eaf499ffd58b9258162add948717cf21372458132f14e13a6bc7172"}, - {file = "tokenizers-0.20.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cce124264903a8ea6f8f48e1cc7669e5ef638c18bd4ab0a88769d5f92debdf7f"}, - {file = "tokenizers-0.20.0-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:07bbeba0231cf8de07aa6b9e33e9779ff103d47042eeeb859a8c432e3292fb98"}, - {file = "tokenizers-0.20.0-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:06c0ca8397b35d38b83a44a9c6929790c1692957d88541df061cb34d82ebbf08"}, - {file = "tokenizers-0.20.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ca6557ac3b83d912dfbb1f70ab56bd4b0594043916688e906ede09f42e192401"}, - {file = "tokenizers-0.20.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2a5ad94c9e80ac6098328bee2e3264dbced4c6faa34429994d473f795ec58ef4"}, - {file = "tokenizers-0.20.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0b5c7f906ee6bec30a9dc20268a8b80f3b9584de1c9f051671cb057dc6ce28f6"}, - {file = "tokenizers-0.20.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:31e087e9ee1b8f075b002bfee257e858dc695f955b43903e1bb4aa9f170e37fe"}, - {file = "tokenizers-0.20.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:c3124fb6f3346cb3d8d775375d3b429bf4dcfc24f739822702009d20a4297990"}, - {file = "tokenizers-0.20.0-cp311-none-win32.whl", hash = "sha256:a4bb8b40ba9eefa621fdcabf04a74aa6038ae3be0c614c6458bd91a4697a452f"}, - {file = "tokenizers-0.20.0-cp311-none-win_amd64.whl", hash = "sha256:2b709d371f1fe60a28ef0c5c67815952d455ca7f34dbe7197eaaed3cc54b658e"}, - {file = "tokenizers-0.20.0-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:15c81a17d0d66f4987c6ca16f4bea7ec253b8c7ed1bb00fdc5d038b1bb56e714"}, - {file = "tokenizers-0.20.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:6a531cdf1fb6dc41c984c785a3b299cb0586de0b35683842a3afbb1e5207f910"}, - {file = "tokenizers-0.20.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:06caabeb4587f8404e0cd9d40f458e9cba3e815c8155a38e579a74ff3e2a4301"}, - {file = "tokenizers-0.20.0-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:8768f964f23f5b9f50546c0369c75ab3262de926983888bbe8b98be05392a79c"}, - {file = "tokenizers-0.20.0-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:626403860152c816f97b649fd279bd622c3d417678c93b4b1a8909b6380b69a8"}, - {file = "tokenizers-0.20.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9c1b88fa9e5ff062326f4bf82681da5a96fca7104d921a6bd7b1e6fcf224af26"}, - {file = "tokenizers-0.20.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3d7e559436a07dc547f22ce1101f26d8b2fad387e28ec8e7e1e3b11695d681d8"}, - {file = "tokenizers-0.20.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e48afb75e50449848964e4a67b0da01261dd3aa8df8daecf10db8fd7f5b076eb"}, - {file = "tokenizers-0.20.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:baf5d0e1ff44710a95eefc196dd87666ffc609fd447c5e5b68272a7c3d342a1d"}, - {file = "tokenizers-0.20.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:e5e56df0e8ed23ba60ae3848c3f069a0710c4b197218fe4f89e27eba38510768"}, - {file = "tokenizers-0.20.0-cp312-none-win32.whl", hash = "sha256:ec53e5ecc142a82432f9c6c677dbbe5a2bfee92b8abf409a9ecb0d425ee0ce75"}, - {file = "tokenizers-0.20.0-cp312-none-win_amd64.whl", hash = "sha256:f18661ece72e39c0dfaa174d6223248a15b457dbd4b0fc07809b8e6d3ca1a234"}, - {file = "tokenizers-0.20.0-cp37-cp37m-macosx_10_12_x86_64.whl", hash = "sha256:f7065b1084d8d1a03dc89d9aad69bcbc8415d4bc123c367063eb32958cd85054"}, - {file = "tokenizers-0.20.0-cp37-cp37m-macosx_11_0_arm64.whl", hash = "sha256:e5d4069e4714e3f7ba0a4d3d44f9d84a432cd4e4aa85c3d7dd1f51440f12e4a1"}, - {file = "tokenizers-0.20.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:799b808529e54b7e1a36350bda2aeb470e8390e484d3e98c10395cee61d4e3c6"}, - {file = "tokenizers-0.20.0-cp37-cp37m-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7f9baa027cc8a281ad5f7725a93c204d7a46986f88edbe8ef7357f40a23fb9c7"}, - {file = "tokenizers-0.20.0-cp37-cp37m-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:010ec7f3f7a96adc4c2a34a3ada41fa14b4b936b5628b4ff7b33791258646c6b"}, - {file = "tokenizers-0.20.0-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:98d88f06155335b14fd78e32ee28ca5b2eb30fced4614e06eb14ae5f7fba24ed"}, - {file = "tokenizers-0.20.0-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e13eb000ef540c2280758d1b9cfa5fe424b0424ae4458f440e6340a4f18b2638"}, - {file = "tokenizers-0.20.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fab3cf066ff426f7e6d70435dc28a9ff01b2747be83810e397cba106f39430b0"}, - {file = "tokenizers-0.20.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:39fa3761b30a89368f322e5daf4130dce8495b79ad831f370449cdacfb0c0d37"}, - {file = "tokenizers-0.20.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:c8da0fba4d179ddf2607821575998df3c294aa59aa8df5a6646dc64bc7352bce"}, - {file = "tokenizers-0.20.0-cp37-none-win32.whl", hash = "sha256:fada996d6da8cf213f6e3c91c12297ad4f6cdf7a85c2fadcd05ec32fa6846fcd"}, - {file = "tokenizers-0.20.0-cp37-none-win_amd64.whl", hash = "sha256:7d29aad702279e0760c265fcae832e89349078e3418dd329732d4503259fd6bd"}, - {file = "tokenizers-0.20.0-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:099c68207f3ef0227ecb6f80ab98ea74de559f7b124adc7b17778af0250ee90a"}, - {file = "tokenizers-0.20.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:68012d8a8cddb2eab3880870d7e2086cb359c7f7a2b03f5795044f5abff4e850"}, - {file = "tokenizers-0.20.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9253bdd209c6aee168deca7d0e780581bf303e0058f268f9bb06859379de19b6"}, - {file = "tokenizers-0.20.0-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:8f868600ddbcb0545905ed075eb7218a0756bf6c09dae7528ea2f8436ebd2c93"}, - {file = "tokenizers-0.20.0-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9a9643d9c8c5f99b6aba43fd10034f77cc6c22c31f496d2f0ee183047d948fa0"}, - {file = "tokenizers-0.20.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c375c6a889aeab44734028bc65cc070acf93ccb0f9368be42b67a98e1063d3f6"}, - {file = "tokenizers-0.20.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e359f852328e254f070bbd09a19a568421d23388f04aad9f2fb7da7704c7228d"}, - {file = "tokenizers-0.20.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d98b01a309d4387f3b1c1dd68a8b8136af50376cf146c1b7e8d8ead217a5be4b"}, - {file = "tokenizers-0.20.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:459f7537119554c2899067dec1ac74a00d02beef6558f4ee2e99513bf6d568af"}, - {file = "tokenizers-0.20.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:392b87ec89452628c045c9f2a88bc2a827f4c79e7d84bc3b72752b74c2581f70"}, - {file = "tokenizers-0.20.0-cp38-none-win32.whl", hash = "sha256:55a393f893d2ed4dd95a1553c2e42d4d4086878266f437b03590d3f81984c4fe"}, - {file = "tokenizers-0.20.0-cp38-none-win_amd64.whl", hash = "sha256:30ffe33c5c2f2aab8e9a3340d0110dd9f7ace7eec7362e20a697802306bd8068"}, - {file = "tokenizers-0.20.0-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:aa2d4a6fed2a7e3f860c7fc9d48764bb30f2649d83915d66150d6340e06742b8"}, - {file = "tokenizers-0.20.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:b5ef0f814084a897e9071fc4a868595f018c5c92889197bdc4bf19018769b148"}, - {file = "tokenizers-0.20.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fc1e1b791e8c3bf4c4f265f180dadaff1c957bf27129e16fdd5e5d43c2d3762c"}, - {file = "tokenizers-0.20.0-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:2b69e55e481459c07885263743a0d3c18d52db19bae8226a19bcca4aaa213fff"}, - {file = "tokenizers-0.20.0-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4806b4d82e27a2512bc23057b2986bc8b85824914286975b84d8105ff40d03d9"}, - {file = "tokenizers-0.20.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9859e9ef13adf5a473ccab39d31bff9c550606ae3c784bf772b40f615742a24f"}, - {file = "tokenizers-0.20.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ef703efedf4c20488a8eb17637b55973745b27997ff87bad88ed499b397d1144"}, - {file = "tokenizers-0.20.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6eec0061bab94b1841ab87d10831fdf1b48ebaed60e6d66d66dbe1d873f92bf5"}, - {file = "tokenizers-0.20.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:980f3d0d7e73f845b69087f29a63c11c7eb924c4ad6b358da60f3db4cf24bdb4"}, - {file = "tokenizers-0.20.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:7c157550a2f3851b29d7fdc9dc059fcf81ff0c0fc49a1e5173a89d533ed043fa"}, - {file = "tokenizers-0.20.0-cp39-none-win32.whl", hash = "sha256:8a3d2f4d08608ec4f9895ec25b4b36a97f05812543190a5f2c3cd19e8f041e5a"}, - {file = "tokenizers-0.20.0-cp39-none-win_amd64.whl", hash = "sha256:d90188d12afd0c75e537f9a1d92f9c7375650188ee4f48fdc76f9e38afbd2251"}, - {file = "tokenizers-0.20.0-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:d68e15f1815357b059ec266062340c343ea7f98f7f330602df81ffa3474b6122"}, - {file = "tokenizers-0.20.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:23f9ecec637b9bc80da5f703808d29ed5329e56b5aa8d791d1088014f48afadc"}, - {file = "tokenizers-0.20.0-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f830b318ee599e3d0665b3e325f85bc75ee2d2ca6285f52e439dc22b64691580"}, - {file = "tokenizers-0.20.0-pp310-pypy310_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b3dc750def789cb1de1b5a37657919545e1d9ffa667658b3fa9cb7862407a1b8"}, - {file = "tokenizers-0.20.0-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e26e6c755ae884c2ea6135cd215bdd0fccafe4ee62405014b8c3cd19954e3ab9"}, - {file = "tokenizers-0.20.0-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:a1158c7174f427182e08baa2a8ded2940f2b4a3e94969a85cc9cfd16004cbcea"}, - {file = "tokenizers-0.20.0-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:6324826287a3fc198898d3dcf758fe4a8479e42d6039f4c59e2cedd3cf92f64e"}, - {file = "tokenizers-0.20.0-pp37-pypy37_pp73-macosx_10_12_x86_64.whl", hash = "sha256:7d8653149405bb0c16feaf9cfee327fdb6aaef9dc2998349fec686f35e81c4e2"}, - {file = "tokenizers-0.20.0-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b8a2dc1e402a155e97309287ca085c80eb1b7fab8ae91527d3b729181639fa51"}, - {file = "tokenizers-0.20.0-pp37-pypy37_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:07bef67b20aa6e5f7868c42c7c5eae4d24f856274a464ae62e47a0f2cccec3da"}, - {file = "tokenizers-0.20.0-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:da06e397182ff53789c506c7833220c192952c57e1581a53f503d8d953e2d67e"}, - {file = "tokenizers-0.20.0-pp37-pypy37_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:302f7e11a14814028b7fc88c45a41f1bbe9b5b35fd76d6869558d1d1809baa43"}, - {file = "tokenizers-0.20.0-pp37-pypy37_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:055ec46e807b875589dfbe3d9259f9a6ee43394fb553b03b3d1e9541662dbf25"}, - {file = "tokenizers-0.20.0-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:e3144b8acebfa6ae062e8f45f7ed52e4b50fb6c62f93afc8871b525ab9fdcab3"}, - {file = "tokenizers-0.20.0-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:b52aa3fd14b2a07588c00a19f66511cff5cca8f7266ca3edcdd17f3512ad159f"}, - {file = "tokenizers-0.20.0-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2b8cf52779ffc5d4d63a0170fbeb512372bad0dd014ce92bbb9149756c831124"}, - {file = "tokenizers-0.20.0-pp38-pypy38_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:983a45dd11a876124378dae71d6d9761822199b68a4c73f32873d8cdaf326a5b"}, - {file = "tokenizers-0.20.0-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:df6b819c9a19831ebec581e71a7686a54ab45d90faf3842269a10c11d746de0c"}, - {file = "tokenizers-0.20.0-pp38-pypy38_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:e738cfd80795fcafcef89c5731c84b05638a4ab3f412f97d5ed7765466576eb1"}, - {file = "tokenizers-0.20.0-pp38-pypy38_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:c8842c7be2fadb9c9edcee233b1b7fe7ade406c99b0973f07439985c1c1d0683"}, - {file = "tokenizers-0.20.0-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:e47a82355511c373a4a430c4909dc1e518e00031207b1fec536c49127388886b"}, - {file = "tokenizers-0.20.0-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:9afbf359004551179a5db19424180c81276682773cff2c5d002f6eaaffe17230"}, - {file = "tokenizers-0.20.0-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a07eaa8799a92e6af6f472c21a75bf71575de2af3c0284120b7a09297c0de2f3"}, - {file = "tokenizers-0.20.0-pp39-pypy39_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0994b2e5fc53a301071806bc4303e4bc3bdc3f490e92a21338146a36746b0872"}, - {file = "tokenizers-0.20.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0b6466e0355b603d10e3cc3d282d350b646341b601e50969464a54939f9848d0"}, - {file = "tokenizers-0.20.0-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:1e86594c2a433cb1ea09cfbe596454448c566e57ee8905bd557e489d93e89986"}, - {file = "tokenizers-0.20.0-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:3e14cdef1efa96ecead6ea64a891828432c3ebba128bdc0596e3059fea104ef3"}, - {file = "tokenizers-0.20.0.tar.gz", hash = "sha256:39d7acc43f564c274085cafcd1dae9d36f332456de1a31970296a6b8da4eac8d"}, + {file = "tokenizers-0.20.1-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:439261da7c0a5c88bda97acb284d49fbdaf67e9d3b623c0bfd107512d22787a9"}, + {file = "tokenizers-0.20.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:03dae629d99068b1ea5416d50de0fea13008f04129cc79af77a2a6392792d93c"}, + {file = "tokenizers-0.20.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b61f561f329ffe4b28367798b89d60c4abf3f815d37413b6352bc6412a359867"}, + {file = "tokenizers-0.20.1-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ec870fce1ee5248a10be69f7a8408a234d6f2109f8ea827b4f7ecdbf08c9fd15"}, + {file = "tokenizers-0.20.1-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d388d1ea8b7447da784e32e3b86a75cce55887e3b22b31c19d0b186b1c677800"}, + {file = "tokenizers-0.20.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:299c85c1d21135bc01542237979bf25c32efa0d66595dd0069ae259b97fb2dbe"}, + {file = "tokenizers-0.20.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e96f6c14c9752bb82145636b614d5a78e9cde95edfbe0a85dad0dd5ddd6ec95c"}, + {file = "tokenizers-0.20.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fc9e95ad49c932b80abfbfeaf63b155761e695ad9f8a58c52a47d962d76e310f"}, + {file = "tokenizers-0.20.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:f22dee205329a636148c325921c73cf3e412e87d31f4d9c3153b302a0200057b"}, + {file = "tokenizers-0.20.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:a2ffd9a8895575ac636d44500c66dffaef133823b6b25067604fa73bbc5ec09d"}, + {file = "tokenizers-0.20.1-cp310-none-win32.whl", hash = "sha256:2847843c53f445e0f19ea842a4e48b89dd0db4e62ba6e1e47a2749d6ec11f50d"}, + {file = "tokenizers-0.20.1-cp310-none-win_amd64.whl", hash = "sha256:f9aa93eacd865f2798b9e62f7ce4533cfff4f5fbd50c02926a78e81c74e432cd"}, + {file = "tokenizers-0.20.1-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:4a717dcb08f2dabbf27ae4b6b20cbbb2ad7ed78ce05a829fae100ff4b3c7ff15"}, + {file = "tokenizers-0.20.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3f84dad1ff1863c648d80628b1b55353d16303431283e4efbb6ab1af56a75832"}, + {file = "tokenizers-0.20.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:929c8f3afa16a5130a81ab5079c589226273ec618949cce79b46d96e59a84f61"}, + {file = "tokenizers-0.20.1-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d10766473954397e2d370f215ebed1cc46dcf6fd3906a2a116aa1d6219bfedc3"}, + {file = "tokenizers-0.20.1-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9300fac73ddc7e4b0330acbdda4efaabf74929a4a61e119a32a181f534a11b47"}, + {file = "tokenizers-0.20.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:0ecaf7b0e39caeb1aa6dd6e0975c405716c82c1312b55ac4f716ef563a906969"}, + {file = "tokenizers-0.20.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5170be9ec942f3d1d317817ced8d749b3e1202670865e4fd465e35d8c259de83"}, + {file = "tokenizers-0.20.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ef3f1ae08fa9aea5891cbd69df29913e11d3841798e0bfb1ff78b78e4e7ea0a4"}, + {file = "tokenizers-0.20.1-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:ee86d4095d3542d73579e953c2e5e07d9321af2ffea6ecc097d16d538a2dea16"}, + {file = "tokenizers-0.20.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:86dcd08da163912e17b27bbaba5efdc71b4fbffb841530fdb74c5707f3c49216"}, + {file = "tokenizers-0.20.1-cp311-none-win32.whl", hash = "sha256:9af2dc4ee97d037bc6b05fa4429ddc87532c706316c5e11ce2f0596dfcfa77af"}, + {file = "tokenizers-0.20.1-cp311-none-win_amd64.whl", hash = "sha256:899152a78b095559c287b4c6d0099469573bb2055347bb8154db106651296f39"}, + {file = "tokenizers-0.20.1-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:407ab666b38e02228fa785e81f7cf79ef929f104bcccf68a64525a54a93ceac9"}, + {file = "tokenizers-0.20.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:2f13a2d16032ebc8bd812eb8099b035ac65887d8f0c207261472803b9633cf3e"}, + {file = "tokenizers-0.20.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e98eee4dca22849fbb56a80acaa899eec5b72055d79637dd6aa15d5e4b8628c9"}, + {file = "tokenizers-0.20.1-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:47c1bcdd61e61136087459cb9e0b069ff23b5568b008265e5cbc927eae3387ce"}, + {file = "tokenizers-0.20.1-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:128c1110e950534426e2274837fc06b118ab5f2fa61c3436e60e0aada0ccfd67"}, + {file = "tokenizers-0.20.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e2e2d47a819d2954f2c1cd0ad51bb58ffac6f53a872d5d82d65d79bf76b9896d"}, + {file = "tokenizers-0.20.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:bdd67a0e3503a9a7cf8bc5a4a49cdde5fa5bada09a51e4c7e1c73900297539bd"}, + {file = "tokenizers-0.20.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:689b93d2e26d04da337ac407acec8b5d081d8d135e3e5066a88edd5bdb5aff89"}, + {file = "tokenizers-0.20.1-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:0c6a796ddcd9a19ad13cf146997cd5895a421fe6aec8fd970d69f9117bddb45c"}, + {file = "tokenizers-0.20.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:3ea919687aa7001a8ff1ba36ac64f165c4e89035f57998fa6cedcfd877be619d"}, + {file = "tokenizers-0.20.1-cp312-none-win32.whl", hash = "sha256:6d3ac5c1f48358ffe20086bf065e843c0d0a9fce0d7f0f45d5f2f9fba3609ca5"}, + {file = "tokenizers-0.20.1-cp312-none-win_amd64.whl", hash = "sha256:b0874481aea54a178f2bccc45aa2d0c99cd3f79143a0948af6a9a21dcc49173b"}, + {file = "tokenizers-0.20.1-cp37-cp37m-macosx_10_12_x86_64.whl", hash = "sha256:96af92e833bd44760fb17f23f402e07a66339c1dcbe17d79a9b55bb0cc4f038e"}, + {file = "tokenizers-0.20.1-cp37-cp37m-macosx_11_0_arm64.whl", hash = "sha256:65f34e5b731a262dfa562820818533c38ce32a45864437f3d9c82f26c139ca7f"}, + {file = "tokenizers-0.20.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:17f98fccb5c12ab1ce1f471731a9cd86df5d4bd2cf2880c5a66b229802d96145"}, + {file = "tokenizers-0.20.1-cp37-cp37m-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:b8c0fc3542cf9370bf92c932eb71bdeb33d2d4aeeb4126d9fd567b60bd04cb30"}, + {file = "tokenizers-0.20.1-cp37-cp37m-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4b39356df4575d37f9b187bb623aab5abb7b62c8cb702867a1768002f814800c"}, + {file = "tokenizers-0.20.1-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bfdad27b0e50544f6b838895a373db6114b85112ba5c0cefadffa78d6daae563"}, + {file = "tokenizers-0.20.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:094663dd0e85ee2e573126918747bdb40044a848fde388efb5b09d57bc74c680"}, + {file = "tokenizers-0.20.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:14e4cf033a2aa207d7ac790e91adca598b679999710a632c4a494aab0fc3a1b2"}, + {file = "tokenizers-0.20.1-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:9310951c92c9fb91660de0c19a923c432f110dbfad1a2d429fbc44fa956bf64f"}, + {file = "tokenizers-0.20.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:05e41e302c315bd2ed86c02e917bf03a6cf7d2f652c9cee1a0eb0d0f1ca0d32c"}, + {file = "tokenizers-0.20.1-cp37-none-win32.whl", hash = "sha256:212231ab7dfcdc879baf4892ca87c726259fa7c887e1688e3f3cead384d8c305"}, + {file = "tokenizers-0.20.1-cp37-none-win_amd64.whl", hash = "sha256:896195eb9dfdc85c8c052e29947169c1fcbe75a254c4b5792cdbd451587bce85"}, + {file = "tokenizers-0.20.1-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:741fb22788482d09d68e73ece1495cfc6d9b29a06c37b3df90564a9cfa688e6d"}, + {file = "tokenizers-0.20.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:10be14ebd8082086a342d969e17fc2d6edc856c59dbdbddd25f158fa40eaf043"}, + {file = "tokenizers-0.20.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:514cf279b22fa1ae0bc08e143458c74ad3b56cd078b319464959685a35c53d5e"}, + {file = "tokenizers-0.20.1-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:a647c5b7cb896d6430cf3e01b4e9a2d77f719c84cefcef825d404830c2071da2"}, + {file = "tokenizers-0.20.1-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7cdf379219e1e1dd432091058dab325a2e6235ebb23e0aec8d0508567c90cd01"}, + {file = "tokenizers-0.20.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ba72260449e16c4c2f6f3252823b059fbf2d31b32617e582003f2b18b415c39"}, + {file = "tokenizers-0.20.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:910b96ed87316e4277b23c7bcaf667ce849c7cc379a453fa179e7e09290eeb25"}, + {file = "tokenizers-0.20.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e53975a6694428a0586534cc1354b2408d4e010a3103117f617cbb550299797c"}, + {file = "tokenizers-0.20.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:07c4b7be58da142b0730cc4e5fd66bb7bf6f57f4986ddda73833cd39efef8a01"}, + {file = "tokenizers-0.20.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:b605c540753e62199bf15cf69c333e934077ef2350262af2ccada46026f83d1c"}, + {file = "tokenizers-0.20.1-cp38-none-win32.whl", hash = "sha256:88b3bc76ab4db1ab95ead623d49c95205411e26302cf9f74203e762ac7e85685"}, + {file = "tokenizers-0.20.1-cp38-none-win_amd64.whl", hash = "sha256:d412a74cf5b3f68a90c615611a5aa4478bb303d1c65961d22db45001df68afcb"}, + {file = "tokenizers-0.20.1-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:a25dcb2f41a0a6aac31999e6c96a75e9152fa0127af8ece46c2f784f23b8197a"}, + {file = "tokenizers-0.20.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:a12c3cebb8c92e9c35a23ab10d3852aee522f385c28d0b4fe48c0b7527d59762"}, + {file = "tokenizers-0.20.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:02e18da58cf115b7c40de973609c35bde95856012ba42a41ee919c77935af251"}, + {file = "tokenizers-0.20.1-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:f326a1ac51ae909b9760e34671c26cd0dfe15662f447302a9d5bb2d872bab8ab"}, + {file = "tokenizers-0.20.1-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0b4872647ea6f25224e2833b044b0b19084e39400e8ead3cfe751238b0802140"}, + {file = "tokenizers-0.20.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ce6238a3311bb8e4c15b12600927d35c267b92a52c881ef5717a900ca14793f7"}, + {file = "tokenizers-0.20.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:57b7a8880b208866508b06ce365dc631e7a2472a3faa24daa430d046fb56c885"}, + {file = "tokenizers-0.20.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a908c69c2897a68f412aa05ba38bfa87a02980df70f5a72fa8490479308b1f2d"}, + {file = "tokenizers-0.20.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:da1001aa46f4490099c82e2facc4fbc06a6a32bf7de3918ba798010954b775e0"}, + {file = "tokenizers-0.20.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:42c097390e2f0ed0a5c5d569e6669dd4e9fff7b31c6a5ce6e9c66a61687197de"}, + {file = "tokenizers-0.20.1-cp39-none-win32.whl", hash = "sha256:3d4d218573a3d8b121a1f8c801029d70444ffb6d8f129d4cca1c7b672ee4a24c"}, + {file = "tokenizers-0.20.1-cp39-none-win_amd64.whl", hash = "sha256:37d1e6f616c84fceefa7c6484a01df05caf1e207669121c66213cb5b2911d653"}, + {file = "tokenizers-0.20.1-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:48689da7a395df41114f516208d6550e3e905e1239cc5ad386686d9358e9cef0"}, + {file = "tokenizers-0.20.1-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:712f90ea33f9bd2586b4a90d697c26d56d0a22fd3c91104c5858c4b5b6489a79"}, + {file = "tokenizers-0.20.1-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:359eceb6a620c965988fc559cebc0a98db26713758ec4df43fb76d41486a8ed5"}, + {file = "tokenizers-0.20.1-pp310-pypy310_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0d3caf244ce89d24c87545aafc3448be15870096e796c703a0d68547187192e1"}, + {file = "tokenizers-0.20.1-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:03b03cf8b9a32254b1bf8a305fb95c6daf1baae0c1f93b27f2b08c9759f41dee"}, + {file = "tokenizers-0.20.1-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:218e5a3561561ea0f0ef1559c6d95b825308dbec23fb55b70b92589e7ff2e1e8"}, + {file = "tokenizers-0.20.1-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:f40df5e0294a95131cc5f0e0eb91fe86d88837abfbee46b9b3610b09860195a7"}, + {file = "tokenizers-0.20.1-pp37-pypy37_pp73-macosx_10_12_x86_64.whl", hash = "sha256:08aaa0d72bb65058e8c4b0455f61b840b156c557e2aca57627056624c3a93976"}, + {file = "tokenizers-0.20.1-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:998700177b45f70afeb206ad22c08d9e5f3a80639dae1032bf41e8cbc4dada4b"}, + {file = "tokenizers-0.20.1-pp37-pypy37_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:62f7fbd3c2c38b179556d879edae442b45f68312019c3a6013e56c3947a4e648"}, + {file = "tokenizers-0.20.1-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:31e87fca4f6bbf5cc67481b562147fe932f73d5602734de7dd18a8f2eee9c6dd"}, + {file = "tokenizers-0.20.1-pp37-pypy37_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:956f21d359ae29dd51ca5726d2c9a44ffafa041c623f5aa33749da87cfa809b9"}, + {file = "tokenizers-0.20.1-pp37-pypy37_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:1fbbaf17a393c78d8aedb6a334097c91cb4119a9ced4764ab8cfdc8d254dc9f9"}, + {file = "tokenizers-0.20.1-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:ebe63e31f9c1a970c53866d814e35ec2ec26fda03097c486f82f3891cee60830"}, + {file = "tokenizers-0.20.1-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:81970b80b8ac126910295f8aab2d7ef962009ea39e0d86d304769493f69aaa1e"}, + {file = "tokenizers-0.20.1-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:130e35e76f9337ed6c31be386e75d4925ea807055acf18ca1a9b0eec03d8fe23"}, + {file = "tokenizers-0.20.1-pp38-pypy38_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cd28a8614f5c82a54ab2463554e84ad79526c5184cf4573bbac2efbbbcead457"}, + {file = "tokenizers-0.20.1-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9041ee665d0fa7f5c4ccf0f81f5e6b7087f797f85b143c094126fc2611fec9d0"}, + {file = "tokenizers-0.20.1-pp38-pypy38_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:62eb9daea2a2c06bcd8113a5824af8ef8ee7405d3a71123ba4d52c79bb3d9f1a"}, + {file = "tokenizers-0.20.1-pp38-pypy38_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:f861889707b54a9ab1204030b65fd6c22bdd4a95205deec7994dc22a8baa2ea4"}, + {file = "tokenizers-0.20.1-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:89d5c337d74ea6e5e7dc8af124cf177be843bbb9ca6e58c01f75ea103c12c8a9"}, + {file = "tokenizers-0.20.1-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:0b7f515c83397e73292accdbbbedc62264e070bae9682f06061e2ddce67cacaf"}, + {file = "tokenizers-0.20.1-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e0305fc1ec6b1e5052d30d9c1d5c807081a7bd0cae46a33d03117082e91908c"}, + {file = "tokenizers-0.20.1-pp39-pypy39_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5dc611e6ac0fa00a41de19c3bf6391a05ea201d2d22b757d63f5491ec0e67faa"}, + {file = "tokenizers-0.20.1-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c5ffe0d7f7bfcfa3b2585776ecf11da2e01c317027c8573c78ebcb8985279e23"}, + {file = "tokenizers-0.20.1-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:e7edb8ec12c100d5458d15b1e47c0eb30ad606a05641f19af7563bc3d1608c14"}, + {file = "tokenizers-0.20.1-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:de291633fb9303555793cc544d4a86e858da529b7d0b752bcaf721ae1d74b2c9"}, + {file = "tokenizers-0.20.1.tar.gz", hash = "sha256:84edcc7cdeeee45ceedb65d518fffb77aec69311c9c8e30f77ad84da3025f002"}, ] [package.dependencies] @@ -6468,13 +6620,13 @@ testing = ["black (==22.3)", "datasets", "numpy", "pytest", "requests", "ruff"] [[package]] name = "tomli" -version = "2.0.1" +version = "2.0.2" description = "A lil' TOML parser" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"}, - {file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"}, + {file = "tomli-2.0.2-py3-none-any.whl", hash = "sha256:2ebe24485c53d303f690b0ec092806a085f07af5a5aa1464f3931eec36caaa38"}, + {file = "tomli-2.0.2.tar.gz", hash = "sha256:d46d457a85337051c36524bc5349dd91b1877838e2979ac5ced3e710ed8a60ed"}, ] [[package]] @@ -6660,13 +6812,13 @@ zstd = ["zstandard (>=0.18.0)"] [[package]] name = "uvicorn" -version = "0.31.0" +version = "0.31.1" description = "The lightning-fast ASGI server." optional = false python-versions = ">=3.8" files = [ - {file = "uvicorn-0.31.0-py3-none-any.whl", hash = "sha256:cac7be4dd4d891c363cd942160a7b02e69150dcbc7a36be04d5f4af4b17c8ced"}, - {file = "uvicorn-0.31.0.tar.gz", hash = "sha256:13bc21373d103859f68fe739608e2eb054a816dea79189bc3ca08ea89a275906"}, + {file = "uvicorn-0.31.1-py3-none-any.whl", hash = "sha256:adc42d9cac80cf3e51af97c1851648066841e7cfb6993a4ca8de29ac1548ed41"}, + {file = "uvicorn-0.31.1.tar.gz", hash = "sha256:f5167919867b161b7bcaf32646c6a94cdbd4c3aa2eb5c17d36bb9aa5cfd8c493"}, ] [package.dependencies] @@ -6744,6 +6896,26 @@ PyYAML = "*" wrapt = "*" yarl = "*" +[[package]] +name = "vcrpy" +version = "6.0.2" +description = "Automatically mock your HTTP interactions to simplify and speed up testing" +optional = false +python-versions = ">=3.8" +files = [ + {file = "vcrpy-6.0.2-py2.py3-none-any.whl", hash = "sha256:40370223861181bc76a5e5d4b743a95058bb1ad516c3c08570316ab592f56cad"}, + {file = "vcrpy-6.0.2.tar.gz", hash = "sha256:88e13d9111846745898411dbc74a75ce85870af96dd320d75f1ee33158addc09"}, +] + +[package.dependencies] +PyYAML = "*" +urllib3 = {version = "*", markers = "platform_python_implementation != \"PyPy\" and python_version >= \"3.10\""} +wrapt = "*" +yarl = "*" + +[package.extras] +tests = ["Werkzeug (==2.0.3)", "aiohttp", "boto3", "httplib2", "httpx", "pytest", "pytest-aiohttp", "pytest-asyncio", "pytest-cov", "pytest-httpbin", "requests (>=2.22.0)", "tornado", "urllib3"] + [[package]] name = "virtualenv" version = "20.26.6" @@ -7202,108 +7374,109 @@ test = ["pytest"] [[package]] name = "yarl" -version = "1.13.1" +version = "1.14.0" description = "Yet another URL library" optional = false python-versions = ">=3.8" files = [ - {file = "yarl-1.13.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:82e692fb325013a18a5b73a4fed5a1edaa7c58144dc67ad9ef3d604eccd451ad"}, - {file = "yarl-1.13.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:df4e82e68f43a07735ae70a2d84c0353e58e20add20ec0af611f32cd5ba43fb4"}, - {file = "yarl-1.13.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ec9dd328016d8d25702a24ee274932aebf6be9787ed1c28d021945d264235b3c"}, - {file = "yarl-1.13.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5820bd4178e6a639b3ef1db8b18500a82ceab6d8b89309e121a6859f56585b05"}, - {file = "yarl-1.13.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:86c438ce920e089c8c2388c7dcc8ab30dfe13c09b8af3d306bcabb46a053d6f7"}, - {file = "yarl-1.13.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3de86547c820e4f4da4606d1c8ab5765dd633189791f15247706a2eeabc783ae"}, - {file = "yarl-1.13.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8ca53632007c69ddcdefe1e8cbc3920dd88825e618153795b57e6ebcc92e752a"}, - {file = "yarl-1.13.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d4ee1d240b84e2f213565f0ec08caef27a0e657d4c42859809155cf3a29d1735"}, - {file = "yarl-1.13.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:c49f3e379177f4477f929097f7ed4b0622a586b0aa40c07ac8c0f8e40659a1ac"}, - {file = "yarl-1.13.1-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:5c5e32fef09ce101fe14acd0f498232b5710effe13abac14cd95de9c274e689e"}, - {file = "yarl-1.13.1-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:ab9524e45ee809a083338a749af3b53cc7efec458c3ad084361c1dbf7aaf82a2"}, - {file = "yarl-1.13.1-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:b1481c048fe787f65e34cb06f7d6824376d5d99f1231eae4778bbe5c3831076d"}, - {file = "yarl-1.13.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:31497aefd68036d8e31bfbacef915826ca2e741dbb97a8d6c7eac66deda3b606"}, - {file = "yarl-1.13.1-cp310-cp310-win32.whl", hash = "sha256:1fa56f34b2236f5192cb5fceba7bbb09620e5337e0b6dfe2ea0ddbd19dd5b154"}, - {file = "yarl-1.13.1-cp310-cp310-win_amd64.whl", hash = "sha256:1bbb418f46c7f7355084833051701b2301092e4611d9e392360c3ba2e3e69f88"}, - {file = "yarl-1.13.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:216a6785f296169ed52cd7dcdc2612f82c20f8c9634bf7446327f50398732a51"}, - {file = "yarl-1.13.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:40c6e73c03a6befb85b72da213638b8aaa80fe4136ec8691560cf98b11b8ae6e"}, - {file = "yarl-1.13.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:2430cf996113abe5aee387d39ee19529327205cda975d2b82c0e7e96e5fdabdc"}, - {file = "yarl-1.13.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9fb4134cc6e005b99fa29dbc86f1ea0a298440ab6b07c6b3ee09232a3b48f495"}, - {file = "yarl-1.13.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:309c104ecf67626c033845b860d31594a41343766a46fa58c3309c538a1e22b2"}, - {file = "yarl-1.13.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f90575e9fe3aae2c1e686393a9689c724cd00045275407f71771ae5d690ccf38"}, - {file = "yarl-1.13.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9d2e1626be8712333a9f71270366f4a132f476ffbe83b689dd6dc0d114796c74"}, - {file = "yarl-1.13.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5b66c87da3c6da8f8e8b648878903ca54589038a0b1e08dde2c86d9cd92d4ac9"}, - {file = "yarl-1.13.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:cf1ad338620249f8dd6d4b6a91a69d1f265387df3697ad5dc996305cf6c26fb2"}, - {file = "yarl-1.13.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:9915300fe5a0aa663c01363db37e4ae8e7c15996ebe2c6cce995e7033ff6457f"}, - {file = "yarl-1.13.1-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:703b0f584fcf157ef87816a3c0ff868e8c9f3c370009a8b23b56255885528f10"}, - {file = "yarl-1.13.1-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:1d8e3ca29f643dd121f264a7c89f329f0fcb2e4461833f02de6e39fef80f89da"}, - {file = "yarl-1.13.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:7055bbade838d68af73aea13f8c86588e4bcc00c2235b4b6d6edb0dbd174e246"}, - {file = "yarl-1.13.1-cp311-cp311-win32.whl", hash = "sha256:a3442c31c11088e462d44a644a454d48110f0588de830921fd201060ff19612a"}, - {file = "yarl-1.13.1-cp311-cp311-win_amd64.whl", hash = "sha256:81bad32c8f8b5897c909bf3468bf601f1b855d12f53b6af0271963ee67fff0d2"}, - {file = "yarl-1.13.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:f452cc1436151387d3d50533523291d5f77c6bc7913c116eb985304abdbd9ec9"}, - {file = "yarl-1.13.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:9cec42a20eae8bebf81e9ce23fb0d0c729fc54cf00643eb251ce7c0215ad49fe"}, - {file = "yarl-1.13.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:d959fe96e5c2712c1876d69af0507d98f0b0e8d81bee14cfb3f6737470205419"}, - {file = "yarl-1.13.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b8c837ab90c455f3ea8e68bee143472ee87828bff19ba19776e16ff961425b57"}, - {file = "yarl-1.13.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:94a993f976cdcb2dc1b855d8b89b792893220db8862d1a619efa7451817c836b"}, - {file = "yarl-1.13.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2b2442a415a5f4c55ced0fade7b72123210d579f7d950e0b5527fc598866e62c"}, - {file = "yarl-1.13.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3fdbf0418489525231723cdb6c79e7738b3cbacbaed2b750cb033e4ea208f220"}, - {file = "yarl-1.13.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6b7f6e699304717fdc265a7e1922561b02a93ceffdaefdc877acaf9b9f3080b8"}, - {file = "yarl-1.13.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:bcd5bf4132e6a8d3eb54b8d56885f3d3a38ecd7ecae8426ecf7d9673b270de43"}, - {file = "yarl-1.13.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:2a93a4557f7fc74a38ca5a404abb443a242217b91cd0c4840b1ebedaad8919d4"}, - {file = "yarl-1.13.1-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:22b739f99c7e4787922903f27a892744189482125cc7b95b747f04dd5c83aa9f"}, - {file = "yarl-1.13.1-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:2db874dd1d22d4c2c657807562411ffdfabec38ce4c5ce48b4c654be552759dc"}, - {file = "yarl-1.13.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:4feaaa4742517eaceafcbe74595ed335a494c84634d33961214b278126ec1485"}, - {file = "yarl-1.13.1-cp312-cp312-win32.whl", hash = "sha256:bbf9c2a589be7414ac4a534d54e4517d03f1cbb142c0041191b729c2fa23f320"}, - {file = "yarl-1.13.1-cp312-cp312-win_amd64.whl", hash = "sha256:d07b52c8c450f9366c34aa205754355e933922c79135125541daae6cbf31c799"}, - {file = "yarl-1.13.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:95c6737f28069153c399d875317f226bbdea939fd48a6349a3b03da6829fb550"}, - {file = "yarl-1.13.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:cd66152561632ed4b2a9192e7f8e5a1d41e28f58120b4761622e0355f0fe034c"}, - {file = "yarl-1.13.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:6a2acde25be0cf9be23a8f6cbd31734536a264723fca860af3ae5e89d771cd71"}, - {file = "yarl-1.13.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9a18595e6a2ee0826bf7dfdee823b6ab55c9b70e8f80f8b77c37e694288f5de1"}, - {file = "yarl-1.13.1-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a31d21089894942f7d9a8df166b495101b7258ff11ae0abec58e32daf8088813"}, - {file = "yarl-1.13.1-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:45f209fb4bbfe8630e3d2e2052535ca5b53d4ce2d2026bed4d0637b0416830da"}, - {file = "yarl-1.13.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8f722f30366474a99745533cc4015b1781ee54b08de73260b2bbe13316079851"}, - {file = "yarl-1.13.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f3bf60444269345d712838bb11cc4eadaf51ff1a364ae39ce87a5ca8ad3bb2c8"}, - {file = "yarl-1.13.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:942c80a832a79c3707cca46bd12ab8aa58fddb34b1626d42b05aa8f0bcefc206"}, - {file = "yarl-1.13.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:44b07e1690f010c3c01d353b5790ec73b2f59b4eae5b0000593199766b3f7a5c"}, - {file = "yarl-1.13.1-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:396e59b8de7e4d59ff5507fb4322d2329865b909f29a7ed7ca37e63ade7f835c"}, - {file = "yarl-1.13.1-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:3bb83a0f12701c0b91112a11148b5217617982e1e466069d0555be9b372f2734"}, - {file = "yarl-1.13.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:c92b89bffc660f1274779cb6fbb290ec1f90d6dfe14492523a0667f10170de26"}, - {file = "yarl-1.13.1-cp313-cp313-win32.whl", hash = "sha256:269c201bbc01d2cbba5b86997a1e0f73ba5e2f471cfa6e226bcaa7fd664b598d"}, - {file = "yarl-1.13.1-cp313-cp313-win_amd64.whl", hash = "sha256:1d0828e17fa701b557c6eaed5edbd9098eb62d8838344486248489ff233998b8"}, - {file = "yarl-1.13.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:8be8cdfe20787e6a5fcbd010f8066227e2bb9058331a4eccddec6c0db2bb85b2"}, - {file = "yarl-1.13.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:08d7148ff11cb8e886d86dadbfd2e466a76d5dd38c7ea8ebd9b0e07946e76e4b"}, - {file = "yarl-1.13.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:4afdf84610ca44dcffe8b6c22c68f309aff96be55f5ea2fa31c0c225d6b83e23"}, - {file = "yarl-1.13.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d0d12fe78dcf60efa205e9a63f395b5d343e801cf31e5e1dda0d2c1fb618073d"}, - {file = "yarl-1.13.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:298c1eecfd3257aa16c0cb0bdffb54411e3e831351cd69e6b0739be16b1bdaa8"}, - {file = "yarl-1.13.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c14c16831b565707149c742d87a6203eb5597f4329278446d5c0ae7a1a43928e"}, - {file = "yarl-1.13.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5a9bacedbb99685a75ad033fd4de37129449e69808e50e08034034c0bf063f99"}, - {file = "yarl-1.13.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:658e8449b84b92a4373f99305de042b6bd0d19bf2080c093881e0516557474a5"}, - {file = "yarl-1.13.1-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:373f16f38721c680316a6a00ae21cc178e3a8ef43c0227f88356a24c5193abd6"}, - {file = "yarl-1.13.1-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:45d23c4668d4925688e2ea251b53f36a498e9ea860913ce43b52d9605d3d8177"}, - {file = "yarl-1.13.1-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:f7917697bcaa3bc3e83db91aa3a0e448bf5cde43c84b7fc1ae2427d2417c0224"}, - {file = "yarl-1.13.1-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:5989a38ba1281e43e4663931a53fbf356f78a0325251fd6af09dd03b1d676a09"}, - {file = "yarl-1.13.1-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:11b3ca8b42a024513adce810385fcabdd682772411d95bbbda3b9ed1a4257644"}, - {file = "yarl-1.13.1-cp38-cp38-win32.whl", hash = "sha256:dcaef817e13eafa547cdfdc5284fe77970b891f731266545aae08d6cce52161e"}, - {file = "yarl-1.13.1-cp38-cp38-win_amd64.whl", hash = "sha256:7addd26594e588503bdef03908fc207206adac5bd90b6d4bc3e3cf33a829f57d"}, - {file = "yarl-1.13.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:a0ae6637b173d0c40b9c1462e12a7a2000a71a3258fa88756a34c7d38926911c"}, - {file = "yarl-1.13.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:576365c9f7469e1f6124d67b001639b77113cfd05e85ce0310f5f318fd02fe85"}, - {file = "yarl-1.13.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:78f271722423b2d4851cf1f4fa1a1c4833a128d020062721ba35e1a87154a049"}, - {file = "yarl-1.13.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9d74f3c335cfe9c21ea78988e67f18eb9822f5d31f88b41aec3a1ec5ecd32da5"}, - {file = "yarl-1.13.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1891d69a6ba16e89473909665cd355d783a8a31bc84720902c5911dbb6373465"}, - {file = "yarl-1.13.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fb382fd7b4377363cc9f13ba7c819c3c78ed97c36a82f16f3f92f108c787cbbf"}, - {file = "yarl-1.13.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9c8854b9f80693d20cec797d8e48a848c2fb273eb6f2587b57763ccba3f3bd4b"}, - {file = "yarl-1.13.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bbf2c3f04ff50f16404ce70f822cdc59760e5e2d7965905f0e700270feb2bbfc"}, - {file = "yarl-1.13.1-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:fb9f59f3848edf186a76446eb8bcf4c900fe147cb756fbbd730ef43b2e67c6a7"}, - {file = "yarl-1.13.1-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:ef9b85fa1bc91c4db24407e7c4da93a5822a73dd4513d67b454ca7064e8dc6a3"}, - {file = "yarl-1.13.1-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:098b870c18f1341786f290b4d699504e18f1cd050ed179af8123fd8232513424"}, - {file = "yarl-1.13.1-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:8c723c91c94a3bc8033dd2696a0f53e5d5f8496186013167bddc3fb5d9df46a3"}, - {file = "yarl-1.13.1-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:44a4c40a6f84e4d5955b63462a0e2a988f8982fba245cf885ce3be7618f6aa7d"}, - {file = "yarl-1.13.1-cp39-cp39-win32.whl", hash = "sha256:84bbcdcf393139f0abc9f642bf03f00cac31010f3034faa03224a9ef0bb74323"}, - {file = "yarl-1.13.1-cp39-cp39-win_amd64.whl", hash = "sha256:fc2931ac9ce9c61c9968989ec831d3a5e6fcaaff9474e7cfa8de80b7aff5a093"}, - {file = "yarl-1.13.1-py3-none-any.whl", hash = "sha256:6a5185ad722ab4dd52d5fb1f30dcc73282eb1ed494906a92d1a228d3f89607b0"}, - {file = "yarl-1.13.1.tar.gz", hash = "sha256:ec8cfe2295f3e5e44c51f57272afbd69414ae629ec7c6b27f5a410efc78b70a0"}, + {file = "yarl-1.14.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:1bfc25aa6a7c99cf86564210f79a0b7d4484159c67e01232b116e445b3036547"}, + {file = "yarl-1.14.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:0cf21f46a15d445417de8fc89f2568852cf57fe8ca1ab3d19ddb24d45c0383ae"}, + {file = "yarl-1.14.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:1dda53508df0de87b6e6b0a52d6718ff6c62a5aca8f5552748404963df639269"}, + {file = "yarl-1.14.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:587c3cc59bc148a9b1c07a019346eda2549bc9f468acd2f9824d185749acf0a6"}, + {file = "yarl-1.14.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3007a5b75cb50140708420fe688c393e71139324df599434633019314ceb8b59"}, + {file = "yarl-1.14.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:06ff23462398333c78b6f4f8d3d70410d657a471c2c5bbe6086133be43fc8f1a"}, + {file = "yarl-1.14.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:689a99a42ee4583fcb0d3a67a0204664aa1539684aed72bdafcbd505197a91c4"}, + {file = "yarl-1.14.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b0547ab1e9345dc468cac8368d88ea4c5bd473ebc1d8d755347d7401982b5dd8"}, + {file = "yarl-1.14.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:742aef0a99844faaac200564ea6f5e08facb285d37ea18bd1a5acf2771f3255a"}, + {file = "yarl-1.14.0-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:176110bff341b6730f64a1eb3a7070e12b373cf1c910a9337e7c3240497db76f"}, + {file = "yarl-1.14.0-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:46a9772a1efa93f9cd170ad33101c1817c77e0e9914d4fe33e2da299d7cf0f9b"}, + {file = "yarl-1.14.0-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:ee2c68e4f2dd1b1c15b849ba1c96fac105fca6ffdb7c1e8be51da6fabbdeafb9"}, + {file = "yarl-1.14.0-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:047b258e00b99091b6f90355521f026238c63bd76dcf996d93527bb13320eefd"}, + {file = "yarl-1.14.0-cp310-cp310-win32.whl", hash = "sha256:0aa92e3e30a04f9462a25077db689c4ac5ea9ab6cc68a2e563881b987d42f16d"}, + {file = "yarl-1.14.0-cp310-cp310-win_amd64.whl", hash = "sha256:d9baec588f015d0ee564057aa7574313c53a530662ffad930b7886becc85abdf"}, + {file = "yarl-1.14.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:07f9eaf57719d6721ab15805d85f4b01a5b509a0868d7320134371bcb652152d"}, + {file = "yarl-1.14.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c14b504a74e58e2deb0378b3eca10f3d076635c100f45b113c18c770b4a47a50"}, + {file = "yarl-1.14.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:16a682a127930f3fc4e42583becca6049e1d7214bcad23520c590edd741d2114"}, + {file = "yarl-1.14.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:73bedd2be05f48af19f0f2e9e1353921ce0c83f4a1c9e8556ecdcf1f1eae4892"}, + {file = "yarl-1.14.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f3ab950f8814f3b7b5e3eebc117986f817ec933676f68f0a6c5b2137dd7c9c69"}, + {file = "yarl-1.14.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b693c63e7e64b524f54aa4888403c680342d1ad0d97be1707c531584d6aeeb4f"}, + {file = "yarl-1.14.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:85cb3e40eaa98489f1e2e8b29f5ad02ee1ee40d6ce6b88d50cf0f205de1d9d2c"}, + {file = "yarl-1.14.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4f24f08b6c9b9818fd80612c97857d28f9779f0d1211653ece9844fc7b414df2"}, + {file = "yarl-1.14.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:29a84a46ec3ebae7a1c024c055612b11e9363a8a23238b3e905552d77a2bc51b"}, + {file = "yarl-1.14.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:5cd5dad8366e0168e0fd23d10705a603790484a6dbb9eb272b33673b8f2cce72"}, + {file = "yarl-1.14.0-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:a152751af7ef7b5d5fa6d215756e508dd05eb07d0cf2ba51f3e740076aa74373"}, + {file = "yarl-1.14.0-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:3d569f877ed9a708e4c71a2d13d2940cb0791da309f70bd970ac1a5c088a0a92"}, + {file = "yarl-1.14.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:6a615cad11ec3428020fb3c5a88d85ce1b5c69fd66e9fcb91a7daa5e855325dd"}, + {file = "yarl-1.14.0-cp311-cp311-win32.whl", hash = "sha256:bab03192091681d54e8225c53f270b0517637915d9297028409a2a5114ff4634"}, + {file = "yarl-1.14.0-cp311-cp311-win_amd64.whl", hash = "sha256:985623575e5c4ea763056ffe0e2d63836f771a8c294b3de06d09480538316b13"}, + {file = "yarl-1.14.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:fc2c80bc87fba076e6cbb926216c27fba274dae7100a7b9a0983b53132dd99f2"}, + {file = "yarl-1.14.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:55c144d363ad4626ca744556c049c94e2b95096041ac87098bb363dcc8635e8d"}, + {file = "yarl-1.14.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:b03384eed107dbeb5f625a99dc3a7de8be04fc8480c9ad42fccbc73434170b20"}, + {file = "yarl-1.14.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f72a0d746d38cb299b79ce3d4d60ba0892c84bbc905d0d49c13df5bace1b65f8"}, + {file = "yarl-1.14.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8648180b34faaea4aa5b5ca7e871d9eb1277033fa439693855cf0ea9195f85f1"}, + {file = "yarl-1.14.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9557c9322aaa33174d285b0c1961fb32499d65ad1866155b7845edc876c3c835"}, + {file = "yarl-1.14.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8f50eb3837012a937a2b649ec872b66ba9541ad9d6f103ddcafb8231cfcafd22"}, + {file = "yarl-1.14.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8892fa575ac9b1b25fae7b221bc4792a273877b9b56a99ee2d8d03eeb3dbb1d2"}, + {file = "yarl-1.14.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:e6a2c5c5bb2556dfbfffffc2bcfb9c235fd2b566d5006dfb2a37afc7e3278a07"}, + {file = "yarl-1.14.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:ab3abc0b78a5dfaa4795a6afbe7b282b6aa88d81cf8c1bb5e394993d7cae3457"}, + {file = "yarl-1.14.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:47eede5d11d669ab3759b63afb70d28d5328c14744b8edba3323e27dc52d298d"}, + {file = "yarl-1.14.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:fe4d2536c827f508348d7b40c08767e8c7071614250927233bf0c92170451c0a"}, + {file = "yarl-1.14.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:0fd7b941dd1b00b5f0acb97455fea2c4b7aac2dd31ea43fb9d155e9bc7b78664"}, + {file = "yarl-1.14.0-cp312-cp312-win32.whl", hash = "sha256:99ff3744f5fe48288be6bc402533b38e89749623a43208e1d57091fc96b783b9"}, + {file = "yarl-1.14.0-cp312-cp312-win_amd64.whl", hash = "sha256:1ca3894e9e9f72da93544f64988d9c052254a338a9f855165f37f51edb6591de"}, + {file = "yarl-1.14.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:5d02d700705d67e09e1f57681f758f0b9d4412eeb70b2eb8d96ca6200b486db3"}, + {file = "yarl-1.14.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:30600ba5db60f7c0820ef38a2568bb7379e1418ecc947a0f76fd8b2ff4257a97"}, + {file = "yarl-1.14.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:e85d86527baebb41a214cc3b45c17177177d900a2ad5783dbe6f291642d4906f"}, + {file = "yarl-1.14.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:37001e5d4621cef710c8dc1429ca04e189e572f128ab12312eab4e04cf007132"}, + {file = "yarl-1.14.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f4f4547944d4f5cfcdc03f3f097d6f05bbbc915eaaf80a2ee120d0e756de377d"}, + {file = "yarl-1.14.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:75ff4c819757f9bdb35de049a509814d6ce851fe26f06eb95a392a5640052482"}, + {file = "yarl-1.14.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:68ac1a09392ed6e3fd14be880d39b951d7b981fd135416db7d18a6208c536561"}, + {file = "yarl-1.14.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:96952f642ac69075e44c7d0284528938fdff39422a1d90d3e45ce40b72e5e2d9"}, + {file = "yarl-1.14.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:a56fbe3d7f3bce1d060ea18d2413a2ca9ca814eea7cedc4d247b5f338d54844e"}, + {file = "yarl-1.14.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:7e2637d75e92763d1322cb5041573279ec43a80c0f7fbbd2d64f5aee98447b17"}, + {file = "yarl-1.14.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:9abe80ae2c9d37c17599557b712e6515f4100a80efb2cda15f5f070306477cd2"}, + {file = "yarl-1.14.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:217a782020b875538eebf3948fac3a7f9bbbd0fd9bf8538f7c2ad7489e80f4e8"}, + {file = "yarl-1.14.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:b9cfef3f14f75bf6aba73a76caf61f9d00865912a04a4393c468a7ce0981b519"}, + {file = "yarl-1.14.0-cp313-cp313-win32.whl", hash = "sha256:d8361c7d04e6a264481f0b802e395f647cd3f8bbe27acfa7c12049efea675bd1"}, + {file = "yarl-1.14.0-cp313-cp313-win_amd64.whl", hash = "sha256:bc24f968b82455f336b79bf37dbb243b7d76cd40897489888d663d4e028f5069"}, + {file = "yarl-1.14.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:91d875f75fabf76b3018c5f196bf3d308ed2b49ddcb46c1576d6b075754a1393"}, + {file = "yarl-1.14.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:4009def9be3a7e5175db20aa2d7307ecd00bbf50f7f0f989300710eee1d0b0b9"}, + {file = "yarl-1.14.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:582cedde49603f139be572252a318b30dc41039bc0b8165f070f279e5d12187f"}, + {file = "yarl-1.14.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dbd9ff43a04f8ffe8a959a944c2dca10d22f5f99fc6a459f49c3ebfb409309d9"}, + {file = "yarl-1.14.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b9f805e37ed16cc212fdc538a608422d7517e7faf539bedea4fe69425bc55d76"}, + {file = "yarl-1.14.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:95e16e9eaa2d7f5d87421b8fe694dd71606aa61d74b824c8d17fc85cc51983d1"}, + {file = "yarl-1.14.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:816d24f584edefcc5ca63428f0b38fee00b39fe64e3c5e558f895a18983efe96"}, + {file = "yarl-1.14.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cd2660c01367eb3ef081b8fa0a5da7fe767f9427aa82023a961a5f28f0d4af6c"}, + {file = "yarl-1.14.0-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:94b2bb9bcfd5be9d27004ea4398fb640373dd0c1a9e219084f42c08f77a720ab"}, + {file = "yarl-1.14.0-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:c2089a9afef887664115f7fa6d3c0edd6454adaca5488dba836ca91f60401075"}, + {file = "yarl-1.14.0-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:2192f718db4a8509f63dd6d950f143279211fa7e6a2c612edc17d85bf043d36e"}, + {file = "yarl-1.14.0-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:8385ab36bf812e9d37cf7613999a87715f27ef67a53f0687d28c44b819df7cb0"}, + {file = "yarl-1.14.0-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:b4c1ecba93e7826dc71ddba75fb7740cdb52e7bd0be9f03136b83f54e6a1f511"}, + {file = "yarl-1.14.0-cp38-cp38-win32.whl", hash = "sha256:e749af6c912a7bb441d105c50c1a3da720474e8acb91c89350080dd600228f0e"}, + {file = "yarl-1.14.0-cp38-cp38-win_amd64.whl", hash = "sha256:147e36331f6f63e08a14640acf12369e041e0751bb70d9362df68c2d9dcf0c87"}, + {file = "yarl-1.14.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a9f917966d27f7ce30039fe8d900f913c5304134096554fd9bea0774bcda6d1"}, + {file = "yarl-1.14.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:8a2f8fb7f944bcdfecd4e8d855f84c703804a594da5123dd206f75036e536d4d"}, + {file = "yarl-1.14.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:8f4e475f29a9122f908d0f1f706e1f2fc3656536ffd21014ff8a6f2e1b14d1d8"}, + {file = "yarl-1.14.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8089d4634d8fa2b1806ce44fefa4979b1ab2c12c0bc7ef3dfa45c8a374811348"}, + {file = "yarl-1.14.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1b16f6c75cffc2dc0616ea295abb0e1967601bd1fb1e0af6a1de1c6c887f3439"}, + {file = "yarl-1.14.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:498b3c55087b9d762636bca9b45f60d37e51d24341786dc01b81253f9552a607"}, + {file = "yarl-1.14.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e3f8bfc1db82589ef965ed234b87de30d140db8b6dc50ada9e33951ccd8ec07a"}, + {file = "yarl-1.14.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:625f207b1799e95e7c823f42f473c1e9dbfb6192bd56bba8695656d92be4535f"}, + {file = "yarl-1.14.0-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:781e2495e408a81e4eaeedeb41ba32b63b1980dddf8b60dbbeff6036bcd35049"}, + {file = "yarl-1.14.0-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:659603d26d40dd4463200df9bfbc339fbfaed3fe32e5c432fe1dc2b5d4aa94b4"}, + {file = "yarl-1.14.0-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:4e0d45ebf975634468682c8bec021618b3ad52c37619e5c938f8f831fa1ac5c0"}, + {file = "yarl-1.14.0-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:a2e4725a08cb2b4794db09e350c86dee18202bb8286527210e13a1514dc9a59a"}, + {file = "yarl-1.14.0-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:19268b4fec1d7760134f2de46ef2608c2920134fb1fa61e451f679e41356dc55"}, + {file = "yarl-1.14.0-cp39-cp39-win32.whl", hash = "sha256:337912bcdcf193ade64b9aae5a4017a0a1950caf8ca140362e361543c6773f21"}, + {file = "yarl-1.14.0-cp39-cp39-win_amd64.whl", hash = "sha256:b6d0147574ce2e7b812c989e50fa72bbc5338045411a836bd066ce5fc8ac0bce"}, + {file = "yarl-1.14.0-py3-none-any.whl", hash = "sha256:c8ed4034f0765f8861620c1f2f2364d2e58520ea288497084dae880424fc0d9f"}, + {file = "yarl-1.14.0.tar.gz", hash = "sha256:88c7d9d58aab0724b979ab5617330acb1c7030b79379c8138c1c8c94e121d1b3"}, ] [package.dependencies] idna = ">=2.0" multidict = ">=4.0" +propcache = ">=0.2.0" [[package]] name = "zipp" @@ -7331,4 +7504,4 @@ tools = ["crewai-tools"] [metadata] lock-version = "2.0" python-versions = ">=3.10,<=3.13" -content-hash = "b008b28add072e8f002aa90d230b20027f0ecffcd3c4b3fe4ec954f5ac7c46ca" +content-hash = "0b833460455da407e9b73fe545bb8dfccc114384d3ce1aa66a1d2fc83afb00f7" diff --git a/pyproject.toml b/pyproject.toml index bb844427a..54cf230b4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "crewai" -version = "0.67.0" +version = "0.70.1" description = "Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks." authors = ["Joao Moura "] readme = "README.md" @@ -57,6 +57,7 @@ pytest = "^8.0.0" pytest-vcr = "^1.0.2" python-dotenv = "1.0.0" pytest-asyncio = "^0.23.7" +pytest-subprocess = "^1.5.2" [tool.poetry.scripts] crewai = "crewai.cli.cli:crewai" diff --git a/src/crewai/__init__.py b/src/crewai/__init__.py index 7fdc1ddeb..d237ad2a4 100644 --- a/src/crewai/__init__.py +++ b/src/crewai/__init__.py @@ -1,5 +1,4 @@ import warnings - from crewai.agent import Agent from crewai.crew import Crew from crewai.flow.flow import Flow @@ -15,5 +14,5 @@ warnings.filterwarnings( category=UserWarning, module="pydantic.main", ) - +__version__ = "0.70.1" __all__ = ["Agent", "Crew", "Process", "Task", "Pipeline", "Router", "LLM", "Flow"] diff --git a/src/crewai/agent.py b/src/crewai/agent.py index 89e92498f..3895d7a92 100644 --- a/src/crewai/agent.py +++ b/src/crewai/agent.py @@ -295,9 +295,9 @@ class Agent(BaseAgent): step_callback=self.step_callback, function_calling_llm=self.function_calling_llm, respect_context_window=self.respect_context_window, - request_within_rpm_limit=self._rpm_controller.check_or_wait - if self._rpm_controller - else None, + request_within_rpm_limit=( + self._rpm_controller.check_or_wait if self._rpm_controller else None + ), callbacks=[TokenCalcHandler(self._token_process)], ) diff --git a/src/crewai/cli/cli.py b/src/crewai/cli/cli.py index de6160ba6..6f9cbd423 100644 --- a/src/crewai/cli/cli.py +++ b/src/crewai/cli/cli.py @@ -260,19 +260,29 @@ def deploy_remove(uuid: Optional[str]): deploy_cmd.remove_crew(uuid=uuid) +@tool.command(name="create") +@click.argument("handle") +def tool_create(handle: str): + tool_cmd = ToolCommand() + tool_cmd.create(handle) + + @tool.command(name="install") @click.argument("handle") def tool_install(handle: str): tool_cmd = ToolCommand() + tool_cmd.login() tool_cmd.install(handle) @tool.command(name="publish") +@click.option("--force", is_flag=True, show_default=True, default=False, help="Bypasses Git remote validations") @click.option("--public", "is_public", flag_value=True, default=False) @click.option("--private", "is_public", flag_value=False) -def tool_publish(is_public: bool): +def tool_publish(is_public: bool, force: bool): tool_cmd = ToolCommand() - tool_cmd.publish(is_public) + tool_cmd.login() + tool_cmd.publish(is_public, force) @crewai.group() diff --git a/src/crewai/cli/command.py b/src/crewai/cli/command.py index 0b12b9082..f05fe237f 100644 --- a/src/crewai/cli/command.py +++ b/src/crewai/cli/command.py @@ -1,4 +1,5 @@ -from typing import Dict, Any +import requests +from requests.exceptions import JSONDecodeError from rich.console import Console from crewai.cli.plus_api import PlusAPI from crewai.cli.utils import get_auth_token @@ -27,14 +28,44 @@ class PlusAPIMixin: console.print("Run 'crewai signup' to sign up/login.", style="bold green") raise SystemExit - def _handle_plus_api_error(self, json_response: Dict[str, Any]) -> None: + def _validate_response(self, response: requests.Response) -> None: """ Handle and display error messages from API responses. Args: - json_response (Dict[str, Any]): The JSON response containing error information. + response (requests.Response): The response from the Plus API """ - error = json_response.get("error", "Unknown error") - message = json_response.get("message", "No message provided") - console.print(f"Error: {error}", style="bold red") - console.print(f"Message: {message}", style="bold red") + try: + json_response = response.json() + except (JSONDecodeError, ValueError): + console.print( + "Failed to parse response from Enterprise API failed. Details:", + style="bold red", + ) + console.print(f"Status Code: {response.status_code}") + console.print(f"Response:\n{response.content}") + raise SystemExit + + if response.status_code == 422: + console.print( + "Failed to complete operation. Please fix the following errors:", + style="bold red", + ) + for field, messages in json_response.items(): + for message in messages: + console.print( + f"* [bold red]{field.capitalize()}[/bold red] {message}" + ) + raise SystemExit + + if not response.ok: + console.print( + "Request to Enterprise API failed. Details:", style="bold red" + ) + details = ( + json_response.get("error") + or json_response.get("message") + or response.content + ) + console.print(f"{details}") + raise SystemExit diff --git a/src/crewai/cli/create_flow.py b/src/crewai/cli/create_flow.py index a1c10bf46..ec68611b5 100644 --- a/src/crewai/cli/create_flow.py +++ b/src/crewai/cli/create_flow.py @@ -2,6 +2,8 @@ from pathlib import Path import click +from crewai.telemetry import Telemetry + def create_flow(name): """Create a new flow.""" @@ -15,6 +17,10 @@ def create_flow(name): click.secho(f"Error: Folder {folder_name} already exists.", fg="red") return + # Initialize telemetry + telemetry = Telemetry() + telemetry.flow_creation_span(class_name) + # Create directory structure (project_root / "src" / folder_name).mkdir(parents=True) (project_root / "src" / folder_name / "crews").mkdir(parents=True) diff --git a/src/crewai/cli/deploy/main.py b/src/crewai/cli/deploy/main.py index d6c9d8fe6..486959201 100644 --- a/src/crewai/cli/deploy/main.py +++ b/src/crewai/cli/deploy/main.py @@ -2,12 +2,9 @@ from typing import Any, Dict, List, Optional from rich.console import Console +from crewai.cli import git from crewai.cli.command import BaseCommand, PlusAPIMixin -from crewai.cli.utils import ( - fetch_and_json_env_file, - get_git_remote_url, - get_project_name, -) +from crewai.cli.utils import fetch_and_json_env_file, get_project_name console = Console() @@ -79,11 +76,8 @@ class DeployCommand(BaseCommand, PlusAPIMixin): self._standard_no_param_error_message() return - json_response = response.json() - if response.status_code == 200: - self._display_deployment_info(json_response) - else: - self._handle_plus_api_error(json_response) + self._validate_response(response) + self._display_deployment_info(response.json()) def create_crew(self, confirm: bool = False) -> None: """ @@ -94,7 +88,11 @@ class DeployCommand(BaseCommand, PlusAPIMixin): ) console.print("Creating deployment...", style="bold blue") env_vars = fetch_and_json_env_file() - remote_repo_url = get_git_remote_url() + + try: + remote_repo_url = git.Repository().origin_url() + except ValueError: + remote_repo_url = None if remote_repo_url is None: console.print("No remote repository URL found.", style="bold red") @@ -106,12 +104,10 @@ class DeployCommand(BaseCommand, PlusAPIMixin): self._confirm_input(env_vars, remote_repo_url, confirm) payload = self._create_payload(env_vars, remote_repo_url) - response = self.plus_api_client.create_crew(payload) - if response.status_code == 201: - self._display_creation_success(response.json()) - else: - self._handle_plus_api_error(response.json()) + + self._validate_response(response) + self._display_creation_success(response.json()) def _confirm_input( self, env_vars: Dict[str, str], remote_repo_url: str, confirm: bool @@ -218,11 +214,8 @@ class DeployCommand(BaseCommand, PlusAPIMixin): self._standard_no_param_error_message() return - json_response = response.json() - if response.status_code == 200: - self._display_crew_status(json_response) - else: - self._handle_plus_api_error(json_response) + self._validate_response(response) + self._display_crew_status(response.json()) def _display_crew_status(self, status_data: Dict[str, str]) -> None: """ @@ -253,10 +246,8 @@ class DeployCommand(BaseCommand, PlusAPIMixin): self._standard_no_param_error_message() return - if response.status_code == 200: - self._display_logs(response.json()) - else: - self._handle_plus_api_error(response.json()) + self._validate_response(response) + self._display_logs(response.json()) def remove_crew(self, uuid: Optional[str]) -> None: """ diff --git a/src/crewai/cli/git.py b/src/crewai/cli/git.py new file mode 100644 index 000000000..94c3648b0 --- /dev/null +++ b/src/crewai/cli/git.py @@ -0,0 +1,80 @@ +import subprocess + + +class Repository: + def __init__(self, path="."): + self.path = path + + if not self.is_git_installed(): + raise ValueError("Git is not installed or not found in your PATH.") + + if not self.is_git_repo(): + raise ValueError(f"{self.path} is not a Git repository.") + + self.fetch() + + def is_git_installed(self) -> bool: + """Check if Git is installed and available in the system.""" + try: + subprocess.run( + ["git", "--version"], capture_output=True, check=True, text=True + ) + return True + except (subprocess.CalledProcessError, FileNotFoundError): + return False + + def fetch(self) -> None: + """Fetch latest updates from the remote.""" + subprocess.run(["git", "fetch"], cwd=self.path, check=True) + + def status(self) -> str: + """Get the git status in porcelain format.""" + return subprocess.check_output( + ["git", "status", "--branch", "--porcelain"], + cwd=self.path, + encoding="utf-8", + ).strip() + + def is_git_repo(self) -> bool: + """Check if the current directory is a git repository.""" + try: + subprocess.check_output( + ["git", "rev-parse", "--is-inside-work-tree"], + cwd=self.path, + encoding="utf-8", + ) + return True + except subprocess.CalledProcessError: + return False + + def has_uncommitted_changes(self) -> bool: + """Check if the repository has uncommitted changes.""" + return len(self.status().splitlines()) > 1 + + def is_ahead_or_behind(self) -> bool: + """Check if the repository is ahead or behind the remote.""" + for line in self.status().splitlines(): + if line.startswith("##") and ("ahead" in line or "behind" in line): + return True + return False + + def is_synced(self) -> bool: + """Return True if the Git repository is fully synced with the remote, False otherwise.""" + if self.has_uncommitted_changes() or self.is_ahead_or_behind(): + return False + else: + return True + + def origin_url(self) -> str | None: + """Get the Git repository's remote URL.""" + try: + result = subprocess.run( + ["git", "remote", "get-url", "origin"], + cwd=self.path, + capture_output=True, + text=True, + check=True, + ) + return result.stdout.strip() + except subprocess.CalledProcessError: + return None diff --git a/src/crewai/cli/plus_api.py b/src/crewai/cli/plus_api.py index e72d27bfe..0fa9ff3aa 100644 --- a/src/crewai/cli/plus_api.py +++ b/src/crewai/cli/plus_api.py @@ -27,6 +27,9 @@ class PlusAPI: url = urljoin(self.base_url, endpoint) return requests.request(method, url, headers=self.headers, **kwargs) + def login_to_tool_repository(self): + return self._make_request("POST", f"{self.TOOLS_RESOURCE}/login") + def get_tool(self, handle: str): return self._make_request("GET", f"{self.TOOLS_RESOURCE}/{handle}") diff --git a/src/crewai/cli/templates/crew/pyproject.toml b/src/crewai/cli/templates/crew/pyproject.toml index 41534fd27..c1f520bbb 100644 --- a/src/crewai/cli/templates/crew/pyproject.toml +++ b/src/crewai/cli/templates/crew/pyproject.toml @@ -6,7 +6,7 @@ authors = ["Your Name "] [tool.poetry.dependencies] python = ">=3.10,<=3.13" -crewai = { extras = ["tools"], version = ">=0.67.0,<1.0.0" } +crewai = { extras = ["tools"], version = ">=0.70.1,<1.0.0" } [tool.poetry.scripts] diff --git a/src/crewai/cli/templates/flow/pyproject.toml b/src/crewai/cli/templates/flow/pyproject.toml index 204c8f642..b0ed7435a 100644 --- a/src/crewai/cli/templates/flow/pyproject.toml +++ b/src/crewai/cli/templates/flow/pyproject.toml @@ -6,7 +6,7 @@ authors = ["Your Name "] [tool.poetry.dependencies] python = ">=3.10,<=3.13" -crewai = { extras = ["tools"], version = ">=0.67.0,<1.0.0" } +crewai = { extras = ["tools"], version = ">=0.70.1,<1.0.0" } asyncio = "*" [tool.poetry.scripts] diff --git a/src/crewai/cli/templates/pipeline/pyproject.toml b/src/crewai/cli/templates/pipeline/pyproject.toml index b9a68a643..933f62d89 100644 --- a/src/crewai/cli/templates/pipeline/pyproject.toml +++ b/src/crewai/cli/templates/pipeline/pyproject.toml @@ -6,7 +6,7 @@ authors = ["Your Name "] [tool.poetry.dependencies] python = ">=3.10,<=3.13" -crewai = { extras = ["tools"], version = ">=0.67.0,<1.0.0" } +crewai = { extras = ["tools"], version = ">=0.70.1,<1.0.0" } asyncio = "*" [tool.poetry.scripts] diff --git a/src/crewai/cli/templates/pipeline_router/pyproject.toml b/src/crewai/cli/templates/pipeline_router/pyproject.toml index ca7618b2d..f5742e68e 100644 --- a/src/crewai/cli/templates/pipeline_router/pyproject.toml +++ b/src/crewai/cli/templates/pipeline_router/pyproject.toml @@ -6,7 +6,7 @@ authors = ["Your Name "] [tool.poetry.dependencies] python = ">=3.10,<=3.13" -crewai = { extras = ["tools"], version = ">=0.67.0,<1.0.0" } +crewai = { extras = ["tools"], version = ">=0.70.1,<1.0.0" } [tool.poetry.scripts] diff --git a/src/crewai/cli/templates/tool/README.md b/src/crewai/cli/templates/tool/README.md new file mode 100644 index 000000000..65cb0ffb2 --- /dev/null +++ b/src/crewai/cli/templates/tool/README.md @@ -0,0 +1,48 @@ +# {{folder_name}} + +{{folder_name}} is a CrewAI Tool. This template is designed to help you create +custom tools to power up your crews. + +## Installing + +Ensure you have Python >=3.10 <=3.13 installed on your system. This project +uses [Poetry](https://python-poetry.org/) for dependency management and package +handling, offering a seamless setup and execution experience. + +First, if you haven't already, install Poetry: + +```bash +pip install poetry +``` + +Next, navigate to your project directory and install the dependencies with: + +```bash +crewai install +``` + +## Publishing + +Collaborate by sharing tools within your organization, or publish them publicly +to contribute with the community. + +```bash +crewai tool publish {{tool_name}} +``` + +Others may install your tool in their crews running: + +```bash +crewai tool install {{tool_name}} +``` + +## Support + +For support, questions, or feedback regarding the {{crew_name}} tool or CrewAI. + +- Visit our [documentation](https://docs.crewai.com) +- Reach out to us through our [GitHub repository](https://github.com/joaomdmoura/crewai) +- [Join our Discord](https://discord.com/invite/X4JWnZnxPb) +- [Chat with our docs](https://chatg.pt/DWjSBZn) + +Let's create wonders together with the power and simplicity of crewAI. diff --git a/src/crewai/cli/templates/tool/pyproject.toml b/src/crewai/cli/templates/tool/pyproject.toml new file mode 100644 index 000000000..972e3c104 --- /dev/null +++ b/src/crewai/cli/templates/tool/pyproject.toml @@ -0,0 +1,14 @@ +[tool.poetry] +name = "{{folder_name}}" +version = "0.1.0" +description = "Power up your crews with {{folder_name}}" +authors = ["Your Name "] +readme = "README.md" + +[tool.poetry.dependencies] +python = ">=3.10,<=3.13" +crewai = { extras = ["tools"], version = ">=0.70.1,<1.0.0" } + +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api" diff --git a/src/crewai/cli/templates/tool/src/{{folder_name}}/__init__.py b/src/crewai/cli/templates/tool/src/{{folder_name}}/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/src/crewai/cli/templates/tool/src/{{folder_name}}/tool.py b/src/crewai/cli/templates/tool/src/{{folder_name}}/tool.py new file mode 100644 index 000000000..63c653a6c --- /dev/null +++ b/src/crewai/cli/templates/tool/src/{{folder_name}}/tool.py @@ -0,0 +1,9 @@ +from crewai_tools import BaseTool + +class {{class_name}}(BaseTool): + name: str = "Name of my tool" + description: str = "What this tool does. It's vital for effective utilization." + + def _run(self, argument: str) -> str: + # Your tool's logic here + return "Tool's result" diff --git a/src/crewai/cli/tools/main.py b/src/crewai/cli/tools/main.py index 8acbcedd5..6b0a76e9f 100644 --- a/src/crewai/cli/tools/main.py +++ b/src/crewai/cli/tools/main.py @@ -1,14 +1,18 @@ import base64 +from pathlib import Path import click import os import subprocess import tempfile from crewai.cli.command import BaseCommand, PlusAPIMixin +from crewai.cli import git from crewai.cli.utils import ( get_project_name, get_project_description, get_project_version, + tree_copy, + tree_find_and_replace, ) from rich.console import Console @@ -24,7 +28,49 @@ class ToolCommand(BaseCommand, PlusAPIMixin): BaseCommand.__init__(self) PlusAPIMixin.__init__(self, telemetry=self._telemetry) - def publish(self, is_public: bool): + def create(self, handle: str): + self._ensure_not_in_project() + + folder_name = handle.replace(" ", "_").replace("-", "_").lower() + class_name = handle.replace("_", " ").replace("-", " ").title().replace(" ", "") + + project_root = Path(folder_name) + if project_root.exists(): + click.secho(f"Folder {folder_name} already exists.", fg="red") + raise SystemExit + else: + os.makedirs(project_root) + + click.secho(f"Creating custom tool {folder_name}...", fg="green", bold=True) + + template_dir = Path(__file__).parent.parent / "templates" / "tool" + tree_copy(template_dir, project_root) + tree_find_and_replace(project_root, "{{folder_name}}", folder_name) + tree_find_and_replace(project_root, "{{class_name}}", class_name) + + old_directory = os.getcwd() + os.chdir(project_root) + try: + self.login() + subprocess.run(["git", "init"], check=True) + console.print( + f"[green]Created custom tool [bold]{folder_name}[/bold]. Run [bold]cd {project_root}[/bold] to start working.[/green]" + ) + finally: + os.chdir(old_directory) + + def publish(self, is_public: bool, force: bool = False): + if not git.Repository().is_synced() and not force: + console.print( + "[bold red]Failed to publish tool.[/bold red]\n" + "Local changes need to be resolved before publishing. Please do the following:\n" + "* [bold]Commit[/bold] your changes.\n" + "* [bold]Push[/bold] to sync with the remote.\n" + "* [bold]Pull[/bold] the latest changes from the remote.\n" + "\nOnce your repository is up-to-date, retry publishing the tool." + ) + raise SystemExit() + project_name = get_project_name(require=True) assert isinstance(project_name, str) @@ -64,23 +110,8 @@ class ToolCommand(BaseCommand, PlusAPIMixin): description=project_description, encoded_file=f"data:application/x-gzip;base64,{encoded_tarball}", ) - if publish_response.status_code == 422: - console.print( - "[bold red]Failed to publish tool. Please fix the following errors:[/bold red]" - ) - for field, messages in publish_response.json().items(): - for message in messages: - console.print( - f"* [bold red]{field.capitalize()}[/bold red] {message}" - ) - raise SystemExit - elif publish_response.status_code != 200: - self._handle_plus_api_error(publish_response.json()) - console.print( - "Failed to publish tool. Please try again later.", style="bold red" - ) - raise SystemExit + self._validate_response(publish_response) published_handle = publish_response.json()["handle"] console.print( @@ -103,15 +134,32 @@ class ToolCommand(BaseCommand, PlusAPIMixin): ) raise SystemExit - self._add_repository_to_poetry(get_response.json()) self._add_package(get_response.json()) console.print(f"Succesfully installed {handle}", style="bold green") - def _add_repository_to_poetry(self, tool_details): - repository_handle = f"crewai-{tool_details['repository']['handle']}" - repository_url = tool_details["repository"]["url"] - repository_credentials = tool_details["repository"]["credentials"] + def login(self): + login_response = self.plus_api_client.login_to_tool_repository() + + if login_response.status_code != 200: + console.print( + "Failed to authenticate to the tool repository. Make sure you have the access to tools.", + style="bold red", + ) + raise SystemExit + + login_response_json = login_response.json() + for repository in login_response_json["repositories"]: + self._add_repository_to_poetry( + repository, login_response_json["credential"] + ) + + console.print( + "Succesfully authenticated to the tool repository.", style="bold green" + ) + + def _add_repository_to_poetry(self, repository, credentials): + repository_handle = f"crewai-{repository['handle']}" add_repository_command = [ "poetry", @@ -119,7 +167,7 @@ class ToolCommand(BaseCommand, PlusAPIMixin): "add", "--priority=explicit", repository_handle, - repository_url, + repository["url"], ] add_repository_result = subprocess.run( add_repository_command, text=True, check=True @@ -133,8 +181,8 @@ class ToolCommand(BaseCommand, PlusAPIMixin): "poetry", "config", f"http-basic.{repository_handle}", - repository_credentials, - '""', + credentials["username"], + credentials["password"], ] add_repository_credentials_result = subprocess.run( add_repository_credentials_command, @@ -166,3 +214,16 @@ class ToolCommand(BaseCommand, PlusAPIMixin): if add_package_result.stderr: click.echo(add_package_result.stderr, err=True) raise SystemExit + + def _ensure_not_in_project(self): + if os.path.isfile("./pyproject.toml"): + console.print( + "[bold red]Oops! It looks like you're inside a project.[/bold red]" + ) + console.print( + "You can't create a new tool while inside an existing project." + ) + console.print( + "[bold yellow]Tip:[/bold yellow] Navigate to a different directory and try again." + ) + raise SystemExit diff --git a/src/crewai/cli/utils.py b/src/crewai/cli/utils.py index 58aa154dd..ba553f034 100644 --- a/src/crewai/cli/utils.py +++ b/src/crewai/cli/utils.py @@ -1,7 +1,8 @@ +import os +import shutil import click -import re -import subprocess import sys +import importlib.metadata from crewai.cli.authentication.utils import TokenManager from functools import reduce @@ -58,38 +59,6 @@ def parse_toml(content): return simple_toml_parser(content) -def get_git_remote_url() -> str | None: - """Get the Git repository's remote URL.""" - try: - # Run the git remote -v command - result = subprocess.run( - ["git", "remote", "-v"], capture_output=True, text=True, check=True - ) - - # Get the output - output = result.stdout - - # Parse the output to find the origin URL - matches = re.findall(r"origin\s+(.*?)\s+\(fetch\)", output) - - if matches: - return matches[0] # Return the first match (origin URL) - else: - console.print("No origin remote found.", style="bold red") - - except subprocess.CalledProcessError as e: - console.print( - f"Error running trying to fetch the Git Repository: {e}", style="bold red" - ) - except FileNotFoundError: - console.print( - "Git command not found. Make sure Git is installed and in your PATH.", - style="bold red", - ) - - return None - - def get_project_name( pyproject_path: str = "pyproject.toml", require: bool = False ) -> str | None: @@ -162,29 +131,9 @@ def _get_nested_value(data: Dict[str, Any], keys: List[str]) -> Any: return reduce(dict.__getitem__, keys, data) -def get_crewai_version(poetry_lock_path: str = "poetry.lock") -> str: - """Get the version number of crewai from the poetry.lock file.""" - try: - with open(poetry_lock_path, "r") as f: - lock_content = f.read() - - match = re.search( - r'\[\[package\]\]\s*name\s*=\s*"crewai"\s*version\s*=\s*"([^"]+)"', - lock_content, - re.DOTALL, - ) - if match: - return match.group(1) - else: - print("crewai package not found in poetry.lock") - return "no-version-found" - - except FileNotFoundError: - print(f"Error: {poetry_lock_path} not found.") - except Exception as e: - print(f"Error reading the poetry.lock file: {e}") - - return "no-version-found" +def get_crewai_version() -> str: + """Get the version number of CrewAI running the CLI""" + return importlib.metadata.version("crewai") def fetch_and_json_env_file(env_file_path: str = ".env") -> dict: @@ -217,3 +166,40 @@ def get_auth_token() -> str: if not access_token: raise Exception() return access_token + + +def tree_copy(source, destination): + """Copies the entire directory structure from the source to the destination.""" + for item in os.listdir(source): + source_item = os.path.join(source, item) + destination_item = os.path.join(destination, item) + if os.path.isdir(source_item): + shutil.copytree(source_item, destination_item) + else: + shutil.copy2(source_item, destination_item) + + +def tree_find_and_replace(directory, find, replace): + """Recursively searches through a directory, replacing a target string in + both file contents and filenames with a specified replacement string. + """ + for path, dirs, files in os.walk(os.path.abspath(directory), topdown=False): + for filename in files: + filepath = os.path.join(path, filename) + + with open(filepath, "r") as file: + contents = file.read() + with open(filepath, "w") as file: + file.write(contents.replace(find, replace)) + + if find in filename: + new_filename = filename.replace(find, replace) + new_filepath = os.path.join(path, new_filename) + os.rename(filepath, new_filepath) + + for dirname in dirs: + if find in dirname: + new_dirname = dirname.replace(find, replace) + new_dirpath = os.path.join(path, new_dirname) + old_dirpath = os.path.join(path, dirname) + os.rename(old_dirpath, new_dirpath) diff --git a/src/crewai/crew.py b/src/crewai/crew.py index 105207b91..3878420a0 100644 --- a/src/crewai/crew.py +++ b/src/crewai/crew.py @@ -796,7 +796,7 @@ class Crew(BaseModel): def _log_task_start(self, task: Task, role: str = "None"): if self.output_log_file: - self._file_handler.log(agent=role, task=task.description, status="started") + self._file_handler.log(task_name=task.name, task=task.description, agent=role, status="started") def _update_manager_tools(self, task: Task): if self.manager_agent: @@ -818,7 +818,7 @@ class Crew(BaseModel): def _process_task_result(self, task: Task, output: TaskOutput) -> None: role = task.agent.role if task.agent is not None else "None" if self.output_log_file: - self._file_handler.log(agent=role, task=output, status="completed") + self._file_handler.log(task_name=task.name, task=task.description, agent=role, status="completed", output=output.raw) def _create_crew_output(self, task_outputs: List[TaskOutput]) -> CrewOutput: if len(task_outputs) != 1: @@ -926,7 +926,22 @@ class Crew(BaseModel): } cloned_agents = [agent.copy() for agent in self.agents] - cloned_tasks = [task.copy(cloned_agents) for task in self.tasks] + + task_mapping = {} + + cloned_tasks = [] + for task in self.tasks: + cloned_task = task.copy(cloned_agents, task_mapping) + cloned_tasks.append(cloned_task) + task_mapping[task.key] = cloned_task + + for cloned_task, original_task in zip(cloned_tasks, self.tasks): + if original_task.context: + cloned_context = [ + task_mapping[context_task.key] + for context_task in original_task.context + ] + cloned_task.context = cloned_context copied_data = self.model_dump(exclude=exclude) copied_data = {k: v for k, v in copied_data.items() if v is not None} diff --git a/src/crewai/flow/config.py b/src/crewai/flow/config.py index ddaddc7a8..b04d5d0c2 100644 --- a/src/crewai/flow/config.py +++ b/src/crewai/flow/config.py @@ -2,6 +2,7 @@ DARK_GRAY = "#333333" CREWAI_ORANGE = "#FF5A50" GRAY = "#666666" WHITE = "#FFFFFF" +BLACK = "#000000" COLORS = { "bg": WHITE, @@ -16,31 +17,43 @@ COLORS = { NODE_STYLES = { "start": { - "color": COLORS["start"], + "color": CREWAI_ORANGE, "shape": "box", - "font": {"color": COLORS["text"]}, + "font": {"color": WHITE}, "margin": {"top": 10, "bottom": 8, "left": 10, "right": 10}, }, "method": { - "color": COLORS["method"], + "color": DARK_GRAY, "shape": "box", - "font": {"color": COLORS["text"]}, + "font": {"color": WHITE}, "margin": {"top": 10, "bottom": 8, "left": 10, "right": 10}, }, "router": { "color": { - "background": COLORS["router"], - "border": COLORS["router_border"], + "background": DARK_GRAY, + "border": CREWAI_ORANGE, "highlight": { - "border": COLORS["router_border"], - "background": COLORS["router"], + "border": CREWAI_ORANGE, + "background": DARK_GRAY, }, }, "shape": "box", - "font": {"color": COLORS["text"]}, + "font": {"color": WHITE}, "borderWidth": 3, "borderWidthSelected": 4, "shapeProperties": {"borderDashes": [5, 5]}, "margin": {"top": 10, "bottom": 8, "left": 10, "right": 10}, }, + "crew": { + "color": { + "background": WHITE, + "border": CREWAI_ORANGE, + }, + "shape": "box", + "font": {"color": BLACK}, + "borderWidth": 3, + "borderWidthSelected": 4, + "shapeProperties": {"borderDashes": False}, + "margin": {"top": 10, "bottom": 8, "left": 10, "right": 10}, + }, } diff --git a/src/crewai/flow/flow.py b/src/crewai/flow/flow.py index f60e5c1e3..34e4955fc 100644 --- a/src/crewai/flow/flow.py +++ b/src/crewai/flow/flow.py @@ -1,7 +1,5 @@ # flow.py -# flow.py - import asyncio import inspect from typing import Any, Callable, Dict, Generic, List, Set, Type, TypeVar, Union @@ -9,6 +7,8 @@ from typing import Any, Callable, Dict, Generic, List, Set, Type, TypeVar, Union from pydantic import BaseModel from crewai.flow.flow_visualizer import plot_flow +from crewai.flow.utils import get_possible_return_constants +from crewai.telemetry import Telemetry T = TypeVar("T", bound=Union[BaseModel, Dict[str, Any]]) @@ -63,12 +63,10 @@ def listen(condition): return decorator -def router(method, paths=None): +def router(method): def decorator(func): func.__is_router__ = True func.__router_for__ = method.__name__ - if paths: - func.__router_paths__ = paths return func return decorator @@ -124,10 +122,11 @@ class FlowMeta(type): listeners[attr_name] = (condition_type, methods) elif hasattr(attr_value, "__is_router__"): routers[attr_value.__router_for__] = attr_name - if hasattr(attr_value, "__router_paths__"): - router_paths[attr_name] = attr_value.__router_paths__ + possible_returns = get_possible_return_constants(attr_value) + if possible_returns: + router_paths[attr_name] = possible_returns - # **Register router as a listener to its triggering method** + # Register router as a listener to its triggering method trigger_method_name = attr_value.__router_for__ methods = [trigger_method_name] condition_type = "OR" @@ -142,25 +141,30 @@ class FlowMeta(type): class Flow(Generic[T], metaclass=FlowMeta): + _telemetry = Telemetry() + _start_methods: List[str] = [] _listeners: Dict[str, tuple[str, List[str]]] = {} _routers: Dict[str, str] = {} _router_paths: Dict[str, List[str]] = {} initial_state: Union[Type[T], T, None] = None - def __class_getitem__(cls, item): + def __class_getitem__(cls, item: Type[T]) -> Type["Flow"]: class _FlowGeneric(cls): - _initial_state_T = item + _initial_state_T: Type[T] = item + _FlowGeneric.__name__ = f"{cls.__name__}[{item.__name__}]" return _FlowGeneric - def __init__(self): + def __init__(self) -> None: self._methods: Dict[str, Callable] = {} - self._state = self._create_initial_state() + self._state: T = self._create_initial_state() self._completed_methods: Set[str] = set() self._pending_and_listeners: Dict[str, Set[str]] = {} self._method_outputs: List[Any] = [] # List to store all method outputs + self._telemetry.flow_creation_span(self.__class__.__name__) + for method_name in dir(self): if callable(getattr(self, method_name)) and not method_name.startswith( "__" @@ -190,6 +194,10 @@ class Flow(Generic[T], metaclass=FlowMeta): if not self._start_methods: raise ValueError("No start method defined") + self._telemetry.flow_execution_span( + self.__class__.__name__, list(self._methods.keys()) + ) + # Create tasks for all start methods tasks = [ self._execute_start_method(start_method) @@ -205,11 +213,11 @@ class Flow(Generic[T], metaclass=FlowMeta): else: return None # Or raise an exception if no methods were executed - async def _execute_start_method(self, start_method: str): + async def _execute_start_method(self, start_method: str) -> None: result = await self._execute_method(self._methods[start_method]) await self._execute_listeners(start_method, result) - async def _execute_method(self, method: Callable, *args, **kwargs): + async def _execute_method(self, method: Callable, *args: Any, **kwargs: Any) -> Any: result = ( await method(*args, **kwargs) if asyncio.iscoroutinefunction(method) @@ -218,7 +226,7 @@ class Flow(Generic[T], metaclass=FlowMeta): self._method_outputs.append(result) # Store the output return result - async def _execute_listeners(self, trigger_method: str, result: Any): + async def _execute_listeners(self, trigger_method: str, result: Any) -> None: listener_tasks = [] if trigger_method in self._routers: @@ -246,7 +254,7 @@ class Flow(Generic[T], metaclass=FlowMeta): # Run all listener tasks concurrently and wait for them to complete await asyncio.gather(*listener_tasks) - async def _execute_single_listener(self, listener: str, result: Any): + async def _execute_single_listener(self, listener: str, result: Any) -> None: try: method = self._methods[listener] sig = inspect.signature(method) @@ -270,5 +278,9 @@ class Flow(Generic[T], metaclass=FlowMeta): traceback.print_exc() - def plot(self, filename: str = "crewai_flow_graph"): + def plot(self, filename: str = "crewai_flow") -> None: + self._telemetry.flow_plotting_span( + self.__class__.__name__, list(self._methods.keys()) + ) + plot_flow(self, filename) diff --git a/src/crewai/flow/flow_visualizer.py b/src/crewai/flow/flow_visualizer.py index 822f192b0..988f27919 100644 --- a/src/crewai/flow/flow_visualizer.py +++ b/src/crewai/flow/flow_visualizer.py @@ -30,6 +30,22 @@ class FlowPlot: layout=None, ) + # Set options to disable physics + net.set_options( + """ + var options = { + "nodes": { + "font": { + "multi": "html" + } + }, + "physics": { + "enabled": false + } + } + """ + ) + # Calculate levels for nodes node_levels = calculate_node_levels(self.flow) @@ -42,24 +58,13 @@ class FlowPlot: # Add edges to the network add_edges(net, self.flow, node_positions, self.colors) - # Set options to disable physics - net.set_options( - """ - var options = { - "physics": { - "enabled": false - } - } - """ - ) - network_html = net.generate_html() final_html_content = self._generate_final_html(network_html) # Save the final HTML content to the file with open(f"{filename}.html", "w", encoding="utf-8") as f: f.write(final_html_content) - print(f"Graph saved as {filename}.html") + print(f"Plot saved as {filename}.html") self._cleanup_pyvis_lib() @@ -94,6 +99,6 @@ class FlowPlot: print(f"Error cleaning up {lib_folder}: {e}") -def plot_flow(flow, filename="flow_graph"): +def plot_flow(flow, filename="flow_plot"): visualizer = FlowPlot(flow) visualizer.plot(filename) diff --git a/src/crewai/flow/html_template_handler.py b/src/crewai/flow/html_template_handler.py index 8a88da42a..d521d8cf8 100644 --- a/src/crewai/flow/html_template_handler.py +++ b/src/crewai/flow/html_template_handler.py @@ -1,5 +1,4 @@ import base64 -import os import re @@ -48,7 +47,7 @@ class HTMLTemplateHandler: """ return legend_items_html - def generate_final_html(self, network_body, legend_items_html, title="Flow Graph"): + def generate_final_html(self, network_body, legend_items_html, title="Flow Plot"): html_template = self.read_template() logo_svg_base64 = self.encode_logo() diff --git a/src/crewai/flow/legend_generator.py b/src/crewai/flow/legend_generator.py index 83d9b97a2..fb3d5cfd6 100644 --- a/src/crewai/flow/legend_generator.py +++ b/src/crewai/flow/legend_generator.py @@ -2,6 +2,12 @@ def get_legend_items(colors): return [ {"label": "Start Method", "color": colors["start"]}, {"label": "Method", "color": colors["method"]}, + { + "label": "Crew Method", + "color": colors["bg"], + "border": colors["start"], + "dashed": False, + }, { "label": "Router", "color": colors["router"], @@ -22,9 +28,10 @@ def generate_legend_items_html(legend_items): legend_items_html = "" for item in legend_items: if "border" in item: + style = "dashed" if item["dashed"] else "solid" legend_items_html += f"""
-
+
{item['label']}
""" @@ -32,14 +39,14 @@ def generate_legend_items_html(legend_items): style = "dashed" if item["dashed"] else "solid" legend_items_html += f"""
-
+
{item['label']}
""" else: legend_items_html += f"""
-
+
{item['label']}
""" diff --git a/src/crewai/flow/utils.py b/src/crewai/flow/utils.py index f2dbfb7fd..98d03f24f 100644 --- a/src/crewai/flow/utils.py +++ b/src/crewai/flow/utils.py @@ -1,3 +1,48 @@ +import ast +import inspect +import textwrap + + +def get_possible_return_constants(function): + try: + source = inspect.getsource(function) + except OSError: + # Can't get source code + return None + except Exception as e: + print(f"Error retrieving source code for function {function.__name__}: {e}") + return None + + try: + # Remove leading indentation + source = textwrap.dedent(source) + # Parse the source code into an AST + code_ast = ast.parse(source) + except IndentationError as e: + print(f"IndentationError while parsing source code of {function.__name__}: {e}") + print(f"Source code:\n{source}") + return None + except SyntaxError as e: + print(f"SyntaxError while parsing source code of {function.__name__}: {e}") + print(f"Source code:\n{source}") + return None + except Exception as e: + print(f"Unexpected error while parsing source code of {function.__name__}: {e}") + print(f"Source code:\n{source}") + return None + + return_values = [] + + class ReturnVisitor(ast.NodeVisitor): + def visit_Return(self, node): + # Check if the return value is a constant (Python 3.8+) + if isinstance(node.value, ast.Constant): + return_values.append(node.value.value) + + ReturnVisitor().visit(code_ast) + return return_values + + def calculate_node_levels(flow): levels = {} queue = [] diff --git a/src/crewai/flow/visualization_utils.py b/src/crewai/flow/visualization_utils.py index ba2ba5f18..5b95a1369 100644 --- a/src/crewai/flow/visualization_utils.py +++ b/src/crewai/flow/visualization_utils.py @@ -1,3 +1,6 @@ +import ast +import inspect + from .utils import ( build_ancestor_dict, build_parent_children_dict, @@ -6,6 +9,70 @@ from .utils import ( ) +def method_calls_crew(method): + """Check if the method calls `.crew()`.""" + try: + source = inspect.getsource(method) + source = inspect.cleandoc(source) + tree = ast.parse(source) + except Exception as e: + print(f"Could not parse method {method.__name__}: {e}") + return False + + class CrewCallVisitor(ast.NodeVisitor): + def __init__(self): + self.found = False + + def visit_Call(self, node): + if isinstance(node.func, ast.Attribute): + if node.func.attr == "crew": + self.found = True + self.generic_visit(node) + + visitor = CrewCallVisitor() + visitor.visit(tree) + return visitor.found + + +def add_nodes_to_network(net, flow, node_positions, node_styles): + def human_friendly_label(method_name): + return method_name.replace("_", " ").title() + + for method_name, (x, y) in node_positions.items(): + method = flow._methods.get(method_name) + if hasattr(method, "__is_start_method__"): + node_style = node_styles["start"] + elif hasattr(method, "__is_router__"): + node_style = node_styles["router"] + elif method_calls_crew(method): + node_style = node_styles["crew"] + else: + node_style = node_styles["method"] + + node_style = node_style.copy() + label = human_friendly_label(method_name) + + node_style.update( + { + "label": label, + "shape": "box", + "font": { + "multi": "html", + "color": node_style.get("font", {}).get("color", "#FFFFFF"), + }, + } + ) + + net.add_node( + method_name, + x=x, + y=y, + fixed=True, + physics=False, + **node_style, + ) + + def compute_positions(flow, node_levels, y_spacing=150, x_spacing=150): level_nodes = {} node_positions = {} @@ -109,24 +176,3 @@ def add_edges(net, flow, node_positions, colors): "smooth": edge_smooth, } net.add_edge(router_method_name, listener_name, **edge_style) - - -def add_nodes_to_network(net, flow, node_positions, node_styles): - for method_name, (x, y) in node_positions.items(): - method = flow._methods.get(method_name) - if hasattr(method, "__is_start_method__"): - node_style = node_styles["start"] - elif hasattr(method, "__is_router__"): - node_style = node_styles["router"] - else: - node_style = node_styles["method"] - - net.add_node( - method_name, - label=method_name, - x=x, - y=y, - fixed=True, - physics=False, - **node_style, - ) diff --git a/src/crewai/memory/storage/rag_storage.py b/src/crewai/memory/storage/rag_storage.py index 23bd1a634..27361e11f 100644 --- a/src/crewai/memory/storage/rag_storage.py +++ b/src/crewai/memory/storage/rag_storage.py @@ -7,10 +7,6 @@ from typing import Any, Dict, List, Optional from crewai.memory.storage.interface import Storage from crewai.utilities.paths import db_storage_path -from embedchain import App -from embedchain.llm.base import BaseLlm -from embedchain.models.data_type import DataType -from embedchain.vectordb.chroma import InvalidDimensionException @contextlib.contextmanager @@ -28,10 +24,6 @@ def suppress_logging( logger.setLevel(original_level) -class FakeLLM(BaseLlm): - pass - - class RAGStorage(Storage): """ Extends Storage to handle embeddings for memory entries, improving @@ -73,9 +65,19 @@ class RAGStorage(Storage): if embedder_config: config["embedder"] = embedder_config self.type = type - self.app = App.from_config(config=config) + self.config = config + self.allow_reset = allow_reset + + def _initialize_app(self): + from embedchain import App + from embedchain.llm.base import BaseLlm + + class FakeLLM(BaseLlm): + pass + + self.app = App.from_config(config=self.config) self.app.llm = FakeLLM() - if allow_reset: + if self.allow_reset: self.app.reset() def _sanitize_role(self, role: str) -> str: @@ -85,6 +87,8 @@ class RAGStorage(Storage): return role.replace("\n", "").replace(" ", "_").replace("/", "_") def save(self, value: Any, metadata: Dict[str, Any]) -> None: + if not hasattr(self, "app"): + self._initialize_app() self._generate_embedding(value, metadata) def search( # type: ignore # BUG?: Signature of "search" incompatible with supertype "Storage" @@ -94,6 +98,10 @@ class RAGStorage(Storage): filters: Optional[dict] = None, score_threshold: float = 0.35, ) -> List[Any]: + if not hasattr(self, "app"): + self._initialize_app() + from embedchain.vectordb.chroma import InvalidDimensionException + with suppress_logging(): try: results = ( @@ -107,6 +115,10 @@ class RAGStorage(Storage): return [r for r in results if r["metadata"]["score"] >= score_threshold] def _generate_embedding(self, text: str, metadata: Dict[str, Any]) -> Any: + if not hasattr(self, "app"): + self._initialize_app() + from embedchain.models.data_type import DataType + self.app.add(text, data_type=DataType.TEXT, metadata=metadata) def reset(self) -> None: diff --git a/src/crewai/task.py b/src/crewai/task.py index 979ebc347..82baa9959 100644 --- a/src/crewai/task.py +++ b/src/crewai/task.py @@ -276,9 +276,7 @@ class Task(BaseModel): content = ( json_output if json_output - else pydantic_output.model_dump_json() - if pydantic_output - else result + else pydantic_output.model_dump_json() if pydantic_output else result ) self._save_file(content) @@ -319,7 +317,9 @@ class Task(BaseModel): self.processed_by_agents.add(agent_name) self.delegations += 1 - def copy(self, agents: List["BaseAgent"]) -> "Task": + def copy( + self, agents: List["BaseAgent"], task_mapping: Dict[str, "Task"] + ) -> "Task": """Create a deep copy of the Task.""" exclude = { "id", @@ -332,7 +332,9 @@ class Task(BaseModel): copied_data = {k: v for k, v in copied_data.items() if v is not None} cloned_context = ( - [task.copy(agents) for task in self.context] if self.context else None + [task_mapping[context_task.key] for context_task in self.context] + if self.context + else None ) def get_agent_by_role(role: str) -> Union["BaseAgent", None]: diff --git a/src/crewai/telemetry/telemetry.py b/src/crewai/telemetry/telemetry.py index a3928ecd0..f6a018f27 100644 --- a/src/crewai/telemetry/telemetry.py +++ b/src/crewai/telemetry/telemetry.py @@ -5,8 +5,8 @@ import json import os import platform import warnings -from typing import TYPE_CHECKING, Any, Optional from contextlib import contextmanager +from typing import TYPE_CHECKING, Any, Optional @contextmanager @@ -117,9 +117,11 @@ class Telemetry: "max_iter": agent.max_iter, "max_rpm": agent.max_rpm, "i18n": agent.i18n.prompt_file, - "function_calling_llm": agent.function_calling_llm.model - if agent.function_calling_llm - else "", + "function_calling_llm": ( + agent.function_calling_llm.model + if agent.function_calling_llm + else "" + ), "llm": agent.llm.model, "delegation_enabled?": agent.allow_delegation, "allow_code_execution?": agent.allow_code_execution, @@ -145,9 +147,9 @@ class Telemetry: "expected_output": task.expected_output, "async_execution?": task.async_execution, "human_input?": task.human_input, - "agent_role": task.agent.role - if task.agent - else "None", + "agent_role": ( + task.agent.role if task.agent else "None" + ), "agent_key": task.agent.key if task.agent else None, "context": ( [task.description for task in task.context] @@ -184,9 +186,11 @@ class Telemetry: "verbose?": agent.verbose, "max_iter": agent.max_iter, "max_rpm": agent.max_rpm, - "function_calling_llm": agent.function_calling_llm.model - if agent.function_calling_llm - else "", + "function_calling_llm": ( + agent.function_calling_llm.model + if agent.function_calling_llm + else "" + ), "llm": agent.llm.model, "delegation_enabled?": agent.allow_delegation, "allow_code_execution?": agent.allow_code_execution, @@ -210,9 +214,9 @@ class Telemetry: "id": str(task.id), "async_execution?": task.async_execution, "human_input?": task.human_input, - "agent_role": task.agent.role - if task.agent - else "None", + "agent_role": ( + task.agent.role if task.agent else "None" + ), "agent_key": task.agent.key if task.agent else None, "tools_names": [ tool.name.casefold() @@ -568,3 +572,38 @@ class Telemetry: return span.set_attribute(key, value) except Exception: pass + + def flow_creation_span(self, flow_name: str): + if self.ready: + try: + tracer = trace.get_tracer("crewai.telemetry") + span = tracer.start_span("Flow Creation") + self._add_attribute(span, "flow_name", flow_name) + span.set_status(Status(StatusCode.OK)) + span.end() + except Exception: + pass + + def flow_plotting_span(self, flow_name: str, node_names: list[str]): + if self.ready: + try: + tracer = trace.get_tracer("crewai.telemetry") + span = tracer.start_span("Flow Plotting") + self._add_attribute(span, "flow_name", flow_name) + self._add_attribute(span, "node_names", json.dumps(node_names)) + span.set_status(Status(StatusCode.OK)) + span.end() + except Exception: + pass + + def flow_execution_span(self, flow_name: str, node_names: list[str]): + if self.ready: + try: + tracer = trace.get_tracer("crewai.telemetry") + span = tracer.start_span("Flow Execution") + self._add_attribute(span, "flow_name", flow_name) + self._add_attribute(span, "node_names", json.dumps(node_names)) + span.set_status(Status(StatusCode.OK)) + span.end() + except Exception: + pass diff --git a/src/crewai/tools/agent_tools.py b/src/crewai/tools/agent_tools.py index 911173bbc..7831285cf 100644 --- a/src/crewai/tools/agent_tools.py +++ b/src/crewai/tools/agent_tools.py @@ -1,4 +1,3 @@ -from langchain.tools import StructuredTool from crewai.agents.agent_builder.utilities.base_agent_tool import BaseAgentTools @@ -6,6 +5,8 @@ class AgentTools(BaseAgentTools): """Default tools around agent delegation""" def tools(self): + from langchain.tools import StructuredTool + coworkers = ", ".join([f"{agent.role}" for agent in self.agents]) tools = [ StructuredTool.from_function( diff --git a/src/crewai/tools/cache_tools.py b/src/crewai/tools/cache_tools.py index cc42d07f0..a0bb2dbad 100644 --- a/src/crewai/tools/cache_tools.py +++ b/src/crewai/tools/cache_tools.py @@ -1,4 +1,3 @@ -from langchain.tools import StructuredTool from pydantic import BaseModel, Field from crewai.agents.cache import CacheHandler @@ -14,6 +13,8 @@ class CacheTools(BaseModel): ) def tool(self): + from langchain.tools import StructuredTool + return StructuredTool.from_function( func=self.hit_cache, name=self.name, diff --git a/src/crewai/tools/tool_usage.py b/src/crewai/tools/tool_usage.py index c30207fd2..ebc9c5914 100644 --- a/src/crewai/tools/tool_usage.py +++ b/src/crewai/tools/tool_usage.py @@ -1,5 +1,7 @@ import ast +import datetime import os +import time from difflib import SequenceMatcher from textwrap import dedent from typing import Any, List, Union @@ -8,7 +10,10 @@ from crewai.agents.tools_handler import ToolsHandler from crewai.task import Task from crewai.telemetry import Telemetry from crewai.tools.tool_calling import InstructorToolCalling, ToolCalling +from crewai.tools.tool_usage_events import ToolUsageError, ToolUsageFinished from crewai.utilities import I18N, Converter, ConverterError, Printer +import crewai.utilities.events as events + agentops = None if os.environ.get("AGENTOPS_API_KEY"): @@ -126,12 +131,16 @@ class ToolUsage: except Exception: self.task.increment_tools_errors() - result = None # type: ignore # Incompatible types in assignment (expression has type "None", variable has type "str") + started_at = time.time() + from_cache = False + result = None # type: ignore # Incompatible types in assignment (expression has type "None", variable has type "str") + # check if cache is available if self.tools_handler.cache: result = self.tools_handler.cache.read( # type: ignore # Incompatible types in assignment (expression has type "str | None", variable has type "str") tool=calling.tool_name, input=calling.arguments ) + from_cache = result is not None original_tool = next( (ot for ot in self.original_tools if ot.name == tool.name), None @@ -163,6 +172,7 @@ class ToolUsage: else: result = tool.invoke(input={}) except Exception as e: + self.on_tool_error(tool=tool, tool_calling=calling, e=e) self._run_attempts += 1 if self._run_attempts > self._max_parsing_attempts: self._telemetry.tool_usage_error(llm=self.function_calling_llm) @@ -214,6 +224,13 @@ class ToolUsage: "tool_args": calling.arguments, } + self.on_tool_use_finished( + tool=tool, + tool_calling=calling, + from_cache=from_cache, + started_at=started_at, + ) + if ( hasattr(original_tool, "result_as_answer") and original_tool.result_as_answer # type: ignore # Item "None" of "Any | None" has no attribute "cache_function" @@ -431,3 +448,34 @@ class ToolUsage: # Reconstruct the JSON string new_json_string = "{" + ", ".join(formatted_entries) + "}" return new_json_string + + def on_tool_error(self, tool: Any, tool_calling: ToolCalling, e: Exception) -> None: + event_data = self._prepare_event_data(tool, tool_calling) + events.emit( + source=self, event=ToolUsageError(**{**event_data, "error": str(e)}) + ) + + def on_tool_use_finished( + self, tool: Any, tool_calling: ToolCalling, from_cache: bool, started_at: float + ) -> None: + finished_at = time.time() + event_data = self._prepare_event_data(tool, tool_calling) + event_data.update( + { + "started_at": datetime.datetime.fromtimestamp(started_at), + "finished_at": datetime.datetime.fromtimestamp(finished_at), + "from_cache": from_cache, + } + ) + events.emit(source=self, event=ToolUsageFinished(**event_data)) + + def _prepare_event_data(self, tool: Any, tool_calling: ToolCalling) -> dict: + return { + "agent_key": self.agent.key, + "agent_role": (self.agent._original_role or self.agent.role), + "run_attempts": self._run_attempts, + "delegations": self.task.delegations, + "tool_name": tool.name, + "tool_args": tool_calling.arguments, + "tool_class": tool.__class__.__name__, + } diff --git a/src/crewai/tools/tool_usage_events.py b/src/crewai/tools/tool_usage_events.py new file mode 100644 index 000000000..fea9d3f3c --- /dev/null +++ b/src/crewai/tools/tool_usage_events.py @@ -0,0 +1,23 @@ +from typing import Any, Dict +from pydantic import BaseModel +from datetime import datetime + + +class ToolUsageEvent(BaseModel): + agent_key: str + agent_role: str + tool_name: str + tool_args: Dict[str, Any] + tool_class: str + run_attempts: int | None = None + delegations: int | None = None + + +class ToolUsageFinished(ToolUsageEvent): + started_at: datetime + finished_at: datetime + from_cache: bool = False + + +class ToolUsageError(ToolUsageEvent): + error: str diff --git a/src/crewai/utilities/converter.py b/src/crewai/utilities/converter.py index 9a2cde755..4d0af67ca 100644 --- a/src/crewai/utilities/converter.py +++ b/src/crewai/utilities/converter.py @@ -103,10 +103,12 @@ def convert_to_model( return handle_partial_json( result, model, bool(output_json), agent, converter_cls ) + except ValidationError: return handle_partial_json( result, model, bool(output_json), agent, converter_cls ) + except Exception as e: Printer().print( content=f"Unexpected error during model conversion: {type(e).__name__}: {e}. Returning original result.", diff --git a/src/crewai/utilities/crew_json_encoder.py b/src/crewai/utilities/crew_json_encoder.py index 0df5f546a..3cab07ffc 100644 --- a/src/crewai/utilities/crew_json_encoder.py +++ b/src/crewai/utilities/crew_json_encoder.py @@ -1,4 +1,4 @@ -from datetime import datetime +from datetime import datetime, date import json from uuid import UUID from pydantic import BaseModel @@ -11,8 +11,9 @@ class CrewJSONEncoder(json.JSONEncoder): elif isinstance(obj, UUID): return str(obj) - elif isinstance(obj, datetime): + elif isinstance(obj, datetime) or isinstance(obj, date): return obj.isoformat() + return super().default(obj) def _handle_pydantic_model(self, obj): diff --git a/src/crewai/utilities/events.py b/src/crewai/utilities/events.py new file mode 100644 index 000000000..75425fca2 --- /dev/null +++ b/src/crewai/utilities/events.py @@ -0,0 +1,44 @@ +from typing import Any, Callable, Generic, List, Dict, Type, TypeVar +from functools import wraps +from pydantic import BaseModel + + +T = TypeVar("T") +EVT = TypeVar("EVT", bound=BaseModel) + + +class Emitter(Generic[T, EVT]): + _listeners: Dict[Type[EVT], List[Callable]] = {} + + def on(self, event_type: Type[EVT]): + def decorator(func: Callable): + @wraps(func) + def wrapper(*args, **kwargs): + return func(*args, **kwargs) + + self._listeners.setdefault(event_type, []).append(wrapper) + return wrapper + + return decorator + + def emit(self, source: T, event: EVT) -> None: + event_type = type(event) + for func in self._listeners.get(event_type, []): + func(source, event) + + +default_emitter = Emitter[Any, BaseModel]() + + +def emit(source: Any, event: BaseModel, raise_on_error: bool = False) -> None: + try: + default_emitter.emit(source, event) + except Exception as e: + if raise_on_error: + raise e + else: + print(f"Error emitting event: {e}") + + +def on(event_type: Type[BaseModel]) -> Callable: + return default_emitter.on(event_type) diff --git a/src/crewai/utilities/file_handler.py b/src/crewai/utilities/file_handler.py index 1125cae4e..091bd930a 100644 --- a/src/crewai/utilities/file_handler.py +++ b/src/crewai/utilities/file_handler.py @@ -16,7 +16,7 @@ class FileHandler: def log(self, **kwargs): now = datetime.now().strftime("%Y-%m-%d %H:%M:%S") - message = f"{now}: ".join([f"{key}={value}" for key, value in kwargs.items()]) + message = f"{now}: " + ", ".join([f"{key}=\"{value}\"" for key, value in kwargs.items()]) + "\n" with open(self._path, "a", encoding="utf-8") as file: file.write(message + "\n") diff --git a/src/crewai/utilities/internal_instructor.py b/src/crewai/utilities/internal_instructor.py index 0d9deaa24..13fe5a19f 100644 --- a/src/crewai/utilities/internal_instructor.py +++ b/src/crewai/utilities/internal_instructor.py @@ -1,8 +1,5 @@ from typing import Any, Optional, Type -import instructor -from litellm import completion - class InternalInstructor: """Class that wraps an agent llm with instructor.""" @@ -28,6 +25,10 @@ class InternalInstructor: if self.agent and not self.llm: self.llm = self.agent.function_calling_llm or self.agent.llm + # Lazy import + import instructor + from litellm import completion + self._client = instructor.from_litellm( completion, mode=instructor.Mode.TOOLS, diff --git a/src/crewai/utilities/pydantic_schema_parser.py b/src/crewai/utilities/pydantic_schema_parser.py index 9d9cdabe8..073280dd2 100644 --- a/src/crewai/utilities/pydantic_schema_parser.py +++ b/src/crewai/utilities/pydantic_schema_parser.py @@ -1,4 +1,4 @@ -from typing import Type, get_args, get_origin +from typing import Type, get_args, get_origin, Union from pydantic import BaseModel @@ -36,7 +36,14 @@ class PydanticSchemaParser(BaseModel): return f"List[\n{nested_schema}\n{' ' * 4 * depth}]" else: return f"List[{list_item_type.__name__}]" - elif issubclass(field_type, BaseModel): + elif get_origin(field_type) is Union: + union_args = get_args(field_type) + if type(None) in union_args: + non_none_type = next(arg for arg in union_args if arg is not type(None)) + return f"Optional[{self._get_field_type(field.__class__(annotation=non_none_type), depth)}]" + else: + return f"Union[{', '.join(arg.__name__ for arg in union_args)}]" + elif isinstance(field_type, type) and issubclass(field_type, BaseModel): return self._get_model_schema(field_type, depth) else: - return field_type.__name__ + return getattr(field_type, "__name__", str(field_type)) diff --git a/src/crewai/utilities/token_counter_callback.py b/src/crewai/utilities/token_counter_callback.py index 6d0cb7a93..1b6215232 100644 --- a/src/crewai/utilities/token_counter_callback.py +++ b/src/crewai/utilities/token_counter_callback.py @@ -1,4 +1,5 @@ from litellm.integrations.custom_logger import CustomLogger + from crewai.agents.agent_builder.utilities.base_token_process import TokenProcess diff --git a/tests/agent_test.py b/tests/agent_test.py index 50e94d46d..bb245949d 100644 --- a/tests/agent_test.py +++ b/tests/agent_test.py @@ -12,9 +12,11 @@ from crewai.llm import LLM from crewai.agents.parser import CrewAgentParser, OutputParserException from crewai.tools.tool_calling import InstructorToolCalling from crewai.tools.tool_usage import ToolUsage +from crewai.tools.tool_usage_events import ToolUsageFinished from crewai.utilities import RPMController from crewai_tools import tool from crewai.agents.parser import AgentAction +from crewai.utilities.events import Emitter def test_agent_llm_creation_with_env_vars(): @@ -178,8 +180,15 @@ def test_agent_execution_with_tools(): agent=agent, expected_output="The result of the multiplication.", ) - output = agent.execute_task(task) - assert output == "The result of the multiplication is 12." + with patch.object(Emitter, "emit") as emit: + output = agent.execute_task(task) + assert output == "The result of the multiplication is 12." + assert emit.call_count == 1 + args, _ = emit.call_args + assert isinstance(args[1], ToolUsageFinished) + assert not args[1].from_cache + assert args[1].tool_name == "multiplier" + assert args[1].tool_args == {"first_number": 3, "second_number": 4} @pytest.mark.vcr(filter_headers=["authorization"]) @@ -267,7 +276,9 @@ def test_cache_hitting(): "multiplier-{'first_number': 12, 'second_number': 3}": 36, } - with patch.object(CacheHandler, "read") as read: + with patch.object(CacheHandler, "read") as read, patch.object( + Emitter, "emit" + ) as emit: read.return_value = "0" task = Task( description="What is 2 times 6? Ignore correctness and just return the result of the multiplication tool, you must use the tool.", @@ -279,6 +290,10 @@ def test_cache_hitting(): read.assert_called_with( tool="multiplier", input={"first_number": 2, "second_number": 6} ) + assert emit.call_count == 1 + args, _ = emit.call_args + assert isinstance(args[1], ToolUsageFinished) + assert args[1].from_cache @pytest.mark.vcr(filter_headers=["authorization"]) diff --git a/tests/cli/__init__.py b/tests/cli/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/cli/authentication/__init__.py b/tests/cli/authentication/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/cli/deploy/test_deploy_main.py b/tests/cli/deploy/test_deploy_main.py index ddb9709d3..b30883be3 100644 --- a/tests/cli/deploy/test_deploy_main.py +++ b/tests/cli/deploy/test_deploy_main.py @@ -1,7 +1,11 @@ -import unittest -from io import StringIO -from unittest.mock import MagicMock, patch +import pytest +import requests import sys +import unittest + +from io import StringIO +from requests.exceptions import JSONDecodeError +from unittest.mock import MagicMock, Mock, patch from crewai.cli.deploy.main import DeployCommand from crewai.cli.utils import parse_toml @@ -33,13 +37,65 @@ class TestDeployCommand(unittest.TestCase): with self.assertRaises(SystemExit): DeployCommand() - def test_handle_plus_api_error(self): + def test_validate_response_successful_response(self): + mock_response = Mock(spec=requests.Response) + mock_response.json.return_value = {"message": "Success"} + mock_response.status_code = 200 + mock_response.ok = True + with patch("sys.stdout", new=StringIO()) as fake_out: - self.deploy_command._handle_plus_api_error( - {"error": "Test error", "message": "Test message"} + self.deploy_command._validate_response(mock_response) + assert fake_out.getvalue() == "" + + def test_validate_response_json_decode_error(self): + mock_response = Mock(spec=requests.Response) + mock_response.json.side_effect = JSONDecodeError("Decode error", "", 0) + mock_response.status_code = 500 + mock_response.content = b"Invalid JSON" + + with patch("sys.stdout", new=StringIO()) as fake_out: + with pytest.raises(SystemExit): + self.deploy_command._validate_response(mock_response) + output = fake_out.getvalue() + assert ( + "Failed to parse response from Enterprise API failed. Details:" + in output ) - self.assertIn("Error: Test error", fake_out.getvalue()) - self.assertIn("Message: Test message", fake_out.getvalue()) + assert "Status Code: 500" in output + assert "Response:\nb'Invalid JSON'" in output + + def test_validate_response_422_error(self): + mock_response = Mock(spec=requests.Response) + mock_response.json.return_value = { + "field1": ["Error message 1"], + "field2": ["Error message 2"], + } + mock_response.status_code = 422 + mock_response.ok = False + + with patch("sys.stdout", new=StringIO()) as fake_out: + with pytest.raises(SystemExit): + self.deploy_command._validate_response(mock_response) + output = fake_out.getvalue() + assert ( + "Failed to complete operation. Please fix the following errors:" + in output + ) + assert "Field1 Error message 1" in output + assert "Field2 Error message 2" in output + + def test_validate_response_other_error(self): + mock_response = Mock(spec=requests.Response) + mock_response.json.return_value = {"error": "Something went wrong"} + mock_response.status_code = 500 + mock_response.ok = False + + with patch("sys.stdout", new=StringIO()) as fake_out: + with pytest.raises(SystemExit): + self.deploy_command._validate_response(mock_response) + output = fake_out.getvalue() + assert "Request to Enterprise API failed. Details:" in output + assert "Details:\nSomething went wrong" in output def test_standard_no_param_error_message(self): with patch("sys.stdout", new=StringIO()) as fake_out: @@ -87,11 +143,11 @@ class TestDeployCommand(unittest.TestCase): mock_display.assert_called_once_with({"uuid": "test-uuid"}) @patch("crewai.cli.deploy.main.fetch_and_json_env_file") - @patch("crewai.cli.deploy.main.get_git_remote_url") + @patch("crewai.cli.deploy.main.git.Repository.origin_url") @patch("builtins.input") - def test_create_crew(self, mock_input, mock_get_git_remote_url, mock_fetch_env): + def test_create_crew(self, mock_input, mock_git_origin_url, mock_fetch_env): mock_fetch_env.return_value = {"ENV_VAR": "value"} - mock_get_git_remote_url.return_value = "https://github.com/test/repo.git" + mock_git_origin_url.return_value = "https://github.com/test/repo.git" mock_input.return_value = "" mock_response = MagicMock() @@ -207,30 +263,7 @@ class TestDeployCommand(unittest.TestCase): project_name = get_project_name() self.assertEqual(project_name, "test_project") - @patch( - "builtins.open", - new_callable=unittest.mock.mock_open, - read_data=""" - [[package]] - name = "crewai" - version = "0.51.1" - description = "Some description" - category = "main" - optional = false - python-versions = ">=3.10,<4.0" - """, - ) - def test_get_crewai_version(self, mock_open): + def test_get_crewai_version(self): from crewai.cli.utils import get_crewai_version - version = get_crewai_version() - self.assertEqual(version, "0.51.1") - - @patch("builtins.open", side_effect=FileNotFoundError) - def test_get_crewai_version_file_not_found(self, mock_open): - from crewai.cli.utils import get_crewai_version - - with patch("sys.stdout", new=StringIO()) as fake_out: - version = get_crewai_version() - self.assertEqual(version, "no-version-found") - self.assertIn("Error: poetry.lock not found.", fake_out.getvalue()) + assert isinstance(get_crewai_version(), str) diff --git a/tests/cli/test_git.py b/tests/cli/test_git.py new file mode 100644 index 000000000..1fb1296cd --- /dev/null +++ b/tests/cli/test_git.py @@ -0,0 +1,101 @@ +from crewai.cli.git import Repository +import pytest + + +@pytest.fixture() +def repository(fp): + fp.register(["git", "--version"], stdout="git version 2.30.0\n") + fp.register(["git", "rev-parse", "--is-inside-work-tree"], stdout="true\n") + fp.register(["git", "fetch"], stdout="") + return Repository(path=".") + + +def test_init_with_invalid_git_repo(fp): + fp.register(["git", "--version"], stdout="git version 2.30.0\n") + fp.register( + ["git", "rev-parse", "--is-inside-work-tree"], + returncode=1, + stderr="fatal: not a git repository\n", + ) + + with pytest.raises(ValueError): + Repository(path="invalid/path") + + +def test_is_git_not_installed(fp): + fp.register(["git", "--version"], returncode=1) + + with pytest.raises( + ValueError, match="Git is not installed or not found in your PATH." + ): + Repository(path=".") + + +def test_status(fp, repository): + fp.register( + ["git", "status", "--branch", "--porcelain"], + stdout="## main...origin/main [ahead 1]\n", + ) + assert repository.status() == "## main...origin/main [ahead 1]" + + +def test_has_uncommitted_changes(fp, repository): + fp.register( + ["git", "status", "--branch", "--porcelain"], + stdout="## main...origin/main\n M somefile.txt\n", + ) + assert repository.has_uncommitted_changes() is True + + +def test_is_ahead_or_behind(fp, repository): + fp.register( + ["git", "status", "--branch", "--porcelain"], + stdout="## main...origin/main [ahead 1]\n", + ) + assert repository.is_ahead_or_behind() is True + + +def test_is_synced_when_synced(fp, repository): + fp.register( + ["git", "status", "--branch", "--porcelain"], stdout="## main...origin/main\n" + ) + fp.register( + ["git", "status", "--branch", "--porcelain"], stdout="## main...origin/main\n" + ) + assert repository.is_synced() is True + + +def test_is_synced_with_uncommitted_changes(fp, repository): + fp.register( + ["git", "status", "--branch", "--porcelain"], + stdout="## main...origin/main\n M somefile.txt\n", + ) + assert repository.is_synced() is False + + +def test_is_synced_when_ahead_or_behind(fp, repository): + fp.register( + ["git", "status", "--branch", "--porcelain"], + stdout="## main...origin/main [ahead 1]\n", + ) + fp.register( + ["git", "status", "--branch", "--porcelain"], + stdout="## main...origin/main [ahead 1]\n", + ) + assert repository.is_synced() is False + + +def test_is_synced_with_uncommitted_changes_and_ahead(fp, repository): + fp.register( + ["git", "status", "--branch", "--porcelain"], + stdout="## main...origin/main [ahead 1]\n M somefile.txt\n", + ) + assert repository.is_synced() is False + + +def test_origin_url(fp, repository): + fp.register( + ["git", "remote", "get-url", "origin"], + stdout="https://github.com/user/repo.git\n", + ) + assert repository.origin_url() == "https://github.com/user/repo.git" diff --git a/tests/cli/test_plus_api.py b/tests/cli/test_plus_api.py index 506246290..ace9e4e58 100644 --- a/tests/cli/test_plus_api.py +++ b/tests/cli/test_plus_api.py @@ -11,15 +11,22 @@ class TestPlusAPI(unittest.TestCase): def test_init(self): self.assertEqual(self.api.api_key, self.api_key) - self.assertEqual( - self.api.headers, - { - "Authorization": f"Bearer {self.api_key}", - "Content-Type": "application/json", - "User-Agent": "CrewAI-CLI/no-version-found", - "X-Crewai-Version": "no-version-found", - }, + self.assertEqual(self.api.headers["Authorization"], f"Bearer {self.api_key}") + self.assertEqual(self.api.headers["Content-Type"], "application/json") + self.assertTrue("CrewAI-CLI/" in self.api.headers["User-Agent"]) + self.assertTrue(self.api.headers["X-Crewai-Version"]) + + @patch("crewai.cli.plus_api.PlusAPI._make_request") + def test_login_to_tool_repository(self, mock_make_request): + mock_response = MagicMock() + mock_make_request.return_value = mock_response + + response = self.api.login_to_tool_repository() + + mock_make_request.assert_called_once_with( + "POST", "/crewai_plus/api/v1/tools/login" ) + self.assertEqual(response, mock_response) @patch("crewai.cli.plus_api.PlusAPI._make_request") def test_get_tool(self, mock_make_request): diff --git a/tests/cli/test_utils.py b/tests/cli/test_utils.py new file mode 100644 index 000000000..616fb3d2f --- /dev/null +++ b/tests/cli/test_utils.py @@ -0,0 +1,100 @@ +import pytest +import shutil +import tempfile +import os +from crewai.cli import utils + + +@pytest.fixture +def temp_tree(): + root_dir = tempfile.mkdtemp() + + create_file(os.path.join(root_dir, "file1.txt"), "Hello, world!") + create_file(os.path.join(root_dir, "file2.txt"), "Another file") + os.mkdir(os.path.join(root_dir, "empty_dir")) + nested_dir = os.path.join(root_dir, "nested_dir") + os.mkdir(nested_dir) + create_file(os.path.join(nested_dir, "nested_file.txt"), "Nested content") + + yield root_dir + + shutil.rmtree(root_dir) + + +def create_file(path, content): + with open(path, "w") as f: + f.write(content) + + +def test_tree_find_and_replace_file_content(temp_tree): + utils.tree_find_and_replace(temp_tree, "world", "universe") + with open(os.path.join(temp_tree, "file1.txt"), "r") as f: + assert f.read() == "Hello, universe!" + + +def test_tree_find_and_replace_file_name(temp_tree): + old_path = os.path.join(temp_tree, "file2.txt") + new_path = os.path.join(temp_tree, "file2_renamed.txt") + os.rename(old_path, new_path) + utils.tree_find_and_replace(temp_tree, "renamed", "modified") + assert os.path.exists(os.path.join(temp_tree, "file2_modified.txt")) + assert not os.path.exists(new_path) + + +def test_tree_find_and_replace_directory_name(temp_tree): + utils.tree_find_and_replace(temp_tree, "empty", "renamed") + assert os.path.exists(os.path.join(temp_tree, "renamed_dir")) + assert not os.path.exists(os.path.join(temp_tree, "empty_dir")) + + +def test_tree_find_and_replace_nested_content(temp_tree): + utils.tree_find_and_replace(temp_tree, "Nested", "Updated") + with open(os.path.join(temp_tree, "nested_dir", "nested_file.txt"), "r") as f: + assert f.read() == "Updated content" + + +def test_tree_find_and_replace_no_matches(temp_tree): + utils.tree_find_and_replace(temp_tree, "nonexistent", "replacement") + assert set(os.listdir(temp_tree)) == { + "file1.txt", + "file2.txt", + "empty_dir", + "nested_dir", + } + + +def test_tree_copy_full_structure(temp_tree): + dest_dir = tempfile.mkdtemp() + try: + utils.tree_copy(temp_tree, dest_dir) + assert set(os.listdir(dest_dir)) == set(os.listdir(temp_tree)) + assert os.path.isfile(os.path.join(dest_dir, "file1.txt")) + assert os.path.isfile(os.path.join(dest_dir, "file2.txt")) + assert os.path.isdir(os.path.join(dest_dir, "empty_dir")) + assert os.path.isdir(os.path.join(dest_dir, "nested_dir")) + assert os.path.isfile(os.path.join(dest_dir, "nested_dir", "nested_file.txt")) + finally: + shutil.rmtree(dest_dir) + + +def test_tree_copy_preserve_content(temp_tree): + dest_dir = tempfile.mkdtemp() + try: + utils.tree_copy(temp_tree, dest_dir) + with open(os.path.join(dest_dir, "file1.txt"), "r") as f: + assert f.read() == "Hello, world!" + with open(os.path.join(dest_dir, "nested_dir", "nested_file.txt"), "r") as f: + assert f.read() == "Nested content" + finally: + shutil.rmtree(dest_dir) + + +def test_tree_copy_to_existing_directory(temp_tree): + dest_dir = tempfile.mkdtemp() + try: + create_file(os.path.join(dest_dir, "existing_file.txt"), "I was here first") + utils.tree_copy(temp_tree, dest_dir) + assert os.path.isfile(os.path.join(dest_dir, "existing_file.txt")) + assert os.path.isfile(os.path.join(dest_dir, "file1.txt")) + finally: + shutil.rmtree(dest_dir) diff --git a/tests/cli/tools/test_main.py b/tests/cli/tools/test_main.py index f387c8d3f..354d98865 100644 --- a/tests/cli/tools/test_main.py +++ b/tests/cli/tools/test_main.py @@ -1,229 +1,344 @@ +import tempfile import unittest import unittest.mock +import os +from contextlib import contextmanager + +from pytest import raises from crewai.cli.tools.main import ToolCommand from io import StringIO from unittest.mock import patch, MagicMock +@contextmanager +def in_temp_dir(): + original_dir = os.getcwd() + with tempfile.TemporaryDirectory() as temp_dir: + os.chdir(temp_dir) + try: + yield temp_dir + finally: + os.chdir(original_dir) -class TestToolCommand(unittest.TestCase): - @patch("crewai.cli.tools.main.subprocess.run") - @patch("crewai.cli.plus_api.PlusAPI.get_tool") - def test_install_success(self, mock_get, mock_subprocess_run): - mock_get_response = MagicMock() - mock_get_response.status_code = 200 - mock_get_response.json.return_value = { - "handle": "sample-tool", - "repository": { - "handle": "sample-repo", - "url": "https://example.com/repo", - "credentials": "my_very_secret", - }, - } - mock_get.return_value = mock_get_response - mock_subprocess_run.return_value = MagicMock(stderr=None) - +@patch("crewai.cli.tools.main.subprocess.run") +def test_create_success(mock_subprocess): + with in_temp_dir(): tool_command = ToolCommand() - with patch("sys.stdout", new=StringIO()) as fake_out: - tool_command.install("sample-tool") + with patch.object(tool_command, "login") as mock_login, patch( + "sys.stdout", new=StringIO() + ) as fake_out: + tool_command.create("test-tool") output = fake_out.getvalue() - mock_get.assert_called_once_with("sample-tool") - mock_subprocess_run.assert_any_call( - [ - "poetry", - "source", - "add", - "--priority=explicit", - "crewai-sample-repo", - "https://example.com/repo", - ], - text=True, - check=True, - ) - mock_subprocess_run.assert_any_call( - [ - "poetry", - "config", - "http-basic.crewai-sample-repo", - "my_very_secret", - '""', - ], - capture_output=False, - text=True, - check=True, - ) - mock_subprocess_run.assert_any_call( - ["poetry", "add", "--source", "crewai-sample-repo", "sample-tool"], - capture_output=False, - text=True, - check=True, + assert os.path.isdir("test_tool") + assert os.path.isfile(os.path.join("test_tool", "README.md")) + assert os.path.isfile(os.path.join("test_tool", "pyproject.toml")) + assert os.path.isfile( + os.path.join("test_tool", "src", "test_tool", "__init__.py") ) + assert os.path.isfile(os.path.join("test_tool", "src", "test_tool", "tool.py")) - self.assertIn("Succesfully installed sample-tool", output) + with open( + os.path.join("test_tool", "src", "test_tool", "tool.py"), "r" + ) as f: + content = f.read() + assert "class TestTool" in content - @patch("crewai.cli.plus_api.PlusAPI.get_tool") - def test_install_tool_not_found(self, mock_get): - mock_get_response = MagicMock() - mock_get_response.status_code = 404 - mock_get.return_value = mock_get_response + mock_login.assert_called_once() + mock_subprocess.assert_called_once_with(["git", "init"], check=True) - tool_command = ToolCommand() + assert "Creating custom tool test_tool..." in output - with patch("sys.stdout", new=StringIO()) as fake_out: - with self.assertRaises(SystemExit): - tool_command.install("non-existent-tool") - output = fake_out.getvalue() +@patch("crewai.cli.tools.main.subprocess.run") +@patch("crewai.cli.plus_api.PlusAPI.get_tool") +def test_install_success(mock_get, mock_subprocess_run): + mock_get_response = MagicMock() + mock_get_response.status_code = 200 + mock_get_response.json.return_value = { + "handle": "sample-tool", + "repository": {"handle": "sample-repo", "url": "https://example.com/repo"}, + } + mock_get.return_value = mock_get_response + mock_subprocess_run.return_value = MagicMock(stderr=None) - mock_get.assert_called_once_with("non-existent-tool") - self.assertIn("No tool found with this name", output) + tool_command = ToolCommand() - @patch("crewai.cli.plus_api.PlusAPI.get_tool") - def test_install_api_error(self, mock_get): - mock_get_response = MagicMock() - mock_get_response.status_code = 500 - mock_get.return_value = mock_get_response + with patch("sys.stdout", new=StringIO()) as fake_out: + tool_command.install("sample-tool") + output = fake_out.getvalue() - tool_command = ToolCommand() - - with patch("sys.stdout", new=StringIO()) as fake_out: - with self.assertRaises(SystemExit): - tool_command.install("error-tool") - output = fake_out.getvalue() - - mock_get.assert_called_once_with("error-tool") - self.assertIn("Failed to get tool details", output) - - @patch("crewai.cli.tools.main.get_project_name", return_value="sample-tool") - @patch("crewai.cli.tools.main.get_project_version", return_value="1.0.0") - @patch( - "crewai.cli.tools.main.get_project_description", return_value="A sample tool" + mock_get.assert_called_once_with("sample-tool") + mock_subprocess_run.assert_any_call( + ["poetry", "add", "--source", "crewai-sample-repo", "sample-tool"], + capture_output=False, + text=True, + check=True, ) - @patch("crewai.cli.tools.main.subprocess.run") - @patch( - "crewai.cli.tools.main.os.listdir", return_value=["sample-tool-1.0.0.tar.gz"] - ) - @patch( - "crewai.cli.tools.main.open", - new_callable=unittest.mock.mock_open, - read_data=b"sample tarball content", - ) - @patch("crewai.cli.plus_api.PlusAPI.publish_tool") - def test_publish_success( - self, - mock_publish, - mock_open, - mock_listdir, - mock_subprocess_run, - mock_get_project_description, - mock_get_project_version, - mock_get_project_name, - ): - mock_publish_response = MagicMock() - mock_publish_response.status_code = 200 - mock_publish_response.json.return_value = {"handle": "sample-tool"} - mock_publish.return_value = mock_publish_response + assert "Succesfully installed sample-tool" in output + +@patch("crewai.cli.plus_api.PlusAPI.get_tool") +def test_install_tool_not_found(mock_get): + mock_get_response = MagicMock() + mock_get_response.status_code = 404 + mock_get.return_value = mock_get_response + + tool_command = ToolCommand() + + with patch("sys.stdout", new=StringIO()) as fake_out: + try: + tool_command.install("non-existent-tool") + except SystemExit: + pass + output = fake_out.getvalue() + + mock_get.assert_called_once_with("non-existent-tool") + assert "No tool found with this name" in output + +@patch("crewai.cli.plus_api.PlusAPI.get_tool") +def test_install_api_error(mock_get): + mock_get_response = MagicMock() + mock_get_response.status_code = 500 + mock_get.return_value = mock_get_response + + tool_command = ToolCommand() + + with patch("sys.stdout", new=StringIO()) as fake_out: + try: + tool_command.install("error-tool") + except SystemExit: + pass + output = fake_out.getvalue() + + mock_get.assert_called_once_with("error-tool") + assert "Failed to get tool details" in output + +@patch("crewai.cli.tools.main.git.Repository.is_synced", return_value=False) +def test_publish_when_not_in_sync(mock_is_synced): + with patch("sys.stdout", new=StringIO()) as fake_out, \ + raises(SystemExit): tool_command = ToolCommand() tool_command.publish(is_public=True) - mock_get_project_name.assert_called_once_with(require=True) - mock_get_project_version.assert_called_once_with(require=True) - mock_get_project_description.assert_called_once_with(require=False) - mock_subprocess_run.assert_called_once_with( - ["poetry", "build", "-f", "sdist", "--output", unittest.mock.ANY], - check=True, - capture_output=False, - ) - mock_open.assert_called_once_with(unittest.mock.ANY, "rb") - mock_publish.assert_called_once_with( - handle="sample-tool", - is_public=True, - version="1.0.0", - description="A sample tool", - encoded_file=unittest.mock.ANY, - ) + assert "Local changes need to be resolved before publishing" in fake_out.getvalue() - @patch("crewai.cli.tools.main.get_project_name", return_value="sample-tool") - @patch("crewai.cli.tools.main.get_project_version", return_value="1.0.0") - @patch( - "crewai.cli.tools.main.get_project_description", return_value="A sample tool" +@patch("crewai.cli.tools.main.get_project_name", return_value="sample-tool") +@patch("crewai.cli.tools.main.get_project_version", return_value="1.0.0") +@patch("crewai.cli.tools.main.get_project_description", return_value="A sample tool") +@patch("crewai.cli.tools.main.subprocess.run") +@patch("crewai.cli.tools.main.os.listdir", return_value=["sample-tool-1.0.0.tar.gz"]) +@patch( + "crewai.cli.tools.main.open", + new_callable=unittest.mock.mock_open, + read_data=b"sample tarball content", +) +@patch("crewai.cli.plus_api.PlusAPI.publish_tool") +@patch("crewai.cli.tools.main.git.Repository.is_synced", return_value=False) +def test_publish_when_not_in_sync_and_force( + mock_is_synced, + mock_publish, + mock_open, + mock_listdir, + mock_subprocess_run, + mock_get_project_description, + mock_get_project_version, + mock_get_project_name, +): + mock_publish_response = MagicMock() + mock_publish_response.status_code = 200 + mock_publish_response.json.return_value = {"handle": "sample-tool"} + mock_publish.return_value = mock_publish_response + + tool_command = ToolCommand() + tool_command.publish(is_public=True, force=True) + + mock_get_project_name.assert_called_with(require=True) + mock_get_project_version.assert_called_with(require=True) + mock_get_project_description.assert_called_with(require=False) + mock_subprocess_run.assert_called_with( + ["poetry", "build", "-f", "sdist", "--output", unittest.mock.ANY], + check=True, + capture_output=False, ) - @patch("crewai.cli.tools.main.subprocess.run") - @patch( - "crewai.cli.tools.main.os.listdir", return_value=["sample-tool-1.0.0.tar.gz"] + mock_open.assert_called_with(unittest.mock.ANY, "rb") + mock_publish.assert_called_with( + handle="sample-tool", + is_public=True, + version="1.0.0", + description="A sample tool", + encoded_file=unittest.mock.ANY, ) - @patch( - "crewai.cli.tools.main.open", - new_callable=unittest.mock.mock_open, - read_data=b"sample tarball content", + +@patch("crewai.cli.tools.main.get_project_name", return_value="sample-tool") +@patch("crewai.cli.tools.main.get_project_version", return_value="1.0.0") +@patch("crewai.cli.tools.main.get_project_description", return_value="A sample tool") +@patch("crewai.cli.tools.main.subprocess.run") +@patch("crewai.cli.tools.main.os.listdir", return_value=["sample-tool-1.0.0.tar.gz"]) +@patch( + "crewai.cli.tools.main.open", + new_callable=unittest.mock.mock_open, + read_data=b"sample tarball content", +) +@patch("crewai.cli.plus_api.PlusAPI.publish_tool") +@patch("crewai.cli.tools.main.git.Repository.is_synced", return_value=True) +def test_publish_success( + mock_is_synced, + mock_publish, + mock_open, + mock_listdir, + mock_subprocess_run, + mock_get_project_description, + mock_get_project_version, + mock_get_project_name, +): + mock_publish_response = MagicMock() + mock_publish_response.status_code = 200 + mock_publish_response.json.return_value = {"handle": "sample-tool"} + mock_publish.return_value = mock_publish_response + + tool_command = ToolCommand() + tool_command.publish(is_public=True) + + mock_get_project_name.assert_called_with(require=True) + mock_get_project_version.assert_called_with(require=True) + mock_get_project_description.assert_called_with(require=False) + mock_subprocess_run.assert_called_with( + ["poetry", "build", "-f", "sdist", "--output", unittest.mock.ANY], + check=True, + capture_output=False, ) - @patch("crewai.cli.plus_api.PlusAPI.publish_tool") - def test_publish_failure( - self, - mock_publish, - mock_open, - mock_listdir, - mock_subprocess_run, - mock_get_project_description, - mock_get_project_version, - mock_get_project_name, - ): - mock_publish_response = MagicMock() - mock_publish_response.status_code = 422 - mock_publish_response.json.return_value = {"name": ["is already taken"]} - mock_publish.return_value = mock_publish_response - - tool_command = ToolCommand() - - with patch("sys.stdout", new=StringIO()) as fake_out: - with self.assertRaises(SystemExit): - tool_command.publish(is_public=True) - output = fake_out.getvalue() - - mock_publish.assert_called_once() - self.assertIn("Failed to publish tool", output) - self.assertIn("Name is already taken", output) - - @patch("crewai.cli.tools.main.get_project_name", return_value="sample-tool") - @patch("crewai.cli.tools.main.get_project_version", return_value="1.0.0") - @patch( - "crewai.cli.tools.main.get_project_description", return_value="A sample tool" + mock_open.assert_called_with(unittest.mock.ANY, "rb") + mock_publish.assert_called_with( + handle="sample-tool", + is_public=True, + version="1.0.0", + description="A sample tool", + encoded_file=unittest.mock.ANY, ) - @patch("crewai.cli.tools.main.subprocess.run") - @patch( - "crewai.cli.tools.main.os.listdir", return_value=["sample-tool-1.0.0.tar.gz"] + +@patch("crewai.cli.tools.main.get_project_name", return_value="sample-tool") +@patch("crewai.cli.tools.main.get_project_version", return_value="1.0.0") +@patch("crewai.cli.tools.main.get_project_description", return_value="A sample tool") +@patch("crewai.cli.tools.main.subprocess.run") +@patch("crewai.cli.tools.main.os.listdir", return_value=["sample-tool-1.0.0.tar.gz"]) +@patch( + "crewai.cli.tools.main.open", + new_callable=unittest.mock.mock_open, + read_data=b"sample tarball content", +) +@patch("crewai.cli.plus_api.PlusAPI.publish_tool") +def test_publish_failure( + mock_publish, + mock_open, + mock_listdir, + mock_subprocess_run, + mock_get_project_description, + mock_get_project_version, + mock_get_project_name, +): + mock_publish_response = MagicMock() + mock_publish_response.status_code = 422 + mock_publish_response.json.return_value = {"name": ["is already taken"]} + mock_publish.return_value = mock_publish_response + + tool_command = ToolCommand() + + with patch("sys.stdout", new=StringIO()) as fake_out: + try: + tool_command.publish(is_public=True) + except SystemExit: + pass + output = fake_out.getvalue() + + mock_publish.assert_called_once() + assert "Failed to complete operation" in output + assert "Name is already taken" in output + +@patch("crewai.cli.tools.main.get_project_name", return_value="sample-tool") +@patch("crewai.cli.tools.main.get_project_version", return_value="1.0.0") +@patch("crewai.cli.tools.main.get_project_description", return_value="A sample tool") +@patch("crewai.cli.tools.main.subprocess.run") +@patch("crewai.cli.tools.main.os.listdir", return_value=["sample-tool-1.0.0.tar.gz"]) +@patch( + "crewai.cli.tools.main.open", + new_callable=unittest.mock.mock_open, + read_data=b"sample tarball content", +) +@patch("crewai.cli.plus_api.PlusAPI.publish_tool") +def test_publish_api_error( + mock_publish, + mock_open, + mock_listdir, + mock_subprocess_run, + mock_get_project_description, + mock_get_project_version, + mock_get_project_name, +): + mock_response = MagicMock() + mock_response.status_code = 500 + mock_response.json.return_value = {"error": "Internal Server Error"} + mock_response.ok = False + mock_publish.return_value = mock_response + + tool_command = ToolCommand() + + with patch("sys.stdout", new=StringIO()) as fake_out: + try: + tool_command.publish(is_public=True) + except SystemExit: + pass + output = fake_out.getvalue() + + mock_publish.assert_called_once() + assert "Request to Enterprise API failed" in output + +@patch("crewai.cli.plus_api.PlusAPI.login_to_tool_repository") +@patch("crewai.cli.tools.main.subprocess.run") +def test_login_success(mock_subprocess_run, mock_login): + mock_login_response = MagicMock() + mock_login_response.status_code = 200 + mock_login_response.json.return_value = { + "repositories": [ + { + "handle": "tools", + "url": "https://example.com/repo", + } + ], + "credential": {"username": "user", "password": "pass"}, + } + mock_login.return_value = mock_login_response + + mock_subprocess_run.return_value = MagicMock(stderr=None) + + tool_command = ToolCommand() + + with patch("sys.stdout", new=StringIO()) as fake_out: + tool_command.login() + output = fake_out.getvalue() + + mock_login.assert_called_once() + mock_subprocess_run.assert_any_call( + [ + "poetry", + "source", + "add", + "--priority=explicit", + "crewai-tools", + "https://example.com/repo", + ], + text=True, + check=True, ) - @patch( - "crewai.cli.tools.main.open", - new_callable=unittest.mock.mock_open, - read_data=b"sample tarball content", + mock_subprocess_run.assert_any_call( + [ + "poetry", + "config", + "http-basic.crewai-tools", + "user", + "pass", + ], + capture_output=False, + text=True, + check=True, ) - @patch("crewai.cli.plus_api.PlusAPI.publish_tool") - def test_publish_api_error( - self, - mock_publish, - mock_open, - mock_listdir, - mock_subprocess_run, - mock_get_project_description, - mock_get_project_version, - mock_get_project_name, - ): - mock_publish_response = MagicMock() - mock_publish_response.status_code = 500 - mock_publish.return_value = mock_publish_response - - tool_command = ToolCommand() - - with patch("sys.stdout", new=StringIO()) as fake_out: - with self.assertRaises(SystemExit): - tool_command.publish(is_public=True) - output = fake_out.getvalue() - - mock_publish.assert_called_once() - self.assertIn("Failed to publish tool", output) - - -if __name__ == "__main__": - unittest.main() + assert "Succesfully authenticated to the tool repository" in output