mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 21:58:11 +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>
287 lines
11 KiB
Plaintext
287 lines
11 KiB
Plaintext
---
|
|
title: Integração LangDB
|
|
description: Governe, proteja e otimize seus fluxos de trabalho CrewAI com LangDB AI Gateway—acesse mais de 350 modelos, roteamento automático, otimização de custos e observabilidade completa.
|
|
icon: database
|
|
mode: "wide"
|
|
---
|
|
|
|
# Introdução
|
|
|
|
[LangDB AI Gateway](https://langdb.ai) fornece APIs compatíveis com OpenAI para conectar com múltiplos Modelos de Linguagem Grandes e serve como uma plataforma de observabilidade que torna effortless rastrear fluxos de trabalho CrewAI de ponta a ponta, proporcionando acesso a mais de 350 modelos de linguagem. Com uma única chamada `init()`, todas as interações de agentes, execuções de tarefas e chamadas LLM são capturadas, fornecendo observabilidade abrangente e infraestrutura de IA pronta para produção para suas aplicações.
|
|
|
|
<Frame caption="Exemplo de Rastreamento CrewAI LangDB">
|
|
<img src="/images/langdb-1.png" alt="Exemplo de rastreamento CrewAI LangDB" />
|
|
</Frame>
|
|
|
|
**Confira:** [Ver o exemplo de trace ao vivo](https://app.langdb.ai/sharing/threads/3becbfed-a1be-ae84-ea3c-4942867a3e22)
|
|
|
|
## Recursos
|
|
|
|
### Capacidades do AI Gateway
|
|
- **Acesso a mais de 350 LLMs**: Conecte-se a todos os principais modelos de linguagem através de uma única integração
|
|
- **Modelos Virtuais**: Crie configurações de modelo personalizadas com parâmetros específicos e regras de roteamento
|
|
- **MCP Virtual**: Habilite compatibilidade e integração com sistemas MCP (Model Context Protocol) para comunicação aprimorada de agentes
|
|
- **Guardrails**: Implemente medidas de segurança e controles de conformidade para comportamento de agentes
|
|
|
|
### Observabilidade e Rastreamento
|
|
- **Rastreamento Automático**: Uma única chamada `init()` captura todas as interações CrewAI
|
|
- **Visibilidade Ponta a Ponta**: Monitore fluxos de trabalho de agentes do início ao fim
|
|
- **Rastreamento de Uso de Ferramentas**: Rastreie quais ferramentas os agentes usam e seus resultados
|
|
- **Monitoramento de Chamadas de Modelo**: Insights detalhados sobre interações LLM
|
|
- **Análise de Performance**: Monitore latência, uso de tokens e custos
|
|
- **Suporte a Depuração**: Execução passo a passo para solução de problemas
|
|
- **Monitoramento em Tempo Real**: Dashboard de traces e métricas ao vivo
|
|
|
|
## Instruções de Configuração
|
|
|
|
<Steps>
|
|
<Step title="Instalar LangDB">
|
|
Instale o cliente LangDB com flag de recurso CrewAI:
|
|
```bash
|
|
pip install 'pylangdb[crewai]'
|
|
```
|
|
</Step>
|
|
<Step title="Definir Variáveis de Ambiente">
|
|
Configure suas credenciais LangDB:
|
|
```bash
|
|
export LANGDB_API_KEY="<sua_chave_api_langdb>"
|
|
export LANGDB_PROJECT_ID="<seu_id_projeto_langdb>"
|
|
export LANGDB_API_BASE_URL='https://api.us-east-1.langdb.ai'
|
|
```
|
|
</Step>
|
|
<Step title="Inicializar Rastreamento">
|
|
Importe e inicialize LangDB antes de configurar seu código CrewAI:
|
|
```python
|
|
from pylangdb.crewai import init
|
|
# Inicializar LangDB
|
|
init()
|
|
```
|
|
</Step>
|
|
<Step title="Configurar CrewAI com LangDB">
|
|
Configure seu LLM com cabeçalhos LangDB:
|
|
```python
|
|
from crewai import Agent, Task, Crew, LLM
|
|
import os
|
|
|
|
# Configurar LLM com cabeçalhos LangDB
|
|
llm = LLM(
|
|
model="openai/gpt-4o", # Substitua pelo modelo que você quer usar
|
|
api_key=os.getenv("LANGDB_API_KEY"),
|
|
base_url=os.getenv("LANGDB_API_BASE_URL"),
|
|
extra_headers={"x-project-id": os.getenv("LANGDB_PROJECT_ID")}
|
|
)
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Exemplo de Início Rápido
|
|
|
|
Aqui está um exemplo simples para começar com LangDB e CrewAI:
|
|
|
|
```python
|
|
import os
|
|
from pylangdb.crewai import init
|
|
from crewai import Agent, Task, Crew, LLM
|
|
|
|
# Inicializar LangDB antes de qualquer importação CrewAI
|
|
init()
|
|
|
|
def create_llm(model):
|
|
return LLM(
|
|
model=model,
|
|
api_key=os.environ.get("LANGDB_API_KEY"),
|
|
base_url=os.environ.get("LANGDB_API_BASE_URL"),
|
|
extra_headers={"x-project-id": os.environ.get("LANGDB_PROJECT_ID")}
|
|
)
|
|
|
|
# Defina seu agente
|
|
researcher = Agent(
|
|
role="Especialista em Pesquisa",
|
|
goal="Pesquisar tópicos minuciosamente",
|
|
backstory="Pesquisador especialista com habilidades em encontrar informações",
|
|
llm=create_llm("openai/gpt-4o"), # Substitua pelo modelo que você quer usar
|
|
verbose=True
|
|
)
|
|
|
|
# Criar uma tarefa
|
|
task = Task(
|
|
description="Pesquise o tópico dado e forneça um resumo abrangente",
|
|
agent=researcher,
|
|
expected_output="Resumo de pesquisa detalhado com principais descobertas"
|
|
)
|
|
|
|
# Criar e executar a equipe
|
|
crew = Crew(agents=[researcher], tasks=[task])
|
|
result = crew.kickoff()
|
|
print(result)
|
|
```
|
|
|
|
## Exemplo Completo: Agente de Pesquisa e Planejamento
|
|
|
|
Este exemplo abrangente demonstra um fluxo de trabalho multi-agente com capacidades de pesquisa e planejamento.
|
|
|
|
### Pré-requisitos
|
|
|
|
```bash
|
|
pip install crewai 'pylangdb[crewai]' crewai_tools setuptools python-dotenv
|
|
```
|
|
|
|
### Configuração do Ambiente
|
|
|
|
```bash
|
|
# Credenciais LangDB
|
|
export LANGDB_API_KEY="<sua_chave_api_langdb>"
|
|
export LANGDB_PROJECT_ID="<seu_id_projeto_langdb>"
|
|
export LANGDB_API_BASE_URL='https://api.us-east-1.langdb.ai'
|
|
|
|
# Chaves API adicionais (opcional)
|
|
export SERPER_API_KEY="<sua_chave_api_serper>" # Para capacidades de busca na web
|
|
```
|
|
|
|
### Implementação Completa
|
|
|
|
```python
|
|
#!/usr/bin/env python3
|
|
|
|
import os
|
|
import sys
|
|
from pylangdb.crewai import init
|
|
init() # Inicializar LangDB antes de qualquer importação CrewAI
|
|
from dotenv import load_dotenv
|
|
from crewai import Agent, Task, Crew, Process, LLM
|
|
from crewai_tools import SerperDevTool
|
|
|
|
load_dotenv()
|
|
|
|
def create_llm(model):
|
|
return LLM(
|
|
model=model,
|
|
api_key=os.environ.get("LANGDB_API_KEY"),
|
|
base_url=os.environ.get("LANGDB_API_BASE_URL"),
|
|
extra_headers={"x-project-id": os.environ.get("LANGDB_PROJECT_ID")}
|
|
)
|
|
|
|
class ResearchPlanningCrew:
|
|
def researcher(self) -> Agent:
|
|
return Agent(
|
|
role="Especialista em Pesquisa",
|
|
goal="Pesquisar tópicos minuciosamente e compilar informações abrangentes",
|
|
backstory="Pesquisador especialista com habilidades em encontrar e analisar informações de várias fontes",
|
|
tools=[SerperDevTool()],
|
|
llm=create_llm("openai/gpt-4o"),
|
|
verbose=True
|
|
)
|
|
|
|
def planner(self) -> Agent:
|
|
return Agent(
|
|
role="Planejador Estratégico",
|
|
goal="Criar planos acionáveis baseados em descobertas de pesquisa",
|
|
backstory="Planejador estratégico que divide desafios complexos em planos executáveis",
|
|
reasoning=True,
|
|
max_reasoning_attempts=3,
|
|
llm=create_llm("openai/anthropic/claude-3.7-sonnet"),
|
|
verbose=True
|
|
)
|
|
|
|
def research_task(self) -> Task:
|
|
return Task(
|
|
description="Pesquise o tópico minuciosamente e compile informações abrangentes",
|
|
agent=self.researcher(),
|
|
expected_output="Relatório de pesquisa abrangente com principais descobertas e insights"
|
|
)
|
|
|
|
def planning_task(self) -> Task:
|
|
return Task(
|
|
description="Crie um plano estratégico baseado nas descobertas da pesquisa",
|
|
agent=self.planner(),
|
|
expected_output="Plano de execução estratégica com fases, objetivos e etapas acionáveis",
|
|
context=[self.research_task()]
|
|
)
|
|
|
|
def crew(self) -> Crew:
|
|
return Crew(
|
|
agents=[self.researcher(), self.planner()],
|
|
tasks=[self.research_task(), self.planning_task()],
|
|
verbose=True,
|
|
process=Process.sequential
|
|
)
|
|
|
|
def main():
|
|
topic = sys.argv[1] if len(sys.argv) > 1 else "Inteligência Artificial na Saúde"
|
|
|
|
crew_instance = ResearchPlanningCrew()
|
|
|
|
# Atualizar descrições de tarefas com o tópico específico
|
|
crew_instance.research_task().description = f"Pesquise {topic} minuciosamente e compile informações abrangentes"
|
|
crew_instance.planning_task().description = f"Crie um plano estratégico para {topic} baseado nas descobertas da pesquisa"
|
|
|
|
result = crew_instance.crew().kickoff()
|
|
print(result)
|
|
|
|
if __name__ == "__main__":
|
|
main()
|
|
```
|
|
|
|
### Executando o Exemplo
|
|
|
|
```bash
|
|
python main.py "Soluções de Energia Sustentável"
|
|
```
|
|
|
|
## Visualizando Traces no LangDB
|
|
|
|
Após executar sua aplicação CrewAI, você pode visualizar traces detalhados no dashboard LangDB:
|
|
|
|
<Frame caption="Dashboard de Trace LangDB">
|
|
<img src="/images/langdb-2.png" alt="Dashboard de trace LangDB mostrando fluxo de trabalho CrewAI" />
|
|
</Frame>
|
|
|
|
### O Que Você Verá
|
|
|
|
- **Interações de Agentes**: Fluxo completo de conversas de agentes e transferências de tarefas
|
|
- **Uso de Ferramentas**: Quais ferramentas foram chamadas, suas entradas e saídas
|
|
- **Chamadas de Modelo**: Interações LLM detalhadas com prompts e respostas
|
|
- **Métricas de Performance**: Rastreamento de latência, uso de tokens e custos
|
|
- **Linha do Tempo de Execução**: Visualização passo a passo de todo o fluxo de trabalho
|
|
|
|
|
|
## Solução de Problemas
|
|
|
|
### Problemas Comuns
|
|
|
|
- **Nenhum trace aparecendo**: Certifique-se de que `init()` seja chamado antes de qualquer importação CrewAI
|
|
- **Erros de autenticação**: Verifique sua chave API LangDB e ID do projeto
|
|
|
|
|
|
## Recursos
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="Documentação LangDB" icon="book" href="https://docs.langdb.ai">
|
|
Documentação oficial e guias LangDB
|
|
</Card>
|
|
<Card title="Guias LangDB" icon="graduation-cap" href="https://docs.langdb.ai/guides">
|
|
Tutoriais passo a passo para construir agentes de IA
|
|
</Card>
|
|
<Card title="Exemplos GitHub" icon="github" href="https://github.com/langdb/langdb-samples/tree/main/examples/crewai" >
|
|
Exemplos completos de integração CrewAI
|
|
</Card>
|
|
<Card title="Dashboard LangDB" icon="chart-line" href="https://app.langdb.ai">
|
|
Acesse seus traces e análises
|
|
</Card>
|
|
<Card title="Catálogo de Modelos" icon="list" href="https://app.langdb.ai/models">
|
|
Navegue por mais de 350 modelos de linguagem disponíveis
|
|
</Card>
|
|
<Card title="Recursos Enterprise" icon="building" href="https://docs.langdb.ai/enterprise">
|
|
Opções auto-hospedadas e capacidades empresariais
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Próximos Passos
|
|
|
|
Este guia cobriu o básico da integração do LangDB AI Gateway com CrewAI. Para aprimorar ainda mais seus fluxos de trabalho de IA, explore:
|
|
|
|
- **Modelos Virtuais**: Crie configurações de modelo personalizadas com estratégias de roteamento
|
|
- **Guardrails e Segurança**: Implemente filtragem de conteúdo e controles de conformidade
|
|
- **Implantação em Produção**: Configure fallbacks, tentativas e balanceamento de carga
|
|
|
|
Para recursos mais avançados e casos de uso, visite a [Documentação LangDB](https://docs.langdb.ai) ou explore o [Catálogo de Modelos](https://app.langdb.ai/models) para descobrir todos os modelos disponíveis. |