Hierarchical Tasks Agent Workflow Documentation
Overview
This workflow utilizes a hierarchical agent-based approach to answer user queries. It leverages multiple CrewAI agents, each specializing in a specific task, coordinated by a manager agent. The system takes a user's input, generates a prompt, performs searches if needed, and then synthesizes the information to provide a comprehensive and informative response.
Components Overview
The workflow comprises the following components:
- Chat Input: Captures user input from the interface.
- Prompt: Generates a prompt based on user input.
- OpenAI Model: A large language model (LLM) used for text generation and understanding.
- CrewAI Agent (Research): An agent responsible for researching information relevant to the user's query.
- CrewAI Agent (Editor): An agent responsible for evaluating the gathered information for bias and misleading content.
- CrewAI Agent (Manager): An agent that manages and coordinates the Research and Editor agents.
- DuckDuckGo Search: Performs web searches using the DuckDuckGo search engine.
- Hierarchical Crew: Orchestrates the collaboration between multiple CrewAI agents.
- Hierarchical Task: Defines the tasks for the agents.
- Chat Output: Displays the final response to the user.
Detailed Component Descriptions
Chat Input
- Description: Retrieves user input as a message from the chat interface.
- Input Parameters: None.
- Output Parameters: Message (containing user's text input).
- Key Configurations/Conditions: Allows for optional settings to specify sender information and whether to store the message.
Prompt
- Description: Creates a prompt template incorporating the user's query.
- Input Parameters: Message (containing the user's query).
- Output Parameters: Message (containing the formatted prompt).
- Key Configurations/Conditions: Uses a template to structure the prompt, including the user's query.
OpenAI Model
- Description: Generates text using OpenAI's LLMs.
- Input Parameters: Input value (prompt or other text), various parameters controlling generation (e.g.,
max_tokens,temperature). - Output Parameters: Text output (generated text), Language Model object.
- Key Configurations/Conditions: Allows selection of different OpenAI models.
CrewAI Agent (Research, Editor, Manager)
- Description: Represents a CrewAI agent capable of performing specific tasks.
- Input Parameters: LLM (Language Model), Tools (optional), Backstory (optional), Goal, Role.
- Output Parameters: Agent output (results of the agent's task).
- Key Configurations/Conditions: Allows configuration of agent behavior through backstory, goal, and role parameters. Can utilize tools for task execution.
DuckDuckGo Search
- Description: Performs web searches using the DuckDuckGo search engine.
- Input Parameters: Search query (text),
max_results(number of results). - Output Parameters: Data (search results), Tool (DuckDuckGo search tool).
- Key Configurations/Conditions: Allows specifying search region and source (e.g., "text" or "news").
Hierarchical Crew
- Description: Orchestrates the execution of multiple CrewAI agents.
- Input Parameters: Agents (list of agents), optional parameters for configuration (e.g.,
memory,verbose). - Output Parameters: Message (containing the synthesized response).
- Key Configurations/Conditions: Enables management of agent interactions and task assignments.
Hierarchical Task
- Description: Defines a task for the hierarchical agent system.
- Input Parameters: Task description (text), expected output (text), tools (optional).
- Output Parameters: HierarchicalTask object (defines the task).
- Key Configurations/Conditions: Defines the specific task to be performed by agents within the hierarchy.
Chat Output
- Description: Displays a message in the chat interface.
- Input Parameters: Message (containing the response text).
- Output Parameters: None.
- Key Configurations/Conditions: Allows customization of sender information and message display.
Workflow Execution
- Chat Input: The workflow begins with user input captured by the Chat Input component.
- Prompt Generation: The user's input is passed to the Prompt component to generate a structured prompt.
- OpenAI Model: The prompt is sent to the OpenAI Model to generate the initial response. This response is also used to inform and guide the subsequent agent behaviors.
- Agent Execution: The OpenAI Model output (a Language Model object) is fed into the CrewAI Agents (Research, Editor and Manager), along with relevant parameters. The Manager agent orchestrates their operations. The Research agent uses the DuckDuckGo Search tool.
- Hierarchical Crew: The manager, research, and editor agents are coordinated by the Hierarchical Crew component. The Hierarchical Task component is used to define tasks for these agents.
- Response Synthesis: The Hierarchical Crew component combines the output of the various agents to generate a final response.
- Chat Output: Finally, the Chat Output component displays the synthesized response to the user.
Additional Notes
The success of this workflow depends on the proper configuration of the agents, their goals, and the availability and functionality of the tools they utilize. The OpenAI Model's performance significantly impacts the overall quality of the response. Error handling and fallback mechanisms may be necessary to manage situations where agents fail to execute their tasks successfully. Consider memory management within the agents to improve performance and consistency.
graph TD
%%{init: {'theme': 'mc','layout': 'elk'}}%%
ChatOutput-qt51O[<img src="/_astro/messages-square.BaSDmT6g.svg" class="w-8 h-8 max-w-12 object-contain mx-auto" width="20">Chat Output]
ChatOutput-qt51O@{ shape: rounded}
style ChatOutput-qt51O stroke:#a170ff
OpenAIModel-KL3ma[<img src="/_astro/openAI.CA91HhVI.svg" class="w-8 h-8 max-w-12 object-contain mx-auto" width="20">OpenAI]
OpenAIModel-KL3ma@{ shape: rounded}
style OpenAIModel-KL3ma stroke:#a170ff
Prompt-hdtzE[<img src="/_astro/square-terminal.BMOXc-nZ.svg" class="w-8 h-8 max-w-12 object-contain mx-auto" width="20">Prompt]
Prompt-hdtzE@{ shape: rounded}
style Prompt-hdtzE stroke:#a170ff
ChatInput-MsBiW[<img src="/_astro/messages-square.BaSDmT6g.svg" class="w-8 h-8 max-w-12 object-contain mx-auto" width="20">Chat Input]
ChatInput-MsBiW@{ shape: rounded}
style ChatInput-MsBiW stroke:#a170ff
CrewAIAgent-1Hl9X[<img src="/_astro/crewai.DJDxJ-P5.svg" class="w-8 h-8 max-w-12 object-contain mx-auto" width="20">CrewAI Agent]
CrewAIAgent-1Hl9X@{ shape: rounded}
style CrewAIAgent-1Hl9X stroke:#a170ff
HierarchicalCrew-7eFBe[<img src="/_astro/crewai.DJDxJ-P5.svg" class="w-8 h-8 max-w-12 object-contain mx-auto" width="20">Hierarchical Crew]
HierarchicalCrew-7eFBe@{ shape: rounded}
style HierarchicalCrew-7eFBe stroke:#a170ff
CrewAIAgent-WHOnw[<img src="/_astro/crewai.DJDxJ-P5.svg" class="w-8 h-8 max-w-12 object-contain mx-auto" width="20">CrewAI Agent]
CrewAIAgent-WHOnw@{ shape: rounded}
style CrewAIAgent-WHOnw stroke:#a170ff
CrewAIAgent-oTbpZ[<img src="/_astro/crewai.DJDxJ-P5.svg" class="w-8 h-8 max-w-12 object-contain mx-auto" width="20">CrewAI Agent]
CrewAIAgent-oTbpZ@{ shape: rounded}
style CrewAIAgent-oTbpZ stroke:#a170ff
DuckDuckGoSearch-NfyM5[DuckDuckGo Search]
DuckDuckGoSearch-NfyM5@{ shape: rounded}
style DuckDuckGoSearch-NfyM5 stroke:#a170ff
HierarchicalTask-G1HM6[<img src="/_astro/crewai.DJDxJ-P5.svg" class="w-8 h-8 max-w-12 object-contain mx-auto" width="20">Hierarchical Task]
HierarchicalTask-G1HM6@{ shape: rounded}
style HierarchicalTask-G1HM6 stroke:#a170ff
ChatInput-MsBiW -.- Prompt-hdtzE
linkStyle 0 stroke:#a170ff
CrewAIAgent-1Hl9X -.- HierarchicalCrew-7eFBe
linkStyle 1 stroke:#a170ff
OpenAIModel-KL3ma -.- CrewAIAgent-1Hl9X
linkStyle 2 stroke:#a170ff
OpenAIModel-KL3ma -.- CrewAIAgent-WHOnw
linkStyle 3 stroke:#a170ff
CrewAIAgent-WHOnw -.- HierarchicalCrew-7eFBe
linkStyle 4 stroke:#a170ff
OpenAIModel-KL3ma -.- CrewAIAgent-oTbpZ
linkStyle 5 stroke:#a170ff
CrewAIAgent-oTbpZ -.- HierarchicalCrew-7eFBe
linkStyle 6 stroke:#a170ff
HierarchicalCrew-7eFBe -.- ChatOutput-qt51O
linkStyle 7 stroke:#a170ff
DuckDuckGoSearch-NfyM5 -.- CrewAIAgent-oTbpZ
linkStyle 8 stroke:#a170ff
HierarchicalTask-G1HM6 -.- HierarchicalCrew-7eFBe
linkStyle 9 stroke:#a170ff
Prompt-hdtzE -.- HierarchicalTask-G1HM6
linkStyle 10 stroke:#a170ff