mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +00:00
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
114 lines
5.4 KiB
Plaintext
114 lines
5.4 KiB
Plaintext
---
|
|
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
|
|
mode: "wide"
|
|
---
|
|
|
|
## 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.
|
|
|
|
<Tip>
|
|
The hierarchical process is designed to leverage advanced models like GPT-4, optimizing token usage while handling complex tasks with greater efficiency.
|
|
</Tip>
|
|
|
|
## 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.
|
|
|
|
### 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.
|
|
- **System Prompt Handling**: Optionally specify whether the system should use predefined prompts.
|
|
- **Stop Words Control**: Optionally specify whether stop words should be used, supporting various models including the o1 models.
|
|
- **Context Window Respect**: Prioritize important context by enabling respect of the context window, which is now the default behavior.
|
|
- **Delegation Control**: Delegation is now disabled by default to give users explicit control.
|
|
- **Max Requests Per Minute**: Configurable option to set the maximum number of requests per minute.
|
|
- **Max Iterations**: Limit the maximum number of iterations for obtaining a final answer.
|
|
|
|
|
|
## 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.
|
|
|
|
<Tip>
|
|
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.
|
|
</Tip>
|
|
|
|
<Tip>
|
|
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.
|
|
</Tip>
|
|
|
|
```python Code
|
|
from crewai import Crew, Process, Agent
|
|
|
|
# Agents are defined with attributes for backstory, cache, and verbose mode
|
|
researcher = Agent(
|
|
role='Researcher',
|
|
goal='Conduct in-depth analysis',
|
|
backstory='Experienced data analyst with a knack for uncovering hidden trends.',
|
|
)
|
|
writer = Agent(
|
|
role='Writer',
|
|
goal='Create engaging content',
|
|
backstory='Creative writer passionate about storytelling in technical domains.',
|
|
)
|
|
|
|
# Establishing the crew with a hierarchical process and additional configurations
|
|
project_crew = Crew(
|
|
tasks=[...], # Tasks to be delegated and executed under the manager's supervision
|
|
agents=[researcher, writer],
|
|
manager_llm="gpt-4o", # Specify which LLM the manager should use
|
|
process=Process.hierarchical,
|
|
planning=True,
|
|
)
|
|
```
|
|
|
|
### Using a Custom Manager Agent
|
|
|
|
Alternatively, you can create a custom manager agent with specific attributes tailored to your project's management needs. This gives you more control over the manager's behavior and capabilities.
|
|
|
|
```python
|
|
# Define a custom manager agent
|
|
manager = Agent(
|
|
role="Project Manager",
|
|
goal="Efficiently manage the crew and ensure high-quality task completion",
|
|
backstory="You're an experienced project manager, skilled in overseeing complex projects and guiding teams to success.",
|
|
allow_delegation=True,
|
|
)
|
|
|
|
# Use the custom manager in your crew
|
|
project_crew = Crew(
|
|
tasks=[...],
|
|
agents=[researcher, writer],
|
|
manager_agent=manager, # Use your custom manager agent
|
|
process=Process.hierarchical,
|
|
planning=True,
|
|
)
|
|
```
|
|
|
|
<Tip>
|
|
For more details on creating and customizing a manager agent, check out the [Custom Manager Agent documentation](/en/learn/custom-manager-agent).
|
|
</Tip>
|
|
|
|
|
|
### 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.
|