mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 14:09:24 +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>
130 lines
5.5 KiB
Plaintext
130 lines
5.5 KiB
Plaintext
---
|
|
title: Integração Opik
|
|
description: Saiba como usar o Comet Opik para depurar, avaliar e monitorar suas aplicações CrewAI com rastreamento abrangente, avaliações automatizadas e dashboards prontos para produção.
|
|
icon: meteor
|
|
mode: "wide"
|
|
---
|
|
|
|
# Visão Geral do Opik
|
|
|
|
Com o [Comet Opik](https://www.comet.com/docs/opik/), depure, avalie e monitore suas aplicações LLM, sistemas RAG e fluxos de trabalho agentic com rastreamento detalhado, avaliações automatizadas e dashboards prontos para produção.
|
|
|
|
<Frame caption="Dashboard do Agente Opik">
|
|
<img src="/images/opik-crewai-dashboard.png" alt="Exemplo de monitoramento de agente Opik com CrewAI" />
|
|
</Frame>
|
|
|
|
O Opik oferece suporte abrangente para cada etapa do desenvolvimento da sua aplicação CrewAI:
|
|
|
|
- **Registrar Traces e Spans**: Acompanhe automaticamente chamadas LLM e lógica da aplicação para depurar e analisar sistemas em desenvolvimento e em produção. Anote manualmente ou programaticamente, visualize e compare respostas entre projetos.
|
|
- **Avalie a Performance da sua Aplicação LLM**: Avalie contra um conjunto de testes personalizado e execute métricas de avaliação nativas ou defina suas próprias métricas via SDK ou UI.
|
|
- **Teste no Pipeline CI/CD**: Estabeleça bases de performance confiáveis com os testes unitários LLM do Opik, baseados em PyTest. Execute avaliações online para monitoramento contínuo em produção.
|
|
- **Monitore & Analise Dados de Produção**: Entenda a performance dos seus modelos em dados inéditos em produção e gere conjuntos de dados para novas iterações de desenvolvimento.
|
|
|
|
## Configuração
|
|
A Comet oferece uma versão hospedada da plataforma Opik, ou você pode rodar a plataforma localmente.
|
|
|
|
Para usar a versão hospedada, basta [criar uma conta gratuita na Comet](https://www.comet.com/signup?utm_medium=github&utm_source=crewai_docs) e obter sua chave de API.
|
|
|
|
Para rodar a plataforma Opik localmente, veja nosso [guia de instalação](https://www.comet.com/docs/opik/self-host/overview/) para mais informações.
|
|
|
|
Neste guia, utilizaremos o exemplo de início rápido da CrewAI.
|
|
|
|
<Steps>
|
|
<Step title="Instale os pacotes necessários">
|
|
```shell
|
|
pip install crewai crewai-tools opik --upgrade
|
|
```
|
|
</Step>
|
|
<Step title="Configure o Opik">
|
|
```python
|
|
import opik
|
|
opik.configure(use_local=False)
|
|
```
|
|
</Step>
|
|
<Step title="Prepare o ambiente">
|
|
Primeiro, configuramos nossas chaves de API do provedor LLM como variáveis de ambiente:
|
|
|
|
```python
|
|
import os
|
|
import getpass
|
|
|
|
if "OPENAI_API_KEY" not in os.environ:
|
|
os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter your OpenAI API key: ")
|
|
```
|
|
</Step>
|
|
<Step title="Usando a CrewAI">
|
|
O primeiro passo é criar nosso projeto. Vamos utilizar um exemplo da documentação do CrewAI:
|
|
|
|
```python
|
|
from crewai import Agent, Crew, Task, Process
|
|
|
|
|
|
class NomeDaEquipe:
|
|
def agente_um(self) -> Agent:
|
|
return Agent(
|
|
role="Analista de Dados",
|
|
goal="Analisar tendências de dados no mercado",
|
|
backstory="Analista de dados experiente com formação em economia",
|
|
verbose=True,
|
|
)
|
|
|
|
def agente_dois(self) -> Agent:
|
|
return Agent(
|
|
role="Pesquisador de Mercado",
|
|
goal="Coletar informações sobre a dinâmica do mercado",
|
|
backstory="Pesquisador dedicado com olhar atento para detalhes",
|
|
verbose=True,
|
|
)
|
|
|
|
def tarefa_um(self) -> Task:
|
|
return Task(
|
|
name="Tarefa de Coleta de Dados",
|
|
description="Coletar dados recentes do mercado e identificar tendências.",
|
|
expected_output="Um relatório resumindo as principais tendências do mercado.",
|
|
agent=self.agente_um(),
|
|
)
|
|
|
|
def tarefa_dois(self) -> Task:
|
|
return Task(
|
|
name="Tarefa de Pesquisa de Mercado",
|
|
description="Pesquisar fatores que afetam a dinâmica do mercado.",
|
|
expected_output="Uma análise dos fatores que influenciam o mercado.",
|
|
agent=self.agente_dois(),
|
|
)
|
|
|
|
def equipe(self) -> Crew:
|
|
return Crew(
|
|
agents=[self.agente_um(), self.agente_dois()],
|
|
tasks=[self.tarefa_um(), self.tarefa_dois()],
|
|
process=Process.sequential,
|
|
verbose=True,
|
|
)
|
|
|
|
```
|
|
|
|
Agora podemos importar o tracker do Opik e executar nossa crew:
|
|
|
|
```python
|
|
from opik.integrations.crewai import track_crewai
|
|
|
|
track_crewai(project_name="crewai-integration-demo")
|
|
|
|
my_crew = NomeDaEquipe().equipe()
|
|
result = my_crew.kickoff()
|
|
|
|
print(result)
|
|
```
|
|
Após rodar sua aplicação CrewAI, acesse o app Opik para visualizar:
|
|
- Traces LLM, spans e seus metadados
|
|
- Interações dos agentes e fluxo de execução das tarefas
|
|
- Métricas de performance, como latência e uso de tokens
|
|
- Métricas de avaliação (nativas ou personalizadas)
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Recursos
|
|
|
|
- [🦉 Documentação Opik](https://www.comet.com/docs/opik/)
|
|
- [👉 Opik + CrewAI Colab](https://colab.research.google.com/github/comet-ml/opik/blob/main/apps/opik-documentation/documentation/docs/cookbook/crewai.ipynb)
|
|
- [🐦 X](https://x.com/cometml)
|
|
- [💬 Slack](https://slack.comet.com/) |