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>
141 lines
5.5 KiB
Plaintext
141 lines
5.5 KiB
Plaintext
---
|
||
title: Usando Agentes Multimodais
|
||
description: Aprenda como habilitar e usar capacidades multimodais em seus agentes para processar imagens e outros conteúdos não textuais dentro do framework CrewAI.
|
||
icon: video
|
||
mode: "wide"
|
||
---
|
||
|
||
## Usando Agentes Multimodais
|
||
|
||
O CrewAI suporta agentes multimodais que podem processar tanto conteúdo textual quanto não textual, como imagens. Este guia mostrará como habilitar e utilizar capacidades multimodais em seus agentes.
|
||
|
||
### Habilitando Capacidades Multimodais
|
||
|
||
Para criar um agente multimodal, basta definir o parâmetro `multimodal` como `True` ao inicializar seu agente:
|
||
|
||
```python
|
||
from crewai import Agent
|
||
|
||
agent = Agent(
|
||
role="Image Analyst",
|
||
goal="Analyze and extract insights from images",
|
||
backstory="An expert in visual content interpretation with years of experience in image analysis",
|
||
multimodal=True # This enables multimodal capabilities
|
||
)
|
||
```
|
||
|
||
Ao definir `multimodal=True`, o agente é automaticamente configurado com as ferramentas necessárias para lidar com conteúdo não textual, incluindo a `AddImageTool`.
|
||
|
||
### Trabalhando com Imagens
|
||
|
||
O agente multimodal vem pré-configurado com a `AddImageTool`, permitindo que ele processe imagens. Não é necessário adicionar esta ferramenta manualmente – ela é automaticamente incluída ao habilitar capacidades multimodais.
|
||
|
||
Aqui está um exemplo completo mostrando como usar um agente multimodal para analisar uma imagem:
|
||
|
||
```python
|
||
from crewai import Agent, Task, Crew
|
||
|
||
# Create a multimodal agent
|
||
image_analyst = Agent(
|
||
role="Product Analyst",
|
||
goal="Analyze product images and provide detailed descriptions",
|
||
backstory="Expert in visual product analysis with deep knowledge of design and features",
|
||
multimodal=True
|
||
)
|
||
|
||
# Create a task for image analysis
|
||
task = Task(
|
||
description="Analyze the product image at https://example.com/product.jpg and provide a detailed description",
|
||
expected_output="A detailed description of the product image",
|
||
agent=image_analyst
|
||
)
|
||
|
||
# Create and run the crew
|
||
crew = Crew(
|
||
agents=[image_analyst],
|
||
tasks=[task]
|
||
)
|
||
|
||
result = crew.kickoff()
|
||
```
|
||
|
||
### Uso Avançado com Contexto
|
||
|
||
Você pode fornecer contexto adicional ou perguntas específicas sobre a imagem ao criar tarefas para agentes multimodais. A descrição da tarefa pode incluir aspectos específicos nos quais você deseja que o agente foque:
|
||
|
||
```python
|
||
from crewai import Agent, Task, Crew
|
||
|
||
# Create a multimodal agent for detailed analysis
|
||
expert_analyst = Agent(
|
||
role="Visual Quality Inspector",
|
||
goal="Perform detailed quality analysis of product images",
|
||
backstory="Senior quality control expert with expertise in visual inspection",
|
||
multimodal=True # AddImageTool is automatically included
|
||
)
|
||
|
||
# Create a task with specific analysis requirements
|
||
inspection_task = Task(
|
||
description="""
|
||
Analyze the product image at https://example.com/product.jpg with focus on:
|
||
1. Quality of materials
|
||
2. Manufacturing defects
|
||
3. Compliance with standards
|
||
Provide a detailed report highlighting any issues found.
|
||
""",
|
||
expected_output="A detailed report highlighting any issues found",
|
||
agent=expert_analyst
|
||
)
|
||
|
||
# Create and run the crew
|
||
crew = Crew(
|
||
agents=[expert_analyst],
|
||
tasks=[inspection_task]
|
||
)
|
||
|
||
result = crew.kickoff()
|
||
```
|
||
|
||
### Detalhes da Ferramenta
|
||
|
||
Ao trabalhar com agentes multimodais, a `AddImageTool` é automaticamente configurada com o seguinte esquema:
|
||
|
||
```python
|
||
class AddImageToolSchema:
|
||
image_url: str # Required: The URL or path of the image to process
|
||
action: Optional[str] = None # Optional: Additional context or specific questions about the image
|
||
```
|
||
|
||
O agente multimodal irá automaticamente realizar o processamento de imagens por meio de suas ferramentas internas, permitindo que ele:
|
||
- Acesse imagens via URLs ou caminhos de arquivos locais
|
||
- Processe o conteúdo da imagem com contexto opcional ou perguntas específicas
|
||
- Forneça análises e insights com base nas informações visuais e requisitos da tarefa
|
||
|
||
### Boas Práticas
|
||
|
||
Ao trabalhar com agentes multimodais, tenha em mente as seguintes boas práticas:
|
||
|
||
1. **Acesso à Imagem**
|
||
- Certifique-se de que suas imagens estejam acessíveis via URLs alcançáveis pelo agente
|
||
- Para imagens locais, considere hospedá-las temporariamente ou utilize caminhos absolutos
|
||
- Verifique se as URLs das imagens são válidas e acessíveis antes de rodar as tarefas
|
||
|
||
2. **Descrição da Tarefa**
|
||
- Seja específico sobre quais aspectos da imagem você deseja que o agente analise
|
||
- Inclua perguntas ou requisitos claros na descrição da tarefa
|
||
- Considere usar o parâmetro opcional `action` para uma análise focada
|
||
|
||
3. **Gerenciamento de Recursos**
|
||
- O processamento de imagens pode exigir mais recursos computacionais do que tarefas apenas textuais
|
||
- Alguns modelos de linguagem podem exigir codificação em base64 para dados de imagem
|
||
- Considere o processamento em lote para múltiplas imagens visando otimizar o desempenho
|
||
|
||
4. **Configuração do Ambiente**
|
||
- Verifique se seu ambiente possui as dependências necessárias para processamento de imagens
|
||
- Certifique-se de que seu modelo de linguagem suporta capacidades multimodais
|
||
- Teste primeiro com imagens pequenas para validar sua configuração
|
||
|
||
5. **Tratamento de Erros**
|
||
- Implemente tratamento apropriado para falhas no carregamento de imagens
|
||
- Tenha estratégias de contingência para casos onde o processamento de imagens falhar
|
||
- Monitore e registre operações de processamento de imagens para depuração |