mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +00:00
a237ebabba
* 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>
116 lines
4.1 KiB
Plaintext
116 lines
4.1 KiB
Plaintext
---
|
|
title: Galileo Galileu
|
|
description: Integração Galileo para rastreamento e avaliação CrewAI
|
|
icon: telescope
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão geral
|
|
|
|
Este guia demonstra como integrar o **Galileo**com o **CrewAI**
|
|
para rastreamento abrangente e engenharia de avaliação.
|
|
Ao final deste guia, você será capaz de rastrear seus agentes CrewAI,
|
|
monitorar seu desempenho e avaliar seu comportamento com
|
|
A poderosa plataforma de observabilidade do Galileo.
|
|
|
|
> **O que é Galileo?**[Galileo](https://galileo.ai/) é avaliação e observabilidade de IA
|
|
plataforma que oferece rastreamento, avaliação e
|
|
e monitoramento de aplicações de IA. Ele permite que as equipes capturem a verdade,
|
|
criar grades de proteção robustas e realizar experimentos sistemáticos com
|
|
rastreamento de experimentos integrado e análise de desempenho -garantindo confiabilidade,
|
|
transparência e melhoria contínua em todo o ciclo de vida da IA.
|
|
|
|
## Primeiros passos
|
|
|
|
Este tutorial segue o [CrewAI Quickstart](pt-BR/quickstart) e mostra como adicionar
|
|
[CrewAIEventListener] do Galileo(https://v2docs.galileo.ai/sdk-api/python/reference/handlers/crewai/handler),
|
|
um manipulador de eventos.
|
|
Para mais informações, consulte Galileu
|
|
[Adicionar Galileo a um aplicativo CrewAI](https://v2docs.galileo.ai/how-to-guides/third-party-integrations/add-galileo-to-crewai/add-galileo-to-crewai)
|
|
guia prático.
|
|
|
|
> **Observação**Este tutorial pressupõe que você concluiu o [CrewAI Quickstart](pt-BR/quickstart).
|
|
Se você quiser um exemplo completo e abrangente, consulte o Galileo
|
|
[Repositório de exemplo SDK da CrewAI](https://github.com/rungalileo/sdk-examples/tree/main/python/agent/crew-ai).
|
|
|
|
### Etapa 1: instalar dependências
|
|
|
|
Instale as dependências necessárias para seu aplicativo.
|
|
Crie um ambiente virtual usando seu método preferido,
|
|
em seguida, instale dependências dentro desse ambiente usando seu
|
|
ferramenta preferida:
|
|
|
|
```bash
|
|
uv add galileo
|
|
```
|
|
|
|
### Etapa 2: adicione ao arquivo .env do [CrewAI Quickstart](/pt-BR/quickstart)
|
|
|
|
```bash
|
|
# Your Galileo API key
|
|
GALILEO_API_KEY="your-galileo-api-key"
|
|
|
|
# Your Galileo project name
|
|
GALILEO_PROJECT="your-galileo-project-name"
|
|
|
|
# The name of the Log stream you want to use for logging
|
|
GALILEO_LOG_STREAM="your-galileo-log-stream "
|
|
```
|
|
|
|
### Etapa 3: adicionar o ouvinte de eventos Galileo
|
|
|
|
Para habilitar o registro com Galileo, você precisa criar uma instância do `CrewAIEventListener`.
|
|
Importe o pacote manipulador Galileo CrewAI por
|
|
adicionando o seguinte código no topo do seu arquivo main.py:
|
|
|
|
```python
|
|
from galileo.handlers.crewai.handler import CrewAIEventListener
|
|
```
|
|
|
|
No início da sua função run, crie o ouvinte de evento:
|
|
|
|
```python
|
|
def run():
|
|
# Create the event listener
|
|
CrewAIEventListener()
|
|
# The rest of your existing code goes here
|
|
```
|
|
|
|
Quando você cria a instância do listener, ela é automaticamente
|
|
registrado na CrewAI.
|
|
|
|
### Etapa 4: administre sua Crew
|
|
|
|
Administre sua Crew com o CrewAI CLI:
|
|
|
|
```bash
|
|
crewai run
|
|
```
|
|
|
|
### Passo 5: Visualize os traços no Galileo
|
|
|
|
Assim que sua tripulação terminar, os rastros serão eliminados e aparecerão no Galileo.
|
|
|
|
|
|
|
|
## Compreendendo a integração do Galileo
|
|
|
|
Galileo se integra ao CrewAI registrando um ouvinte de evento
|
|
que captura eventos de execução da tripulação (por exemplo, ações do agente, chamadas de ferramentas, respostas do modelo)
|
|
e os encaminha ao Galileo para observabilidade e avaliação.
|
|
|
|
### Compreendendo o ouvinte de eventos
|
|
|
|
Criar uma instância `CrewAIEventListener()` é tudo o que você precisa
|
|
necessário para habilitar o Galileo para uma execução do CrewAI. Quando instanciado, o ouvinte:
|
|
|
|
-Registra-se automaticamente no CrewAI
|
|
-Lê a configuração do Galileo a partir de variáveis de ambiente
|
|
-Registra todos os dados de execução no projeto Galileo e fluxo de log especificado por
|
|
`GALILEO_PROJECT` e `GALILEO_LOG_STREAM`
|
|
|
|
Nenhuma configuração adicional ou alterações de código são necessárias.
|
|
Todos os dados desta execução são registados no projecto Galileo e
|
|
fluxo de log especificado pela configuração do seu ambiente
|
|
(por exemplo, GALILEO_PROJECT e GALILEO_LOG_STREAM).
|