mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +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>
296 lines
11 KiB
Plaintext
296 lines
11 KiB
Plaintext
---
|
||
title: Dominando o Gerenciamento de Estado em Flows
|
||
description: Um guia abrangente sobre como gerenciar, persistir e utilizar o estado em CrewAI Flows para construir aplicações de IA robustas.
|
||
icon: diagram-project
|
||
mode: "wide"
|
||
---
|
||
|
||
## Entendendo o Poder do Estado em Flows
|
||
|
||
O gerenciamento de estado é a espinha dorsal de qualquer workflow de IA sofisticado. Nos Flows da CrewAI, o sistema de estado permite manter o contexto, compartilhar dados entre etapas e construir lógicas de aplicação complexas. Dominar o gerenciamento de estado é essencial para criar aplicações de IA confiáveis, sustentáveis e poderosas.
|
||
|
||
Este guia vai te levar por tudo o que você precisa saber sobre como gerenciar o estado em CrewAI Flows, desde conceitos básicos até técnicas avançadas, com exemplos práticos de código ao longo do conteúdo.
|
||
|
||
### Por Que o Gerenciamento de Estado Importa
|
||
|
||
Um gerenciamento de estado efetivo possibilita que você:
|
||
|
||
1. **Mantenha o contexto entre as etapas de execução** – Transfira informações de forma transparente entre diferentes estágios do seu workflow
|
||
2. **Construa lógicas condicionais complexas** – Tome decisões baseadas nos dados acumulados
|
||
3. **Crie aplicações persistentes** – Salve e recupere o progresso do workflow
|
||
4. **Trate erros de forma elegante** – Implemente padrões de recuperação para aplicações mais robustas
|
||
5. **Escalone suas aplicações** – Ofereça suporte a workflows complexos com organização apropriada dos dados
|
||
6. **Habilite aplicações conversacionais** – Armazene e acesse o histórico da conversa para interações de IA com contexto
|
||
|
||
Vamos explorar como aproveitar essas capacidades de forma eficiente.
|
||
|
||
## Fundamentos do Gerenciamento de Estado
|
||
|
||
### O Ciclo de Vida do Estado em um Flow
|
||
|
||
Nos Flows da CrewAI, o estado segue um ciclo de vida previsível:
|
||
|
||
1. **Inicialização** – Quando um flow é criado, seu estado é inicializado (como um dicionário vazio ou uma instância de modelo Pydantic)
|
||
2. **Modificação** – Os métodos do flow acessam e modificam o estado durante a execução
|
||
3. **Transmissão** – O estado é automaticamente passado entre os métodos do flow
|
||
4. **Persistência** (opcional) – O estado pode ser salvo em um armazenamento e recuperado posteriormente
|
||
5. **Conclusão** – O estado final reflete as mudanças acumuladas de todos os métodos executados
|
||
|
||
Compreender esse ciclo de vida é crucial para projetar flows eficientes.
|
||
|
||
### Duas Abordagens Para Gerenciar Estado
|
||
|
||
A CrewAI oferece duas maneiras para você gerenciar o estado nos seus flows:
|
||
|
||
1. **Estado Não Estruturado** – Usando objetos do tipo dicionário para mais flexibilidade
|
||
2. **Estado Estruturado** – Usando modelos Pydantic para segurança de tipo e validação
|
||
|
||
Vamos analisar cada abordagem em detalhe.
|
||
|
||
## Gerenciamento de Estado Não Estruturado
|
||
|
||
O estado não estruturado utiliza uma abordagem semelhante a dicionários, oferecendo flexibilidade e simplicidade para aplicações diretas.
|
||
|
||
### Como Funciona
|
||
|
||
Com estado não estruturado:
|
||
- Você acessa o estado via `self.state`, que se comporta como um dicionário
|
||
- Pode adicionar, modificar ou remover chaves livremente a qualquer momento
|
||
- Todo o estado está disponível automaticamente para todos os métodos do flow
|
||
|
||
### Exemplo Básico
|
||
|
||
Veja um exemplo simples de gerenciamento de estado não estruturado:
|
||
|
||
```python
|
||
# código não traduzido
|
||
```
|
||
|
||
### Quando Usar Estado Não Estruturado
|
||
|
||
O estado não estruturado é ideal para:
|
||
- Prototipagem rápida e flows simples
|
||
- Necessidade de estado que evolui dinamicamente
|
||
- Casos onde a estrutura pode não ser conhecida antecipadamente
|
||
- Flows com requisitos de estado simples
|
||
|
||
Embora seja flexível, o estado não estruturado não possui checagem de tipos nem validação de esquema, o que pode gerar erros em aplicações mais complexas.
|
||
|
||
## Gerenciamento de Estado Estruturado
|
||
|
||
O estado estruturado utiliza modelos Pydantic para definir um esquema para o estado do seu flow, provendo segurança de tipo, validação e melhor experiência de desenvolvimento.
|
||
|
||
### Como Funciona
|
||
|
||
Ao utilizar estado estruturado:
|
||
- Você define um modelo Pydantic que representa a estrutura do seu estado
|
||
- Passa este tipo de modelo para sua classe Flow como parâmetro de tipo
|
||
- Acessa o estado via `self.state`, que se comporta como uma instância do modelo Pydantic
|
||
- Todos os campos são validados de acordo com os tipos definidos
|
||
- O IDE oferece autocompletar e suporte à checagem de tipos
|
||
|
||
### Exemplo Básico
|
||
|
||
Veja como implementar o gerenciamento de estado estruturado:
|
||
|
||
```python
|
||
# código não traduzido
|
||
```
|
||
|
||
### Benefícios do Estado Estruturado
|
||
|
||
Utilizar estado estruturado traz várias vantagens:
|
||
|
||
1. **Segurança de Tipo** – Detecte erros de tipo durante o desenvolvimento
|
||
2. **Autodocumentação** – O modelo de estado documenta claramente quais dados estão disponíveis
|
||
3. **Validação** – Validação automática de tipos de dados e restrições
|
||
4. **Suporte do IDE** – Obtenha autocompletar e documentação inline
|
||
5. **Valores Padrão** – Defina facilmente valores padrões para falta de dados
|
||
|
||
### Quando Usar Estado Estruturado
|
||
|
||
O estado estruturado é recomendado para:
|
||
- Flows complexos com esquemas de dados bem definidos
|
||
- Projetos em equipe com múltiplos desenvolvedores no mesmo código
|
||
- Aplicações onde a validação de dados é importante
|
||
- Flows que precisam impor tipos de dados e restrições específicas
|
||
|
||
## O ID de Estado Automático
|
||
|
||
Tanto estados não estruturados quanto estruturados recebem automaticamente um identificador único (UUID) para ajudar a rastrear e gerenciar instâncias de estado.
|
||
|
||
### Como Funciona
|
||
|
||
- Para estado não estruturado, o ID é acessível via `self.state["id"]`
|
||
- Para estado estruturado, o ID é acessível via `self.state.id`
|
||
- Este ID é gerado automaticamente ao criar o flow
|
||
- O ID permanece igual durante todo o ciclo de vida do flow
|
||
- O ID pode ser usado para rastreamento, logs e recuperação de estados persistidos
|
||
|
||
Este UUID é útil especialmente ao implementar persistência ou monitorar múltiplas execuções de flows.
|
||
|
||
## Atualizações Dinâmicas de Estado
|
||
|
||
Independente de você usar estado estruturado ou não estruturado, é possível atualizar o estado dinamicamente ao longo da execução do flow.
|
||
|
||
### Passando Dados Entre Etapas
|
||
|
||
Métodos do flow podem retornar valores que serão passados como argumento para métodos listeners:
|
||
|
||
```python
|
||
# código não traduzido
|
||
```
|
||
|
||
Esse padrão permite combinar passagem de dados direta com atualizações de estado para obter máxima flexibilidade.
|
||
|
||
## Persistindo o Estado do Flow
|
||
|
||
Uma das funcionalidades mais poderosas da CrewAI é a habilidade de persistir o estado do flow entre execuções. Isso habilita workflows que podem ser pausados, retomados e até recuperados após falhas.
|
||
|
||
### O Decorador @persist()
|
||
|
||
O decorador `@persist()` automatiza a persistência de estado, salvando o estado do flow em pontos chave da execução.
|
||
|
||
#### Persistência em Nível de Classe
|
||
|
||
Ao aplicar em nível de classe, `@persist()` salva o estado após cada execução de método:
|
||
|
||
```python
|
||
# código não traduzido
|
||
```
|
||
|
||
#### Persistência em Nível de Método
|
||
|
||
Para mais controle, você pode aplicar `@persist()` em métodos específicos:
|
||
|
||
```python
|
||
# código não traduzido
|
||
```
|
||
|
||
## Padrões Avançados de Estado
|
||
|
||
### Lógica Condicional Baseada no Estado
|
||
|
||
Você pode usar o estado para implementar lógicas condicionais complexas em seus flows:
|
||
|
||
```python
|
||
# código não traduzido
|
||
```
|
||
|
||
### Manipulações Complexas de Estado
|
||
|
||
Para transformar estados complexos, você pode criar métodos dedicados:
|
||
|
||
```python
|
||
# código não traduzido
|
||
```
|
||
|
||
Esse padrão de criar métodos auxiliares mantém seus métodos de flow limpos, enquanto permite manipulações complexas de estado.
|
||
|
||
## Gerenciamento de Estado com Crews
|
||
|
||
Um dos padrões mais poderosos na CrewAI é combinar o gerenciamento de estado do flow com a execução de crews.
|
||
|
||
### Passando Estado para Crews
|
||
|
||
Você pode usar o estado do flow para parametrizar crews:
|
||
|
||
```python
|
||
# código não traduzido
|
||
```
|
||
|
||
### Manipulando Saídas de Crews no Estado
|
||
|
||
Quando um crew finaliza, é possível processar sua saída e armazená-la no estado do flow:
|
||
|
||
```python
|
||
# código não traduzido
|
||
```
|
||
|
||
## Boas Práticas para Gerenciamento de Estado
|
||
|
||
### 1. Mantenha o Estado Focado
|
||
|
||
Projete seu estado para conter somente o necessário:
|
||
|
||
```python
|
||
# Exemplo não traduzido
|
||
```
|
||
|
||
### 2. Use Estado Estruturado em Flows Complexos
|
||
|
||
À medida que seus flows evoluem em complexidade, o estado estruturado se torna cada vez mais valioso:
|
||
|
||
```python
|
||
# Exemplo não traduzido
|
||
```
|
||
|
||
### 3. Documente Transições de Estado
|
||
|
||
Para flows complexos, documente como o estado muda ao longo da execução:
|
||
|
||
```python
|
||
# Exemplo não traduzido
|
||
```
|
||
|
||
### 4. Trate Erros de Estado de Forma Elegante
|
||
|
||
Implemente tratamento de erros ao acessar o estado:
|
||
|
||
```python
|
||
# Exemplo não traduzido
|
||
```
|
||
|
||
### 5. Use o Estado Para Acompanhar o Progresso
|
||
|
||
Aproveite o estado para monitorar o progresso em flows de longa duração:
|
||
|
||
```python
|
||
# Exemplo não traduzido
|
||
```
|
||
|
||
### 6. Prefira Operações Imutáveis Quando Possível
|
||
|
||
Especialmente com estado estruturado, prefira operações imutáveis para maior clareza:
|
||
|
||
```python
|
||
# Exemplo não traduzido
|
||
```
|
||
|
||
## Depurando o Estado do Flow
|
||
|
||
### Logando Alterações no Estado
|
||
|
||
Ao desenvolver, adicione logs para acompanhar mudanças no estado:
|
||
|
||
```python
|
||
# Exemplo não traduzido
|
||
```
|
||
|
||
### Visualizando o Estado
|
||
|
||
Você pode adicionar métodos para visualizar seu estado durante o debug:
|
||
|
||
```python
|
||
# Exemplo não traduzido
|
||
```
|
||
|
||
## Conclusão
|
||
|
||
Dominar o gerenciamento de estado em CrewAI Flows te dá poder para construir aplicações de IA sofisticadas e robustas, que mantêm contexto, tomam decisões complexas e entregam resultados consistentes.
|
||
|
||
Seja escolhendo estado não estruturado ou estruturado, implementar boas práticas de gerenciamento de estado irá ajudar a criar flows manteníveis, extensíveis e eficazes na resolução de problemas do mundo real.
|
||
|
||
À medida que desenvolver flows mais complexos, lembre-se de que um bom gerenciamento de estado está relacionado ao equilíbrio entre flexibilidade e estrutura, tornando seu código tanto poderoso quanto fácil de entender.
|
||
|
||
<Check>
|
||
Agora você domina os conceitos e práticas de gerenciamento de estado em CrewAI Flows! Com este conhecimento, você pode criar workflows de IA robustos que mantêm contexto, compartilham dados entre as etapas e constroem lógicas avançadas de aplicação.
|
||
</Check>
|
||
|
||
## Próximos Passos
|
||
|
||
- Experimente usar estado estruturado e não estruturado em seus flows
|
||
- Teste a implementação de persistência de estado para workflows de longa duração
|
||
- Explore [como construir seu primeiro crew](/pt-BR/guides/crews/first-crew) para ver como crews e flows podem funcionar juntos
|
||
- Confira a [documentação de referência de Flow](/pt-BR/concepts/flows) para funcionalidades mais avançadas
|