mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18: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>
384 lines
11 KiB
Plaintext
384 lines
11 KiB
Plaintext
---
|
|
title: Streaming Crew Execution
|
|
description: Stream real-time output from your CrewAI crew execution
|
|
icon: wave-pulse
|
|
mode: "wide"
|
|
---
|
|
|
|
## Introduction
|
|
|
|
CrewAI provides the ability to stream real-time output during crew execution, allowing you to display results as they're generated rather than waiting for the entire process to complete. This feature is particularly useful for building interactive applications, providing user feedback, and monitoring long-running processes.
|
|
|
|
## How Streaming Works
|
|
|
|
When streaming is enabled, CrewAI captures LLM responses and tool calls as they happen, packaging them into structured chunks that include context about which task and agent is executing. You can iterate over these chunks in real-time and access the final result once execution completes.
|
|
|
|
## Enabling Streaming
|
|
|
|
To enable streaming, set the `stream` parameter to `True` when creating your crew:
|
|
|
|
```python Code
|
|
from crewai import Agent, Crew, Task
|
|
|
|
# Create your agents and tasks
|
|
researcher = Agent(
|
|
role="Research Analyst",
|
|
goal="Gather comprehensive information on topics",
|
|
backstory="You are an experienced researcher with excellent analytical skills.",
|
|
)
|
|
|
|
task = Task(
|
|
description="Research the latest developments in AI",
|
|
expected_output="A detailed report on recent AI advancements",
|
|
agent=researcher,
|
|
)
|
|
|
|
# Enable streaming
|
|
crew = Crew(
|
|
agents=[researcher],
|
|
tasks=[task],
|
|
stream=True # Enable streaming output
|
|
)
|
|
```
|
|
|
|
## Synchronous Streaming
|
|
|
|
When you call `kickoff()` on a crew with streaming enabled, it returns a `CrewStreamingOutput` object that you can iterate over to receive chunks as they arrive:
|
|
|
|
```python Code
|
|
# Start streaming execution
|
|
streaming = crew.kickoff(inputs={"topic": "artificial intelligence"})
|
|
|
|
# Iterate over chunks as they arrive
|
|
for chunk in streaming:
|
|
print(chunk.content, end="", flush=True)
|
|
|
|
# Access the final result after streaming completes
|
|
result = streaming.result
|
|
print(f"\n\nFinal output: {result.raw}")
|
|
```
|
|
|
|
### Stream Chunk Information
|
|
|
|
Each chunk provides rich context about the execution:
|
|
|
|
```python Code
|
|
streaming = crew.kickoff(inputs={"topic": "AI"})
|
|
|
|
for chunk in streaming:
|
|
print(f"Task: {chunk.task_name} (index {chunk.task_index})")
|
|
print(f"Agent: {chunk.agent_role}")
|
|
print(f"Content: {chunk.content}")
|
|
print(f"Type: {chunk.chunk_type}") # TEXT or TOOL_CALL
|
|
if chunk.tool_call:
|
|
print(f"Tool: {chunk.tool_call.tool_name}")
|
|
print(f"Arguments: {chunk.tool_call.arguments}")
|
|
```
|
|
|
|
### Accessing Streaming Results
|
|
|
|
The `CrewStreamingOutput` object provides several useful properties:
|
|
|
|
```python Code
|
|
streaming = crew.kickoff(inputs={"topic": "AI"})
|
|
|
|
# Iterate and collect chunks
|
|
for chunk in streaming:
|
|
print(chunk.content, end="", flush=True)
|
|
|
|
# After iteration completes
|
|
print(f"\nCompleted: {streaming.is_completed}")
|
|
print(f"Full text: {streaming.get_full_text()}")
|
|
print(f"All chunks: {len(streaming.chunks)}")
|
|
print(f"Final result: {streaming.result.raw}")
|
|
```
|
|
|
|
## Asynchronous Streaming
|
|
|
|
For async applications, you can use either `akickoff()` (native async) or `kickoff_async()` (thread-based) with async iteration:
|
|
|
|
### Native Async with `akickoff()`
|
|
|
|
The `akickoff()` method provides true native async execution throughout the entire chain:
|
|
|
|
```python Code
|
|
import asyncio
|
|
|
|
async def stream_crew():
|
|
crew = Crew(
|
|
agents=[researcher],
|
|
tasks=[task],
|
|
stream=True
|
|
)
|
|
|
|
# Start native async streaming
|
|
streaming = await crew.akickoff(inputs={"topic": "AI"})
|
|
|
|
# Async iteration over chunks
|
|
async for chunk in streaming:
|
|
print(chunk.content, end="", flush=True)
|
|
|
|
# Access final result
|
|
result = streaming.result
|
|
print(f"\n\nFinal output: {result.raw}")
|
|
|
|
asyncio.run(stream_crew())
|
|
```
|
|
|
|
### Thread-Based Async with `kickoff_async()`
|
|
|
|
For simpler async integration or backward compatibility:
|
|
|
|
```python Code
|
|
import asyncio
|
|
|
|
async def stream_crew():
|
|
crew = Crew(
|
|
agents=[researcher],
|
|
tasks=[task],
|
|
stream=True
|
|
)
|
|
|
|
# Start thread-based async streaming
|
|
streaming = await crew.kickoff_async(inputs={"topic": "AI"})
|
|
|
|
# Async iteration over chunks
|
|
async for chunk in streaming:
|
|
print(chunk.content, end="", flush=True)
|
|
|
|
# Access final result
|
|
result = streaming.result
|
|
print(f"\n\nFinal output: {result.raw}")
|
|
|
|
asyncio.run(stream_crew())
|
|
```
|
|
|
|
<Note>
|
|
For high-concurrency workloads, `akickoff()` is recommended as it uses native async for task execution, memory operations, and knowledge retrieval. See the [Kickoff Crew Asynchronously](/en/learn/kickoff-async) guide for more details.
|
|
</Note>
|
|
|
|
## Streaming with kickoff_for_each
|
|
|
|
When executing a crew for multiple inputs with `kickoff_for_each()`, streaming works differently depending on whether you use sync or async:
|
|
|
|
### Synchronous kickoff_for_each
|
|
|
|
With synchronous `kickoff_for_each()`, you get a list of `CrewStreamingOutput` objects, one for each input:
|
|
|
|
```python Code
|
|
crew = Crew(
|
|
agents=[researcher],
|
|
tasks=[task],
|
|
stream=True
|
|
)
|
|
|
|
inputs_list = [
|
|
{"topic": "AI in healthcare"},
|
|
{"topic": "AI in finance"}
|
|
]
|
|
|
|
# Returns list of streaming outputs
|
|
streaming_outputs = crew.kickoff_for_each(inputs=inputs_list)
|
|
|
|
# Iterate over each streaming output
|
|
for i, streaming in enumerate(streaming_outputs):
|
|
print(f"\n=== Input {i + 1} ===")
|
|
for chunk in streaming:
|
|
print(chunk.content, end="", flush=True)
|
|
|
|
result = streaming.result
|
|
print(f"\n\nResult {i + 1}: {result.raw}")
|
|
```
|
|
|
|
### Asynchronous kickoff_for_each_async
|
|
|
|
With async `kickoff_for_each_async()`, you get a single `CrewStreamingOutput` that yields chunks from all crews as they arrive concurrently:
|
|
|
|
```python Code
|
|
import asyncio
|
|
|
|
async def stream_multiple_crews():
|
|
crew = Crew(
|
|
agents=[researcher],
|
|
tasks=[task],
|
|
stream=True
|
|
)
|
|
|
|
inputs_list = [
|
|
{"topic": "AI in healthcare"},
|
|
{"topic": "AI in finance"}
|
|
]
|
|
|
|
# Returns single streaming output for all crews
|
|
streaming = await crew.kickoff_for_each_async(inputs=inputs_list)
|
|
|
|
# Chunks from all crews arrive as they're generated
|
|
async for chunk in streaming:
|
|
print(f"[{chunk.task_name}] {chunk.content}", end="", flush=True)
|
|
|
|
# Access all results
|
|
results = streaming.results # List of CrewOutput objects
|
|
for i, result in enumerate(results):
|
|
print(f"\n\nResult {i + 1}: {result.raw}")
|
|
|
|
asyncio.run(stream_multiple_crews())
|
|
```
|
|
|
|
## Stream Chunk Types
|
|
|
|
Chunks can be of different types, indicated by the `chunk_type` field:
|
|
|
|
### TEXT Chunks
|
|
|
|
Standard text content from LLM responses:
|
|
|
|
```python Code
|
|
for chunk in streaming:
|
|
if chunk.chunk_type == StreamChunkType.TEXT:
|
|
print(chunk.content, end="", flush=True)
|
|
```
|
|
|
|
### TOOL_CALL Chunks
|
|
|
|
Information about tool calls being made:
|
|
|
|
```python Code
|
|
for chunk in streaming:
|
|
if chunk.chunk_type == StreamChunkType.TOOL_CALL:
|
|
print(f"\nCalling tool: {chunk.tool_call.tool_name}")
|
|
print(f"Arguments: {chunk.tool_call.arguments}")
|
|
```
|
|
|
|
## Practical Example: Building a UI with Streaming
|
|
|
|
Here's a complete example showing how to build an interactive application with streaming:
|
|
|
|
```python Code
|
|
import asyncio
|
|
from crewai import Agent, Crew, Task
|
|
from crewai.types.streaming import StreamChunkType
|
|
|
|
async def interactive_research():
|
|
# Create crew with streaming enabled
|
|
researcher = Agent(
|
|
role="Research Analyst",
|
|
goal="Provide detailed analysis on any topic",
|
|
backstory="You are an expert researcher with broad knowledge.",
|
|
)
|
|
|
|
task = Task(
|
|
description="Research and analyze: {topic}",
|
|
expected_output="A comprehensive analysis with key insights",
|
|
agent=researcher,
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[researcher],
|
|
tasks=[task],
|
|
stream=True,
|
|
verbose=False
|
|
)
|
|
|
|
# Get user input
|
|
topic = input("Enter a topic to research: ")
|
|
|
|
print(f"\n{'='*60}")
|
|
print(f"Researching: {topic}")
|
|
print(f"{'='*60}\n")
|
|
|
|
# Start streaming execution
|
|
streaming = await crew.kickoff_async(inputs={"topic": topic})
|
|
|
|
current_task = ""
|
|
async for chunk in streaming:
|
|
# Show task transitions
|
|
if chunk.task_name != current_task:
|
|
current_task = chunk.task_name
|
|
print(f"\n[{chunk.agent_role}] Working on: {chunk.task_name}")
|
|
print("-" * 60)
|
|
|
|
# Display text chunks
|
|
if chunk.chunk_type == StreamChunkType.TEXT:
|
|
print(chunk.content, end="", flush=True)
|
|
|
|
# Display tool calls
|
|
elif chunk.chunk_type == StreamChunkType.TOOL_CALL and chunk.tool_call:
|
|
print(f"\n🔧 Using tool: {chunk.tool_call.tool_name}")
|
|
|
|
# Show final result
|
|
result = streaming.result
|
|
print(f"\n\n{'='*60}")
|
|
print("Analysis Complete!")
|
|
print(f"{'='*60}")
|
|
print(f"\nToken Usage: {result.token_usage}")
|
|
|
|
asyncio.run(interactive_research())
|
|
```
|
|
|
|
## Use Cases
|
|
|
|
Streaming is particularly valuable for:
|
|
|
|
- **Interactive Applications**: Provide real-time feedback to users as agents work
|
|
- **Long-Running Tasks**: Show progress for research, analysis, or content generation
|
|
- **Debugging and Monitoring**: Observe agent behavior and decision-making in real-time
|
|
- **User Experience**: Reduce perceived latency by showing incremental results
|
|
- **Live Dashboards**: Build monitoring interfaces that display crew execution status
|
|
|
|
## Cancellation and Resource Cleanup
|
|
|
|
`CrewStreamingOutput` supports graceful cancellation so that in-flight work stops promptly when the consumer disconnects.
|
|
|
|
### Async Context Manager
|
|
|
|
```python Code
|
|
streaming = await crew.akickoff(inputs={"topic": "AI"})
|
|
|
|
async with streaming:
|
|
async for chunk in streaming:
|
|
print(chunk.content, end="", flush=True)
|
|
```
|
|
|
|
### Explicit Cancellation
|
|
|
|
```python Code
|
|
streaming = await crew.akickoff(inputs={"topic": "AI"})
|
|
try:
|
|
async for chunk in streaming:
|
|
print(chunk.content, end="", flush=True)
|
|
finally:
|
|
await streaming.aclose() # async
|
|
# streaming.close() # sync equivalent
|
|
```
|
|
|
|
After cancellation, `streaming.is_cancelled` and `streaming.is_completed` are both `True`. Both `aclose()` and `close()` are idempotent.
|
|
|
|
## Important Notes
|
|
|
|
- Streaming automatically enables LLM streaming for all agents in the crew
|
|
- You must iterate through all chunks before accessing the `.result` property
|
|
- For `kickoff_for_each_async()` with streaming, use `.results` (plural) to get all outputs
|
|
- Streaming adds minimal overhead and can actually improve perceived performance
|
|
- Each chunk includes full context (task, agent, chunk type) for rich UIs
|
|
|
|
## Error Handling
|
|
|
|
Handle errors during streaming execution:
|
|
|
|
```python Code
|
|
streaming = crew.kickoff(inputs={"topic": "AI"})
|
|
|
|
try:
|
|
for chunk in streaming:
|
|
print(chunk.content, end="", flush=True)
|
|
|
|
result = streaming.result
|
|
print(f"\nSuccess: {result.raw}")
|
|
|
|
except Exception as e:
|
|
print(f"\nError during streaming: {e}")
|
|
if streaming.is_completed:
|
|
print("Streaming completed but an error occurred")
|
|
```
|
|
|
|
By leveraging streaming, you can build more responsive and interactive applications with CrewAI, providing users with real-time visibility into agent execution and results. |