mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 06:08:15 +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>
123 lines
3.0 KiB
Plaintext
123 lines
3.0 KiB
Plaintext
---
|
|
title: Implementação de LLM Personalizada
|
|
description: Aprenda a criar implementações personalizadas de LLM no CrewAI.
|
|
icon: code
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão Geral
|
|
|
|
O CrewAI oferece suporte a implementações personalizadas de LLM por meio da classe abstrata `BaseLLM`. Isso permite integrar qualquer provedor de LLM que não tenha suporte nativo no LiteLLM ou implementar mecanismos de autenticação personalizados.
|
|
|
|
## Início Rápido
|
|
|
|
Aqui está uma implementação mínima de LLM personalizada:
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
## Usando Seu LLM Personalizado
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
## Métodos Necessários
|
|
|
|
### Construtor: `__init__()`
|
|
|
|
**Crítico**: Você deve chamar `super().__init__(model, temperature)` com os parâmetros necessários:
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
### Método Abstrato: `call()`
|
|
|
|
O método `call()` é o núcleo da sua implementação de LLM. Ele deve:
|
|
|
|
- Aceitar mensagens (string ou lista de dicionários com 'role' e 'content')
|
|
- Retornar uma resposta como string
|
|
- Lidar com ferramentas e chamada de funções, se suportado
|
|
- Lançar exceções apropriadas para erros
|
|
|
|
### Métodos Opcionais
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
## Padrões Comuns
|
|
|
|
### Tratamento de Erros
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
### Autenticação Personalizada
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
### Suporte a Stop Words
|
|
|
|
O CrewAI adiciona automaticamente `"\nObservation:"` como stop word para controlar o comportamento do agente. Se o seu LLM suporta stop words:
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
Se o seu LLM não suporta stop words nativamente:
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
## Chamada de Funções
|
|
|
|
Se o seu LLM suporta chamada de funções, implemente o fluxo completo:
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
## Solução de Problemas
|
|
|
|
### Problemas Comuns
|
|
|
|
**Erros no Construtor**
|
|
```python
|
|
# ❌ Errado - parâmetros obrigatórios ausentes
|
|
def __init__(self, api_key: str):
|
|
super().__init__()
|
|
|
|
# ✅ Correto
|
|
def __init__(self, model: str, api_key: str, temperature: Optional[float] = None):
|
|
super().__init__(model=model, temperature=temperature)
|
|
```
|
|
|
|
**Chamada de Funções Não Funciona**
|
|
- Certifique-se de que `supports_function_calling()` retorna `True`
|
|
- Verifique se você lida com `tool_calls` na resposta
|
|
- Assegure-se de que o parâmetro `available_functions` está sendo corretamente utilizado
|
|
|
|
**Falhas de Autenticação**
|
|
- Verifique o formato e as permissões da chave de API
|
|
- Confira o formato do header de autenticação
|
|
- Certifique-se de que as URLs dos endpoints estão corretas
|
|
|
|
**Erros de Parsing de Resposta**
|
|
- Valide a estrutura da resposta antes de acessar campos aninhados
|
|
- Trate casos em que o content pode ser None
|
|
- Adicione tratamento de erros para respostas malformadas
|
|
|
|
## Testando Seu LLM Personalizado
|
|
|
|
```python
|
|
# (não traduzir blocos de código)
|
|
```
|
|
|
|
Este guia cobre o essencial para implementar LLMs personalizados no CrewAI. |