mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +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>
307 lines
9.5 KiB
Plaintext
307 lines
9.5 KiB
Plaintext
---
|
|
title: Inicie uma Crew de Forma Assíncrona
|
|
description: Inicie uma Crew de Forma Assíncrona
|
|
icon: rocket-launch
|
|
mode: "wide"
|
|
---
|
|
|
|
## Introdução
|
|
|
|
A CrewAI oferece a capacidade de iniciar uma crew de forma assíncrona, permitindo que você comece a execução da crew de maneira não bloqueante.
|
|
Esse recurso é especialmente útil quando você deseja executar múltiplas crews simultaneamente ou quando precisa realizar outras tarefas enquanto a crew está em execução.
|
|
|
|
O CrewAI oferece duas abordagens para execução assíncrona:
|
|
|
|
| Método | Tipo | Descrição |
|
|
|--------|------|-------------|
|
|
| `akickoff()` | Async nativo | Async/await verdadeiro em toda a cadeia de execução |
|
|
| `kickoff_async()` | Baseado em thread | Envolve execução síncrona em `asyncio.to_thread` |
|
|
|
|
<Note>
|
|
Para cargas de trabalho de alta concorrência, `akickoff()` é recomendado pois usa async nativo para execução de tasks, operações de memória e recuperação de conhecimento.
|
|
</Note>
|
|
|
|
## Execução Async Nativa com `akickoff()`
|
|
|
|
O método `akickoff()` fornece execução async nativa verdadeira, usando async/await em toda a cadeia de execução, incluindo execução de tasks, operações de memória e consultas de conhecimento.
|
|
|
|
### Assinatura do Método
|
|
|
|
```python Code
|
|
async def akickoff(self, inputs: dict) -> CrewOutput:
|
|
```
|
|
|
|
### Parâmetros
|
|
|
|
- `inputs` (dict): Um dicionário contendo os dados de entrada necessários para as tarefas.
|
|
|
|
### Retorno
|
|
|
|
- `CrewOutput`: Um objeto que representa o resultado da execução da crew.
|
|
|
|
### Exemplo: Execução Async Nativa de Crew
|
|
|
|
```python Code
|
|
import asyncio
|
|
from crewai import Crew, Agent, Task
|
|
|
|
# Criar um agente
|
|
coding_agent = Agent(
|
|
role="Python Data Analyst",
|
|
goal="Analyze data and provide insights using Python",
|
|
backstory="You are an experienced data analyst with strong Python skills.",
|
|
allow_code_execution=True
|
|
)
|
|
|
|
# Criar uma tarefa
|
|
data_analysis_task = Task(
|
|
description="Analyze the given dataset and calculate the average age of participants. Ages: {ages}",
|
|
agent=coding_agent,
|
|
expected_output="The average age of the participants."
|
|
)
|
|
|
|
# Criar uma crew
|
|
analysis_crew = Crew(
|
|
agents=[coding_agent],
|
|
tasks=[data_analysis_task]
|
|
)
|
|
|
|
# Execução async nativa
|
|
async def main():
|
|
result = await analysis_crew.akickoff(inputs={"ages": [25, 30, 35, 40, 45]})
|
|
print("Crew Result:", result)
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
### Exemplo: Múltiplas Crews Async Nativas
|
|
|
|
Execute múltiplas crews concorrentemente usando `asyncio.gather()` com async nativo:
|
|
|
|
```python Code
|
|
import asyncio
|
|
from crewai import Crew, Agent, Task
|
|
|
|
coding_agent = Agent(
|
|
role="Python Data Analyst",
|
|
goal="Analyze data and provide insights using Python",
|
|
backstory="You are an experienced data analyst with strong Python skills.",
|
|
allow_code_execution=True
|
|
)
|
|
|
|
task_1 = Task(
|
|
description="Analyze the first dataset and calculate the average age. Ages: {ages}",
|
|
agent=coding_agent,
|
|
expected_output="The average age of the participants."
|
|
)
|
|
|
|
task_2 = Task(
|
|
description="Analyze the second dataset and calculate the average age. Ages: {ages}",
|
|
agent=coding_agent,
|
|
expected_output="The average age of the participants."
|
|
)
|
|
|
|
crew_1 = Crew(agents=[coding_agent], tasks=[task_1])
|
|
crew_2 = Crew(agents=[coding_agent], tasks=[task_2])
|
|
|
|
async def main():
|
|
results = await asyncio.gather(
|
|
crew_1.akickoff(inputs={"ages": [25, 30, 35, 40, 45]}),
|
|
crew_2.akickoff(inputs={"ages": [20, 22, 24, 28, 30]})
|
|
)
|
|
|
|
for i, result in enumerate(results, 1):
|
|
print(f"Crew {i} Result:", result)
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
### Exemplo: Async Nativo para Múltiplas Entradas
|
|
|
|
Use `akickoff_for_each()` para executar sua crew contra múltiplas entradas concorrentemente com async nativo:
|
|
|
|
```python Code
|
|
import asyncio
|
|
from crewai import Crew, Agent, Task
|
|
|
|
coding_agent = Agent(
|
|
role="Python Data Analyst",
|
|
goal="Analyze data and provide insights using Python",
|
|
backstory="You are an experienced data analyst with strong Python skills.",
|
|
allow_code_execution=True
|
|
)
|
|
|
|
data_analysis_task = Task(
|
|
description="Analyze the dataset and calculate the average age. Ages: {ages}",
|
|
agent=coding_agent,
|
|
expected_output="The average age of the participants."
|
|
)
|
|
|
|
analysis_crew = Crew(
|
|
agents=[coding_agent],
|
|
tasks=[data_analysis_task]
|
|
)
|
|
|
|
async def main():
|
|
datasets = [
|
|
{"ages": [25, 30, 35, 40, 45]},
|
|
{"ages": [20, 22, 24, 28, 30]},
|
|
{"ages": [30, 35, 40, 45, 50]}
|
|
]
|
|
|
|
results = await analysis_crew.akickoff_for_each(datasets)
|
|
|
|
for i, result in enumerate(results, 1):
|
|
print(f"Dataset {i} Result:", result)
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
## Async Baseado em Thread com `kickoff_async()`
|
|
|
|
O método `kickoff_async()` fornece execução async envolvendo o `kickoff()` síncrono em uma thread. Isso é útil para integração async mais simples ou compatibilidade retroativa.
|
|
|
|
### Assinatura do Método
|
|
|
|
```python Code
|
|
async def kickoff_async(self, inputs: dict) -> CrewOutput:
|
|
```
|
|
|
|
### Parâmetros
|
|
|
|
- `inputs` (dict): Um dicionário contendo os dados de entrada necessários para as tarefas.
|
|
|
|
### Retorno
|
|
|
|
- `CrewOutput`: Um objeto que representa o resultado da execução da crew.
|
|
|
|
### Exemplo: Execução Async Baseada em Thread
|
|
|
|
```python Code
|
|
import asyncio
|
|
from crewai import Crew, Agent, Task
|
|
|
|
coding_agent = Agent(
|
|
role="Python Data Analyst",
|
|
goal="Analyze data and provide insights using Python",
|
|
backstory="You are an experienced data analyst with strong Python skills.",
|
|
allow_code_execution=True
|
|
)
|
|
|
|
data_analysis_task = Task(
|
|
description="Analyze the given dataset and calculate the average age of participants. Ages: {ages}",
|
|
agent=coding_agent,
|
|
expected_output="The average age of the participants."
|
|
)
|
|
|
|
analysis_crew = Crew(
|
|
agents=[coding_agent],
|
|
tasks=[data_analysis_task]
|
|
)
|
|
|
|
async def async_crew_execution():
|
|
result = await analysis_crew.kickoff_async(inputs={"ages": [25, 30, 35, 40, 45]})
|
|
print("Crew Result:", result)
|
|
|
|
asyncio.run(async_crew_execution())
|
|
```
|
|
|
|
### Exemplo: Múltiplas Crews Async Baseadas em Thread
|
|
|
|
```python Code
|
|
import asyncio
|
|
from crewai import Crew, Agent, Task
|
|
|
|
coding_agent = Agent(
|
|
role="Python Data Analyst",
|
|
goal="Analyze data and provide insights using Python",
|
|
backstory="You are an experienced data analyst with strong Python skills.",
|
|
allow_code_execution=True
|
|
)
|
|
|
|
task_1 = Task(
|
|
description="Analyze the first dataset and calculate the average age of participants. Ages: {ages}",
|
|
agent=coding_agent,
|
|
expected_output="The average age of the participants."
|
|
)
|
|
|
|
task_2 = Task(
|
|
description="Analyze the second dataset and calculate the average age of participants. Ages: {ages}",
|
|
agent=coding_agent,
|
|
expected_output="The average age of the participants."
|
|
)
|
|
|
|
crew_1 = Crew(agents=[coding_agent], tasks=[task_1])
|
|
crew_2 = Crew(agents=[coding_agent], tasks=[task_2])
|
|
|
|
async def async_multiple_crews():
|
|
result_1 = crew_1.kickoff_async(inputs={"ages": [25, 30, 35, 40, 45]})
|
|
result_2 = crew_2.kickoff_async(inputs={"ages": [20, 22, 24, 28, 30]})
|
|
|
|
results = await asyncio.gather(result_1, result_2)
|
|
|
|
for i, result in enumerate(results, 1):
|
|
print(f"Crew {i} Result:", result)
|
|
|
|
asyncio.run(async_multiple_crews())
|
|
```
|
|
|
|
## Streaming Assíncrono
|
|
|
|
Ambos os métodos async suportam streaming quando `stream=True` está definido na crew:
|
|
|
|
```python Code
|
|
import asyncio
|
|
from crewai import Crew, Agent, Task
|
|
|
|
agent = Agent(
|
|
role="Researcher",
|
|
goal="Research and summarize topics",
|
|
backstory="You are an expert researcher."
|
|
)
|
|
|
|
task = Task(
|
|
description="Research the topic: {topic}",
|
|
agent=agent,
|
|
expected_output="A comprehensive summary of the topic."
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[agent],
|
|
tasks=[task],
|
|
stream=True # Habilitar streaming
|
|
)
|
|
|
|
async def main():
|
|
streaming_output = await crew.akickoff(inputs={"topic": "AI trends in 2024"})
|
|
|
|
# Iteração async sobre chunks de streaming
|
|
async for chunk in streaming_output:
|
|
print(f"Chunk: {chunk.content}")
|
|
|
|
# Acessar resultado final após streaming completar
|
|
result = streaming_output.result
|
|
print(f"Final result: {result.raw}")
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
## Possíveis Casos de Uso
|
|
|
|
- **Geração Paralela de Conteúdo**: Inicie múltiplas crews independentes de forma assíncrona, cada uma responsável por gerar conteúdo sobre temas diferentes. Por exemplo, uma crew pode pesquisar e redigir um artigo sobre tendências em IA, enquanto outra gera posts para redes sociais sobre o lançamento de um novo produto.
|
|
|
|
- **Tarefas Conjuntas de Pesquisa de Mercado**: Lance múltiplas crews de forma assíncrona para realizar pesquisas de mercado em paralelo. Uma crew pode analisar tendências do setor, outra examinar estratégias de concorrentes e ainda outra avaliar o sentimento do consumidor.
|
|
|
|
- **Módulos Independentes de Planejamento de Viagem**: Execute crews separadas para planejar diferentes aspectos de uma viagem de forma independente. Uma crew pode cuidar das opções de voo, outra das acomodações e uma terceira do planejamento das atividades.
|
|
|
|
## Escolhendo entre `akickoff()` e `kickoff_async()`
|
|
|
|
| Recurso | `akickoff()` | `kickoff_async()` |
|
|
|---------|--------------|-------------------|
|
|
| Modelo de execução | Async/await nativo | Wrapper baseado em thread |
|
|
| Execução de tasks | Async com `aexecute_sync()` | Síncrono em thread pool |
|
|
| Operações de memória | Async | Síncrono em thread pool |
|
|
| Recuperação de conhecimento | Async | Síncrono em thread pool |
|
|
| Melhor para | Alta concorrência, cargas I/O-bound | Integração async simples |
|
|
| Suporte a streaming | Sim | Sim |
|