mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 14:37:59 -05:00
chore(docs): bring AMP doc refresh from release/v1.0.0 into main (#3637)
* WIP: v1 docs (#3626) (cherry picked from commit d46e20fa09bcd2f5916282f5553ddeb7183bd92c) * docs: parity for all translations * docs: full name of acronym AMP * docs: fix lingering unused code * docs: expand contextual options in docs.json * docs: add contextual action to request feature on GitHub * chore: tidy docs formatting
This commit is contained in:
Tony Kipkemboi
@@ -1,29 +1,29 @@
|
||||
---
|
||||
title: "Introdução"
|
||||
description: "Referência completa para a API REST do CrewAI Enterprise"
|
||||
description: "Referência completa para a API REST do CrewAI AMP"
|
||||
icon: "code"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# CrewAI Enterprise API
|
||||
# CrewAI AMP API
|
||||
|
||||
Bem-vindo à referência da API do CrewAI Enterprise. Esta API permite que você interaja programaticamente com seus crews implantados, possibilitando a integração com seus aplicativos, fluxos de trabalho e serviços.
|
||||
Bem-vindo à referência da API do CrewAI AMP. Esta API permite que você interaja programaticamente com seus crews implantados, possibilitando a integração com seus aplicativos, fluxos de trabalho e serviços.
|
||||
|
||||
## Início Rápido
|
||||
|
||||
<Steps>
|
||||
<Step title="Obtenha suas credenciais de API">
|
||||
Navegue até a página de detalhes do seu crew no painel do CrewAI Enterprise e copie seu Bearer Token na aba Status.
|
||||
Navegue até a página de detalhes do seu crew no painel do CrewAI AMP e copie seu Bearer Token na aba Status.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Descubra os Inputs Necessários">
|
||||
Use o endpoint `GET /inputs` para ver quais parâmetros seu crew espera.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Inicie uma Execução de Crew">
|
||||
Chame `POST /kickoff` com seus inputs para iniciar a execução do crew e receber um `kickoff_id`.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Monitore o Progresso">
|
||||
Use `GET /status/{kickoff_id}` para checar o status da execução e recuperar os resultados.
|
||||
</Step>
|
||||
@@ -46,7 +46,7 @@ curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \
|
||||
| **User Bearer Token** | Acesso com escopo de usuário | Permissões limitadas, adequado para operações específicas de usuário |
|
||||
|
||||
<Tip>
|
||||
Você pode encontrar ambos os tipos de token na aba Status da página de detalhes do seu crew no painel do CrewAI Enterprise.
|
||||
Você pode encontrar ambos os tipos de token na aba Status da página de detalhes do seu crew no painel do CrewAI AMP.
|
||||
</Tip>
|
||||
|
||||
## URL Base
|
||||
@@ -62,7 +62,7 @@ Substitua `your-crew-name` pela URL real do seu crew no painel.
|
||||
## Fluxo Típico
|
||||
|
||||
1. **Descoberta**: Chame `GET /inputs` para entender o que seu crew precisa
|
||||
2. **Execução**: Envie os inputs via `POST /kickoff` para iniciar o processamento
|
||||
2. **Execução**: Envie os inputs via `POST /kickoff` para iniciar o processamento
|
||||
3. **Monitoramento**: Faça polling em `GET /status/{kickoff_id}` até a conclusão
|
||||
4. **Resultados**: Extraia o output final da resposta concluída
|
||||
|
||||
@@ -82,12 +82,12 @@ A API utiliza códigos de status HTTP padrão:
|
||||
## Testes Interativos
|
||||
|
||||
<Info>
|
||||
**Por que não há botão "Enviar"?** Como cada usuário do CrewAI Enterprise possui sua própria URL de crew, utilizamos o **modo referência** em vez de um playground interativo para evitar confusão. Isso mostra exatamente como as requisições devem ser feitas, sem botões de envio não funcionais.
|
||||
**Por que não há botão "Enviar"?** Como cada usuário do CrewAI AMP possui sua própria URL de crew, utilizamos o **modo referência** em vez de um playground interativo para evitar confusão. Isso mostra exatamente como as requisições devem ser feitas, sem botões de envio não funcionais.
|
||||
</Info>
|
||||
|
||||
Cada página de endpoint mostra para você:
|
||||
- ✅ **Formato exato da requisição** com todos os parâmetros
|
||||
- ✅ **Exemplos de resposta** para casos de sucesso e erro
|
||||
- ✅ **Exemplos de resposta** para casos de sucesso e erro
|
||||
- ✅ **Exemplos de código** em várias linguagens (cURL, Python, JavaScript, etc.)
|
||||
- ✅ **Exemplos de autenticação** com o formato adequado de Bearer token
|
||||
|
||||
@@ -104,7 +104,7 @@ Cada página de endpoint mostra para você:
|
||||
|
||||
**Exemplo de fluxo:**
|
||||
1. **Copie este exemplo cURL** de qualquer página de endpoint
|
||||
2. **Substitua `your-actual-crew-name.crewai.com`** pela URL real do seu crew
|
||||
2. **Substitua `your-actual-crew-name.crewai.com`** pela URL real do seu crew
|
||||
3. **Substitua o Bearer token** pelo seu token real do painel
|
||||
4. **Execute a requisição** no seu terminal ou cliente de API
|
||||
|
||||
@@ -117,4 +117,4 @@ Cada página de endpoint mostra para você:
|
||||
<Card title="Painel Enterprise" icon="chart-line" href="https://app.crewai.com">
|
||||
Gerencie seus crews e visualize logs de execução
|
||||
</Card>
|
||||
</CardGroup>
|
||||
</CardGroup>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -20,7 +20,7 @@ Pense em um agente como um membro especializado da equipe com habilidades, compe
|
||||
</Tip>
|
||||
|
||||
<Note type="info" title="Aprimoramento Empresarial: Construtor Visual de Agentes">
|
||||
O CrewAI Enterprise inclui um Construtor Visual de Agentes, que simplifica a criação e configuração de agentes sem escrever código. Projete seus agentes visualmente e teste-os em tempo real.
|
||||
O CrewAI AMP inclui um Construtor Visual de Agentes, que simplifica a criação e configuração de agentes sem escrever código. Projete seus agentes visualmente e teste-os em tempo real.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ description: Aprenda a usar o CLI do CrewAI para interagir com o CrewAI.
|
||||
icon: terminal
|
||||
mode: "wide"
|
||||
---
|
||||
<Warning>A partir da versão 0.140.0, a plataforma CrewAI Enterprise iniciou um processo de migração de seu provedor de login. Como resultado, o fluxo de autenticação via CLI foi atualizado. Usuários que utlizam o Google para fazer login, ou que criaram conta após 3 de julho de 2025 não poderão fazer login com versões anteriores da biblioteca `crewai`.</Warning>
|
||||
<Warning>A partir da versão 0.140.0, a plataforma CrewAI AMP iniciou um processo de migração de seu provedor de login. Como resultado, o fluxo de autenticação via CLI foi atualizado. Usuários que utlizam o Google para fazer login, ou que criaram conta após 3 de julho de 2025 não poderão fazer login com versões anteriores da biblioteca `crewai`.</Warning>
|
||||
|
||||
## Visão Geral
|
||||
|
||||
@@ -201,9 +201,9 @@ def crew(self) -> Crew:
|
||||
|
||||
### 10. Deploy
|
||||
|
||||
Implemente o crew ou flow no [CrewAI Enterprise](https://app.crewai.com).
|
||||
Implemente o crew ou flow no [CrewAI AMP](https://app.crewai.com).
|
||||
|
||||
- **Autenticação**: Você precisa estar autenticado para implementar no CrewAI Enterprise.
|
||||
- **Autenticação**: Você precisa estar autenticado para implementar no CrewAI AMP.
|
||||
Você pode fazer login ou criar uma conta com:
|
||||
```shell Terminal
|
||||
crewai login
|
||||
@@ -218,7 +218,7 @@ Implemente o crew ou flow no [CrewAI Enterprise](https://app.crewai.com).
|
||||
|
||||
### 11. Gerenciamento de Organização
|
||||
|
||||
Gerencie suas organizações no CrewAI Enterprise.
|
||||
Gerencie suas organizações no CrewAI AMP.
|
||||
|
||||
```shell Terminal
|
||||
crewai org [COMMAND] [OPTIONS]
|
||||
@@ -242,17 +242,17 @@ crewai org switch <organization_id>
|
||||
```
|
||||
|
||||
<Note>
|
||||
Você deve estar autenticado no CrewAI Enterprise para usar estes comandos de gerenciamento de organização.
|
||||
Você deve estar autenticado no CrewAI AMP para usar estes comandos de gerenciamento de organização.
|
||||
</Note>
|
||||
|
||||
- **Criar um deployment** (continuação):
|
||||
- Vincula o deployment ao respectivo repositório remoto do GitHub (normalmente detectado automaticamente).
|
||||
|
||||
- **Implantar o Crew**: Depois de autenticado, você pode implantar seu crew ou flow no CrewAI Enterprise.
|
||||
- **Implantar o Crew**: Depois de autenticado, você pode implantar seu crew ou flow no CrewAI AMP.
|
||||
```shell Terminal
|
||||
crewai deploy push
|
||||
```
|
||||
- Inicia o processo de deployment na plataforma CrewAI Enterprise.
|
||||
- Inicia o processo de deployment na plataforma CrewAI AMP.
|
||||
- Após a iniciação bem-sucedida, será exibida a mensagem Deployment created successfully! juntamente com o Nome do Deployment e um Deployment ID (UUID) único.
|
||||
|
||||
- **Status do Deployment**: Você pode verificar o status do seu deployment com:
|
||||
@@ -277,7 +277,7 @@ Você deve estar autenticado no CrewAI Enterprise para usar estes comandos de ge
|
||||
```shell Terminal
|
||||
crewai deploy remove
|
||||
```
|
||||
Isto exclui o deployment da plataforma CrewAI Enterprise.
|
||||
Isto exclui o deployment da plataforma CrewAI AMP.
|
||||
|
||||
- **Comando de Ajuda**: Você pode obter ajuda sobre o CLI com:
|
||||
```shell Terminal
|
||||
@@ -285,17 +285,15 @@ Você deve estar autenticado no CrewAI Enterprise para usar estes comandos de ge
|
||||
```
|
||||
Isto exibe a mensagem de ajuda para o CLI CrewAI Deploy.
|
||||
|
||||
Assista ao vídeo tutorial para uma demonstração passo-a-passo de implantação do seu crew no [CrewAI Enterprise](http://app.crewai.com) usando o CLI.
|
||||
Assista ao vídeo tutorial para uma demonstração passo-a-passo de implantação do seu crew no [CrewAI AMP](http://app.crewai.com) usando o CLI.
|
||||
|
||||
<iframe
|
||||
width="100%"
|
||||
height="400"
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/3EqSV-CYDZA"
|
||||
title="CrewAI Deployment Guide"
|
||||
frameborder="0"
|
||||
style={{ borderRadius: '10px' }}
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowfullscreen
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
### 11. Chaves de API
|
||||
@@ -353,7 +351,7 @@ crewai config reset
|
||||
|
||||
#### Parâmetros de Configuração Disponíveis
|
||||
|
||||
- `enterprise_base_url`: URL base da instância CrewAI Enterprise
|
||||
- `enterprise_base_url`: URL base da instância CrewAI AMP
|
||||
- `oauth2_provider`: Provedor OAuth2 usado para autenticação (ex: workos, okta, auth0)
|
||||
- `oauth2_audience`: Valor de audiência OAuth2, tipicamente usado para identificar a API ou recurso de destino
|
||||
- `oauth2_client_id`: ID do cliente OAuth2 emitido pelo provedor, usado durante solicitações de autenticação
|
||||
@@ -370,7 +368,7 @@ Exemplo de saída:
|
||||
|
||||
| Parâmetro | Valor | Descrição |
|
||||
| :------------------- | :---------------------- | :------------------------------------------------------------ |
|
||||
| enterprise_base_url | https://app.crewai.com | URL base da instância CrewAI Enterprise |
|
||||
| enterprise_base_url | https://app.crewai.com | URL base da instância CrewAI AMP |
|
||||
| org_name | Not set | Nome da organização atualmente ativa |
|
||||
| org_uuid | Not set | UUID da organização atualmente ativa |
|
||||
| oauth2_provider | workos | Provedor OAuth2 (ex.: workos, okta, auth0) |
|
||||
|
||||
@@ -20,7 +20,7 @@ O CrewAI utiliza uma arquitetura de event bus para emitir eventos ao longo do ci
|
||||
Quando ações específicas ocorrem no CrewAI (como a inicialização de um Crew, um Agent concluindo uma tarefa ou o uso de uma ferramenta), o sistema emite os eventos correspondentes. Você pode registrar handlers para esses eventos para executar código personalizado quando eles acontecerem.
|
||||
|
||||
<Note type="info" title="Aprimoramento Enterprise: Prompt Tracing">
|
||||
O CrewAI Enterprise fornece o recurso Prompt Tracing, que aproveita o sistema de eventos para rastrear, armazenar e visualizar todos os prompts, respostas e metadados associados. Isso proporciona poderosas capacidades de depuração e transparência nas operações dos seus agentes.
|
||||
O CrewAI AMP fornece o recurso Prompt Tracing, que aproveita o sistema de eventos para rastrear, armazenar e visualizar todos os prompts, respostas e metadados associados. Isso proporciona poderosas capacidades de depuração e transparência nas operações dos seus agentes.
|
||||
|
||||
|
||||
|
||||
@@ -299,4 +299,4 @@ Listeners de evento podem ser usados para várias finalidades:
|
||||
4. **Escuta Seletiva**: Escute apenas eventos que realmente precisa tratar
|
||||
5. **Testes**: Teste seus listeners de evento isoladamente para garantir que se comportam conforme esperado
|
||||
|
||||
Aproveitando o sistema de eventos do CrewAI, é possível estender a funcionalidade e integrá-lo facilmente à sua infraestrutura existente.
|
||||
Aproveitando o sistema de eventos do CrewAI, é possível estender a funcionalidade e integrá-lo facilmente à sua infraestrutura existente.
|
||||
|
||||
@@ -468,14 +468,13 @@ Explore esses exemplos para descobrir como aproveitar CrewAI Flows em diferentes
|
||||
Além disso, confira nosso vídeo no YouTube sobre como utilizar flows no CrewAI abaixo!
|
||||
|
||||
<iframe
|
||||
width="560"
|
||||
height="315"
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/MTb5my6VOT8"
|
||||
title="YouTube video player"
|
||||
frameborder="0"
|
||||
title="Visão geral de Flows no CrewAI"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
|
||||
referrerpolicy="strict-origin-when-cross-origin"
|
||||
allowfullscreen
|
||||
referrerPolicy="strict-origin-when-cross-origin"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Executando Flows
|
||||
@@ -508,4 +507,4 @@ Por compatibilidade retroativa, também é possível usar:
|
||||
crewai flow kickoff
|
||||
```
|
||||
|
||||
No entanto, o comando `crewai run` é agora o preferido, pois funciona tanto para crews quanto para flows.
|
||||
No entanto, o comando `crewai run` é agora o preferido, pois funciona tanto para crews quanto para flows.
|
||||
|
||||
@@ -14,7 +14,7 @@ As tarefas fornecem todos os detalhes necessários para sua execução, como des
|
||||
As tarefas dentro do CrewAI podem ser colaborativas, exigindo que múltiplos agentes trabalhem juntos. Isso é gerenciado por meio das propriedades da tarefa e orquestrado pelo processo do Crew, potencializando o trabalho em equipe e a eficiência.
|
||||
|
||||
<Note type="info" title="Aprimoramento Empresarial: Construtor Visual de Tarefas">
|
||||
O CrewAI Enterprise inclui um Construtor Visual de Tarefas no Crew Studio, que simplifica a criação e o encadeamento de tarefas complexas. Projete seus fluxos de tarefas visualmente e teste-os em tempo real sem necessidade de escrever código.
|
||||
O CrewAI AMP inclui um Construtor Visual de Tarefas no Crew Studio, que simplifica a criação e o encadeamento de tarefas complexas. Projete seus fluxos de tarefas visualmente e teste-os em tempo real sem necessidade de escrever código.
|
||||
|
||||
|
||||
|
||||
@@ -1029,14 +1029,13 @@ except RuntimeError as e:
|
||||
Veja o vídeo abaixo para aprender como utilizar saídas estruturadas no CrewAI:
|
||||
|
||||
<iframe
|
||||
width="560"
|
||||
height="315"
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/dNpKQk5uxHw"
|
||||
title="YouTube video player"
|
||||
frameborder="0"
|
||||
title="Saídas estruturadas no CrewAI"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
|
||||
referrerpolicy="strict-origin-when-cross-origin"
|
||||
allowfullscreen
|
||||
referrerPolicy="strict-origin-when-cross-origin"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Conclusão
|
||||
|
||||
@@ -17,7 +17,7 @@ Isso inclui ferramentas do [CrewAI Toolkit](https://github.com/joaomdmoura/crewa
|
||||
permitindo desde buscas simples até interações complexas e trabalho em equipe eficiente entre agentes.
|
||||
|
||||
<Note type="info" title="Aprimoramento para Empresas: Repositório de Ferramentas">
|
||||
O CrewAI Enterprise oferece um Repositório de Ferramentas abrangente, com integrações pré-construídas para sistemas empresariais e APIs comuns. Implemente agentes com ferramentas corporativas em minutos em vez de dias.
|
||||
O CrewAI AMP oferece um Repositório de Ferramentas abrangente, com integrações pré-construídas para sistemas empresariais e APIs comuns. Implemente agentes com ferramentas corporativas em minutos em vez de dias.
|
||||
|
||||
O Repositório de Ferramentas Empresariais inclui:
|
||||
- Conectores pré-construídos para sistemas empresariais populares
|
||||
@@ -207,7 +207,7 @@ from crewai.tools import BaseTool
|
||||
class AsyncCustomTool(BaseTool):
|
||||
name: str = "async_custom_tool"
|
||||
description: str = "An asynchronous custom tool"
|
||||
|
||||
|
||||
async def _run(self, query: str = "") -> str:
|
||||
"""Asynchronously run the tool"""
|
||||
# Sua implementação assíncrona aqui
|
||||
@@ -281,4 +281,4 @@ writer1 = Agent(
|
||||
|
||||
Ferramentas são fundamentais para expandir as capacidades dos agentes CrewAI, permitindo que assumam uma ampla gama de tarefas e colaborem de forma eficiente.
|
||||
Ao construir soluções com CrewAI, aproveite tanto ferramentas existentes quanto personalizadas para potencializar seus agentes e ampliar o ecossistema de IA. Considere utilizar tratamento de erros,
|
||||
mecanismos de cache e a flexibilidade de argumentos das ferramentas para otimizar o desempenho e as capacidades dos seus agentes.
|
||||
mecanismos de cache e a flexibilidade de argumentos das ferramentas para otimizar o desempenho e as capacidades dos seus agentes.
|
||||
|
||||
156
docs/pt-BR/enterprise/features/agent-repositories.mdx
Normal file
156
docs/pt-BR/enterprise/features/agent-repositories.mdx
Normal file
@@ -0,0 +1,156 @@
|
||||
---
|
||||
title: 'Repositórios de Agentes'
|
||||
description: 'Aprenda a usar Repositórios de Agentes para compartilhar e reutilizar seus agentes entre equipes e projetos'
|
||||
icon: 'database'
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
Repositórios de Agentes permitem que usuários do enterprise armazenem, compartilhem e reutilizem definições de agentes entre equipes e projetos. Esse recurso possibilita manter uma biblioteca centralizada de agentes padronizados, promovendo consistência e reduzindo a duplicidade de esforços.
|
||||
|
||||
## Benefícios dos Repositórios de Agentes
|
||||
|
||||
- **Padronização**: Mantenha definições de agentes consistentes em toda a sua organização
|
||||
- **Reutilização**: Crie um agente uma vez e use-o em vários crews e projetos
|
||||
- **Governança**: Implemente políticas organizacionais para configurações de agentes
|
||||
- **Colaboração**: Permita que equipes compartilhem e evoluam o trabalho umas das outras
|
||||
|
||||
## Usando Repositórios de Agentes
|
||||
|
||||
### Pré-requisitos
|
||||
|
||||
1. Você deve ter uma conta na CrewAI, experimente o [plano gratuito](https://app.crewai.com).
|
||||
2. Você precisa estar autenticado usando o CLI da CrewAI.
|
||||
3. Se você tiver mais de uma organização, garanta que alternou para a organização correta usando o comando do CLI:
|
||||
|
||||
```bash
|
||||
crewai org switch <org_id>
|
||||
```
|
||||
|
||||
### Criando e gerenciando agentes em repositórios
|
||||
|
||||
Para criar e gerenciar agentes em repositórios, utilize o Painel do Enterprise.
|
||||
|
||||
### Carregando agentes de repositórios
|
||||
|
||||
Você pode carregar agentes de repositórios no seu código usando o parâmetro `from_repository`:
|
||||
|
||||
```python
|
||||
from crewai import Agent
|
||||
|
||||
# Crie um agente carregando-o de um repositório
|
||||
# O agente é carregado com todas as suas configurações predefinidas
|
||||
researcher = Agent(
|
||||
from_repository="market-research-agent"
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
### Sobrescrevendo configurações do repositório
|
||||
|
||||
Você pode sobrescrever configurações específicas do repositório informando-as na configuração do agente:
|
||||
|
||||
```python
|
||||
researcher = Agent(
|
||||
from_repository="market-research-agent",
|
||||
goal="Pesquisar as tendências mais recentes em desenvolvimento de IA", # Sobrescreve o goal do repositório
|
||||
verbose=True # Adiciona uma configuração que não está no repositório
|
||||
)
|
||||
```
|
||||
|
||||
### Exemplo: criando um Crew com agentes do repositório
|
||||
|
||||
```python
|
||||
from crewai import Crew, Agent, Task
|
||||
|
||||
# Carregue agentes dos repositórios
|
||||
researcher = Agent(
|
||||
from_repository="market-research-agent"
|
||||
)
|
||||
|
||||
writer = Agent(
|
||||
from_repository="content-writer-agent"
|
||||
)
|
||||
|
||||
# Crie tarefas
|
||||
research_task = Task(
|
||||
description="Pesquise as tendências mais recentes em IA",
|
||||
agent=researcher
|
||||
)
|
||||
|
||||
writing_task = Task(
|
||||
description="Escreva um relatório abrangente com base na pesquisa",
|
||||
agent=writer
|
||||
)
|
||||
|
||||
# Crie o crew
|
||||
crew = Crew(
|
||||
agents=[researcher, writer],
|
||||
tasks=[research_task, writing_task],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Execute o crew
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
### Exemplo: usando `kickoff()` com agentes do repositório
|
||||
|
||||
Você também pode usar agentes de repositório diretamente com o método `kickoff()` para interações mais simples:
|
||||
|
||||
```python
|
||||
from crewai import Agent
|
||||
from pydantic import BaseModel
|
||||
from typing import List
|
||||
|
||||
# Defina um formato de saída estruturado
|
||||
class MarketAnalysis(BaseModel):
|
||||
key_trends: List[str]
|
||||
opportunities: List[str]
|
||||
recommendation: str
|
||||
|
||||
# Carregue um agente do repositório
|
||||
analyst = Agent(
|
||||
from_repository="market-analyst-agent",
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Obtenha uma resposta livre (texto)
|
||||
result = analyst.kickoff("Analise o mercado de IA em 2025")
|
||||
print(result.raw) # Acessa a resposta bruta
|
||||
|
||||
# Obtenha saída estruturada
|
||||
structured_result = analyst.kickoff(
|
||||
"Forneça uma análise estruturada do mercado de IA em 2025",
|
||||
response_format=MarketAnalysis
|
||||
)
|
||||
|
||||
# Acesse os dados estruturados
|
||||
print(f"Principais Tendências: {structured_result.pydantic.key_trends}")
|
||||
print(f"Recomendação: {structured_result.pydantic.recommendation}")
|
||||
```
|
||||
|
||||
## Boas práticas
|
||||
|
||||
1. **Convenção de nomes**: Use nomes claros e descritivos para seus agentes de repositório
|
||||
2. **Documentação**: Inclua descrições abrangentes para cada agente
|
||||
3. **Gestão de ferramentas**: Garanta que as ferramentas referenciadas pelos agentes do repositório estejam disponíveis no seu ambiente
|
||||
4. **Controle de acesso**: Gerencie permissões para que apenas membros autorizados possam modificar agentes do repositório
|
||||
|
||||
## Gerenciamento de organização
|
||||
|
||||
Para alternar entre organizações ou ver sua organização atual, use o CLI da CrewAI:
|
||||
|
||||
```bash
|
||||
# Ver organização atual
|
||||
crewai org current
|
||||
|
||||
# Alternar para outra organização
|
||||
crewai org switch <org_id>
|
||||
|
||||
# Listar todas as organizações disponíveis
|
||||
crewai org list
|
||||
```
|
||||
|
||||
<Note>
|
||||
Ao carregar agentes de repositórios, você deve estar autenticado e ter alternado para a organização correta. Se você receber erros, verifique seu status de autenticação e as configurações de organização usando os comandos do CLI acima.
|
||||
</Note>
|
||||
103
docs/pt-BR/enterprise/features/automations.mdx
Normal file
103
docs/pt-BR/enterprise/features/automations.mdx
Normal file
@@ -0,0 +1,103 @@
|
||||
---
|
||||
title: "Automações"
|
||||
description: "Gerencie, implante e monitore seus crews (automações) em um só lugar."
|
||||
icon: "rocket"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Visão geral
|
||||
|
||||
Automações é o hub operacional para seus crews implantados. Use para implantar via GitHub ou arquivo ZIP, gerenciar variáveis de ambiente, reimplantar quando necessário e monitorar o status de cada automação.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Métodos de implantação
|
||||
|
||||
### Implantar via GitHub
|
||||
|
||||
Use para projetos versionados e implantação contínua.
|
||||
|
||||
<Steps>
|
||||
<Step title="Conectar GitHub">
|
||||
Clique em <b>Configure GitHub</b> e autorize o acesso.
|
||||
</Step>
|
||||
<Step title="Selecionar Repositório & Branch">
|
||||
Escolha o <b>Repositório</b> e a <b>Branch</b> que deseja implantar.
|
||||
</Step>
|
||||
<Step title="Ativar Auto‑deploy (opcional)">
|
||||
Ative <b>Automatically deploy new commits</b> para publicar a cada push.
|
||||
</Step>
|
||||
<Step title="Adicionar Variáveis de Ambiente">
|
||||
Adicione segredos individualmente ou use <b>Bulk View</b> para múltiplas variáveis.
|
||||
</Step>
|
||||
<Step title="Implantar">
|
||||
Clique em <b>Deploy</b> para criar sua automação.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
### Implantar via ZIP
|
||||
|
||||
Envie rapidamente sem Git — faça upload de um pacote ZIP do projeto.
|
||||
|
||||
<Steps>
|
||||
<Step title="Escolher arquivo">
|
||||
Selecione o arquivo ZIP do seu computador.
|
||||
</Step>
|
||||
<Step title="Adicionar Variáveis de Ambiente">
|
||||
Informe as variáveis necessárias.
|
||||
</Step>
|
||||
<Step title="Implantar">
|
||||
Clique em <b>Deploy</b> para criar sua automação.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Painel de Automações
|
||||
|
||||
A tabela lista todas as automações com detalhes chave:
|
||||
|
||||
- **CREW**: Nome da automação
|
||||
- **STATUS**: Online / Failed / In Progress
|
||||
- **URL**: Endpoint para kickoff/status
|
||||
- **TOKEN**: Token da automação
|
||||
- **ACTIONS**: Re‑deploy, delete e outros
|
||||
|
||||
Use os controles no canto superior direito para filtrar e pesquisar:
|
||||
|
||||
- Pesquisar por nome
|
||||
- Filtrar por <b>Status</b>
|
||||
- Filtrar por <b>Source</b> (GitHub / Studio / ZIP)
|
||||
|
||||
Após implantar, você pode ver os detalhes da automação e usar o menu **Options** para `chat with this crew`, `Export React Component` e `Export as MCP`.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Boas práticas
|
||||
|
||||
- Prefira implantações via GitHub para controle de versão e CI/CD
|
||||
- Use re‑deploy para avançar após mudanças de código/config ou habilite auto‑deploy a cada push
|
||||
|
||||
## Relacionados
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Implantar um Crew" href="/pt-BR/enterprise/guides/deploy-crew" icon="rocket">
|
||||
Implante um Crew via GitHub ou arquivo ZIP.
|
||||
</Card>
|
||||
<Card title="Gatilhos de Automação" href="/pt-BR/enterprise/guides/automation-triggers" icon="trigger">
|
||||
Dispare automações por webhooks ou API.
|
||||
</Card>
|
||||
<Card title="Automação com Webhook" href="/pt-BR/enterprise/guides/webhook-automation" icon="webhook">
|
||||
Transmita eventos e atualizações em tempo real.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
88
docs/pt-BR/enterprise/features/crew-studio.mdx
Normal file
88
docs/pt-BR/enterprise/features/crew-studio.mdx
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
title: "Crew Studio"
|
||||
description: "Crie novas automações com assistência de IA, editor visual e testes integrados."
|
||||
icon: "pencil"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Visão geral
|
||||
|
||||
O Crew Studio é um espaço interativo com assistência de IA para criar novas automações do zero usando linguagem natural e um editor visual de fluxo de trabalho.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Criação baseada em prompts
|
||||
|
||||
- Descreva a automação desejada; a IA gera agentes, tarefas e ferramentas.
|
||||
- Use entrada por voz pelo ícone de microfone se preferir.
|
||||
- Comece com prompts prontos para casos comuns.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Editor Visual
|
||||
|
||||
O canvas reflete o fluxo como nós e arestas com três painéis de suporte que permitem configurar o fluxo sem escrever código ("vibe coding AI Agents"):
|
||||
|
||||
- **AI Thoughts (esquerda)**: raciocínio em tempo real enquanto o fluxo é projetado
|
||||
- **Canvas (centro)**: agentes e tarefas como nós conectados
|
||||
- **Resources (direita)**: componentes de arrastar‑e‑soltar (agentes, tarefas, ferramentas)
|
||||
|
||||
Você pode arrastar e soltar agentes, tarefas e ferramentas no canvas ou usar a seção de chat para construir os agentes. Ambos compartilham estado e podem ser usados de forma intercambiável.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Execução & Depuração
|
||||
|
||||
Alterne para a visão <b>Execution</b> para executar e observar o fluxo:
|
||||
|
||||
- Linha do tempo de eventos
|
||||
- Logs detalhados (Details, Messages, Raw Data)
|
||||
- Execuções locais antes de publicar
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Publicar & Exportar
|
||||
|
||||
- <b>Publish</b> para implantar uma automação
|
||||
- <b>Download</b> do código‑fonte como ZIP para desenvolvimento local
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
Após publicar, você pode visualizar os detalhes da automação e usar o menu **Options** para `chat with this crew`, `Export React Component` e `Export as MCP`.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Boas práticas
|
||||
|
||||
- Itere rapidamente no Studio; publique apenas quando estiver estável
|
||||
- Restrinja permissões das ferramentas ao mínimo necessário
|
||||
- Use Traces para validar comportamento e desempenho
|
||||
|
||||
## Relacionados
|
||||
|
||||
<CardGroup cols={4}>
|
||||
<Card title="Habilitar o Crew Studio" href="/pt-BR/enterprise/guides/enable-crew-studio" icon="palette">
|
||||
Habilite o Crew Studio.
|
||||
</Card>
|
||||
<Card title="Criar um Crew" href="/pt-BR/enterprise/guides/build-crew" icon="paintbrush">
|
||||
Crie um Crew.
|
||||
</Card>
|
||||
<Card title="Implantar um Crew" href="/pt-BR/enterprise/guides/deploy-crew" icon="rocket">
|
||||
Implante um Crew via GitHub ou ZIP.
|
||||
</Card>
|
||||
<Card title="Exportar um Componente React" href="/pt-BR/enterprise/guides/react-component-export" icon="download">
|
||||
Exporte um componente React.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -1,180 +0,0 @@
|
||||
---
|
||||
title: Integrações
|
||||
description: "Aplicativos conectados para que seus agentes possam tomar ações."
|
||||
icon: "plug"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Visão Geral
|
||||
|
||||
Permita que seus agentes autentiquem com qualquer provedor habilitado para OAuth e tomem ações. Do Salesforce e HubSpot ao Google e GitHub, você conta com mais de 16 serviços integrados.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Integrações Suportadas
|
||||
|
||||
### **Comunicação & Colaboração**
|
||||
- **Gmail** - Gerencie e-mails e rascunhos
|
||||
- **Slack** - Notificações e alertas do workspace
|
||||
- **Microsoft** - Integração com Office 365 e Teams
|
||||
|
||||
### **Gerenciamento de Projetos**
|
||||
- **Jira** - Rastreamento de issues e gerenciamento de projetos
|
||||
- **ClickUp** - Gerenciamento de tarefas e produtividade
|
||||
- **Asana** - Coordenação de tarefas e projetos de equipe
|
||||
- **Notion** - Gerenciamento de páginas e bases de dados
|
||||
- **Linear** - Gerenciamento de projetos de software e bugs
|
||||
- **GitHub** - Gerenciamento de repositórios e issues
|
||||
|
||||
### **Gestão de Relacionamento com o Cliente**
|
||||
- **Salesforce** - Gerenciamento de contas e oportunidades de CRM
|
||||
- **HubSpot** - Gestão de pipeline de vendas e contatos
|
||||
- **Zendesk** - Administração de chamados de suporte ao cliente
|
||||
|
||||
### **Negócios & Finanças**
|
||||
- **Stripe** - Processamento de pagamentos e gerenciamento de clientes
|
||||
- **Shopify** - Gestão de loja de e-commerce e produtos
|
||||
|
||||
### **Produtividade & Armazenamento**
|
||||
- **Google Sheets** - Sincronização de dados de planilhas
|
||||
- **Google Calendar** - Gerenciamento de eventos e agendas
|
||||
- **Box** - Armazenamento de arquivos e gerenciamento de documentos
|
||||
|
||||
e mais estão por vir!
|
||||
|
||||
## Pré-requisitos
|
||||
|
||||
Antes de usar as Integrações de Autenticação, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com). Você pode começar com uma avaliação gratuita.
|
||||
|
||||
## Configurando Integrações
|
||||
|
||||
### 1. Conecte sua Conta
|
||||
|
||||
1. Acesse o [CrewAI Enterprise](https://app.crewai.com)
|
||||
2. Vá até a aba **Integrações** - https://app.crewai.com/crewai_plus/connectors
|
||||
3. Clique em **Conectar** no serviço desejado na seção Integrações de Autenticação
|
||||
4. Complete o fluxo de autenticação OAuth
|
||||
5. Conceda as permissões necessárias para seu caso de uso
|
||||
6. Pronto! Obtenha seu Token Enterprise do [CrewAI Enterprise](https://app.crewai.com) na aba **Integration**
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
### 2. Instale as Ferramentas de Integração
|
||||
|
||||
Tudo o que você precisa é da versão mais recente do pacote `crewai-tools`.
|
||||
|
||||
```bash
|
||||
uv add crewai-tools
|
||||
```
|
||||
|
||||
## Exemplos de Uso
|
||||
|
||||
### Uso Básico
|
||||
<Tip>
|
||||
Todos os serviços nos quais você estiver autenticado estarão disponíveis como ferramentas. Portanto, tudo que você precisa fazer é adicionar o `CrewaiEnterpriseTools` ao seu agente e pronto.
|
||||
</Tip>
|
||||
|
||||
```python
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import CrewaiEnterpriseTools
|
||||
|
||||
# Obtenha ferramentas enterprise (a ferramenta Gmail será incluída)
|
||||
ferramentas_enterprise = CrewaiEnterpriseTools(
|
||||
enterprise_token="seu_token_enterprise"
|
||||
)
|
||||
# imprima as ferramentas
|
||||
printf(ferramentas_enterprise)
|
||||
|
||||
# Crie um agente com capacidades do Gmail
|
||||
agente_email = Agent(
|
||||
role="Gerente de E-mails",
|
||||
goal="Gerenciar e organizar comunicações por e-mail",
|
||||
backstory="Um assistente de IA especializado em gestão de e-mails e comunicação.",
|
||||
tools=ferramentas_enterprise
|
||||
)
|
||||
|
||||
# Tarefa para enviar um e-mail
|
||||
tarefa_email = Task(
|
||||
description="Redigir e enviar um e-mail de acompanhamento para john@example.com sobre a atualização do projeto",
|
||||
agent=agente_email,
|
||||
expected_output="Confirmação de que o e-mail foi enviado com sucesso"
|
||||
)
|
||||
|
||||
# Execute a tarefa
|
||||
crew = Crew(
|
||||
agents=[agente_email],
|
||||
tasks=[tarefa_email]
|
||||
)
|
||||
|
||||
# Execute o crew
|
||||
crew.kickoff()
|
||||
```
|
||||
|
||||
### Filtrando Ferramentas
|
||||
|
||||
```python
|
||||
from crewai_tools import CrewaiEnterpriseTools
|
||||
|
||||
enterprise_tools = CrewaiEnterpriseTools(
|
||||
actions_list=["gmail_find_email"] # apenas a ferramenta gmail_find_email estará disponível
|
||||
)
|
||||
gmail_tool = enterprise_tools["gmail_find_email"]
|
||||
|
||||
agente_gmail = Agent(
|
||||
role="Gerente do Gmail",
|
||||
goal="Gerenciar comunicações e notificações do gmail",
|
||||
backstory="Um assistente de IA que ajuda a coordenar comunicações no gmail.",
|
||||
tools=[gmail_tool]
|
||||
)
|
||||
|
||||
tarefa_notificacao = Task(
|
||||
description="Encontrar o e-mail de john@example.com",
|
||||
agent=agente_gmail,
|
||||
expected_output="E-mail encontrado de john@example.com"
|
||||
)
|
||||
|
||||
# Execute a tarefa
|
||||
crew = Crew(
|
||||
agents=[agente_gmail],
|
||||
tasks=[tarefa_notificacao]
|
||||
)
|
||||
```
|
||||
|
||||
## Melhores Práticas
|
||||
|
||||
### Segurança
|
||||
- **Princípio do Menor Privilégio**: Conceda apenas as permissões mínimas exigidas para as tarefas dos seus agentes
|
||||
- **Auditorias Regulares**: Revise periodicamente as integrações conectadas e suas permissões
|
||||
- **Credenciais Seguras**: Nunca insira credenciais diretamente no código; utilize o fluxo seguro de autenticação do CrewAI
|
||||
|
||||
### Filtrando Ferramentas
|
||||
Em um crew implantado, você pode especificar quais ações estão disponíveis para cada integração a partir da página de configurações do serviço ao qual você se conectou.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
### Implantações com Escopo para organizações multiusuário
|
||||
Você pode implantar seu crew e associar cada integração a um usuário específico. Por exemplo, um crew que se conecta ao Google pode usar a conta do Gmail de um usuário específico.
|
||||
|
||||
<Tip>
|
||||
Isso é útil para organizações multiusuário, onde você deseja direcionar a integração para um usuário específico.
|
||||
</Tip>
|
||||
|
||||
Use o `user_bearer_token` para direcionar a integração a um usuário específico; assim, quando o crew for iniciado, ele usará o bearer token desse usuário para autenticar com a integração. Se o usuário não estiver logado, o crew não utilizará nenhuma integração conectada. Use o bearer token padrão para autenticar com as integrações que estão sendo implantadas com o crew.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
### Precisa de Ajuda?
|
||||
|
||||
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nosso time de suporte para assistência com a configuração de integrações ou solução de problemas.
|
||||
</Card>
|
||||
45
docs/pt-BR/enterprise/features/marketplace.mdx
Normal file
45
docs/pt-BR/enterprise/features/marketplace.mdx
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: "Marketplace"
|
||||
description: "Descubra, instale e governe ativos reutilizáveis para seus crews enterprise."
|
||||
icon: "store"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Visão geral
|
||||
|
||||
O Marketplace oferece uma superfície curada para descobrir integrações, ferramentas internas e ativos reutilizáveis que aceleram o desenvolvimento de crews.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Descoberta
|
||||
|
||||
- Navegue por categoria e capacidade
|
||||
- Pesquise por nome ou palavra‑chave
|
||||
|
||||
## Instalar & Habilitar
|
||||
|
||||
- Instalação com um clique para ativos aprovados
|
||||
- Habilite ou desabilite por crew conforme necessário
|
||||
- Configure variáveis de ambiente e escopos necessários
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
Você também pode baixar templates diretamente do marketplace clicando em `Download` para usar localmente ou personalizar conforme necessário.
|
||||
|
||||
## Relacionados
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Ferramentas & Integrações" href="/pt-BR/enterprise/features/tools-and-integrations" icon="wrench">
|
||||
Conecte apps externos e gerencie ferramentas internas que seus agentes podem usar.
|
||||
</Card>
|
||||
<Card title="Repositório de Ferramentas" href="/pt-BR/enterprise/features/tool-repository" icon="toolbox">
|
||||
Publique e instale ferramentas para ampliar as capacidades dos seus crews.
|
||||
</Card>
|
||||
<Card title="Repositório de Agentes" href="/pt-BR/enterprise/features/agent-repositories" icon="people-group">
|
||||
Armazene, compartilhe e reutilize definições de agentes entre equipes e projetos.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -7,11 +7,11 @@ mode: "wide"
|
||||
|
||||
## Visão Geral
|
||||
|
||||
O RBAC no CrewAI Enterprise permite gerenciar acesso de forma segura e escalável combinando **funções em nível de organização** com **controles de visibilidade em nível de automação**.
|
||||
O RBAC no CrewAI AMP permite gerenciar acesso de forma segura e escalável combinando **funções em nível de organização** com **controles de visibilidade em nível de automação**.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/users_and_roles.png" alt="Visão geral de RBAC no CrewAI Enterprise" />
|
||||
|
||||
<img src="/images/enterprise/users_and_roles.png" alt="Visão geral de RBAC no CrewAI AMP" />
|
||||
|
||||
</Frame>
|
||||
|
||||
## Usuários e Funções
|
||||
@@ -28,7 +28,7 @@ A configuração de usuários e funções é feita em Settings → Roles.
|
||||
|
||||
<Steps>
|
||||
<Step title="Abrir Roles">
|
||||
Vá em <b>Settings → Roles</b> no CrewAI Enterprise.
|
||||
Vá em <b>Settings → Roles</b> no CrewAI AMP.
|
||||
</Step>
|
||||
<Step title="Escolher a função">
|
||||
Use <b>Owner</b> ou <b>Member</b>, ou clique em <b>Create role</b> para criar uma função personalizada.
|
||||
@@ -93,12 +93,10 @@ O owner sempre possui acesso. Em modo privado, somente usuários/funções na wh
|
||||
</Tip>
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/visibility.png" alt="Configuração de visibilidade no CrewAI Enterprise" />
|
||||
|
||||
<img src="/images/enterprise/visibility.png" alt="Configuração de visibilidade no CrewAI AMP" />
|
||||
|
||||
</Frame>
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Fale com o nosso time para suporte em configuração e auditoria de RBAC.
|
||||
</Card>
|
||||
|
||||
|
||||
|
||||
234
docs/pt-BR/enterprise/features/tools-and-integrations.mdx
Normal file
234
docs/pt-BR/enterprise/features/tools-and-integrations.mdx
Normal file
@@ -0,0 +1,234 @@
|
||||
---
|
||||
title: "Ferramentas & Integrações"
|
||||
description: "Conecte apps externos e gerencie ferramentas internas que seus agentes podem usar."
|
||||
icon: "wrench"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Visão geral
|
||||
|
||||
Ferramentas & Integrações é o hub central para conectar aplicações de terceiros e gerenciar ferramentas internas que seus agentes podem usar em tempo de execução.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
## Explorar
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Integrações" icon="plug">
|
||||
|
||||
## Aplicativos para Agentes (Integrações)
|
||||
|
||||
Conecte aplicações empresariais (por exemplo, Gmail, Google Drive, HubSpot, Slack) via OAuth para habilitar ações de agentes.
|
||||
|
||||
<Steps>
|
||||
<Step title="Conectar">
|
||||
Clique em <b>Conectar</b> no app desejado e conclua o OAuth.
|
||||
</Step>
|
||||
<Step title="Configurar">
|
||||
Ajuste escopos, gatilhos e ações disponíveis conforme necessário.
|
||||
</Step>
|
||||
<Step title="Usar em Agentes">
|
||||
Os serviços conectados ficam disponíveis como ferramentas para seus agentes.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
### Conectar sua conta
|
||||
|
||||
1. Acesse <Link href="https://app.crewai.com/crewai_plus/connectors">Integrações</Link>
|
||||
2. Clique em <b>Conectar</b> no serviço desejado
|
||||
3. Conclua o fluxo OAuth e conceda os escopos
|
||||
4. Copie seu Token Enterprise na aba <b>Integração</b>
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
### Instalar ferramentas de integração
|
||||
|
||||
Para usar as integrações localmente, instale a versão mais recente do pacote `crewai-tools`.
|
||||
|
||||
```bash
|
||||
uv add crewai-tools
|
||||
```
|
||||
|
||||
### Exemplo de uso
|
||||
|
||||
<Tip>
|
||||
Todos os serviços autenticados ficam disponíveis como ferramentas. Adicione `CrewaiEnterpriseTools` ao agente e pronto.
|
||||
</Tip>
|
||||
|
||||
```python
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import CrewaiEnterpriseTools
|
||||
|
||||
enterprise_tools = CrewaiEnterpriseTools(
|
||||
enterprise_token="seu_enterprise_token"
|
||||
)
|
||||
print(enterprise_tools)
|
||||
|
||||
email_agent = Agent(
|
||||
role="Gerente de Email",
|
||||
goal="Gerenciar e organizar comunicações por email",
|
||||
backstory="Assistente de IA especializado em gestão de emails",
|
||||
tools=enterprise_tools
|
||||
)
|
||||
|
||||
email_task = Task(
|
||||
description="Criar e enviar follow-up para john@example.com sobre a atualização do projeto",
|
||||
agent=email_agent,
|
||||
expected_output="Confirmação de envio do email com sucesso"
|
||||
)
|
||||
|
||||
crew = Crew(agents=[email_agent], tasks=[email_task])
|
||||
crew.kickoff()
|
||||
```
|
||||
|
||||
### Filtrando ferramentas
|
||||
|
||||
```python
|
||||
from crewai_tools import CrewaiEnterpriseTools
|
||||
|
||||
enterprise_tools = CrewaiEnterpriseTools(
|
||||
actions_list=["gmail_find_email"]
|
||||
)
|
||||
|
||||
gmail_tool = enterprise_tools["gmail_find_email"]
|
||||
|
||||
gmail_agent = Agent(
|
||||
role="Gerente de Gmail",
|
||||
goal="Gerenciar comunicações e notificações no Gmail",
|
||||
backstory="Assistente de IA para coordenação de emails",
|
||||
tools=[gmail_tool]
|
||||
)
|
||||
|
||||
notification_task = Task(
|
||||
description="Encontrar o email de john@example.com",
|
||||
agent=gmail_agent,
|
||||
expected_output="Email encontrado de john@example.com"
|
||||
)
|
||||
|
||||
crew = Crew(agents=[gmail_agent], tasks=[notification_task])
|
||||
```
|
||||
|
||||
Em um crew implantado, você pode especificar quais ações ficam disponíveis em cada integração na página de configurações do serviço.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
### Implantações com escopo (organizações multiusuário)
|
||||
|
||||
Você pode escopar cada integração para um usuário específico (por exemplo, usar a conta Gmail de um usuário).
|
||||
|
||||
<Tip>
|
||||
Útil quando diferentes equipes/usuários precisam manter o acesso a dados isolado.
|
||||
</Tip>
|
||||
|
||||
Use `user_bearer_token` para escopar a autenticação ao usuário solicitante. Se o usuário não estiver logado, o crew não usará integrações conectadas; caso contrário, usa o token padrão configurado na implantação.
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
<div id="catalog"></div>
|
||||
### Catálogo
|
||||
|
||||
#### Comunicação & Colaboração
|
||||
- Gmail — Gerenciamento de emails e rascunhos
|
||||
- Slack — Notificações e alertas do workspace
|
||||
- Microsoft — Integração com Office 365 e Teams
|
||||
|
||||
#### Gestão de Projetos
|
||||
- Jira — Rastreamento de issues e projetos
|
||||
- ClickUp — Gestão de tarefas e produtividade
|
||||
- Asana — Coordenação de tarefas de equipe
|
||||
- Notion — Páginas e bancos de dados
|
||||
- Linear — Gestão de bugs e projetos de software
|
||||
- GitHub — Repositórios e issues
|
||||
|
||||
#### CRM
|
||||
- Salesforce — Contas e oportunidades
|
||||
- HubSpot — Pipeline de vendas e contatos
|
||||
- Zendesk — Tickets de suporte
|
||||
|
||||
#### Negócios & Finanças
|
||||
- Stripe — Pagamentos e clientes
|
||||
- Shopify — E‑commerce e produtos
|
||||
|
||||
#### Produtividade & Armazenamento
|
||||
- Google Sheets — Sincronização de planilhas
|
||||
- Google Calendar — Eventos e agenda
|
||||
- Box — Armazenamento de arquivos
|
||||
|
||||
…e mais por vir!
|
||||
|
||||
</Tab>
|
||||
<Tab title="Ferramentas Internas" icon="toolbox">
|
||||
|
||||
## Ferramentas Internas
|
||||
|
||||
Crie ferramentas localmente, publique no Repositório de Ferramentas da CrewAI AMP e use nos seus agentes.
|
||||
|
||||
<Tip>
|
||||
Antes de executar os comandos abaixo, faça login na sua conta CrewAI AMP:
|
||||
```bash
|
||||
crewai login
|
||||
```
|
||||
</Tip>
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
<Steps>
|
||||
<Step title="Criar">
|
||||
Criar uma nova ferramenta localmente.
|
||||
```bash
|
||||
crewai tool create your-tool
|
||||
```
|
||||
</Step>
|
||||
<Step title="Publicar">
|
||||
Publicar a ferramenta no Repositório de Ferramentas.
|
||||
```bash
|
||||
crewai tool publish
|
||||
```
|
||||
</Step>
|
||||
<Step title="Instalar">
|
||||
Instalar a ferramenta do Repositório de Ferramentas.
|
||||
```bash
|
||||
crewai tool install your-tool
|
||||
```
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
Gerenciar:
|
||||
|
||||
- Nome e descrição
|
||||
- Visibilidade (Privado / Público)
|
||||
- Variáveis de ambiente necessárias
|
||||
- Histórico de versões e downloads
|
||||
- Acesso por equipe e função
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Relacionados
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Repositório de Ferramentas" href="/pt-BR/enterprise/features/tool-repository" icon="toolbox">
|
||||
Publique e instale ferramentas para ampliar as capacidades dos seus crews.
|
||||
</Card>
|
||||
<Card title="Automação com Webhook" href="/pt-BR/enterprise/guides/webhook-automation" icon="bolt">
|
||||
Automatize fluxos e integre com plataformas e serviços externos.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -11,7 +11,7 @@ Traces fornecem visibilidade abrangente sobre as execuções dos seus crews, aju
|
||||
|
||||
## O que são Traces?
|
||||
|
||||
Traces no CrewAI Enterprise são registros detalhados de execução que capturam todos os aspectos da operação do seu crew, desde as entradas iniciais até as saídas finais. Eles registram:
|
||||
Traces no CrewAI AMP são registros detalhados de execução que capturam todos os aspectos da operação do seu crew, desde as entradas iniciais até as saídas finais. Eles registram:
|
||||
|
||||
- Pensamentos e raciocínio do agente
|
||||
- Detalhes da execução das tarefas
|
||||
@@ -28,9 +28,9 @@ Traces no CrewAI Enterprise são registros detalhados de execução que capturam
|
||||
|
||||
<Steps>
|
||||
<Step title="Navegue até a aba Traces">
|
||||
No seu painel do CrewAI Enterprise, clique em **Traces** para ver todos os registros de execução.
|
||||
No seu painel do CrewAI AMP, clique em **Traces** para ver todos os registros de execução.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Selecione uma Execução">
|
||||
Você verá uma lista de todas as execuções do crew, ordenadas por data. Clique em qualquer execução para visualizar seu trace detalhado.
|
||||
</Step>
|
||||
@@ -112,7 +112,7 @@ Traces são indispensáveis para solucionar problemas nos seus crews:
|
||||
<Steps>
|
||||
<Step title="Identifique Pontos de Falha">
|
||||
Quando uma execução de crew não produzir os resultados esperados, examine o trace para encontrar onde ocorreu o problema. Procure por:
|
||||
|
||||
|
||||
- Tarefas que falharam
|
||||
- Decisões inesperadas dos agentes
|
||||
- Erros no uso de ferramentas
|
||||
@@ -122,19 +122,19 @@ Traces são indispensáveis para solucionar problemas nos seus crews:
|
||||
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Otimizar Desempenho">
|
||||
Use métricas de execução para identificar gargalos de desempenho:
|
||||
|
||||
|
||||
- Tarefas que demoraram mais do que o esperado
|
||||
- Uso excessivo de tokens
|
||||
- Operações redundantes de ferramentas
|
||||
- Chamadas de API desnecessárias
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Melhore a Eficiência de Custos">
|
||||
Analise o uso de tokens e as estimativas de custo para otimizar a eficiência do seu crew:
|
||||
|
||||
|
||||
- Considere usar modelos menores para tarefas mais simples
|
||||
- Refine prompts para serem mais concisos
|
||||
- Faça cache de informações acessadas frequentemente
|
||||
@@ -143,5 +143,5 @@ Traces são indispensáveis para solucionar problemas nos seus crews:
|
||||
</Steps>
|
||||
|
||||
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para assistência com análise de traces ou outros recursos do CrewAI Enterprise.
|
||||
</Card>
|
||||
Entre em contato com nossa equipe de suporte para assistência com análise de traces ou outros recursos do CrewAI AMP.
|
||||
</Card>
|
||||
|
||||
@@ -7,7 +7,7 @@ mode: "wide"
|
||||
|
||||
## Visão Geral
|
||||
|
||||
O Enterprise Event Streaming permite que você receba atualizações em tempo real via webhook sobre suas crews e flows implantados no CrewAI Enterprise, como chamadas de modelo, uso de ferramentas e etapas do flow.
|
||||
O Enterprise Event Streaming permite que você receba atualizações em tempo real via webhook sobre suas crews e flows implantados no CrewAI AMP, como chamadas de modelo, uso de ferramentas e etapas do flow.
|
||||
|
||||
## Uso
|
||||
|
||||
@@ -81,4 +81,4 @@ Você pode emitir seus próprios eventos personalizados, e eles serão entregues
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para assistência com integração de webhook ou solução de problemas.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -1,75 +1,138 @@
|
||||
---
|
||||
title: "Triggers de Automação"
|
||||
description: "Execute automaticamente seus workflows CrewAI quando eventos específicos ocorrem em integrações conectadas"
|
||||
title: "Visão Geral de Triggers"
|
||||
description: "Entenda como os triggers da CrewAI AMP funcionam, como gerenciá-los e onde encontrar playbooks específicos de integração"
|
||||
icon: "bolt"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
Os triggers de automação permitem executar automaticamente suas implantações CrewAI quando eventos específicos ocorrem em suas integrações conectadas, criando workflows poderosos orientados por eventos que respondem a mudanças em tempo real em seus sistemas de negócio.
|
||||
Os triggers da CrewAI AMP conectam suas automações a eventos em tempo real nas ferramentas que sua equipe já usa. Em vez de fazer polling ou depender de execuções manuais, os triggers escutam mudanças — novos e‑mails, atualizações de calendário, alterações no CRM — e iniciam imediatamente a crew ou flow que você definiu.
|
||||
|
||||
## Visão Geral
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/TpQ45lAZh48"
|
||||
title="Visão geral dos triggers da CrewAI"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
Com triggers de automação, você pode:
|
||||
### Playbooks de Integração
|
||||
|
||||
- **Responder a eventos em tempo real** - Execute workflows automaticamente quando condições específicas forem atendidas
|
||||
- **Integrar com sistemas externos** - Conecte com plataformas como Gmail, Outlook, OneDrive, JIRA, Slack, Stripe e muito mais
|
||||
- **Escalar sua automação** - Lide com eventos de alto volume sem intervenção manual
|
||||
- **Manter contexto** - Acesse dados do trigger dentro de suas crews e flows
|
||||
Os guias abaixo explicam, em detalhe, como habilitar e testar cada integração:
|
||||
|
||||
## Gerenciando Triggers de Automação
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Trigger do Gmail" icon="envelope">
|
||||
<a href="/pt-BR/enterprise/guides/gmail-trigger">Dispare crews quando novos e‑mails chegarem ou threads forem atualizadas.</a>
|
||||
</Card>
|
||||
|
||||
<Card title="Trigger do Google Calendar" icon="calendar-days">
|
||||
<a href="/pt-BR/enterprise/guides/google-calendar-trigger">Reaja a eventos de calendário criados, atualizados ou cancelados.</a>
|
||||
</Card>
|
||||
|
||||
<Card title="Trigger do Google Drive" icon="folder-open">
|
||||
<a href="/pt-BR/enterprise/guides/google-drive-trigger">Monitore uploads, edições e exclusões de arquivos no Drive.</a>
|
||||
</Card>
|
||||
|
||||
<Card title="Trigger do Outlook" icon="envelope-open">
|
||||
<a href="/pt-BR/enterprise/guides/outlook-trigger">Automatize respostas a novos e‑mails ou eventos removidos no Outlook.</a>
|
||||
</Card>
|
||||
|
||||
<Card title="Trigger do OneDrive" icon="cloud">
|
||||
<a href="/pt-BR/enterprise/guides/onedrive-trigger">Audite atividade e compartilhamentos de arquivos no OneDrive.</a>
|
||||
</Card>
|
||||
|
||||
<Card title="Trigger do Microsoft Teams" icon="comments">
|
||||
<a href="/pt-BR/enterprise/guides/microsoft-teams-trigger">Inicie workflows quando novos chats forem criados no Teams.</a>
|
||||
</Card>
|
||||
|
||||
<Card title="Trigger do HubSpot" icon="hubspot">
|
||||
<a href="/pt-BR/enterprise/guides/hubspot-trigger">Execute automações a partir de workflows e eventos de ciclo de vida no HubSpot.</a>
|
||||
</Card>
|
||||
|
||||
<Card title="Trigger do Salesforce" icon="salesforce">
|
||||
<a href="/pt-BR/enterprise/guides/salesforce-trigger">Conecte processos do Salesforce às suas crews para automação de CRM.</a>
|
||||
</Card>
|
||||
|
||||
<Card title="Trigger do Slack" icon="slack">
|
||||
<a href="/pt-BR/enterprise/guides/slack-trigger">Dispare crews diretamente de comandos slash no Slack.</a>
|
||||
</Card>
|
||||
|
||||
<Card title="Trigger do Zapier" icon="bolt">
|
||||
<a href="/pt-BR/enterprise/guides/zapier-trigger">Integre a CrewAI com milhares de apps suportados pelo Zapier.</a>
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Capacidades dos Triggers
|
||||
|
||||
Com triggers você pode:
|
||||
|
||||
- **Responder em tempo real** – Executar workflows automaticamente quando condições forem atendidas
|
||||
- **Integrar com sistemas externos** – Conectar Gmail, Outlook, OneDrive, JIRA, Slack, Stripe e muito mais
|
||||
- **Escalar automações** – Lidar com alto volume de eventos sem intervenção manual
|
||||
- **Manter contexto** – Acessar dados do trigger dentro das suas crews e flows
|
||||
|
||||
## Gerenciando Triggers
|
||||
|
||||
### Visualizando Triggers Disponíveis
|
||||
|
||||
Para acessar e gerenciar seus triggers de automação:
|
||||
|
||||
1. Navegue até sua implantação no painel do CrewAI
|
||||
2. Clique na aba **Triggers** para visualizar todas as integrações de trigger disponíveis
|
||||
1. Abra sua automação no painel da CrewAI
|
||||
2. Clique na aba **Triggers** para listar todas as integrações disponíveis
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/list-available-triggers.png" alt="Lista de triggers de automação disponíveis" />
|
||||
<img src="/images/enterprise/list-available-triggers.png" alt="Lista de triggers disponíveis" />
|
||||
</Frame>
|
||||
|
||||
Esta visualização mostra todas as integrações de trigger disponíveis para sua implantação, junto com seus status de conexão atuais.
|
||||
### Habilitando e Desabilitando
|
||||
|
||||
### Habilitando e Desabilitando Triggers
|
||||
|
||||
Cada trigger pode ser facilmente habilitado ou desabilitado usando o botão de alternância:
|
||||
Cada trigger possui uma chave de ativação:
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/trigger-selected.png" alt="Habilitar ou desabilitar triggers com alternância" />
|
||||
<img src="/images/enterprise/trigger-selected.png" alt="Alternância de trigger habilitado" />
|
||||
</Frame>
|
||||
|
||||
- **Habilitado (alternância azul)**: O trigger está ativo e executará automaticamente sua implantação quando os eventos especificados ocorrerem
|
||||
- **Desabilitado (alternância cinza)**: O trigger está inativo e não responderá a eventos
|
||||
- **Habilitado (azul)** – Executa a automação quando o evento ocorrer
|
||||
- **Desabilitado (cinza)** – Ignora eventos
|
||||
|
||||
Simplesmente clique na alternância para mudar o estado do trigger. As alterações entram em vigor imediatamente.
|
||||
As alterações são aplicadas imediatamente.
|
||||
|
||||
### Monitorando Execuções de Trigger
|
||||
### Monitorando Execuções
|
||||
|
||||
Acompanhe o desempenho e histórico de suas execuções acionadas:
|
||||
Use a lista de execuções para acompanhar histórico, status e payloads:
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/list-executions.png" alt="Lista de execuções acionadas por automação" />
|
||||
<img src="/images/enterprise/list-executions.png" alt="Lista de execuções acionadas por triggers" />
|
||||
</Frame>
|
||||
|
||||
## Construindo Automação
|
||||
## Construindo Automações Orientadas por Trigger
|
||||
|
||||
Antes de construir sua automação, é útil entender a estrutura dos payloads de trigger que suas crews e flows receberão.
|
||||
### Checklist de Configuração
|
||||
|
||||
### Repositório de Amostras de Payload
|
||||
Antes de ativar em produção, confirme que você:
|
||||
|
||||
Mantemos um repositório abrangente com amostras de payload de várias fontes de trigger para ajudá-lo a construir e testar suas automações:
|
||||
- Conectou a integração em **Tools & Integrations** e concluiu OAuth ou configuração de API
|
||||
- Habilitou o trigger na automação correta
|
||||
- Definiu variáveis de ambiente necessárias (tokens, IDs de tenant, segredos)
|
||||
- Criou tarefas que analisam o payload no primeiro passo da crew/flow
|
||||
- Decidiu se usará `allow_crewai_trigger_context` para injetar contexto automaticamente
|
||||
- Configurou monitoramento (webhooks, históricos da CrewAI, alertas externos)
|
||||
|
||||
**🔗 [Amostras de Payload de Trigger CrewAI Enterprise](https://github.com/crewAIInc/crewai-enterprise-trigger-payload-samples)**
|
||||
### Repositório de Payloads e Crews de Exemplo
|
||||
|
||||
Este repositório contém:
|
||||
| Integração | Quando dispara | Amostras de payload | Crews de exemplo |
|
||||
| :-- | :-- | :-- | :-- |
|
||||
| Gmail | Novas mensagens, atualização de threads | [Payloads de alertas e threads](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail) | [`new-email-crew.py`, `gmail-alert-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail) |
|
||||
| Google Calendar | Evento criado/atualizado/iniciado/encerrado/cancelado | [Payloads de eventos](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_calendar) | [`calendar-event-crew.py`, `calendar-meeting-crew.py`, `calendar-working-location-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_calendar) |
|
||||
| Google Drive | Arquivo criado/atualizado/excluído | [Payloads de arquivos](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_drive) | [`drive-file-crew.py`, `drive-file-deletion-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_drive) |
|
||||
| Outlook | Novo e‑mail, evento removido | [Payloads do Outlook](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/outlook) | [`outlook-message-crew.py`, `outlook-event-removal-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/outlook) |
|
||||
| OneDrive | Operações de arquivo (criar, atualizar, compartilhar, excluir) | [Payloads do OneDrive](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/onedrive) | [`onedrive-file-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/onedrive) |
|
||||
| HubSpot | Registros criados/atualizados (contatos, empresas, negócios) | [Payloads do HubSpot](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/hubspot) | [`hubspot-company-crew.py`, `hubspot-contact-crew.py`, `hubspot-record-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/hubspot) |
|
||||
| Microsoft Teams | Chat criado | [Payload do Teams](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/microsoft-teams) | [`teams-chat-created-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/microsoft-teams) |
|
||||
|
||||
- **Exemplos reais de payload** de diferentes fontes de trigger (Gmail, Google Drive, etc.)
|
||||
- **Documentação da estrutura de payload** mostrando o formato e campos disponíveis
|
||||
Use essas amostras para ajustar o parsing, copiar a crew correspondente e substituir o payload de teste pelo dado real.
|
||||
|
||||
### Triggers com Crew
|
||||
### Triggers com Crews
|
||||
|
||||
Suas definições de crew existentes funcionam perfeitamente com triggers, você só precisa ter uma tarefa para analisar o payload recebido:
|
||||
Suas definições de crew funcionam naturalmente com triggers; basta ter uma tarefa que processe o payload recebido:
|
||||
|
||||
```python
|
||||
@CrewBase
|
||||
@@ -95,15 +158,13 @@ class MinhaCrewAutomatizada:
|
||||
)
|
||||
```
|
||||
|
||||
A crew receberá automaticamente e pode acessar o payload do trigger através dos mecanismos de contexto padrão do CrewAI.
|
||||
|
||||
### Integração com Flows
|
||||
|
||||
Para flows, você tem mais controle sobre como os dados do trigger são tratados:
|
||||
Flows oferecem controle adicional sobre o uso do payload:
|
||||
|
||||
#### Acessando Payload do Trigger
|
||||
#### Acessando o Payload
|
||||
|
||||
Todos os métodos `@start()` em seus flows aceitarão um parâmetro adicional chamado `crewai_trigger_payload`:
|
||||
Todos os métodos `@start()` podem receber `crewai_trigger_payload`:
|
||||
|
||||
```python
|
||||
from crewai.flow import Flow, start, listen
|
||||
@@ -111,62 +172,48 @@ from crewai.flow import Flow, start, listen
|
||||
class MeuFlowAutomatizado(Flow):
|
||||
@start()
|
||||
def lidar_com_trigger(self, crewai_trigger_payload: dict = None):
|
||||
"""
|
||||
Este método start pode receber dados do trigger
|
||||
"""
|
||||
if crewai_trigger_payload:
|
||||
# Processa os dados do trigger
|
||||
trigger_id = crewai_trigger_payload.get('id')
|
||||
dados_evento = crewai_trigger_payload.get('payload', {})
|
||||
|
||||
# Armazena no estado do flow para uso por outros métodos
|
||||
self.state.trigger_id = trigger_id
|
||||
self.state.trigger_type = dados_evento
|
||||
|
||||
return dados_evento
|
||||
|
||||
# Lida com execução manual
|
||||
return None
|
||||
|
||||
@listen(lidar_com_trigger)
|
||||
def processar_dados(self, dados_trigger):
|
||||
"""
|
||||
Processa os dados do trigger
|
||||
"""
|
||||
# ... processa o trigger
|
||||
```
|
||||
|
||||
#### Acionando Crews a partir de Flows
|
||||
|
||||
Ao iniciar uma crew dentro de um flow que foi acionado, passe o payload do trigger conforme ele:
|
||||
|
||||
```python
|
||||
@start()
|
||||
def delegar_para_crew(self, crewai_trigger_payload: dict = None):
|
||||
"""
|
||||
Delega processamento para uma crew especializada
|
||||
"""
|
||||
crew = MinhaCrewEspecializada()
|
||||
|
||||
# Passa o payload do trigger para a crew
|
||||
resultado = crew.crew().kickoff(
|
||||
inputs={
|
||||
'parametro_personalizado': "valor_personalizado",
|
||||
'crewai_trigger_payload': crewai_trigger_payload
|
||||
},
|
||||
)
|
||||
|
||||
return resultado
|
||||
```
|
||||
|
||||
## Solução de Problemas
|
||||
|
||||
**Trigger não está sendo disparado:**
|
||||
- Verifique se o trigger está habilitado
|
||||
- Verifique o status de conexão da integração
|
||||
**Trigger não dispara:**
|
||||
- Verifique se está habilitado
|
||||
- Confira o status da conexão
|
||||
|
||||
**Falhas de execução:**
|
||||
- Verifique os logs de execução para detalhes do erro
|
||||
- Se você está desenvolvendo, certifique-se de que as entradas incluem o parâmetro `crewai_trigger_payload` com o payload correto
|
||||
- Consulte os logs para entender o erro
|
||||
- Durante o desenvolvimento, garanta que `crewai_trigger_payload` está presente com o payload correto
|
||||
|
||||
Os triggers de automação transformam suas implantações CrewAI em sistemas responsivos orientados por eventos que podem se integrar perfeitamente com seus processos de negócio e ferramentas existentes.
|
||||
Os triggers transformam suas implantações CrewAI em sistemas orientados por eventos, integrando-se perfeitamente aos processos e ferramentas já usados pelo seu time.
|
||||
|
||||
<Callout icon="github" title="Exemplos na prática">
|
||||
<a href="https://github.com/crewAIInc/crewai-enterprise-trigger-examples">
|
||||
Repositório CrewAI AMP Trigger Examples
|
||||
</a>
|
||||
</Callout>
|
||||
|
||||
@@ -20,7 +20,7 @@ Este guia orienta você na conexão do Azure OpenAI com o Crew Studio para opera
|
||||
</Step>
|
||||
|
||||
<Step title="Configure a Conexão Enterprise do CrewAI">
|
||||
4. Em outra aba, abra `CrewAI Enterprise > LLM Connections`. Dê um nome à sua LLM Connection, selecione Azure como provedor e escolha o mesmo modelo que você selecionou no Azure.
|
||||
4. Em outra aba, abra `CrewAI AMP > LLM Connections`. Dê um nome à sua LLM Connection, selecione Azure como provedor e escolha o mesmo modelo que você selecionou no Azure.
|
||||
5. Na mesma página, adicione as variáveis de ambiente do passo 3:
|
||||
- Uma chamada `AZURE_DEPLOYMENT_TARGET_URL` (usando o Target URI). A URL deve ser parecida com: https://your-deployment.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-08-01-preview
|
||||
- Outra chamada `AZURE_API_KEY` (usando a Key).
|
||||
@@ -28,7 +28,7 @@ Este guia orienta você na conexão do Azure OpenAI com o Crew Studio para opera
|
||||
</Step>
|
||||
|
||||
<Step title="Defina Configurações Padrão">
|
||||
7. Em `CrewAI Enterprise > Settings > Defaults > Crew Studio LLM Settings`, defina a nova LLM Connection e o modelo como padrão.
|
||||
7. Em `CrewAI AMP > Settings > Defaults > Crew Studio LLM Settings`, defina a nova LLM Connection e o modelo como padrão.
|
||||
</Step>
|
||||
|
||||
<Step title="Configure o Acesso à Rede">
|
||||
@@ -49,4 +49,4 @@ Se você encontrar problemas:
|
||||
- Verifique se o formato do Target URI corresponde ao padrão esperado
|
||||
- Confira se a API key está correta e com as permissões adequadas
|
||||
- Certifique-se de que o acesso à rede está configurado para permitir conexões do CrewAI
|
||||
- Confirme se o modelo da implantação corresponde ao que você configurou no CrewAI
|
||||
- Confirme se o modelo da implantação corresponde ao que você configurou no CrewAI
|
||||
|
||||
@@ -7,19 +7,17 @@ mode: "wide"
|
||||
|
||||
## Visão Geral
|
||||
|
||||
[CrewAI Enterprise](https://app.crewai.com) simplifica o processo de **criação**, **implantação** e **gerenciamento** dos seus agentes de IA em ambientes de produção.
|
||||
[CrewAI AMP](https://app.crewai.com) simplifica o processo de **criação**, **implantação** e **gerenciamento** dos seus agentes de IA em ambientes de produção.
|
||||
|
||||
## Primeiros Passos
|
||||
|
||||
<iframe
|
||||
width="100%"
|
||||
height="400"
|
||||
src="https://www.youtube.com/embed/-kSOTtYzgEw"
|
||||
title="Building Crews with CrewAI CLI"
|
||||
frameborder="0"
|
||||
style={{ borderRadius: '10px' }}
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowfullscreen
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/-kSOTtYzgEw"
|
||||
title="Building crews with the CrewAI CLI"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
### Instalação e Configuração
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
---
|
||||
title: "Deploy Crew"
|
||||
description: "Implantando um Crew na CrewAI Enterprise"
|
||||
description: "Implantando um Crew na CrewAI AMP"
|
||||
icon: "rocket"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
<Note>
|
||||
Depois de criar um crew localmente ou pelo Crew Studio, o próximo passo é implantá-lo na plataforma CrewAI Enterprise. Este guia cobre múltiplos métodos de implantação para ajudá-lo a escolher a melhor abordagem para o seu fluxo de trabalho.
|
||||
Depois de criar um crew localmente ou pelo Crew Studio, o próximo passo é implantá-lo na plataforma CrewAI AMP. Este guia cobre múltiplos métodos de implantação para ajudá-lo a escolher a melhor abordagem para o seu fluxo de trabalho.
|
||||
</Note>
|
||||
|
||||
## Pré-requisitos
|
||||
@@ -39,10 +39,10 @@ A CLI fornece a maneira mais rápida de implantar crews desenvolvidos localmente
|
||||
</Step>
|
||||
|
||||
<Step title="Autentique-se na Plataforma Enterprise">
|
||||
Primeiro, você precisa autenticar sua CLI com a plataforma CrewAI Enterprise:
|
||||
Primeiro, você precisa autenticar sua CLI com a plataforma CrewAI AMP:
|
||||
|
||||
```bash
|
||||
# Se já possui uma conta CrewAI Enterprise, ou deseja criar uma:
|
||||
# Se já possui uma conta CrewAI AMP, ou deseja criar uma:
|
||||
crewai login
|
||||
```
|
||||
|
||||
@@ -124,7 +124,7 @@ O CrewAI CLI oferece vários comandos para gerenciar suas implantações:
|
||||
|
||||
## Opção 2: Implantar Diretamente pela Interface Web
|
||||
|
||||
Você também pode implantar seus crews diretamente pela interface web da CrewAI Enterprise conectando sua conta do GitHub. Esta abordagem não requer utilizar a CLI na sua máquina local.
|
||||
Você também pode implantar seus crews diretamente pela interface web da CrewAI AMP conectando sua conta do GitHub. Esta abordagem não requer utilizar a CLI na sua máquina local.
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -134,9 +134,9 @@ Você também pode implantar seus crews diretamente pela interface web da CrewAI
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Conectando o GitHub ao CrewAI Enterprise">
|
||||
<Step title="Conectando o GitHub ao CrewAI AMP">
|
||||
|
||||
1. Faça login em [CrewAI Enterprise](https://app.crewai.com)
|
||||
1. Faça login em [CrewAI AMP](https://app.crewai.com)
|
||||
2. Clique no botão "Connect GitHub"
|
||||
|
||||
<Frame>
|
||||
@@ -190,7 +190,7 @@ Você também pode implantar seus crews diretamente pela interface web da CrewAI
|
||||
## ⚠️ Requisitos de Segurança para Variáveis de Ambiente
|
||||
|
||||
<Warning>
|
||||
**Importante**: A CrewAI Enterprise possui restrições de segurança sobre os nomes de variáveis de ambiente que podem causar falha na implantação caso não sejam seguidas.
|
||||
**Importante**: A CrewAI AMP possui restrições de segurança sobre os nomes de variáveis de ambiente que podem causar falha na implantação caso não sejam seguidas.
|
||||
</Warning>
|
||||
|
||||
### Padrões de Variáveis de Ambiente Bloqueados
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Ativar Crew Studio"
|
||||
description: "Ativando o Crew Studio no CrewAI Enterprise"
|
||||
description: "Ativando o Crew Studio no CrewAI AMP"
|
||||
icon: "comments"
|
||||
mode: "wide"
|
||||
---
|
||||
@@ -24,7 +24,7 @@ Com o Crew Studio, você pode:
|
||||
- Selecionar as ferramentas apropriadas
|
||||
- Configurar os inputs necessários
|
||||
- Gerar código para download e personalização
|
||||
- Fazer deploy diretamente na plataforma CrewAI Enterprise
|
||||
- Fazer deploy diretamente na plataforma CrewAI AMP
|
||||
|
||||
## Etapas de Configuração
|
||||
|
||||
@@ -32,14 +32,14 @@ Antes de começar a usar o Crew Studio, você precisa configurar suas conexões
|
||||
|
||||
<Steps>
|
||||
<Step title="Configurar a Conexão LLM">
|
||||
Acesse a aba **LLM Connections** no painel do CrewAI Enterprise e crie uma nova conexão LLM.
|
||||
Acesse a aba **LLM Connections** no painel do CrewAI AMP e crie uma nova conexão LLM.
|
||||
|
||||
<Note>
|
||||
Sinta-se à vontade para utilizar qualquer provedor LLM suportado pelo CrewAI.
|
||||
</Note>
|
||||
|
||||
|
||||
Configure sua conexão LLM:
|
||||
|
||||
|
||||
- Insira um `Connection Name` (por exemplo, `OpenAI`)
|
||||
- Selecione o provedor do modelo: `openai` ou `azure`
|
||||
- Selecione os modelos que deseja usar em suas Crews geradas pelo Studio
|
||||
@@ -48,28 +48,28 @@ Antes de começar a usar o Crew Studio, você precisa configurar suas conexões
|
||||
- Para OpenAI: adicione `OPENAI_API_KEY` com sua chave de API
|
||||
- Para Azure OpenAI: consulte [este artigo](https://blog.crewai.com/configuring-azure-openai-with-crewai-a-comprehensive-guide/) para detalhes de configuração
|
||||
- Clique em `Add Connection` para salvar sua configuração
|
||||
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Verificar Conexão Adicionada">
|
||||
Assim que concluir a configuração, você verá sua nova conexão adicionada à lista de conexões disponíveis.
|
||||
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Configurar Padrões do LLM">
|
||||
No menu principal, vá em **Settings → Defaults** e configure as opções padrão do LLM:
|
||||
|
||||
|
||||
- Selecione os modelos padrão para agentes e outros componentes
|
||||
- Defina as configurações padrão para o Crew Studio
|
||||
|
||||
|
||||
Clique em `Save Settings` para aplicar as alterações.
|
||||
|
||||
|
||||
<Frame>
|
||||
|
||||
</Frame>
|
||||
@@ -82,38 +82,38 @@ Agora que você configurou sua conexão LLM e os padrões, está pronto para com
|
||||
|
||||
<Steps>
|
||||
<Step title="Acessar o Studio">
|
||||
Navegue até a seção **Studio** no painel do CrewAI Enterprise.
|
||||
Navegue até a seção **Studio** no painel do CrewAI AMP.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Iniciar uma Conversa">
|
||||
Inicie uma conversa com o Crew Assistant descrevendo o problema que deseja resolver:
|
||||
|
||||
|
||||
```md
|
||||
I need a crew that can research the latest AI developments and create a summary report.
|
||||
```
|
||||
|
||||
|
||||
O Crew Assistant fará perguntas de esclarecimento para entender melhor suas necessidades.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Revisar o Crew Gerado">
|
||||
Revise a configuração do crew gerado, incluindo:
|
||||
|
||||
|
||||
- Agentes e seus papéis
|
||||
- Tarefas a serem realizadas
|
||||
- Inputs necessários
|
||||
- Ferramentas a serem utilizadas
|
||||
|
||||
|
||||
Esta é sua oportunidade para refinar a configuração antes de prosseguir.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Fazer Deploy ou Baixar">
|
||||
Quando estiver satisfeito com a configuração, você pode:
|
||||
|
||||
|
||||
- Baixar o código gerado para personalização local
|
||||
- Fazer deploy do crew diretamente na plataforma CrewAI Enterprise
|
||||
- Fazer deploy do crew diretamente na plataforma CrewAI AMP
|
||||
- Modificar a configuração e gerar o crew novamente
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Testar seu Crew">
|
||||
Após o deploy, teste seu crew com inputs de exemplo para garantir que ele funcione conforme esperado.
|
||||
</Step>
|
||||
@@ -130,37 +130,37 @@ Veja um fluxo de trabalho típico para criação de um crew com o Crew Studio:
|
||||
<Steps>
|
||||
<Step title="Descreva seu Problema">
|
||||
Comece descrevendo seu problema:
|
||||
|
||||
|
||||
```md
|
||||
I need a crew that can analyze financial news and provide investment recommendations
|
||||
```
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Responder Perguntas">
|
||||
Responda às perguntas de esclarecimento do Crew Assistant para refinar seus requisitos.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Revisar o Plano">
|
||||
Revise o plano do crew gerado, que pode incluir:
|
||||
|
||||
|
||||
- Um Research Agent para coletar notícias financeiras
|
||||
- Um Analysis Agent para interpretar os dados
|
||||
- Um Recommendations Agent para fornecer conselhos de investimento
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Aprovar ou Modificar">
|
||||
Aprove o plano ou solicite alterações, se necessário.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Baixar ou Fazer Deploy">
|
||||
Baixe o código para personalização ou faça o deploy diretamente na plataforma.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Testar e Refinar">
|
||||
Teste seu crew com inputs de exemplo e faça ajustes conforme necessário.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para obter assistência com o Crew Studio ou qualquer outro recurso do CrewAI Enterprise.
|
||||
</Card>
|
||||
Entre em contato com nossa equipe de suporte para obter assistência com o Crew Studio ou qualquer outro recurso do CrewAI AMP.
|
||||
</Card>
|
||||
|
||||
85
docs/pt-BR/enterprise/guides/gmail-trigger.mdx
Normal file
85
docs/pt-BR/enterprise/guides/gmail-trigger.mdx
Normal file
@@ -0,0 +1,85 @@
|
||||
---
|
||||
title: "Gmail Trigger"
|
||||
description: "Trigger automations when Gmail events occur (e.g., new emails, labels)."
|
||||
icon: "envelope"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Use the Gmail Trigger to kick off your deployed crews when Gmail events happen in connected accounts, such as receiving a new email or messages matching a label/filter.
|
||||
|
||||
<Tip>
|
||||
Make sure Gmail is connected in Tools & Integrations and the trigger is enabled for your deployment.
|
||||
</Tip>
|
||||
|
||||
## Enabling the Gmail Trigger
|
||||
|
||||
1. Open your deployment in CrewAI AMP
|
||||
2. Go to the **Triggers** tab
|
||||
3. Locate **Gmail** and switch the toggle to enable
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/trigger-selected.png" alt="Enable or disable triggers with toggle" />
|
||||
</Frame>
|
||||
|
||||
## Example: Process new emails
|
||||
|
||||
When a new email arrives, the Gmail Trigger will send the payload to your Crew or Flow. Below is a Crew example that parses and processes the trigger payload.
|
||||
|
||||
```python
|
||||
@CrewBase
|
||||
class GmailProcessingCrew:
|
||||
@agent
|
||||
def parser(self) -> Agent:
|
||||
return Agent(
|
||||
config=self.agents_config['parser'],
|
||||
)
|
||||
|
||||
@task
|
||||
def parse_gmail_payload(self) -> Task:
|
||||
return Task(
|
||||
config=self.tasks_config['parse_gmail_payload'],
|
||||
agent=self.parser(),
|
||||
)
|
||||
|
||||
@task
|
||||
def act_on_email(self) -> Task:
|
||||
return Task(
|
||||
config=self.tasks_config['act_on_email'],
|
||||
agent=self.parser(),
|
||||
)
|
||||
```
|
||||
|
||||
The Gmail payload will be available via the standard context mechanisms. See the payload samples repository for structure and fields.
|
||||
|
||||
### Sample payloads & crews
|
||||
|
||||
The [CrewAI AMP Trigger Examples repository](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail) includes:
|
||||
|
||||
- `new-email-payload-1.json` / `new-email-payload-2.json` — production-style new message alerts with matching crews in `new-email-crew.py`
|
||||
- `thread-updated-sample-1.json` — follow-up messages on an existing thread, processed by `gmail-alert-crew.py`
|
||||
|
||||
Use these samples to validate your parsing logic locally before wiring the trigger to your live Gmail accounts.
|
||||
|
||||
## Monitoring Executions
|
||||
|
||||
Track history and performance of triggered runs:
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/list-executions.png" alt="List of executions triggered by automation" />
|
||||
</Frame>
|
||||
|
||||
## Payload Reference
|
||||
|
||||
See the sample payloads and field descriptions:
|
||||
|
||||
<Card title="Gmail samples in Trigger Examples Repo" href="https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail" icon="envelopes-bulk">
|
||||
Gmail samples in Trigger Examples Repo
|
||||
</Card>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- Ensure Gmail is connected in Tools & Integrations
|
||||
- Verify the Gmail Trigger is enabled on the Triggers tab
|
||||
- Check the execution logs and confirm the payload is passed as `crewai_trigger_payload`
|
||||
65
docs/pt-BR/enterprise/guides/google-calendar-trigger.mdx
Normal file
65
docs/pt-BR/enterprise/guides/google-calendar-trigger.mdx
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: "Google Calendar Trigger"
|
||||
description: "Kick off crews when Google Calendar events are created, updated, or cancelled"
|
||||
icon: "calendar"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Use the Google Calendar trigger to launch automations whenever calendar events change. Common use cases include briefing a team before a meeting, notifying stakeholders when a critical event is cancelled, or summarizing daily schedules.
|
||||
|
||||
<Tip>
|
||||
Make sure Google Calendar is connected in **Tools & Integrations** and enabled for the deployment you want to automate.
|
||||
</Tip>
|
||||
|
||||
## Enabling the Google Calendar Trigger
|
||||
|
||||
1. Open your deployment in CrewAI AMP
|
||||
2. Go to the **Triggers** tab
|
||||
3. Locate **Google Calendar** and switch the toggle to enable
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/calendar-trigger.png" alt="Enable or disable triggers with toggle" />
|
||||
</Frame>
|
||||
|
||||
## Example: Summarize meeting details
|
||||
|
||||
The snippet below mirrors the `calendar-event-crew.py` example in the trigger repository. It parses the payload, analyses the attendees and timing, and produces a meeting brief for downstream tools.
|
||||
|
||||
```python
|
||||
from calendar_event_crew import GoogleCalendarEventTrigger
|
||||
|
||||
crew = GoogleCalendarEventTrigger().crew()
|
||||
result = crew.kickoff({
|
||||
"crewai_trigger_payload": calendar_payload,
|
||||
})
|
||||
print(result.raw)
|
||||
```
|
||||
|
||||
Use `crewai_trigger_payload` exactly as it is delivered by the trigger so the crew can extract the proper fields.
|
||||
|
||||
## Sample payloads & crews
|
||||
|
||||
The [Google Calendar examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_calendar) show how to handle multiple event types:
|
||||
|
||||
- `new-event.json` → standard event creation handled by `calendar-event-crew.py`
|
||||
- `event-updated.json` / `event-started.json` / `event-ended.json` → in-flight updates processed by `calendar-meeting-crew.py`
|
||||
- `event-canceled.json` → cancellation workflow that alerts attendees via `calendar-meeting-crew.py`
|
||||
- Working location events use `calendar-working-location-crew.py` to extract on-site schedules
|
||||
|
||||
Each crew transforms raw event metadata (attendees, rooms, working locations) into the summaries your teams need.
|
||||
|
||||
## Monitoring Executions
|
||||
|
||||
The **Executions** list in the deployment dashboard tracks every triggered run and surfaces payload metadata, output summaries, and errors.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/list-executions.png" alt="List of executions triggered by automation" />
|
||||
</Frame>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- Ensure the correct Google account is connected and the trigger is enabled
|
||||
- Confirm your workflow handles all-day events (payloads use `start.date` and `end.date` instead of timestamps)
|
||||
- Check execution logs if reminders or attendee arrays are missing—calendar permissions can limit fields in the payload
|
||||
61
docs/pt-BR/enterprise/guides/google-drive-trigger.mdx
Normal file
61
docs/pt-BR/enterprise/guides/google-drive-trigger.mdx
Normal file
@@ -0,0 +1,61 @@
|
||||
---
|
||||
title: "Google Drive Trigger"
|
||||
description: "Respond to Google Drive file events with automated crews"
|
||||
icon: "folder"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Trigger your automations when files are created, updated, or removed in Google Drive. Typical workflows include summarizing newly uploaded content, enforcing sharing policies, or notifying owners when critical files change.
|
||||
|
||||
<Tip>
|
||||
Connect Google Drive in **Tools & Integrations** and confirm the trigger is enabled for the automation you want to monitor.
|
||||
</Tip>
|
||||
|
||||
## Enabling the Google Drive Trigger
|
||||
|
||||
1. Open your deployment in CrewAI AMP
|
||||
2. Go to the **Triggers** tab
|
||||
3. Locate **Google Drive** and switch the toggle to enable
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/gdrive-trigger.png" alt="Enable or disable triggers with toggle" />
|
||||
</Frame>
|
||||
|
||||
## Example: Summarize file activity
|
||||
|
||||
The drive example crews parse the payload to extract file metadata, evaluate permissions, and publish a summary.
|
||||
|
||||
```python
|
||||
from drive_file_crew import GoogleDriveFileTrigger
|
||||
|
||||
crew = GoogleDriveFileTrigger().crew()
|
||||
crew.kickoff({
|
||||
"crewai_trigger_payload": drive_payload,
|
||||
})
|
||||
```
|
||||
|
||||
## Sample payloads & crews
|
||||
|
||||
Explore the [Google Drive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_drive) to cover different operations:
|
||||
|
||||
- `new-file.json` → new uploads processed by `drive-file-crew.py`
|
||||
- `updated-file.json` → file edits and metadata changes handled by `drive-file-crew.py`
|
||||
- `deleted-file.json` → deletion events routed through `drive-file-deletion-crew.py`
|
||||
|
||||
Each crew highlights the file name, operation type, owner, permissions, and security considerations so downstream systems can respond appropriately.
|
||||
|
||||
## Monitoring Executions
|
||||
|
||||
Track history and performance of triggered runs with the **Executions** list in the deployment dashboard.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/list-executions.png" alt="List of executions triggered by automation" />
|
||||
</Frame>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- Verify Google Drive is connected and the trigger toggle is enabled
|
||||
- If a payload is missing permission data, ensure the connected account has access to the file or folder
|
||||
- The trigger sends file IDs only; use the Drive API if you need to fetch binary content during the crew run
|
||||
@@ -5,22 +5,22 @@ icon: "hubspot"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
Este guia fornece um processo passo a passo para configurar gatilhos do HubSpot para o CrewAI Enterprise, permitindo iniciar crews diretamente a partir de Workflows do HubSpot.
|
||||
Este guia fornece um processo passo a passo para configurar gatilhos do HubSpot para o CrewAI AMP, permitindo iniciar crews diretamente a partir de Workflows do HubSpot.
|
||||
|
||||
## Pré-requisitos
|
||||
|
||||
- Uma conta CrewAI Enterprise
|
||||
- Uma conta CrewAI AMP
|
||||
- Uma conta HubSpot com o recurso de [Workflows do HubSpot](https://knowledge.hubspot.com/workflows/create-workflows)
|
||||
|
||||
## Etapas de Configuração
|
||||
|
||||
<Steps>
|
||||
<Step title="Conecte sua conta HubSpot com o CrewAI Enterprise">
|
||||
- Faça login na sua `Conta CrewAI Enterprise > Triggers`
|
||||
<Step title="Conecte sua conta HubSpot com o CrewAI AMP">
|
||||
- Faça login na sua `Conta CrewAI AMP > Triggers`
|
||||
- Selecione `HubSpot` na lista de gatilhos disponíveis
|
||||
- Escolha a conta HubSpot que deseja conectar ao CrewAI Enterprise
|
||||
- Siga as instruções na tela para autorizar o acesso do CrewAI Enterprise à sua conta HubSpot
|
||||
- Uma mensagem de confirmação aparecerá assim que o HubSpot estiver conectado com sucesso ao CrewAI Enterprise
|
||||
- Escolha a conta HubSpot que deseja conectar ao CrewAI AMP
|
||||
- Siga as instruções na tela para autorizar o acesso do CrewAI AMP à sua conta HubSpot
|
||||
- Uma mensagem de confirmação aparecerá assim que o HubSpot estiver conectado com sucesso ao CrewAI AMP
|
||||
</Step>
|
||||
<Step title="Crie um Workflow no HubSpot">
|
||||
- Faça login na sua `Conta HubSpot > Automations > Workflows > New workflow`
|
||||
@@ -51,4 +51,4 @@ Este guia fornece um processo passo a passo para configurar gatilhos do HubSpot
|
||||
|
||||
## Recursos Adicionais
|
||||
|
||||
Para informações mais detalhadas sobre as ações disponíveis e opções de personalização, consulte a [Documentação de Workflows do HubSpot](https://knowledge.hubspot.com/workflows/create-workflows).
|
||||
Para informações mais detalhadas sobre as ações disponíveis e opções de personalização, consulte a [Documentação de Workflows do HubSpot](https://knowledge.hubspot.com/workflows/create-workflows).
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
title: "Kickoff Crew"
|
||||
description: "Inicie um Crew no CrewAI Enterprise"
|
||||
description: "Inicie um Crew no CrewAI AMP"
|
||||
icon: "flag-checkered"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Visão Geral
|
||||
|
||||
Uma vez que você tenha implantado seu crew na plataforma CrewAI Enterprise, é possível iniciar execuções pela interface web ou pela API. Este guia aborda ambos os métodos.
|
||||
Uma vez que você tenha implantado seu crew na plataforma CrewAI AMP, é possível iniciar execuções pela interface web ou pela API. Este guia aborda ambos os métodos.
|
||||
|
||||
## Método 1: Usando a Interface Web
|
||||
|
||||
### Passo 1: Navegue até seu Crew Implantado
|
||||
|
||||
1. Faça login no [CrewAI Enterprise](https://app.crewai.com)
|
||||
1. Faça login no [CrewAI AMP](https://app.crewai.com)
|
||||
2. Clique no nome do crew na sua lista de projetos
|
||||
3. Você será direcionado para a página de detalhes do crew
|
||||
|
||||
@@ -83,7 +83,7 @@ Quando a execução for concluída:
|
||||
|
||||
## Método 2: Usando a API
|
||||
|
||||
Você também pode iniciar crews programaticamente usando a REST API do CrewAI Enterprise.
|
||||
Você também pode iniciar crews programaticamente usando a REST API do CrewAI AMP.
|
||||
|
||||
### Autenticação
|
||||
|
||||
@@ -183,4 +183,4 @@ Se uma execução falhar:
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para obter ajuda com problemas de execução ou dúvidas sobre a plataforma Enterprise.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
52
docs/pt-BR/enterprise/guides/microsoft-teams-trigger.mdx
Normal file
52
docs/pt-BR/enterprise/guides/microsoft-teams-trigger.mdx
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: "Microsoft Teams Trigger"
|
||||
description: "Kick off crews from Microsoft Teams chat activity"
|
||||
icon: "microsoft"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Use the Microsoft Teams trigger to start automations whenever a new chat is created. Common patterns include summarizing inbound requests, routing urgent messages to support teams, or creating follow-up tasks in other systems.
|
||||
|
||||
<Tip>
|
||||
Confirm Microsoft Teams is connected under **Tools & Integrations** and enabled in the **Triggers** tab for your deployment.
|
||||
</Tip>
|
||||
|
||||
## Enabling the Microsoft Teams Trigger
|
||||
|
||||
1. Open your deployment in CrewAI AMP
|
||||
2. Go to the **Triggers** tab
|
||||
3. Locate **Microsoft Teams** and switch the toggle to enable
|
||||
|
||||
<Frame caption="Microsoft Teams trigger connection">
|
||||
<img src="/images/enterprise/msteams-trigger.png" alt="Enable or disable triggers with toggle" />
|
||||
</Frame>
|
||||
|
||||
## Example: Summarize a new chat thread
|
||||
|
||||
```python
|
||||
from teams_chat_created_crew import MicrosoftTeamsChatTrigger
|
||||
|
||||
crew = MicrosoftTeamsChatTrigger().crew()
|
||||
result = crew.kickoff({
|
||||
"crewai_trigger_payload": teams_payload,
|
||||
})
|
||||
print(result.raw)
|
||||
```
|
||||
|
||||
The crew parses thread metadata (subject, created time, roster) and generates an action plan for the receiving team.
|
||||
|
||||
## Sample payloads & crews
|
||||
|
||||
The [Microsoft Teams examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/microsoft-teams) include:
|
||||
|
||||
- `chat-created.json` → chat creation payload processed by `teams-chat-created-crew.py`
|
||||
|
||||
The crew demonstrates how to extract participants, initial messages, tenant information, and compliance metadata from the Microsoft Graph webhook payload.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- Ensure the Teams connection is active; it must be refreshed if the tenant revokes permissions
|
||||
- Confirm the webhook subscription in Microsoft 365 is still valid if payloads stop arriving
|
||||
- Review execution logs for payload shape mismatches—Graph notifications may omit fields when a chat is private or restricted
|
||||
53
docs/pt-BR/enterprise/guides/onedrive-trigger.mdx
Normal file
53
docs/pt-BR/enterprise/guides/onedrive-trigger.mdx
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: "OneDrive Trigger"
|
||||
description: "Automate responses to OneDrive file activity"
|
||||
icon: "cloud"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Start automations when files change inside OneDrive. You can generate audit summaries, notify security teams about external sharing, or update downstream line-of-business systems with new document metadata.
|
||||
|
||||
<Tip>
|
||||
Connect OneDrive in **Tools & Integrations** and toggle the trigger on for your deployment.
|
||||
</Tip>
|
||||
|
||||
## Enabling the OneDrive Trigger
|
||||
|
||||
1. Open your deployment in CrewAI AMP
|
||||
2. Go to the **Triggers** tab
|
||||
3. Locate **OneDrive** and switch the toggle to enable
|
||||
|
||||
<Frame caption="Microsoft OneDrive trigger connection">
|
||||
<img src="/images/enterprise/onedrive-trigger.png" alt="Enable or disable triggers with toggle" />
|
||||
</Frame>
|
||||
|
||||
## Example: Audit file permissions
|
||||
|
||||
```python
|
||||
from onedrive_file_crew import OneDriveFileTrigger
|
||||
|
||||
crew = OneDriveFileTrigger().crew()
|
||||
crew.kickoff({
|
||||
"crewai_trigger_payload": onedrive_payload,
|
||||
})
|
||||
```
|
||||
|
||||
The crew inspects file metadata, user activity, and permission changes to produce a compliance-friendly summary.
|
||||
|
||||
## Sample payloads & crews
|
||||
|
||||
The [OneDrive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/onedrive) showcase how to:
|
||||
|
||||
- Parse file metadata, size, and folder paths
|
||||
- Track who created and last modified the file
|
||||
- Highlight permission and external sharing changes
|
||||
|
||||
`onedrive-file-crew.py` bundles the analysis and summarization tasks so you can add remediation steps as needed.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- Ensure the connected account has permission to read the file metadata included in the webhook
|
||||
- If the trigger fires but the payload is missing `permissions`, confirm the site-level sharing settings allow Graph to return this field
|
||||
- For large tenants, filter notifications upstream so the crew only runs on relevant directories
|
||||
52
docs/pt-BR/enterprise/guides/outlook-trigger.mdx
Normal file
52
docs/pt-BR/enterprise/guides/outlook-trigger.mdx
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: "Outlook Trigger"
|
||||
description: "Launch automations from Outlook emails and calendar updates"
|
||||
icon: "microsoft"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Automate responses when Outlook delivers a new message or when an event is removed from the calendar. Teams commonly route escalations, file tickets, or alert attendees of cancellations.
|
||||
|
||||
<Tip>
|
||||
Connect Outlook in **Tools & Integrations** and ensure the trigger is enabled for your deployment.
|
||||
</Tip>
|
||||
|
||||
## Enabling the Outlook Trigger
|
||||
|
||||
1. Open your deployment in CrewAI AMP
|
||||
2. Go to the **Triggers** tab
|
||||
3. Locate **Outlook** and switch the toggle to enable
|
||||
|
||||
<Frame caption="Microsoft Outlook trigger connection">
|
||||
<img src="/images/enterprise/outlook-trigger.png" alt="Enable or disable triggers with toggle" />
|
||||
</Frame>
|
||||
|
||||
## Example: Summarize a new email
|
||||
|
||||
```python
|
||||
from outlook_message_crew import OutlookMessageTrigger
|
||||
|
||||
crew = OutlookMessageTrigger().crew()
|
||||
crew.kickoff({
|
||||
"crewai_trigger_payload": outlook_payload,
|
||||
})
|
||||
```
|
||||
|
||||
The crew extracts sender details, subject, body preview, and attachments before generating a structured response.
|
||||
|
||||
## Sample payloads & crews
|
||||
|
||||
Review the [Outlook examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/outlook) for two common scenarios:
|
||||
|
||||
- `new-message.json` → new mail notifications parsed by `outlook-message-crew.py`
|
||||
- `event-removed.json` → calendar cleanup handled by `outlook-event-removal-crew.py`
|
||||
|
||||
Each crew demonstrates how to handle Microsoft Graph payloads, normalize headers, and keep humans in-the-loop with concise summaries.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- Verify the Outlook connector is still authorized; the subscription must be renewed periodically
|
||||
- If attachments are missing, confirm the webhook subscription includes the `includeResourceData` flag
|
||||
- Review execution logs when events fail to match—cancellation payloads lack attendee lists by design and the crew should account for that
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
title: "Exportação de Componentes React"
|
||||
description: "Aprenda como exportar e integrar componentes React do CrewAI Enterprise em suas aplicações"
|
||||
description: "Aprenda como exportar e integrar componentes React do CrewAI AMP em suas aplicações"
|
||||
icon: "react"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
Este guia explica como exportar crews do CrewAI Enterprise como componentes React e integrá-los às suas próprias aplicações.
|
||||
Este guia explica como exportar crews do CrewAI AMP como componentes React e integrá-los às suas próprias aplicações.
|
||||
|
||||
## Exportando um Componente React
|
||||
|
||||
@@ -38,7 +38,7 @@ Para executar este componente React localmente, você precisará configurar um a
|
||||
npx create-react-app my-crew-app
|
||||
```
|
||||
- Entre no diretório do projeto:
|
||||
|
||||
|
||||
```bash
|
||||
cd my-crew-app
|
||||
```
|
||||
@@ -77,7 +77,7 @@ Para executar este componente React localmente, você precisará configurar um a
|
||||
|
||||
<Step title="Inicie o servidor de desenvolvimento">
|
||||
- No diretório do seu projeto, execute:
|
||||
|
||||
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
@@ -101,4 +101,4 @@ Você pode então personalizar o `CrewLead.jsx` para adicionar cor, título etc.
|
||||
- Personalize o estilo do componente para combinar com o design da sua aplicação
|
||||
- Adicione props adicionais para configuração
|
||||
- Integre com o gerenciamento de estado da sua aplicação
|
||||
- Adicione tratamento de erros e estados de carregamento
|
||||
- Adicione tratamento de erros e estados de carregamento
|
||||
|
||||
@@ -5,7 +5,7 @@ icon: "salesforce"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
A CrewAI Enterprise pode ser acionada a partir do Salesforce para automatizar fluxos de trabalho de gestão de relacionamento com o cliente e aprimorar suas operações de vendas.
|
||||
A CrewAI AMP pode ser acionada a partir do Salesforce para automatizar fluxos de trabalho de gestão de relacionamento com o cliente e aprimorar suas operações de vendas.
|
||||
|
||||
## Visão Geral
|
||||
|
||||
@@ -18,15 +18,20 @@ O Salesforce é uma das principais plataformas de gestão de relacionamento com
|
||||
|
||||
## Demonstração
|
||||
|
||||
<Frame>
|
||||
<iframe width="100%" height="400" src="https://www.youtube.com/embed/oJunVqjjfu4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</Frame>
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/oJunVqjjfu4"
|
||||
title="Demonstração de trigger CrewAI + Salesforce"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Primeiros Passos
|
||||
|
||||
Para configurar triggers no Salesforce:
|
||||
|
||||
1. **Contato com o Suporte**: Entre em contato com o suporte da CrewAI Enterprise para obter assistência na configuração dos triggers no Salesforce
|
||||
1. **Contato com o Suporte**: Entre em contato com o suporte da CrewAI AMP para obter assistência na configuração dos triggers no Salesforce
|
||||
2. **Revisar Requisitos**: Certifique-se de possuir as permissões necessárias no Salesforce e acesso à API
|
||||
3. **Configurar Conexão**: Trabalhe com a equipe de suporte para estabelecer a conexão entre a CrewAI e sua instância do Salesforce
|
||||
4. **Testar Triggers**: Verifique se os triggers funcionam corretamente para os seus casos de uso específicos
|
||||
@@ -42,4 +47,4 @@ Cenários comuns de uso de triggers Salesforce + CrewAI incluem:
|
||||
|
||||
## Próximos Passos
|
||||
|
||||
Para instruções detalhadas de configuração e opções avançadas, entre em contato com o suporte da CrewAI Enterprise, que pode fornecer orientações personalizadas para o seu ambiente Salesforce e necessidades de negócio.
|
||||
Para instruções detalhadas de configuração e opções avançadas, entre em contato com o suporte da CrewAI AMP, que pode fornecer orientações personalizadas para o seu ambiente Salesforce e necessidades de negócio.
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
---
|
||||
title: "Gestão de Equipes"
|
||||
description: "Aprenda como convidar e gerenciar membros da equipe em sua organização CrewAI Enterprise"
|
||||
description: "Aprenda como convidar e gerenciar membros da equipe em sua organização CrewAI AMP"
|
||||
icon: "users"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
Como administrador de uma conta CrewAI Enterprise, você pode facilmente convidar novos membros para sua organização. Este guia irá orientá-lo passo a passo pelo processo.
|
||||
Como administrador de uma conta CrewAI AMP, você pode facilmente convidar novos membros para sua organização. Este guia irá orientá-lo passo a passo pelo processo.
|
||||
|
||||
## Convidando Membros da Equipe
|
||||
|
||||
<Steps>
|
||||
<Step title="Acesse a Página de Configurações">
|
||||
- Faça login na sua conta CrewAI Enterprise
|
||||
- Faça login na sua conta CrewAI AMP
|
||||
- Procure o ícone de engrenagem (⚙️) no canto superior direito do painel
|
||||
- Clique no ícone de engrenagem para acessar a página de **Configurações**:
|
||||
<Frame>
|
||||
@@ -43,7 +43,7 @@ Você pode adicionar funções aos membros da equipe para controlar o acesso a d
|
||||
|
||||
<Steps>
|
||||
<Step title="Acesse a Página de Configurações">
|
||||
- Faça login na sua conta CrewAI Enterprise
|
||||
- Faça login na sua conta CrewAI AMP
|
||||
- Procure o ícone de engrenagem (⚙️) no canto superior direito do painel
|
||||
- Clique no ícone de engrenagem para acessar a página de **Configurações**:
|
||||
<Frame>
|
||||
@@ -85,4 +85,4 @@ Você pode adicionar funções aos membros da equipe para controlar o acesso a d
|
||||
- **Aceite do Convite**: Os membros convidados precisarão aceitar o convite para ingressar na sua organização
|
||||
- **Notificações por E-mail**: Oriente seus membros a verificarem o e-mail (incluindo a pasta de spam) para localizar o convite
|
||||
|
||||
Seguindo estes passos, você conseguirá expandir sua equipe e colaborar de forma mais eficaz dentro da sua organização CrewAI Enterprise.
|
||||
Seguindo estes passos, você conseguirá expandir sua equipe e colaborar de forma mais eficaz dentro da sua organização CrewAI AMP.
|
||||
|
||||
@@ -14,17 +14,17 @@ As ferramentas podem ser:
|
||||
- **Privadas**: acessíveis apenas dentro da sua organização (padrão)
|
||||
- **Públicas**: acessíveis a todos os usuários CrewAI se publicadas com a flag `--public`
|
||||
|
||||
O repositório não é um sistema de controle de versões. Use o Git para rastrear mudanças no código e permitir colaboração.
|
||||
O repositório não é um sistema de controle de versões. Use Git para rastrear mudanças no código e permitir colaboração.
|
||||
|
||||
## Pré-requisitos
|
||||
|
||||
Antes de usar o Repositório de Ferramentas, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com)
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com)
|
||||
- [CrewAI CLI](https://docs.crewai.com/concepts/cli#cli) instalada
|
||||
- uv>=0.5.0 instalado. Veja [como atualizar](https://docs.astral.sh/uv/getting-started/installation/#upgrading-uv)
|
||||
- [Git](https://git-scm.com) instalado e configurado
|
||||
- Permissões de acesso para publicar ou instalar ferramentas em sua organização CrewAI Enterprise
|
||||
- Permissões de acesso para publicar ou instalar ferramentas em sua organização CrewAI AMP
|
||||
|
||||
## Instalando ferramentas
|
||||
|
||||
@@ -85,7 +85,7 @@ crewai tool publish
|
||||
|
||||
Para excluir uma ferramenta:
|
||||
|
||||
1. Acesse o [CrewAI Enterprise](https://app.crewai.com)
|
||||
1. Acesse o [CrewAI AMP](https://app.crewai.com)
|
||||
2. Navegue até **Ferramentas**
|
||||
3. Selecione a ferramenta
|
||||
4. Clique em **Excluir**
|
||||
@@ -100,9 +100,8 @@ Cada versão publicada passa por verificações automáticas de segurança e só
|
||||
|
||||
Você pode verificar o status das verificações de segurança de uma ferramenta em:
|
||||
|
||||
`CrewAI Enterprise > Tools > Your Tool > Versions`
|
||||
|
||||
`CrewAI AMP > Tools > Your Tool > Versions`
|
||||
|
||||
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para assistência com integração de API ou resolução de problemas.
|
||||
</Card>
|
||||
</Card>
|
||||
@@ -1,12 +1,12 @@
|
||||
---
|
||||
title: "Atualizar Crew"
|
||||
description: "Atualizando uma Crew no CrewAI Enterprise"
|
||||
description: "Atualizando uma Crew no CrewAI AMP"
|
||||
icon: "pencil"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
<Note>
|
||||
Após implantar sua crew no CrewAI Enterprise, pode ser necessário fazer atualizações no código, configurações de segurança ou configuração.
|
||||
Após implantar sua crew no CrewAI AMP, pode ser necessário fazer atualizações no código, configurações de segurança ou configuração.
|
||||
Este guia explica como realizar essas operações de atualização comuns.
|
||||
</Note>
|
||||
|
||||
@@ -23,7 +23,7 @@ Há várias razões para querer atualizar sua implantação de crew:
|
||||
|
||||
Quando você fizer push de novos commits no seu repositório do GitHub e quiser atualizar sua implantação:
|
||||
|
||||
1. Navegue até sua crew na plataforma CrewAI Enterprise
|
||||
1. Navegue até sua crew na plataforma CrewAI AMP
|
||||
2. Clique no botão `Re-deploy` na página de detalhes da sua crew
|
||||
|
||||
<Frame>
|
||||
@@ -36,7 +36,7 @@ Isso irá acionar uma atualização que pode ser acompanhada pela barra de progr
|
||||
|
||||
Se precisar gerar um novo bearer token (por exemplo, se suspeitar que o token atual possa ter sido comprometido):
|
||||
|
||||
1. Navegue até sua crew na plataforma CrewAI Enterprise
|
||||
1. Navegue até sua crew na plataforma CrewAI AMP
|
||||
2. Encontre a seção `Bearer Token`
|
||||
3. Clique no botão `Reset` ao lado do token atual
|
||||
|
||||
@@ -86,4 +86,4 @@ Se encontrar algum problema após a atualização, é possível visualizar os lo
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para obter assistência com a atualização da sua crew ou solução de problemas de implantação.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
---
|
||||
title: "Automação com Webhook"
|
||||
description: "Automatize fluxos de trabalho do CrewAI Enterprise usando webhooks com plataformas como ActivePieces, Zapier e Make.com"
|
||||
description: "Automatize fluxos de trabalho do CrewAI AMP usando webhooks com plataformas como ActivePieces, Zapier e Make.com"
|
||||
icon: "webhook"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
O CrewAI Enterprise permite que você automatize seu fluxo de trabalho usando webhooks. Este artigo irá guiá-lo no processo de configuração e uso de webhooks para iniciar a execução do crew, com foco na integração com o ActivePieces, uma plataforma de automação de fluxos de trabalho semelhante ao Zapier e Make.com.
|
||||
O CrewAI AMP permite que você automatize seu fluxo de trabalho usando webhooks. Este artigo irá guiá-lo no processo de configuração e uso de webhooks para iniciar a execução do crew, com foco na integração com o ActivePieces, uma plataforma de automação de fluxos de trabalho semelhante ao Zapier e Make.com.
|
||||
|
||||
## Configurando Webhooks
|
||||
|
||||
<Steps>
|
||||
<Step title="Acessando a Interface de Kickoff">
|
||||
- Navegue até o painel do CrewAI Enterprise
|
||||
- Navegue até o painel do CrewAI AMP
|
||||
- Procure pela seção `/kickoff`, que é usada para iniciar a execução do crew
|
||||
<Frame>
|
||||
<img src="/images/enterprise/kickoff-interface.png" alt="Interface Kickoff" />
|
||||
@@ -44,7 +44,7 @@ O CrewAI Enterprise permite que você automatize seu fluxo de trabalho usando we
|
||||
3. Adicione uma etapa de ação HTTP
|
||||
- Configure a ação como `Send HTTP request`
|
||||
- Use o método `POST`
|
||||
- Defina a URL para o endpoint de kickoff do CrewAI Enterprise
|
||||
- Defina a URL para o endpoint de kickoff do CrewAI AMP
|
||||
- Adicione os headers necessários (ex.: `Bearer Token`)
|
||||
<Frame>
|
||||
<img src="/images/enterprise/activepieces-headers.png" alt="Headers ActivePieces" />
|
||||
@@ -121,4 +121,4 @@ O CrewAI Enterprise permite que você automatize seu fluxo de trabalho usando we
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
</Tabs>
|
||||
|
||||
@@ -5,11 +5,11 @@ icon: "bolt"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier para o CrewAI Enterprise, permitindo automatizar fluxos de trabalho entre CrewAI Enterprise e outros aplicativos.
|
||||
Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier para o CrewAI AMP, permitindo automatizar fluxos de trabalho entre CrewAI AMP e outros aplicativos.
|
||||
|
||||
## Pré-requisitos
|
||||
|
||||
- Uma conta CrewAI Enterprise
|
||||
- Uma conta CrewAI AMP
|
||||
- Uma conta Zapier
|
||||
- Uma conta Slack (para este exemplo específico)
|
||||
|
||||
@@ -32,7 +32,7 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
|
||||
- Conecte sua conta Slack, caso ainda não tenha feito isso.
|
||||
</Step>
|
||||
|
||||
<Step title="Configure a ação do CrewAI Enterprise">
|
||||
<Step title="Configure a ação do CrewAI AMP">
|
||||
- Adicione uma nova etapa de ação ao seu Zap.
|
||||
- Escolha CrewAI+ como o app de ação e Kickoff como Evento de Ação.
|
||||
|
||||
@@ -41,8 +41,8 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
<Step title="Conecte sua conta CrewAI Enterprise">
|
||||
- Conecte sua conta CrewAI Enterprise.
|
||||
<Step title="Conecte sua conta CrewAI AMP">
|
||||
- Conecte sua conta CrewAI AMP.
|
||||
- Selecione o Crew apropriado para seu fluxo de trabalho.
|
||||
|
||||
<Frame>
|
||||
@@ -51,8 +51,8 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
|
||||
- Configure as entradas para o Crew usando os dados da mensagem do Slack.
|
||||
</Step>
|
||||
|
||||
<Step title="Formate a saída do CrewAI Enterprise">
|
||||
- Adicione outra etapa de ação para formatar a saída de texto do CrewAI Enterprise.
|
||||
<Step title="Formate a saída do CrewAI AMP">
|
||||
- Adicione outra etapa de ação para formatar a saída de texto do CrewAI AMP.
|
||||
- Utilize as ferramentas de formatação do Zapier para converter a saída em Markdown para HTML.
|
||||
|
||||
<Frame>
|
||||
@@ -67,7 +67,7 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
|
||||
- Adicione uma etapa final de ação para enviar a saída formatada por e-mail.
|
||||
- Escolha seu serviço de e-mail preferido (ex.: Gmail, Outlook).
|
||||
- Configure os detalhes do e-mail, incluindo destinatário, assunto e corpo.
|
||||
- Insira a saída formatada do CrewAI Enterprise no corpo do e-mail.
|
||||
- Insira a saída formatada do CrewAI AMP no corpo do e-mail.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/zapier-7.png" alt="Zapier 7" />
|
||||
@@ -97,8 +97,8 @@ Este guia irá conduzi-lo pelo processo de configuração de triggers no Zapier
|
||||
|
||||
## Dicas para o Sucesso
|
||||
|
||||
- Certifique-se de que as entradas do CrewAI Enterprise estejam corretamente mapeadas a partir da mensagem do Slack.
|
||||
- Certifique-se de que as entradas do CrewAI AMP estejam corretamente mapeadas a partir da mensagem do Slack.
|
||||
- Teste seu Zap cuidadosamente antes de ativá-lo para identificar possíveis problemas.
|
||||
- Considere adicionar etapas de tratamento de erros para gerenciar possíveis falhas no fluxo.
|
||||
|
||||
Seguindo estes passos, você terá configurado com sucesso triggers no Zapier para o CrewAI Enterprise, permitindo fluxos de trabalho automatizados disparados por mensagens no Slack e resultando em notificações por e-mail com a saída do CrewAI Enterprise.
|
||||
Seguindo estes passos, você terá configurado com sucesso triggers no Zapier para o CrewAI AMP, permitindo fluxos de trabalho automatizados disparados por mensagens no Slack e resultando em notificações por e-mail com a saída do CrewAI AMP.
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem tarefas, projetos e a coordenação da equipe
|
||||
|
||||
Antes de usar a integração com o Asana, assegure-se de ter:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta Asana com as permissões apropriadas
|
||||
- Sua conta Asana conectada através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de usar a integração com o Asana, assegure-se de ter:
|
||||
|
||||
### 1. Conecte sua Conta Asana
|
||||
|
||||
1. Acesse [CrewAI Enterprise Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Acesse [CrewAI AMP Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Encontre **Asana** na seção Integrações de Autenticação
|
||||
3. Clique em **Conectar** e complete o fluxo OAuth
|
||||
4. Conceda as permissões necessárias para gerenciamento de tarefas e projetos
|
||||
@@ -251,4 +251,4 @@ crew = Crew(
|
||||
)
|
||||
|
||||
crew.kickoff()
|
||||
```
|
||||
```
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem arquivos, pastas e documentos através do Box
|
||||
|
||||
Antes de utilizar a integração com o Box, assegure-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta Box com as permissões apropriadas
|
||||
- Sua conta Box conectada através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de utilizar a integração com o Box, assegure-se de que você possui:
|
||||
|
||||
### 1. Conecte sua conta Box
|
||||
|
||||
1. Acesse [Integrações do CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Acesse [Integrações do CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Encontre **Box** na seção de Integrações de Autenticação
|
||||
3. Clique em **Conectar** e conclua o fluxo de OAuth
|
||||
4. Conceda as permissões necessárias para gerenciamento de arquivos e pastas
|
||||
@@ -266,4 +266,4 @@ crew = Crew(
|
||||
)
|
||||
|
||||
crew.kickoff()
|
||||
```
|
||||
```
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem tarefas, projetos e fluxos de produtividade p
|
||||
|
||||
Antes de utilizar a integração com o ClickUp, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta ClickUp com as permissões apropriadas
|
||||
- Sua conta ClickUp conectada pela [Página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de utilizar a integração com o ClickUp, certifique-se de que você possu
|
||||
|
||||
### 1. Conecte sua Conta ClickUp
|
||||
|
||||
1. Acesse [CrewAI Enterprise Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Acesse [CrewAI AMP Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Encontre **ClickUp** na seção Integrações de Autenticação
|
||||
3. Clique em **Conectar** e complete o fluxo OAuth
|
||||
4. Conceda as permissões necessárias para gerenciamento de tarefas e projetos
|
||||
@@ -291,4 +291,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para auxílio na configuração ou solução de problemas da integração com ClickUp.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem repositórios, issues e releases através do
|
||||
|
||||
Antes de usar a integração do GitHub, assegure-se de ter:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta GitHub com permissões adequadas no repositório
|
||||
- Conta do GitHub conectada através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de usar a integração do GitHub, assegure-se de ter:
|
||||
|
||||
### 1. Conecte sua conta GitHub
|
||||
|
||||
1. Acesse [Integrações CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Acesse [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Encontre **GitHub** na seção de Integrações de Autenticação
|
||||
3. Clique em **Conectar** e complete o fluxo OAuth
|
||||
4. Conceda as permissões necessárias para gerenciamento de repositório e issues
|
||||
@@ -321,4 +321,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para auxílio na configuração ou solução de problemas com a integração do GitHub.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem e-mails, contatos e rascunhos através do Gma
|
||||
|
||||
Antes de usar a integração com o Gmail, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta do Gmail com as permissões adequadas
|
||||
- Conectou sua conta do Gmail através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de usar a integração com o Gmail, certifique-se de que você possui:
|
||||
|
||||
### 1. Conecte sua Conta do Gmail
|
||||
|
||||
1. Navegue até [Integrações CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Navegue até [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Encontre **Gmail** na seção de Integrações de Autenticação
|
||||
3. Clique em **Conectar** e conclua o fluxo OAuth
|
||||
4. Conceda as permissões necessárias para o gerenciamento de e-mail e contato
|
||||
@@ -354,4 +354,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nosso time de suporte para obter assistência na configuração ou solução de problemas da integração Gmail.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem eventos de calendário, agendas e disponibili
|
||||
|
||||
Antes de usar a integração com o Google Calendar, certifique-se de ter:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta Google com acesso ao Google Calendar
|
||||
- Sua conta Google conectada pela [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de usar a integração com o Google Calendar, certifique-se de ter:
|
||||
|
||||
### 1. Conecte sua Conta Google
|
||||
|
||||
1. Acesse [Integrações do CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Acesse [Integrações do CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Encontre **Google Calendar** na seção de Integrações de Autenticação
|
||||
3. Clique em **Conectar** e complete o fluxo OAuth
|
||||
4. Conceda as permissões necessárias para acesso ao calendário e contatos
|
||||
@@ -389,4 +389,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nosso time de suporte para assistência na configuração da integração com o Google Calendar ou solução de problemas.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem dados de planilhas por meio do Google Sheets.
|
||||
|
||||
Antes de utilizar a integração com o Google Sheets, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta Google com acesso ao Google Sheets
|
||||
- Sua conta Google conectada pela [página de integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
- Planilhas com cabeçalhos de coluna adequados para operações com dados
|
||||
@@ -22,7 +22,7 @@ Antes de utilizar a integração com o Google Sheets, certifique-se de que você
|
||||
|
||||
### 1. Conecte sua Conta Google
|
||||
|
||||
1. Acesse [Integrações do CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Acesse [Integrações do CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Localize **Google Sheets** na seção Integrações de Autenticação
|
||||
3. Clique em **Conectar** e conclua o fluxo OAuth
|
||||
4. Conceda as permissões necessárias para acesso à planilha
|
||||
@@ -319,4 +319,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nosso time de suporte para auxílio na configuração ou solução de problemas da integração com o Google Sheets.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem empresas e contatos dentro do HubSpot. Crie n
|
||||
|
||||
Antes de utilizar a integração com o HubSpot, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa.
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa.
|
||||
- Uma conta HubSpot com permissões adequadas.
|
||||
- Sua conta HubSpot conectada pela [página de Integrações](https://app.crewai.com/crewai_plus/connectors).
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de utilizar a integração com o HubSpot, certifique-se de que você possu
|
||||
|
||||
### 1. Conecte Sua Conta HubSpot
|
||||
|
||||
1. Navegue até [CrewAI Enterprise Integrações](https://app.crewai.com/crewai_plus/connectors).
|
||||
1. Navegue até [CrewAI AMP Integrações](https://app.crewai.com/crewai_plus/connectors).
|
||||
2. Encontre **HubSpot** na seção de Integrações de Autenticação.
|
||||
3. Clique em **Conectar** e complete o fluxo OAuth.
|
||||
4. Conceda as permissões necessárias para gerenciamento de empresas e contatos.
|
||||
@@ -577,4 +577,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para assistência na configuração ou solução de problemas com a integração HubSpot.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem problemas, projetos e fluxos de trabalho pelo
|
||||
|
||||
Antes de usar a integração com o Jira, certifique-se de ter:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta Jira com permissões adequadas para o projeto
|
||||
- Sua conta Jira conectada pela [Página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de usar a integração com o Jira, certifique-se de ter:
|
||||
|
||||
### 1. Conectar Sua Conta Jira
|
||||
|
||||
1. Acesse [Integrações CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Acesse [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Encontre **Jira** na seção de Integrações de Autenticação
|
||||
3. Clique em **Conectar** e complete o fluxo do OAuth
|
||||
4. Conceda as permissões necessárias para gestão de issues e projetos
|
||||
@@ -392,4 +392,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nosso time de suporte para obter assistência na configuração ou solução de problemas da integração Jira.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem issues, projetos e fluxos de trabalho de dese
|
||||
|
||||
Antes de utilizar a integração com o Linear, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com uma assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com uma assinatura ativa
|
||||
- Uma conta Linear com permissões apropriadas no workspace
|
||||
- Conectou sua conta Linear através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de utilizar a integração com o Linear, certifique-se de que você possui
|
||||
|
||||
### 1. Conecte sua Conta Linear
|
||||
|
||||
1. Navegue até [Integrações CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Navegue até [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Encontre **Linear** na seção Integrações de Autenticação
|
||||
3. Clique em **Conectar** e complete o fluxo OAuth
|
||||
4. Conceda as permissões necessárias para gerenciamento de issues e projetos
|
||||
@@ -451,4 +451,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para assistência na configuração ou solução de problemas da integração com o Linear.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem páginas, bancos de dados e conteúdos atrav
|
||||
|
||||
Antes de usar a integração com o Notion, certifique-se de que você tem:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta Notion com permissões adequadas no workspace
|
||||
- Sua conta Notion conectada através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
||||
|
||||
@@ -21,7 +21,7 @@ Antes de usar a integração com o Notion, certifique-se de que você tem:
|
||||
|
||||
### 1. Conecte sua Conta Notion
|
||||
|
||||
1. Acesse [Integrações do CrewAI Enterprise](https://app.crewai.com/crewai_plus/connectors)
|
||||
1. Acesse [Integrações do CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
||||
2. Procure por **Notion** na seção de Integrações de Autenticação
|
||||
3. Clique em **Conectar** e complete o fluxo de OAuth
|
||||
4. Conceda as permissões necessárias para gerenciamento de páginas e bancos de dados
|
||||
@@ -507,4 +507,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nosso time de suporte para auxílio na configuração ou solução de problemas com a integração Notion.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem relacionamentos com clientes, processos de ve
|
||||
|
||||
Antes de usar a integração Salesforce, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta Salesforce com permissões apropriadas
|
||||
- Sua conta Salesforce conectada via a [página de Integrações](https://app.crewai.com/integrations)
|
||||
|
||||
@@ -630,4 +630,4 @@ Esta documentação abrangente cobre todas as ferramentas Salesforce organizadas
|
||||
|
||||
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para assistência na configuração da integração com Salesforce ou para resolução de problemas.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem operações de e-commerce através do Shopify
|
||||
|
||||
Antes de utilizar a integração com o Shopify, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com uma assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com uma assinatura ativa
|
||||
- Uma loja Shopify com permissões administrativas adequadas
|
||||
- Sua loja Shopify conectada através da [página de Integrações](https://app.crewai.com/integrations)
|
||||
|
||||
@@ -380,4 +380,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para assistência na configuração ou resolução de problemas de integração com o Shopify.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem a comunicação da equipe pelo Slack. Envie m
|
||||
|
||||
Antes de usar a integração com o Slack, certifique-se de que você tenha:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
||||
- Um workspace do Slack com permissões apropriadas
|
||||
- Seu workspace do Slack conectado por meio da [página de Integrações](https://app.crewai.com/integrations)
|
||||
|
||||
@@ -291,4 +291,4 @@ crew.kickoff()
|
||||
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para obter ajuda na configuração ou solução de problemas da integração com o Slack.
|
||||
</Card>
|
||||
</Card>
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem pagamentos, assinaturas e faturamento de clie
|
||||
|
||||
Antes de usar a integração com o Stripe, certifique-se de que você tem:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com uma assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com uma assinatura ativa
|
||||
- Uma conta Stripe com permissões apropriadas de API
|
||||
- Sua conta Stripe conectada através da [página de Integrações](https://app.crewai.com/integrations)
|
||||
|
||||
@@ -303,4 +303,4 @@ Os metadados permitem que você armazene informações adicionais sobre clientes
|
||||
}
|
||||
```
|
||||
|
||||
Esta integração permite uma automação abrangente do gerenciamento de pagamentos e assinaturas, possibilitando que seus agentes de IA administrem operações de faturamento perfeitamente dentro do seu ecossistema Stripe.
|
||||
Esta integração permite uma automação abrangente do gerenciamento de pagamentos e assinaturas, possibilitando que seus agentes de IA administrem operações de faturamento perfeitamente dentro do seu ecossistema Stripe.
|
||||
|
||||
@@ -13,7 +13,7 @@ Permita que seus agentes gerenciem operações de suporte ao cliente através do
|
||||
|
||||
Antes de usar a integração com o Zendesk, certifique-se de que você possui:
|
||||
|
||||
- Uma conta [CrewAI Enterprise](https://app.crewai.com) com uma assinatura ativa
|
||||
- Uma conta [CrewAI AMP](https://app.crewai.com) com uma assinatura ativa
|
||||
- Uma conta Zendesk com permissões apropriadas de API
|
||||
- Sua conta Zendesk conectada através da [página de Integrações](https://app.crewai.com/integrations)
|
||||
|
||||
@@ -341,4 +341,4 @@ crew = Crew(
|
||||
)
|
||||
|
||||
crew.kickoff()
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "CrewAI Enterprise"
|
||||
title: "CrewAI AMP"
|
||||
description: "Implemente, monitore e escale seus fluxos de trabalho de agentes de IA"
|
||||
icon: "globe"
|
||||
mode: "wide"
|
||||
@@ -7,13 +7,13 @@ mode: "wide"
|
||||
|
||||
## Introdução
|
||||
|
||||
CrewAI Enterprise fornece uma plataforma para implementar, monitorar e escalar seus crews e agentes em um ambiente de produção.
|
||||
CrewAI AMP(Agent Management Platform) fornece uma plataforma para implementar, monitorar e escalar seus crews e agentes em um ambiente de produção.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/enterprise/crewai-enterprise-dashboard.png" alt="CrewAI Enterprise Dashboard" />
|
||||
<img src="/images/enterprise/crewai-enterprise-dashboard.png" alt="CrewAI AMP Dashboard" />
|
||||
</Frame>
|
||||
|
||||
CrewAI Enterprise expande o poder do framework open-source com funcionalidades projetadas para implantações em produção, colaboração e escalabilidade. Implemente seus crews em uma infraestrutura gerenciada e monitore sua execução em tempo real.
|
||||
CrewAI AMP expande o poder do framework open-source com funcionalidades projetadas para implantações em produção, colaboração e escalabilidade. Implemente seus crews em uma infraestrutura gerenciada e monitore sua execução em tempo real.
|
||||
|
||||
## Principais Funcionalidades
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: FAQs
|
||||
description: "Perguntas frequentes sobre CrewAI Enterprise"
|
||||
description: "Perguntas frequentes sobre CrewAI AMP"
|
||||
icon: "circle-question"
|
||||
mode: "wide"
|
||||
---
|
||||
@@ -129,15 +129,14 @@ mode: "wide"
|
||||
</Steps>
|
||||
|
||||
Aqui está um tutorial de como obter saídas estruturadas de forma consistente dos seus agentes:
|
||||
<Frame>
|
||||
<iframe
|
||||
height="400"
|
||||
width="100%"
|
||||
src="https://www.youtube.com/embed/dNpKQk5uxHw"
|
||||
title="YouTube video player" frameborder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowfullscreen></iframe>
|
||||
</Frame>
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/dNpKQk5uxHw"
|
||||
title="Saídas estruturadas no CrewAI"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Como posso criar ferramentas personalizadas para meus agentes CrewAI?">
|
||||
|
||||
102
docs/pt-BR/index.mdx
Normal file
102
docs/pt-BR/index.mdx
Normal file
@@ -0,0 +1,102 @@
|
||||
---
|
||||
title: "CrewAI Documentação"
|
||||
description: "Construa agentes colaborativos, crews e flows — prontos para produção desde o primeiro dia."
|
||||
icon: "house"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
<div
|
||||
style={{
|
||||
display: 'flex',
|
||||
flexDirection: 'column',
|
||||
alignItems: 'center',
|
||||
gap: 20,
|
||||
textAlign: 'center',
|
||||
padding: '48px 24px',
|
||||
borderRadius: 16,
|
||||
background: 'linear-gradient(180deg, rgba(235,102,88,0.12) 0%, rgba(201,76,60,0.08) 100%)',
|
||||
border: '1px solid rgba(235,102,88,0.18)'
|
||||
}}
|
||||
>
|
||||
<img src="/images/crew_only_logo.png" alt="CrewAI" width="250" height="100" />
|
||||
<div style={{ maxWidth: 720 }}>
|
||||
<h1 style={{ marginBottom: 12 }}>Construa sistemas multiagentes com confiança</h1>
|
||||
<p style={{ color: 'var(--mint-text-2)' }}>
|
||||
Crie agentes, orquestre crews e automatize flows com guardrails, memória, conhecimento e observabilidade integrados.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div style={{ display: 'flex', flexWrap: 'wrap', gap: 12, justifyContent: 'center' }}>
|
||||
<a className="button button-primary" href="/pt-BR/quickstart">Começar agora</a>
|
||||
<a className="button button-secondary" href="/pt-BR/changelog">Ver changelog</a>
|
||||
<a className="button button-secondary" href="/pt-BR/api-reference/introduction">API Reference</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style={{ marginTop: 32 }} />
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Introdução" href="/pt-BR/introduction" icon="sparkles">
|
||||
Visão geral dos conceitos da CrewAI, arquitetura e casos de uso para agentes, crews e flows.
|
||||
</Card>
|
||||
<Card title="Instalação" href="/pt-BR/installation" icon="wrench">
|
||||
Instale com `uv`, configure chaves de API e prepare o CLI para desenvolvimento local.
|
||||
</Card>
|
||||
<Card title="Quickstart" href="/pt-BR/quickstart" icon="rocket">
|
||||
Crie sua primeira crew em poucos minutos. Aprenda o runtime, a estrutura do projeto e o loop de desenvolvimento.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Fundamentos
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Agentes" href="/pt-BR/concepts/agents" icon="users">
|
||||
Modele agentes com ferramentas, memória, conhecimento e saídas estruturadas. Inclui templates e boas práticas.
|
||||
</Card>
|
||||
<Card title="Flows" href="/pt-BR/concepts/flows" icon="arrow-progress">
|
||||
Orquestre start/listen/router, gerencie estado, persista execuções e retome processos longos.
|
||||
</Card>
|
||||
<Card title="Tarefas & Processos" href="/pt-BR/concepts/tasks" icon="check">
|
||||
Defina processos sequenciais, hierárquicos ou híbridos com guardrails, callbacks e intervenção humana.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Jornada Enterprise
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Automations" href="/pt-BR/enterprise/features/automations" icon="server">
|
||||
Gerencie ambientes, faça deploy seguro e monitore execuções ao vivo diretamente no console Enterprise.
|
||||
</Card>
|
||||
<Card title="Triggers & Flows" href="/pt-BR/enterprise/guides/automation-triggers" icon="bolt">
|
||||
Conecte Gmail, Slack, Salesforce e muito mais. Injete payloads dos triggers em crews e flows automaticamente.
|
||||
</Card>
|
||||
<Card title="Gestão de times" href="/pt-BR/enterprise/guides/team-management" icon="users-gear">
|
||||
Convide integrantes, configure RBAC e controle o acesso às automations em produção.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Novidades
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Visão geral de triggers" href="/pt-BR/enterprise/guides/automation-triggers" icon="sparkles">
|
||||
Guia unificado para Gmail, Drive, Outlook, Teams, OneDrive, HubSpot e outros — com payloads e crews de exemplo.
|
||||
</Card>
|
||||
<Card title="Ferramentas de integração" href="/pt-BR/tools/integration/overview" icon="plug">
|
||||
Chame automations CrewAI existentes ou agentes do Amazon Bedrock diretamente das suas crews.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
<Callout title="Explore exemplos práticos" icon="github">
|
||||
Acesse os <a href="/pt-BR/examples/cookbooks">examples e cookbooks</a> para implementações completas envolvendo agentes, flows e automations Enterprise.
|
||||
</Callout>
|
||||
|
||||
## Conecte-se
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Star no GitHub" href="https://github.com/crewAIInc/crewAI" icon="star">
|
||||
Se a CrewAI acelera seu trabalho, deixe uma estrela e compartilhe seus projetos com a comunidade.
|
||||
</Card>
|
||||
<Card title="Participe da comunidade" href="https://community.crewai.com" icon="comments">
|
||||
Tire dúvidas, divulgue workflows e solicite recursos junto a outros builders.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -9,14 +9,12 @@ mode: "wide"
|
||||
Assista a este tutorial em vídeo para uma demonstração passo a passo do processo de instalação:
|
||||
|
||||
<iframe
|
||||
width="100%"
|
||||
height="400"
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/-kSOTtYzgEw"
|
||||
title="CrewAI Installation Guide"
|
||||
frameborder="0"
|
||||
style={{ borderRadius: '10px' }}
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowfullscreen
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Tutorial em Texto
|
||||
@@ -165,7 +163,7 @@ Recomendamos utilizar o template de scaffolding `YAML` para uma abordagem estrut
|
||||
<Note type="info">
|
||||
Para equipes e organizações, o CrewAI oferece opções de implantação corporativa que eliminam a complexidade da configuração:
|
||||
|
||||
### CrewAI Enterprise (SaaS)
|
||||
### CrewAI AMP (SaaS)
|
||||
- Zero instalação necessária - basta se cadastrar gratuitamente em [app.crewai.com](https://app.crewai.com)
|
||||
- Atualizações e manutenção automáticas
|
||||
- Infraestrutura e escalabilidade gerenciadas
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Input Humano na Execução
|
||||
description: Integrando o CrewAI com input humano durante a execução em processos complexos de tomada de decisão e aproveitando ao máximo todos os atributos e ferramentas do agente.
|
||||
icon: user-check
|
||||
icon: user-plus
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
@@ -96,4 +96,4 @@ result = crew.kickoff()
|
||||
|
||||
print("######################")
|
||||
print(result)
|
||||
```
|
||||
```
|
||||
|
||||
@@ -44,7 +44,7 @@ O passo mais crítico na seleção de LLMs é entender o que sua tarefa realment
|
||||
|
||||
- **Tarefas Criativas** exigem um tipo diferente de capacidade cognitiva, focada em gerar conteúdo novo, envolvente e adequado ao contexto. Isso inclui storytelling, criação de textos de marketing e solução criativa de problemas. O modelo deve compreender nuances, tom e público, produzindo conteúdo autêntico e envolvente, não apenas fórmulas.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Requisitos de Saída">
|
||||
- **Dados Estruturados** exigem precisão e consistência na adesão ao formato. Ao trabalhar com JSON, XML ou formatos de banco de dados, o modelo deve produzir saídas sintaticamente corretas, que possam ser processadas programaticamente. Essas tarefas possuem requisitos rígidos de validação e pouca tolerância a erros de formato, tornando a confiabilidade mais importante que a criatividade.
|
||||
|
||||
@@ -52,7 +52,7 @@ O passo mais crítico na seleção de LLMs é entender o que sua tarefa realment
|
||||
|
||||
- **Conteúdo Técnico** situa-se entre dados estruturados e conteúdo criativo, demandando precisão e clareza. Documentação, geração de código e análises técnicas precisam ser exatas e completas, mas ainda assim acessíveis ao público-alvo. O modelo deve entender conceitos técnicos complexos e comunicá-los de forma eficaz.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Necessidades de Contexto">
|
||||
- **Contexto Curto** envolve tarefas imediatas e focalizadas, onde o modelo processa informações limitadas rapidamente. São interações transacionais em que velocidade e eficiência importam mais do que compreensão profunda. O modelo não precisa manter histórico extenso ou processar grandes documentos.
|
||||
|
||||
@@ -74,7 +74,7 @@ Entender as capacidades dos modelos exige ir além do marketing e dos benchmarks
|
||||
|
||||
Entretanto, há trade-offs em termos de custo e velocidade. Podem ser menos adequados para tarefas criativas ou operações simples, onde suas capacidades avançadas não são necessárias. Considere-os quando as tarefas realmente se beneficiarem dessa análise detalhada.
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Modelos de Uso Geral" icon="microchip">
|
||||
Modelos de uso geral oferecem uma abordagem equilibrada, com desempenho sólido em uma ampla gama de tarefas, sem especialização extrema. São treinados em conjuntos de dados diversificados e otimizados para versatilidade.
|
||||
|
||||
@@ -82,7 +82,7 @@ Entender as capacidades dos modelos exige ir além do marketing e dos benchmarks
|
||||
|
||||
Embora não atinjam picos de desempenho como modelos especializados, oferecem simplicidade operacional e baixa complexidade na gestão. São o melhor ponto de partida para novos projetos, permitindo descobertas de necessidades antes de avançar para otimizações.
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Modelos Rápidos & Eficientes" icon="bolt">
|
||||
Modelos rápidos e eficientes priorizam velocidade, custo e eficiência de recursos, em vez de raciocínio sofisticado. São otimizados para cenários de alto volume onde respostas rápidas e baixos custos são mais importantes que compreensão ou criatividade profunda.
|
||||
|
||||
@@ -90,7 +90,7 @@ Entender as capacidades dos modelos exige ir além do marketing e dos benchmarks
|
||||
|
||||
O ponto crucial é garantir que suas capacidades atendam às exigências da tarefa. Podem não atender tarefas que exijam entendimento profundo, raciocínio complexo ou geração de conteúdo sofisticado. São ideais para tarefas rotineiras bem definidas.
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Modelos Criativos" icon="pen">
|
||||
Modelos criativos são otimizados para geração de conteúdo, qualidade de escrita e pensamento inovador. Excelentes na compreensão de nuances, tom e estilo, produzindo conteúdo envolvente e natural.
|
||||
|
||||
@@ -98,7 +98,7 @@ Entender as capacidades dos modelos exige ir além do marketing e dos benchmarks
|
||||
|
||||
Ao selecionar esses modelos, considere não apenas a habilidade de gerar texto, mas a compreensão de público, contexto e objetivo. Os melhores modelos criativos adaptam a saída à voz da marca, diferentes segmentos e mantêm consistência em peças longas.
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Modelos Open Source" icon="code">
|
||||
Modelos open source oferecem vantagens em controle de custos, potencial de customização, privacidade de dados e flexibilidade de deployment. Podem ser rodados localmente ou em infraestrutura própria, dando controle total sobre dados e comportamento.
|
||||
|
||||
@@ -151,7 +151,7 @@ content_writer = Agent(
|
||||
)
|
||||
|
||||
data_processor = Agent(
|
||||
role="Data Analysis Specialist",
|
||||
role="Data Analysis Specialist",
|
||||
goal="Extract and organize key data points from research sources",
|
||||
backstory="Detail-oriented analyst focused on accuracy and efficiency",
|
||||
llm=processing_llm, # Modelo rápido para tarefas rotineiras
|
||||
@@ -178,7 +178,7 @@ O segredo do sucesso na implementação multi-modelo está em entender como os a
|
||||
|
||||
O custo é especialmente relevante, já que este LLM participa de todas as operações. O modelo precisa entregar capacidades suficientes, sem o preço premium de opções sofisticadas demais, buscando sempre o equilíbrio entre performance e valor.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Function Calling LLM">
|
||||
LLMs de function calling gerenciam o uso de ferramentas por todos os agentes, sendo críticos em crews que dependem fortemente de APIs externas e ferramentas. Devem ser precisos na extração de parâmetros e no processamento das respostas.
|
||||
|
||||
@@ -186,7 +186,7 @@ O segredo do sucesso na implementação multi-modelo está em entender como os a
|
||||
|
||||
Muitas equipes descobrem que modelos especializados em function calling ou de uso geral com forte suporte a ferramentas funcionam melhor do que modelos criativos ou de raciocínio nesse papel. O fundamental é assegurar que o modelo consiga converter instruções em chamadas estruturadas sem falhas.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Sobrescritas Específicas de Agente">
|
||||
Agentes individuais podem sobrescrever o LLM do nível da crew quando suas necessidades diferem significativamente das do restante. Isso permite otimização pontual, mantendo a simplicidade operacional para os demais agentes.
|
||||
|
||||
@@ -210,7 +210,7 @@ Definir bem as tarefas é frequentemente mais importante do que a seleção do m
|
||||
|
||||
Erros comuns incluem objetivos vagos, falta de contexto, critérios de sucesso mal definidos ou mistura de tarefas totalmente distintas em um mesmo texto. O objetivo é passar informação suficiente para o sucesso, mas mantendo foco no resultado claro.
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Diretrizes para a Saída Esperada" icon="bullseye">
|
||||
As diretrizes da saída esperada funcionam como contrato entre definição de tarefa e agente, especificando claramente o que deve ser entregue e como será avaliado. Elas abrangem formato, estrutura e elementos essenciais.
|
||||
|
||||
@@ -230,7 +230,7 @@ Definir bem as tarefas é frequentemente mais importante do que a seleção do m
|
||||
|
||||
Funciona melhor quando há progressão lógica evidente e quando a saída de uma tarefa realmente agrega valor nas etapas seguintes. Cuidado com os gargalos; foque nas dependências essenciais.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Execução Paralela">
|
||||
A execução paralela é valiosa quando as tarefas são independentes, o tempo é crítico ou há expertise distintas que não exigem coordenação. Pode reduzir drasticamente o tempo total, permitindo que agentes especializados atuem simultaneamente.
|
||||
|
||||
@@ -286,10 +286,10 @@ domain_expert = Agent(
|
||||
role="B2B SaaS Marketing Strategist",
|
||||
goal="Develop comprehensive go-to-market strategies for enterprise software",
|
||||
backstory="""
|
||||
You have 10+ years of experience scaling B2B SaaS companies from Series A to IPO.
|
||||
You understand the nuances of enterprise sales cycles, the importance of product-market
|
||||
fit in different verticals, and how to balance growth metrics with unit economics.
|
||||
You've worked with companies like Salesforce, HubSpot, and emerging unicorns, giving
|
||||
You have 10+ years of experience scaling B2B SaaS companies from Series A to IPO.
|
||||
You understand the nuances of enterprise sales cycles, the importance of product-market
|
||||
fit in different verticals, and how to balance growth metrics with unit economics.
|
||||
You've worked with companies like Salesforce, HubSpot, and emerging unicorns, giving
|
||||
you perspective on both established and disruptive go-to-market strategies.
|
||||
""",
|
||||
llm=LLM(model="claude-3-5-sonnet", temperature=0.3) # Criatividade balanceada com conhecimento de domínio
|
||||
@@ -317,9 +317,9 @@ tech_writer = Agent(
|
||||
role="API Documentation Specialist",
|
||||
goal="Create comprehensive, developer-friendly API documentation",
|
||||
backstory="""
|
||||
You're a technical writer with 8+ years documenting REST APIs, GraphQL endpoints,
|
||||
and SDK integration guides. You've worked with developer tools companies and
|
||||
understand what developers need: clear examples, comprehensive error handling,
|
||||
You're a technical writer with 8+ years documenting REST APIs, GraphQL endpoints,
|
||||
and SDK integration guides. You've worked with developer tools companies and
|
||||
understand what developers need: clear examples, comprehensive error handling,
|
||||
and practical use cases. You prioritize accuracy and usability over marketing fluff.
|
||||
""",
|
||||
llm=LLM(
|
||||
@@ -327,7 +327,7 @@ tech_writer = Agent(
|
||||
temperature=0.1
|
||||
),
|
||||
tools=[code_analyzer_tool, api_scanner_tool],
|
||||
verbose=True
|
||||
verbose=True
|
||||
)
|
||||
```
|
||||
|
||||
@@ -351,26 +351,26 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
|
||||
- Quais agentes lidam com tarefas mais complexas?
|
||||
- Quais agentes só processam ou formatam dados?
|
||||
- Algum agente depende fortemente de ferramentas?
|
||||
|
||||
|
||||
**Ação**: Documente funções dos agentes e identifique oportunidades de otimização.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Implemente Estratégia no Nível da Crew" icon="users-gear">
|
||||
**Defina sua Base:**
|
||||
```python
|
||||
# Comece com um padrão confiável para a crew
|
||||
default_crew_llm = LLM(model="gpt-4o-mini") # Base econômica
|
||||
|
||||
|
||||
crew = Crew(
|
||||
agents=[...],
|
||||
tasks=[...],
|
||||
memory=True
|
||||
)
|
||||
```
|
||||
|
||||
|
||||
**Ação**: Defina o LLM padrão da crew antes de otimizar agentes individuais.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Otimize Agentes de Maior Impacto" icon="star">
|
||||
**Identifique e Aprimore Agentes-Chave:**
|
||||
```python
|
||||
@@ -380,25 +380,25 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
|
||||
llm=LLM(model="gemini-2.5-flash-preview-05-20"),
|
||||
# ... demais configs
|
||||
)
|
||||
|
||||
# Agentes criativos ou customer-facing
|
||||
|
||||
# Agentes criativos ou customer-facing
|
||||
content_agent = Agent(
|
||||
role="Content Creator",
|
||||
llm=LLM(model="claude-3-5-sonnet"),
|
||||
# ... demais configs
|
||||
)
|
||||
```
|
||||
|
||||
|
||||
**Ação**: Faça upgrade dos 20% dos agentes que tratam 80% da complexidade.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Valide com Testes Empresariais" icon="test-tube">
|
||||
**Após colocar os agentes em produção:**
|
||||
- Use [CrewAI Enterprise platform](https://app.crewai.com) para testar seleções de modelo A/B
|
||||
- Use [CrewAI AMP platform](https://app.crewai.com) para testar seleções de modelo A/B
|
||||
- Execute múltiplas iterações com inputs reais para medir consistência e performance
|
||||
- Compare custo vs performance na configuração otimizada
|
||||
- Compartilhe resultados com o time para tomada coletiva de decisão
|
||||
|
||||
|
||||
**Ação**: Substitua achismos por validação com dados reais usando a plataforma de testes.
|
||||
</Step>
|
||||
</Steps>
|
||||
@@ -413,7 +413,7 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
|
||||
|
||||
Entretanto, esses modelos são mais caros e lentos, devendo ser reservados para tarefas onde suas capacidades agregam valor real — evite usá-los apenas para operações simples.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Modelos Criativos">
|
||||
Modelos criativos são valiosos quando a principal entrega é geração de conteúdo e a qualidade, estilo e engajamento desse conteúdo impactam o sucesso. Se destacam quando redação e estilo importam, ideação criativa é necessária, ou voz de marca é fundamental.
|
||||
|
||||
@@ -421,7 +421,7 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
|
||||
|
||||
Podem ser menos adequados para tarefas técnicas ou analíticas, onde precisão supera criatividade. Use-os quando aspectos comunicativos são fatores críticos de sucesso.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Modelos Eficientes">
|
||||
Modelos eficientes são ideais para operações frequentes e rotineiras, onde velocidade e custo são prioridade. Trabalham melhor em tarefas com parâmetros bem definidos, sem necessidade de raciocínio avançado ou criatividade.
|
||||
|
||||
@@ -429,7 +429,7 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
|
||||
|
||||
O ponto crítico é verificar adequação à tarefa. Funcionam para muitos fluxos rotineiros, mas podem falhar se a tarefa exigir compreensão técnica ou raciocínio.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Modelos Open Source">
|
||||
Modelos open source são atraentes quando há restrição orçamentária, necessidade de privacidade, personalização especial ou exigência de deployment local.
|
||||
|
||||
@@ -451,12 +451,12 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
|
||||
```python
|
||||
# Agente estratégico recebe modelo premium
|
||||
manager = Agent(role="Strategy Manager", llm=LLM(model="gpt-4o"))
|
||||
|
||||
# Agente de processamento recebe modelo eficiente
|
||||
|
||||
# Agente de processamento recebe modelo eficiente
|
||||
processor = Agent(role="Data Processor", llm=LLM(model="gpt-4o-mini"))
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Ignorar Hierarquia de LLM entre Crew e Agente" icon="shuffle">
|
||||
**O problema**: Não entender como funciona a hierarquia LLM da CrewAI — configurações conflitam entre crew, manager e agentes.
|
||||
|
||||
@@ -470,12 +470,12 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
|
||||
manager_llm=LLM(model="gpt-4o"),
|
||||
process=Process.hierarchical
|
||||
)
|
||||
|
||||
|
||||
# Agentes herdam o LLM da crew, salvo sobrescrita
|
||||
agent1 = Agent(llm=LLM(model="claude-3-5-sonnet"))
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Incompatibilidade para Function Calling" icon="screwdriver-wrench">
|
||||
**O problema**: Escolher modelos pela capacidade geral e ignorar o desempenho em function calling em workflows intensivos em ferramentas.
|
||||
|
||||
@@ -493,7 +493,7 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
|
||||
)
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Otimização Prematura sem Teste" icon="gear">
|
||||
**O problema**: Decidir configurações complexas de modelo com base em hipóteses não validadas nos fluxos e tarefas reais CrewAI.
|
||||
|
||||
@@ -503,7 +503,7 @@ Em vez de repetir o framework estratégico, segue um checklist tático para impl
|
||||
```python
|
||||
# Comece assim
|
||||
crew = Crew(agents=[...], tasks=[...], llm=LLM(model="gpt-4o-mini"))
|
||||
|
||||
|
||||
# Teste a performance e só depois otimize agentes específicos
|
||||
# Use testes Enterprise para validar melhorias
|
||||
```
|
||||
@@ -541,7 +541,7 @@ Foque em entender seus requisitos primeiro, e então escolha modelos que melhor
|
||||
|
||||
### Validação de Modelos em Nível Enterprise
|
||||
|
||||
Para equipes sérias sobre otimização, a **plataforma CrewAI Enterprise** oferece testes sofisticados que vão além do CLI. Ela permite avaliação completa para decisões orientadas por dados na estratégia de LLM.
|
||||
Para equipes sérias sobre otimização, a **plataforma CrewAI AMP** oferece testes sofisticados que vão além do CLI. Ela permite avaliação completa para decisões orientadas por dados na estratégia de LLM.
|
||||
|
||||
<Frame>
|
||||
|
||||
@@ -571,23 +571,23 @@ A plataforma Enterprise transforma a seleção de modelos de um "palpite" para u
|
||||
<Card title="Seleção Orientada à Tarefa" icon="bullseye">
|
||||
Escolha os modelos pelo que sua tarefa realmente requer, não por reputação ou capacidades teóricas.
|
||||
</Card>
|
||||
|
||||
|
||||
<Card title="Combinação de Capacidades" icon="puzzle-piece">
|
||||
Alinhe forças do modelo a papéis e responsabilidades dos agentes para melhor desempenho.
|
||||
</Card>
|
||||
|
||||
|
||||
<Card title="Consistência Estratégica" icon="link">
|
||||
Mantenha uma estratégia coerente de seleção de modelos em fluxos e componentes relacionados.
|
||||
</Card>
|
||||
|
||||
|
||||
<Card title="Testes Práticos" icon="flask">
|
||||
Valide escolhas em uso real, não apenas em benchmarks.
|
||||
</Card>
|
||||
|
||||
|
||||
<Card title="Iteração Contínua" icon="arrow-up">
|
||||
Comece simples e otimize com base na performance e necessidade práticas.
|
||||
</Card>
|
||||
|
||||
|
||||
<Card title="Equilíbrio Operacional" icon="scale-balanced">
|
||||
Equilibre performance requerida, custo e complexidade.
|
||||
</Card>
|
||||
@@ -614,7 +614,7 @@ Estas tabelas exibem apenas alguns modelos líderes por categoria. Existem muito
|
||||
<Tabs>
|
||||
<Tab title="Raciocínio & Planejamento">
|
||||
**Melhores para LLMs Manager e Análises Complexas**
|
||||
|
||||
|
||||
| Modelo | Score de Inteligência | Custo ($/M tokens) | Velocidade | Melhor Uso em CrewAI |
|
||||
|:------|:---------------------|:-------------------|:-----------|:--------------------|
|
||||
| **o3** | 70 | $17.50 | Rápido | Manager LLM para coordenação multi-agente |
|
||||
@@ -625,10 +625,10 @@ Estas tabelas exibem apenas alguns modelos líderes por categoria. Existem muito
|
||||
|
||||
Esses modelos se destacam em raciocínio multi-etapas e são ideais para agentes que desenvolvem estratégias, coordenam outros agentes ou analisam informações complexas.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Codificação & Técnica">
|
||||
**Melhores para Desenvolvimento e Workflows com Ferramentas**
|
||||
|
||||
|
||||
| Modelo | Performance em Coding | Tool Use Score | Custo ($/M tokens) | Melhor Uso em CrewAI |
|
||||
|:--------|:---------------------|:--------------|:-------------------|:--------------------|
|
||||
| **Claude 4 Sonnet** | Excelente | 72.7% | $6.00 | Agente principal de código/documentação técnica |
|
||||
@@ -639,10 +639,10 @@ Estas tabelas exibem apenas alguns modelos líderes por categoria. Existem muito
|
||||
|
||||
Otimizados para geração de código, debugging e solução técnica, ideais para equipes de desenvolvimento.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Velocidade & Eficiência">
|
||||
**Melhores para Operações em Massa e Aplicações em Tempo Real**
|
||||
|
||||
|
||||
| Modelo | Velocidade (tokens/s) | Latência (TTFT) | Custo ($/M tokens) | Melhor Uso em CrewAI |
|
||||
|:-------|:---------------------|:----------------|:-------------------|:---------------------|
|
||||
| **Llama 4 Scout** | 2.600 | 0.33s | $0.27 | Agentes de processamento de alto volume |
|
||||
@@ -653,10 +653,10 @@ Estas tabelas exibem apenas alguns modelos líderes por categoria. Existem muito
|
||||
|
||||
Priorizam velocidade e eficiência, perfeitos para agentes em operações de rotina ou resposta ágil. **Dica:** Usar provedores de inference rápidos como Groq potencializa open source como Llama.
|
||||
</Tab>
|
||||
|
||||
|
||||
<Tab title="Performance Equilibrada">
|
||||
**Melhores Modelos Coringa para Crews Diversos**
|
||||
|
||||
|
||||
| Modelo | Score Global | Versatilidade | Custo ($/M tokens) | Melhor Uso em CrewAI |
|
||||
|:------------|:--------------|:-------------|:-------------------|:--------------------|
|
||||
| **GPT-4.1** | 53 | Excelente | $3.50 | LLM generalista para equipes variadas |
|
||||
@@ -677,19 +677,19 @@ Estas tabelas exibem apenas alguns modelos líderes por categoria. Existem muito
|
||||
|
||||
**Estratégia**: Implemente abordagem multi-modelo, reservando premium para raciocínio estratégico e eficientes para operações rotineiras.
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Crews de Baixo Custo" icon="dollar-sign">
|
||||
**Foco no orçamento**: Foque em modelos como **DeepSeek R1**, **Llama 4 Scout** ou **Gemini 2.0 Flash**, que trazem ótimo desempenho com investimento reduzido.
|
||||
|
||||
**Estratégia**: Use modelos econômicos para maioria dos agentes, reservando premium apenas para funções críticas.
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Workflows Especializados" icon="screwdriver-wrench">
|
||||
**Para expertise específica**: Escolha modelos otimizados para seu principal caso de uso: **Claude 4** em código, **Gemini 2.5 Pro** em pesquisa, **Llama 405B** em function calling.
|
||||
|
||||
**Estratégia**: Selecione conforme a principal função da crew, garantindo alinhamento de capacidade e modelo.
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Empresa & Privacidade" icon="shield">
|
||||
**Para operações sensíveis**: Avalie modelos open source como **Llama 4** series, **DeepSeek V3** ou **Qwen3** para deployment privado, mantendo performance competitiva.
|
||||
|
||||
@@ -713,16 +713,16 @@ Estas tabelas exibem apenas alguns modelos líderes por categoria. Existem muito
|
||||
<Step title="Comece por Modelos Validados">
|
||||
Inicie com opções consagradas como **GPT-4.1**, **Claude 3.7 Sonnet** ou **Gemini 2.0 Flash**, que oferecem bom desempenho e ampla validação.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Identifique Demandas Especializadas">
|
||||
Descubra se sua crew possui requisitos específicos (código, raciocínio, velocidade) que justifiquem modelos como **Claude 4 Sonnet** para desenvolvimento ou **o3** para análise. Para aplicações críticas em velocidade, considere Groq aliado à seleção do modelo.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Implemente Estratégia Multi-Modelo">
|
||||
Use modelos diferentes para agentes distintos conforme o papel. Modelos de alta capacidade para managers e tarefas complexas, eficientes para rotinas.
|
||||
</Step>
|
||||
|
||||
|
||||
<Step title="Monitore e Otimize">
|
||||
Acompanhe métricas relevantes ao seu caso e esteja pronto para ajustar modelos conforme lançamentos ou mudanças de preços.
|
||||
</Step>
|
||||
</Steps>
|
||||
</Steps>
|
||||
|
||||
@@ -42,6 +42,15 @@ class LinkedinProfileCrew():
|
||||
|
||||
A anotação `@CrewBase` é usada para decorar a classe principal do crew. Esta classe geralmente contém as configurações e métodos para criação de agentes, tarefas e do próprio crew.
|
||||
|
||||
<Tip>
|
||||
`@CrewBase` faz bem mais do que registrar a classe:
|
||||
|
||||
- **Inicialização de configuração:** busca `agents_config` e `tasks_config` (padrões `config/agents.yaml` e `config/tasks.yaml`) ao lado do arquivo da classe, carrega esses YAMLs na inicialização e utiliza dicionários vazios quando os arquivos não existem.
|
||||
- **Orquestração de decoradores:** mantém versões memoizadas dos métodos marcados com `@agent`, `@task`, `@before_kickoff` e `@after_kickoff` para que sejam instanciados uma única vez por crew e respeitem a ordem de declaração.
|
||||
- **Encadeamento de hooks:** conecta automaticamente os hooks preservados ao objeto `Crew` retornado pelo método `@crew`, garantindo que executem antes e depois de `.kickoff()`.
|
||||
- **Integração MCP:** quando a classe define `mcp_server_params`, `get_mcp_tools()` cria sob demanda um adaptador MCP, carrega as ferramentas declaradas e um hook interno pós-kickoff encerra o adaptador. Consulte a [visão geral de MCP](/pt-BR/mcp/overview) para detalhes de configuração.
|
||||
</Tip>
|
||||
|
||||
### 2. Definição de Tool
|
||||
|
||||
```python
|
||||
@@ -100,7 +109,7 @@ def crew(self) -> Crew:
|
||||
process=Process.sequential,
|
||||
verbose=True
|
||||
)
|
||||
```
|
||||
```
|
||||
|
||||
A anotação `@crew` é usada para decorar o método que cria e retorna o objeto `Crew`. Este método reúne todos os componentes (agentes e tarefas) em um crew funcional.
|
||||
|
||||
@@ -139,4 +148,4 @@ Repare como os campos `llm` e `tools` no arquivo YAML correspondem aos métodos
|
||||
- **Flexibilidade**: Estruture seu crew de forma flexível, permitindo fácil adição ou remoção de agentes e tarefas.
|
||||
- **Correspondência YAML-Código**: Assegure que os nomes e estruturas nos arquivos YAML correspondam corretamente aos métodos decorados em seu código Python.
|
||||
|
||||
Seguindo essas orientações e utilizando corretamente as anotações, você conseguirá criar crews bem estruturados e de fácil manutenção utilizando o framework CrewAI.
|
||||
Seguindo essas orientações e utilizando corretamente as anotações, você conseguirá criar crews bem estruturados e de fácil manutenção utilizando o framework CrewAI.
|
||||
|
||||
@@ -21,14 +21,12 @@ Atualmente, suportamos os seguintes mecanismos de transporte:
|
||||
Assista a este tutorial em vídeo para um guia abrangente sobre a integração do MCP com o CrewAI:
|
||||
|
||||
<iframe
|
||||
width="100%"
|
||||
height="400"
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/TpQ45lAZh48"
|
||||
title="CrewAI MCP Integration Guide"
|
||||
frameborder="0"
|
||||
style={{ borderRadius: '10px' }}
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowfullscreen
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Instalação
|
||||
@@ -151,6 +149,16 @@ class CrewWithMCP:
|
||||
# ... restante da configuração do seu crew ...
|
||||
```
|
||||
|
||||
<Tip>
|
||||
Quando uma classe é decorada com `@CrewBase`, o ciclo de vida do adaptador é controlado automaticamente:
|
||||
|
||||
- A primeira chamada a `get_mcp_tools()` cria de forma preguiçosa um `MCPServerAdapter` compartilhado que é reutilizado por todos os agentes do crew.
|
||||
- Após a conclusão de `.kickoff()`, um hook pós-kickoff injetado por `@CrewBase` encerra o adaptador, dispensando qualquer limpeza manual.
|
||||
- Se `mcp_server_params` não estiver definido, `get_mcp_tools()` retorna uma lista vazia, permitindo manter o mesmo fluxo de código com ou sem MCP configurado.
|
||||
|
||||
Assim, é seguro chamar `get_mcp_tools()` em vários agentes ou habilitar/desabilitar MCP dependendo do ambiente.
|
||||
</Tip>
|
||||
|
||||
### Configuração de Timeout de Conexão
|
||||
|
||||
Você pode configurar o timeout de conexão para servidores MCP definindo o atributo de classe `mcp_connect_timeout`. Se nenhum timeout for especificado, o padrão é 30 segundos.
|
||||
|
||||
134
docs/pt-BR/observability/neatlogs.mdx
Normal file
134
docs/pt-BR/observability/neatlogs.mdx
Normal file
@@ -0,0 +1,134 @@
|
||||
---
|
||||
title: Neatlogs Integration
|
||||
description: Understand, debug, and share your CrewAI agent runs
|
||||
icon: magnifying-glass-chart
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
Neatlogs helps you **see what your agent did**, **why**, and **share it**.
|
||||
|
||||
It captures every step: thoughts, tool calls, responses, evaluations. No raw logs. Just clear, structured traces. Great for debugging and collaboration.
|
||||
|
||||
## Why use Neatlogs?
|
||||
|
||||
CrewAI agents use multiple tools and reasoning steps. When something goes wrong, you need context — not just errors.
|
||||
|
||||
Neatlogs lets you:
|
||||
|
||||
- Follow the full decision path
|
||||
- Add feedback directly on steps
|
||||
- Chat with the trace using AI assistant
|
||||
- Share runs publicly for feedback
|
||||
- Turn insights into tasks
|
||||
|
||||
All in one place.
|
||||
|
||||
Manage your traces effortlessly
|
||||
|
||||
|
||||
|
||||
|
||||
The best UX to view a CrewAI trace. Post comments anywhere you want. Use AI to debug.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Core Features
|
||||
|
||||
- **Trace Viewer**: Track thoughts, tools, and decisions in sequence
|
||||
- **Inline Comments**: Tag teammates on any trace step
|
||||
- **Feedback & Evaluation**: Mark outputs as correct or incorrect
|
||||
- **Error Highlighting**: Automatic flagging of API/tool failures
|
||||
- **Task Conversion**: Convert comments into assigned tasks
|
||||
- **Ask the Trace (AI)**: Chat with your trace using Neatlogs AI bot
|
||||
- **Public Sharing**: Publish trace links to your community
|
||||
|
||||
## Quick Setup with CrewAI
|
||||
|
||||
<Steps>
|
||||
<Step title="Sign Up & Get API Key">
|
||||
Visit [neatlogs.com](https://neatlogs.com/?utm_source=crewAI-docs), create a project, copy the API key.
|
||||
</Step>
|
||||
<Step title="Install SDK">
|
||||
```bash
|
||||
pip install neatlogs
|
||||
```
|
||||
(Latest version 0.8.0, Python 3.8+; MIT license)
|
||||
</Step>
|
||||
<Step title="Initialize Neatlogs">
|
||||
Before starting Crew agents, add:
|
||||
|
||||
```python
|
||||
import neatlogs
|
||||
neatlogs.init("YOUR_PROJECT_API_KEY")
|
||||
```
|
||||
|
||||
Agents run as usual. Neatlogs captures everything automatically.
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
|
||||
|
||||
## Under the Hood
|
||||
|
||||
According to GitHub, Neatlogs:
|
||||
|
||||
- Captures thoughts, tool calls, responses, errors, and token stats
|
||||
- Supports AI-powered task generation and robust evaluation workflows
|
||||
|
||||
All with just two lines of code.
|
||||
|
||||
|
||||
|
||||
## Watch It Work
|
||||
|
||||
### 🔍 Full Demo (4 min)
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/8KDme9T2I7Q?si=b8oHteaBwFNs_Duk"
|
||||
title="NeatLogs overview"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
### ⚙️ CrewAI Integration (30 s)
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.loom.com/embed/9c78b552af43452bb3e4783cb8d91230?sid=e9d7d370-a91a-49b0-809e-2f375d9e801d"
|
||||
title="Loom video player"
|
||||
frameBorder="0"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
|
||||
|
||||
## Links & Support
|
||||
|
||||
- 📘 [Neatlogs Docs](https://docs.neatlogs.com/)
|
||||
- 🔐 [Dashboard & API Key](https://app.neatlogs.com/)
|
||||
- 🐦 [Follow on Twitter](https://twitter.com/neatlogs)
|
||||
- 📧 Contact: hello@neatlogs.com
|
||||
- 🛠 [GitHub SDK](https://github.com/NeatLogs/neatlogs)
|
||||
|
||||
|
||||
|
||||
## TL;DR
|
||||
|
||||
With just:
|
||||
|
||||
```bash
|
||||
pip install neatlogs
|
||||
|
||||
import neatlogs
|
||||
neatlogs.init("YOUR_API_KEY")
|
||||
|
||||
You can now capture, understand, share, and act on your CrewAI agent runs in seconds.
|
||||
No setup overhead. Full trace transparency. Full team collaboration.
|
||||
```
|
||||
@@ -204,9 +204,9 @@ Siga os passos abaixo para começar a tripular! 🚣♂️
|
||||
</Step>
|
||||
|
||||
<Step title="Alternativa para Empresas: Crie no Crew Studio">
|
||||
Para usuários do CrewAI Enterprise, você pode criar a mesma tripulação sem escrever código:
|
||||
Para usuários do CrewAI AMP, você pode criar a mesma tripulação sem escrever código:
|
||||
|
||||
1. Faça login na sua conta CrewAI Enterprise (crie uma conta gratuita em [app.crewai.com](https://app.crewai.com))
|
||||
1. Faça login na sua conta CrewAI AMP (crie uma conta gratuita em [app.crewai.com](https://app.crewai.com))
|
||||
2. Abra o Crew Studio
|
||||
3. Digite qual automação deseja construir
|
||||
4. Crie suas tarefas visualmente e conecte-as em sequência
|
||||
@@ -214,8 +214,8 @@ Siga os passos abaixo para começar a tripular! 🚣♂️
|
||||
|
||||
|
||||
|
||||
<Card title="Experimente o CrewAI Enterprise" icon="rocket" href="https://app.crewai.com">
|
||||
Comece sua conta gratuita no CrewAI Enterprise
|
||||
<Card title="Experimente o CrewAI AMP" icon="rocket" href="https://app.crewai.com">
|
||||
Comece sua conta gratuita no CrewAI AMP
|
||||
</Card>
|
||||
</Step>
|
||||
<Step title="Veja seu relatório final">
|
||||
@@ -335,19 +335,17 @@ email_summarizer_task:
|
||||
|
||||
## Fazendo o Deploy da Sua Tripulação
|
||||
|
||||
A forma mais fácil de fazer deploy da sua tripulação em produção é através da [CrewAI Enterprise](http://app.crewai.com).
|
||||
A forma mais fácil de fazer deploy da sua tripulação em produção é através da [CrewAI AMP](http://app.crewai.com).
|
||||
|
||||
Assista a este vídeo tutorial para uma demonstração detalhada de como fazer deploy da sua tripulação na [CrewAI Enterprise](http://app.crewai.com) usando a CLI.
|
||||
Assista a este vídeo tutorial para uma demonstração detalhada de como fazer deploy da sua tripulação na [CrewAI AMP](http://app.crewai.com) usando a CLI.
|
||||
|
||||
<iframe
|
||||
width="100%"
|
||||
height="400"
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/3EqSV-CYDZA"
|
||||
title="CrewAI Deployment Guide"
|
||||
frameborder="0"
|
||||
style={{ borderRadius: '10px' }}
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowfullscreen
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
@@ -356,7 +354,7 @@ Assista a este vídeo tutorial para uma demonstração detalhada de como fazer d
|
||||
icon="rocket"
|
||||
href="http://app.crewai.com"
|
||||
>
|
||||
Comece com o CrewAI Enterprise e faça o deploy da sua tripulação em ambiente de produção com apenas alguns cliques.
|
||||
Comece com o CrewAI AMP e faça o deploy da sua tripulação em ambiente de produção com apenas alguns cliques.
|
||||
</Card>
|
||||
<Card
|
||||
title="Junte-se à Comunidade"
|
||||
|
||||
57
docs/pt-BR/tools/automation/zapieractionstool.mdx
Normal file
57
docs/pt-BR/tools/automation/zapieractionstool.mdx
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: Zapier Actions Tool
|
||||
description: The `ZapierActionsAdapter` exposes Zapier actions as CrewAI tools for automation.
|
||||
icon: bolt
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `ZapierActionsAdapter`
|
||||
|
||||
## Description
|
||||
|
||||
Use the Zapier adapter to list and call Zapier actions as CrewAI tools. This enables agents to trigger automations across thousands of apps.
|
||||
|
||||
## Installation
|
||||
|
||||
This adapter is included with `crewai-tools`. No extra install required.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
- `ZAPIER_API_KEY` (required): Zapier API key. Get one from the Zapier Actions dashboard at https://actions.zapier.com/ (create an account, then generate an API key). You can also pass `zapier_api_key` directly when constructing the adapter.
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools.adapters.zapier_adapter import ZapierActionsAdapter
|
||||
|
||||
adapter = ZapierActionsAdapter(api_key="your_zapier_api_key")
|
||||
tools = adapter.tools()
|
||||
|
||||
agent = Agent(
|
||||
role="Automator",
|
||||
goal="Execute Zapier actions",
|
||||
backstory="Automation specialist",
|
||||
tools=tools,
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="Create a new Google Sheet and add a row using Zapier actions",
|
||||
expected_output="Confirmation with created resource IDs",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(agents=[agent], tasks=[task])
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Notes & limits
|
||||
|
||||
- The adapter lists available actions for your key and creates `BaseTool` wrappers dynamically.
|
||||
- Handle action‑specific required fields in your task instructions or tool call.
|
||||
- Rate limits depend on your Zapier plan; see the Zapier Actions docs.
|
||||
|
||||
## Notes
|
||||
|
||||
- The adapter fetches available actions and generates `BaseTool` wrappers dynamically.
|
||||
@@ -1,188 +0,0 @@
|
||||
---
|
||||
title: Ferramenta Bedrock Invoke Agent
|
||||
description: Permite que agentes CrewAI invoquem Amazon Bedrock Agents e aproveitem suas capacidades em seus fluxos de trabalho
|
||||
icon: aws
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `BedrockInvokeAgentTool`
|
||||
|
||||
A `BedrockInvokeAgentTool` permite que agentes CrewAI invoquem Amazon Bedrock Agents e aproveitem suas capacidades em seus fluxos de trabalho.
|
||||
|
||||
## Instalação
|
||||
|
||||
```bash
|
||||
uv pip install 'crewai[tools]'
|
||||
```
|
||||
|
||||
## Requisitos
|
||||
|
||||
- Credenciais AWS configuradas (através de variáveis de ambiente ou AWS CLI)
|
||||
- Pacotes `boto3` e `python-dotenv`
|
||||
- Acesso aos Amazon Bedrock Agents
|
||||
|
||||
## Uso
|
||||
|
||||
Veja como usar a ferramenta com um agente CrewAI:
|
||||
|
||||
```python {2, 4-8}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
|
||||
|
||||
# Initialize the tool
|
||||
agent_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id"
|
||||
)
|
||||
|
||||
# Create a CrewAI agent that uses the tool
|
||||
aws_expert = Agent(
|
||||
role='AWS Service Expert',
|
||||
goal='Help users understand AWS services and quotas',
|
||||
backstory='I am an expert in AWS services and can provide detailed information about them.',
|
||||
tools=[agent_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create a task for the agent
|
||||
quota_task = Task(
|
||||
description="Find out the current service quotas for EC2 in us-west-2 and explain any recent changes.",
|
||||
agent=aws_expert
|
||||
)
|
||||
|
||||
# Create a crew with the agent
|
||||
crew = Crew(
|
||||
agents=[aws_expert],
|
||||
tasks=[quota_task],
|
||||
verbose=2
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Argumentos da Ferramenta
|
||||
|
||||
| Argumento | Tipo | Obrigatório | Padrão | Descrição |
|
||||
|:----------|:-----|:------------|:---------|:----------------------------------------------------|
|
||||
| **agent_id** | `str` | Sim | None | O identificador único do agente Bedrock |
|
||||
| **agent_alias_id** | `str` | Sim | None | O identificador único do alias do agente |
|
||||
| **session_id** | `str` | Não | timestamp | O identificador único da sessão |
|
||||
| **enable_trace** | `bool` | Não | False | Define se o trace deve ser habilitado para debug |
|
||||
| **end_session** | `bool` | Não | False | Define se a sessão deve ser encerrada após invocação |
|
||||
| **description** | `str` | Não | None | Descrição personalizada para a ferramenta |
|
||||
|
||||
## Variáveis de Ambiente
|
||||
|
||||
```bash
|
||||
BEDROCK_AGENT_ID=your-agent-id # Alternativa para passar agent_id
|
||||
BEDROCK_AGENT_ALIAS_ID=your-agent-alias-id # Alternativa para passar agent_alias_id
|
||||
AWS_REGION=your-aws-region # Padrão é us-west-2
|
||||
AWS_ACCESS_KEY_ID=your-access-key # Necessário para autenticação AWS
|
||||
AWS_SECRET_ACCESS_KEY=your-secret-key # Necessário para autenticação AWS
|
||||
```
|
||||
|
||||
## Uso Avançado
|
||||
|
||||
### Fluxo de Trabalho Multiagente com Gerenciamento de Sessão
|
||||
|
||||
```python {2, 4-22}
|
||||
from crewai import Agent, Task, Crew, Process
|
||||
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
|
||||
|
||||
# Initialize tools with session management
|
||||
initial_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id",
|
||||
session_id="custom-session-id"
|
||||
)
|
||||
|
||||
followup_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id",
|
||||
session_id="custom-session-id"
|
||||
)
|
||||
|
||||
final_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id",
|
||||
session_id="custom-session-id",
|
||||
end_session=True
|
||||
)
|
||||
|
||||
# Create agents for different stages
|
||||
researcher = Agent(
|
||||
role='AWS Service Researcher',
|
||||
goal='Gather information about AWS services',
|
||||
backstory='I am specialized in finding detailed AWS service information.',
|
||||
tools=[initial_tool]
|
||||
)
|
||||
|
||||
analyst = Agent(
|
||||
role='Service Compatibility Analyst',
|
||||
goal='Analyze service compatibility and requirements',
|
||||
backstory='I analyze AWS services for compatibility and integration possibilities.',
|
||||
tools=[followup_tool]
|
||||
)
|
||||
|
||||
summarizer = Agent(
|
||||
role='Technical Documentation Writer',
|
||||
goal='Create clear technical summaries',
|
||||
backstory='I specialize in creating clear, concise technical documentation.',
|
||||
tools=[final_tool]
|
||||
)
|
||||
|
||||
# Create tasks
|
||||
research_task = Task(
|
||||
description="Find all available AWS services in us-west-2 region.",
|
||||
agent=researcher
|
||||
)
|
||||
|
||||
analysis_task = Task(
|
||||
description="Analyze which services support IPv6 and their implementation requirements.",
|
||||
agent=analyst
|
||||
)
|
||||
|
||||
summary_task = Task(
|
||||
description="Create a summary of IPv6-compatible services and their key features.",
|
||||
agent=summarizer
|
||||
)
|
||||
|
||||
# Create a crew with the agents and tasks
|
||||
crew = Crew(
|
||||
agents=[researcher, analyst, summarizer],
|
||||
tasks=[research_task, analysis_task, summary_task],
|
||||
process=Process.sequential,
|
||||
verbose=2
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Casos de Uso
|
||||
|
||||
### Colaborações Híbridas Multiagente
|
||||
- Crie fluxos de trabalho onde agentes CrewAI colaboram com agentes Bedrock gerenciados executando como serviços na AWS
|
||||
- Permita cenários em que o processamento de dados sensíveis ocorre dentro do seu ambiente AWS enquanto outros agentes operam externamente
|
||||
- Conecte agentes CrewAI on-premises a agentes Bedrock baseados na nuvem para fluxos de trabalho distribuídos de inteligência
|
||||
|
||||
### Soberania e Conformidade de Dados
|
||||
- Mantenha fluxos de trabalho agentivos sensíveis a dados dentro do seu ambiente AWS enquanto permite que agentes CrewAI externos orquestrem tarefas
|
||||
- Mantenha conformidade com requisitos de residência de dados processando informações sensíveis somente em sua conta AWS
|
||||
- Permita colaborações multiagentes seguras onde alguns agentes não podem acessar dados privados da sua organização
|
||||
|
||||
### Integração Transparente com Serviços AWS
|
||||
- Acesse qualquer serviço AWS por meio do Amazon Bedrock Actions sem escrever código de integração complexo
|
||||
- Permita que agentes CrewAI interajam com serviços AWS usando solicitações em linguagem natural
|
||||
- Aproveite as capacidades pré-construídas dos agentes Bedrock para interagir com serviços AWS como Bedrock Knowledge Bases, Lambda e outros
|
||||
|
||||
### Arquiteturas de Agentes Híbridos Escaláveis
|
||||
- Realize tarefas computacionalmente intensivas em agentes Bedrock gerenciados enquanto tarefas leves rodam em CrewAI
|
||||
- Escale o processamento de agentes distribuindo cargas de trabalho entre agentes CrewAI locais e agentes Bedrock na nuvem
|
||||
|
||||
### Colaboração de Agentes Entre Organizações
|
||||
- Permita colaboração segura entre agentes CrewAI da sua organização e agentes Bedrock de organizações parceiras
|
||||
- Crie fluxos de trabalho onde a expertise externa de agentes Bedrock pode ser incorporada sem expor dados sensíveis
|
||||
- Construa ecossistemas de agentes que abrangem fronteiras organizacionais mantendo segurança e controle de dados
|
||||
167
docs/pt-BR/tools/database-data/mongodbvectorsearchtool.mdx
Normal file
167
docs/pt-BR/tools/database-data/mongodbvectorsearchtool.mdx
Normal file
@@ -0,0 +1,167 @@
|
||||
---
|
||||
title: MongoDB Vector Search Tool
|
||||
description: The `MongoDBVectorSearchTool` performs vector search on MongoDB Atlas with optional indexing helpers.
|
||||
icon: "leaf"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `MongoDBVectorSearchTool`
|
||||
|
||||
## Description
|
||||
|
||||
Perform vector similarity queries on MongoDB Atlas collections. Supports index creation helpers and bulk insert of embedded texts.
|
||||
|
||||
MongoDB Atlas supports native vector search. Learn more:
|
||||
https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-overview/
|
||||
|
||||
## Installation
|
||||
|
||||
Install with the MongoDB extra:
|
||||
|
||||
```shell
|
||||
pip install crewai-tools[mongodb]
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```shell
|
||||
uv add crewai-tools --extra mongodb
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### Initialization
|
||||
|
||||
- `connection_string` (str, required)
|
||||
- `database_name` (str, required)
|
||||
- `collection_name` (str, required)
|
||||
- `vector_index_name` (str, default `vector_index`)
|
||||
- `text_key` (str, default `text`)
|
||||
- `embedding_key` (str, default `embedding`)
|
||||
- `dimensions` (int, default `1536`)
|
||||
|
||||
### Run Parameters
|
||||
|
||||
- `query` (str, required): Natural language query to embed and search.
|
||||
|
||||
## Quick start
|
||||
|
||||
```python Code
|
||||
from crewai_tools import MongoDBVectorSearchTool
|
||||
|
||||
tool = MongoDBVectorSearchTool(
|
||||
connection_string="mongodb+srv://...",
|
||||
database_name="mydb",
|
||||
collection_name="docs",
|
||||
)
|
||||
|
||||
print(tool.run(query="how to create vector index"))
|
||||
```
|
||||
|
||||
## Index creation helpers
|
||||
|
||||
Use `create_vector_search_index(...)` to provision an Atlas Vector Search index with the correct dimensions and similarity.
|
||||
|
||||
## Common issues
|
||||
|
||||
- Authentication failures: ensure your Atlas IP Access List allows your runner and the connection string includes credentials.
|
||||
- Index not found: create the vector index first; name must match `vector_index_name`.
|
||||
- Dimensions mismatch: align embedding model dimensions with `dimensions`.
|
||||
|
||||
## More examples
|
||||
|
||||
### Basic initialization
|
||||
|
||||
```python Code
|
||||
from crewai_tools import MongoDBVectorSearchTool
|
||||
|
||||
tool = MongoDBVectorSearchTool(
|
||||
database_name="example_database",
|
||||
collection_name="example_collection",
|
||||
connection_string="<your_mongodb_connection_string>",
|
||||
)
|
||||
```
|
||||
|
||||
### Custom query configuration
|
||||
|
||||
```python Code
|
||||
from crewai_tools import MongoDBVectorSearchConfig, MongoDBVectorSearchTool
|
||||
|
||||
query_config = MongoDBVectorSearchConfig(limit=10, oversampling_factor=2)
|
||||
tool = MongoDBVectorSearchTool(
|
||||
database_name="example_database",
|
||||
collection_name="example_collection",
|
||||
connection_string="<your_mongodb_connection_string>",
|
||||
query_config=query_config,
|
||||
vector_index_name="my_vector_index",
|
||||
)
|
||||
|
||||
rag_agent = Agent(
|
||||
name="rag_agent",
|
||||
role="You are a helpful assistant that can answer questions with the help of the MongoDBVectorSearchTool.",
|
||||
goal="...",
|
||||
backstory="...",
|
||||
tools=[tool],
|
||||
)
|
||||
```
|
||||
|
||||
### Preloading the database and creating the index
|
||||
|
||||
```python Code
|
||||
import os
|
||||
from crewai_tools import MongoDBVectorSearchTool
|
||||
|
||||
tool = MongoDBVectorSearchTool(
|
||||
database_name="example_database",
|
||||
collection_name="example_collection",
|
||||
connection_string="<your_mongodb_connection_string>",
|
||||
)
|
||||
|
||||
# Load text content from a local folder and add to MongoDB
|
||||
texts = []
|
||||
for fname in os.listdir("knowledge"):
|
||||
path = os.path.join("knowledge", fname)
|
||||
if os.path.isfile(path):
|
||||
with open(path, "r", encoding="utf-8") as f:
|
||||
texts.append(f.read())
|
||||
|
||||
tool.add_texts(texts)
|
||||
|
||||
# Create the Atlas Vector Search index (e.g., 3072 dims for text-embedding-3-large)
|
||||
tool.create_vector_search_index(dimensions=3072)
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import MongoDBVectorSearchTool
|
||||
|
||||
tool = MongoDBVectorSearchTool(
|
||||
connection_string="mongodb+srv://...",
|
||||
database_name="mydb",
|
||||
collection_name="docs",
|
||||
)
|
||||
|
||||
agent = Agent(
|
||||
role="RAG Agent",
|
||||
goal="Answer using MongoDB vector search",
|
||||
backstory="Knowledge retrieval specialist",
|
||||
tools=[tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="Find relevant content for 'indexing guidance'",
|
||||
expected_output="A concise answer citing the most relevant matches",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[agent],
|
||||
tasks=[task],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
60
docs/pt-BR/tools/database-data/singlestoresearchtool.mdx
Normal file
60
docs/pt-BR/tools/database-data/singlestoresearchtool.mdx
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: SingleStore Search Tool
|
||||
description: The `SingleStoreSearchTool` safely executes SELECT/SHOW queries on SingleStore with pooling.
|
||||
icon: circle
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `SingleStoreSearchTool`
|
||||
|
||||
## Description
|
||||
|
||||
Execute read‑only queries (`SELECT`/`SHOW`) against SingleStore with connection pooling and input validation.
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
uv add crewai-tools[singlestore]
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
Variables like `SINGLESTOREDB_HOST`, `SINGLESTOREDB_USER`, `SINGLESTOREDB_PASSWORD`, etc., can be used, or `SINGLESTOREDB_URL` as a single DSN.
|
||||
|
||||
Generate the API key from the SingleStore dashboard, [docs here](https://docs.singlestore.com/cloud/reference/management-api/#generate-an-api-key).
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import SingleStoreSearchTool
|
||||
|
||||
tool = SingleStoreSearchTool(
|
||||
tables=["products"],
|
||||
host="host",
|
||||
user="user",
|
||||
password="pass",
|
||||
database="db",
|
||||
)
|
||||
|
||||
agent = Agent(
|
||||
role="Analyst",
|
||||
goal="Query SingleStore",
|
||||
tools=[tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="List 5 products",
|
||||
expected_output="5 rows as JSON/text",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[agent],
|
||||
tasks=[task],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
88
docs/pt-BR/tools/file-document/ocrtool.mdx
Normal file
88
docs/pt-BR/tools/file-document/ocrtool.mdx
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
title: OCR Tool
|
||||
description: The `OCRTool` extracts text from local images or image URLs using an LLM with vision.
|
||||
icon: image
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `OCRTool`
|
||||
|
||||
## Description
|
||||
|
||||
Extract text from images (local path or URL). Uses a vision‑capable LLM via CrewAI’s LLM interface.
|
||||
|
||||
## Installation
|
||||
|
||||
No extra install beyond `crewai-tools`. Ensure your selected LLM supports vision.
|
||||
|
||||
## Parameters
|
||||
|
||||
### Run Parameters
|
||||
|
||||
- `image_path_url` (str, required): Local image path or HTTP(S) URL.
|
||||
|
||||
## Examples
|
||||
|
||||
### Direct usage
|
||||
|
||||
```python Code
|
||||
from crewai_tools import OCRTool
|
||||
|
||||
print(OCRTool().run(image_path_url="/tmp/receipt.png"))
|
||||
```
|
||||
|
||||
### With an agent
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import OCRTool
|
||||
|
||||
ocr = OCRTool()
|
||||
|
||||
agent = Agent(
|
||||
role="OCR",
|
||||
goal="Extract text",
|
||||
tools=[ocr],
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="Extract text from https://example.com/invoice.jpg",
|
||||
expected_output="All detected text in plain text",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(agents=[agent], tasks=[task])
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- Ensure the selected LLM supports image inputs.
|
||||
- For large images, consider downscaling to reduce token usage.
|
||||
- You can pass a specific LLM instance to the tool (e.g., `LLM(model="gpt-4o")`) if needed, matching the README guidance.
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import OCRTool
|
||||
|
||||
tool = OCRTool()
|
||||
|
||||
agent = Agent(
|
||||
role="OCR Specialist",
|
||||
goal="Extract text from images",
|
||||
backstory="Vision‑enabled analyst",
|
||||
tools=[tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="Extract text from https://example.com/receipt.png",
|
||||
expected_output="All detected text in plain text",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(agents=[agent], tasks=[task])
|
||||
result = crew.kickoff()
|
||||
```
|
||||
75
docs/pt-BR/tools/file-document/pdf-text-writing-tool.mdx
Normal file
75
docs/pt-BR/tools/file-document/pdf-text-writing-tool.mdx
Normal file
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: PDF Text Writing Tool
|
||||
description: The `PDFTextWritingTool` writes text to specific positions in a PDF, supporting custom fonts.
|
||||
icon: file-pdf
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `PDFTextWritingTool`
|
||||
|
||||
## Description
|
||||
|
||||
Write text at precise coordinates on a PDF page, optionally embedding a custom TrueType font.
|
||||
|
||||
## Parameters
|
||||
|
||||
### Run Parameters
|
||||
|
||||
- `pdf_path` (str, required): Path to the input PDF.
|
||||
- `text` (str, required): Text to add.
|
||||
- `position` (tuple[int, int], required): `(x, y)` coordinates.
|
||||
- `font_size` (int, default `12`)
|
||||
- `font_color` (str, default `"0 0 0 rg"`)
|
||||
- `font_name` (str, default `"F1"`)
|
||||
- `font_file` (str, optional): Path to `.ttf` file.
|
||||
- `page_number` (int, default `0`)
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import PDFTextWritingTool
|
||||
|
||||
tool = PDFTextWritingTool()
|
||||
|
||||
agent = Agent(
|
||||
role="PDF Editor",
|
||||
goal="Annotate PDFs",
|
||||
backstory="Documentation specialist",
|
||||
tools=[tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="Write 'CONFIDENTIAL' at (72, 720) on page 1 of ./sample.pdf",
|
||||
expected_output="Confirmation message",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[agent],
|
||||
tasks=[task],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
### Direct usage
|
||||
|
||||
```python Code
|
||||
from crewai_tools import PDFTextWritingTool
|
||||
|
||||
PDFTextWritingTool().run(
|
||||
pdf_path="./input.pdf",
|
||||
text="CONFIDENTIAL",
|
||||
position=(72, 720),
|
||||
font_size=18,
|
||||
page_number=0,
|
||||
)
|
||||
```
|
||||
|
||||
## Tips
|
||||
|
||||
- Coordinate origin is the bottom‑left corner.
|
||||
- If using a custom font (`font_file`), ensure it is a valid `.ttf`.
|
||||
188
docs/pt-BR/tools/integration/bedrockinvokeagenttool.mdx
Normal file
188
docs/pt-BR/tools/integration/bedrockinvokeagenttool.mdx
Normal file
@@ -0,0 +1,188 @@
|
||||
---
|
||||
title: Bedrock Invoke Agent Tool
|
||||
description: Enables CrewAI agents to invoke Amazon Bedrock Agents and leverage their capabilities within your workflows
|
||||
icon: aws
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `BedrockInvokeAgentTool`
|
||||
|
||||
The `BedrockInvokeAgentTool` enables CrewAI agents to invoke Amazon Bedrock Agents and leverage their capabilities within your workflows.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
uv pip install 'crewai[tools]'
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- AWS credentials configured (either through environment variables or AWS CLI)
|
||||
- `boto3` and `python-dotenv` packages
|
||||
- Access to Amazon Bedrock Agents
|
||||
|
||||
## Usage
|
||||
|
||||
Here's how to use the tool with a CrewAI agent:
|
||||
|
||||
```python {2, 4-8}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
|
||||
|
||||
# Initialize the tool
|
||||
agent_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id"
|
||||
)
|
||||
|
||||
# Create a CrewAI agent that uses the tool
|
||||
aws_expert = Agent(
|
||||
role='AWS Service Expert',
|
||||
goal='Help users understand AWS services and quotas',
|
||||
backstory='I am an expert in AWS services and can provide detailed information about them.',
|
||||
tools=[agent_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create a task for the agent
|
||||
quota_task = Task(
|
||||
description="Find out the current service quotas for EC2 in us-west-2 and explain any recent changes.",
|
||||
agent=aws_expert
|
||||
)
|
||||
|
||||
# Create a crew with the agent
|
||||
crew = Crew(
|
||||
agents=[aws_expert],
|
||||
tasks=[quota_task],
|
||||
verbose=2
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Tool Arguments
|
||||
|
||||
| Argument | Type | Required | Default | Description |
|
||||
|:---------|:-----|:---------|:--------|:------------|
|
||||
| **agent_id** | `str` | Yes | None | The unique identifier of the Bedrock agent |
|
||||
| **agent_alias_id** | `str` | Yes | None | The unique identifier of the agent alias |
|
||||
| **session_id** | `str` | No | timestamp | The unique identifier of the session |
|
||||
| **enable_trace** | `bool` | No | False | Whether to enable trace for debugging |
|
||||
| **end_session** | `bool` | No | False | Whether to end the session after invocation |
|
||||
| **description** | `str` | No | None | Custom description for the tool |
|
||||
|
||||
## Environment Variables
|
||||
|
||||
```bash
|
||||
BEDROCK_AGENT_ID=your-agent-id # Alternative to passing agent_id
|
||||
BEDROCK_AGENT_ALIAS_ID=your-agent-alias-id # Alternative to passing agent_alias_id
|
||||
AWS_REGION=your-aws-region # Defaults to us-west-2
|
||||
AWS_ACCESS_KEY_ID=your-access-key # Required for AWS authentication
|
||||
AWS_SECRET_ACCESS_KEY=your-secret-key # Required for AWS authentication
|
||||
```
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Multi-Agent Workflow with Session Management
|
||||
|
||||
```python {2, 4-22}
|
||||
from crewai import Agent, Task, Crew, Process
|
||||
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
|
||||
|
||||
# Initialize tools with session management
|
||||
initial_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id",
|
||||
session_id="custom-session-id"
|
||||
)
|
||||
|
||||
followup_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id",
|
||||
session_id="custom-session-id"
|
||||
)
|
||||
|
||||
final_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id",
|
||||
session_id="custom-session-id",
|
||||
end_session=True
|
||||
)
|
||||
|
||||
# Create agents for different stages
|
||||
researcher = Agent(
|
||||
role='AWS Service Researcher',
|
||||
goal='Gather information about AWS services',
|
||||
backstory='I am specialized in finding detailed AWS service information.',
|
||||
tools=[initial_tool]
|
||||
)
|
||||
|
||||
analyst = Agent(
|
||||
role='Service Compatibility Analyst',
|
||||
goal='Analyze service compatibility and requirements',
|
||||
backstory='I analyze AWS services for compatibility and integration possibilities.',
|
||||
tools=[followup_tool]
|
||||
)
|
||||
|
||||
summarizer = Agent(
|
||||
role='Technical Documentation Writer',
|
||||
goal='Create clear technical summaries',
|
||||
backstory='I specialize in creating clear, concise technical documentation.',
|
||||
tools=[final_tool]
|
||||
)
|
||||
|
||||
# Create tasks
|
||||
research_task = Task(
|
||||
description="Find all available AWS services in us-west-2 region.",
|
||||
agent=researcher
|
||||
)
|
||||
|
||||
analysis_task = Task(
|
||||
description="Analyze which services support IPv6 and their implementation requirements.",
|
||||
agent=analyst
|
||||
)
|
||||
|
||||
summary_task = Task(
|
||||
description="Create a summary of IPv6-compatible services and their key features.",
|
||||
agent=summarizer
|
||||
)
|
||||
|
||||
# Create a crew with the agents and tasks
|
||||
crew = Crew(
|
||||
agents=[researcher, analyst, summarizer],
|
||||
tasks=[research_task, analysis_task, summary_task],
|
||||
process=Process.sequential,
|
||||
verbose=2
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Hybrid Multi-Agent Collaborations
|
||||
- Create workflows where CrewAI agents collaborate with managed Bedrock agents running as services in AWS
|
||||
- Enable scenarios where sensitive data processing happens within your AWS environment while other agents operate externally
|
||||
- Bridge on-premises CrewAI agents with cloud-based Bedrock agents for distributed intelligence workflows
|
||||
|
||||
### Data Sovereignty and Compliance
|
||||
- Keep data-sensitive agentic workflows within your AWS environment while allowing external CrewAI agents to orchestrate tasks
|
||||
- Maintain compliance with data residency requirements by processing sensitive information only within your AWS account
|
||||
- Enable secure multi-agent collaborations where some agents cannot access your organization's private data
|
||||
|
||||
### Seamless AWS Service Integration
|
||||
- Access any AWS service through Amazon Bedrock Actions without writing complex integration code
|
||||
- Enable CrewAI agents to interact with AWS services through natural language requests
|
||||
- Leverage pre-built Bedrock agent capabilities to interact with AWS services like Bedrock Knowledge Bases, Lambda, and more
|
||||
|
||||
### Scalable Hybrid Agent Architectures
|
||||
- Offload computationally intensive tasks to managed Bedrock agents while lightweight tasks run in CrewAI
|
||||
- Scale agent processing by distributing workloads between local CrewAI agents and cloud-based Bedrock agents
|
||||
|
||||
### Cross-Organizational Agent Collaboration
|
||||
- Enable secure collaboration between your organization's CrewAI agents and partner organizations' Bedrock agents
|
||||
- Create workflows where external expertise from Bedrock agents can be incorporated without exposing sensitive data
|
||||
- Build agent ecosystems that span organizational boundaries while maintaining security and data control
|
||||
276
docs/pt-BR/tools/integration/crewaiautomationtool.mdx
Normal file
276
docs/pt-BR/tools/integration/crewaiautomationtool.mdx
Normal file
@@ -0,0 +1,276 @@
|
||||
---
|
||||
title: CrewAI Run Automation Tool
|
||||
description: Enables CrewAI agents to invoke CrewAI Platform automations and leverage external crew services within your workflows.
|
||||
icon: robot
|
||||
---
|
||||
|
||||
# `InvokeCrewAIAutomationTool`
|
||||
|
||||
The `InvokeCrewAIAutomationTool` provides CrewAI Platform API integration with external crew services. This tool allows you to invoke and interact with CrewAI Platform automations from within your CrewAI agents, enabling seamless integration between different crew workflows.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
uv pip install 'crewai[tools]'
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- CrewAI Platform API access
|
||||
- Valid bearer token for authentication
|
||||
- Network access to CrewAI Platform automation endpoints
|
||||
|
||||
## Usage
|
||||
|
||||
Here's how to use the tool with a CrewAI agent:
|
||||
|
||||
```python {2, 4-9}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import InvokeCrewAIAutomationTool
|
||||
|
||||
# Initialize the tool
|
||||
automation_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://data-analysis-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="Data Analysis Crew",
|
||||
crew_description="Analyzes data and generates insights"
|
||||
)
|
||||
|
||||
# Create a CrewAI agent that uses the tool
|
||||
automation_coordinator = Agent(
|
||||
role='Automation Coordinator',
|
||||
goal='Coordinate and execute automated crew tasks',
|
||||
backstory='I am an expert at leveraging automation tools to execute complex workflows.',
|
||||
tools=[automation_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create a task for the agent
|
||||
analysis_task = Task(
|
||||
description="Execute data analysis automation and provide insights",
|
||||
agent=automation_coordinator,
|
||||
expected_output="Comprehensive data analysis report"
|
||||
)
|
||||
|
||||
# Create a crew with the agent
|
||||
crew = Crew(
|
||||
agents=[automation_coordinator],
|
||||
tasks=[analysis_task],
|
||||
verbose=2
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Tool Arguments
|
||||
|
||||
| Argument | Type | Required | Default | Description |
|
||||
|:---------|:-----|:---------|:--------|:------------|
|
||||
| **crew_api_url** | `str` | Yes | None | Base URL of the CrewAI Platform automation API |
|
||||
| **crew_bearer_token** | `str` | Yes | None | Bearer token for API authentication |
|
||||
| **crew_name** | `str` | Yes | None | Name of the crew automation |
|
||||
| **crew_description** | `str` | Yes | None | Description of what the crew automation does |
|
||||
| **max_polling_time** | `int` | No | 600 | Maximum time in seconds to wait for task completion |
|
||||
| **crew_inputs** | `dict` | No | None | Dictionary defining custom input schema fields |
|
||||
|
||||
## Environment Variables
|
||||
|
||||
```bash
|
||||
CREWAI_API_URL=https://your-crew-automation.crewai.com # Alternative to passing crew_api_url
|
||||
CREWAI_BEARER_TOKEN=your_bearer_token_here # Alternative to passing crew_bearer_token
|
||||
```
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Custom Input Schema with Dynamic Parameters
|
||||
|
||||
```python {2, 4-15}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import InvokeCrewAIAutomationTool
|
||||
from pydantic import Field
|
||||
|
||||
# Define custom input schema
|
||||
custom_inputs = {
|
||||
"year": Field(..., description="Year to retrieve the report for (integer)"),
|
||||
"region": Field(default="global", description="Geographic region for analysis"),
|
||||
"format": Field(default="summary", description="Report format (summary, detailed, raw)")
|
||||
}
|
||||
|
||||
# Create tool with custom inputs
|
||||
market_research_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://state-of-ai-report-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="State of AI Report",
|
||||
crew_description="Retrieves a comprehensive report on state of AI for a given year and region",
|
||||
crew_inputs=custom_inputs,
|
||||
max_polling_time=15 * 60 # 15 minutes timeout
|
||||
)
|
||||
|
||||
# Create an agent with the tool
|
||||
research_agent = Agent(
|
||||
role="Research Coordinator",
|
||||
goal="Coordinate and execute market research tasks",
|
||||
backstory="You are an expert at coordinating research tasks and leveraging automation tools.",
|
||||
tools=[market_research_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create and execute a task with custom parameters
|
||||
research_task = Task(
|
||||
description="Conduct market research on AI tools market for 2024 in North America with detailed format",
|
||||
agent=research_agent,
|
||||
expected_output="Comprehensive market research report"
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[research_agent],
|
||||
tasks=[research_task]
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
### Multi-Stage Automation Workflow
|
||||
|
||||
```python {2, 4-35}
|
||||
from crewai import Agent, Task, Crew, Process
|
||||
from crewai_tools import InvokeCrewAIAutomationTool
|
||||
|
||||
# Initialize different automation tools
|
||||
data_collection_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://data-collection-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="Data Collection Automation",
|
||||
crew_description="Collects and preprocesses raw data"
|
||||
)
|
||||
|
||||
analysis_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://analysis-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="Analysis Automation",
|
||||
crew_description="Performs advanced data analysis and modeling"
|
||||
)
|
||||
|
||||
reporting_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://reporting-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="Reporting Automation",
|
||||
crew_description="Generates comprehensive reports and visualizations"
|
||||
)
|
||||
|
||||
# Create specialized agents
|
||||
data_collector = Agent(
|
||||
role='Data Collection Specialist',
|
||||
goal='Gather and preprocess data from various sources',
|
||||
backstory='I specialize in collecting and cleaning data from multiple sources.',
|
||||
tools=[data_collection_tool]
|
||||
)
|
||||
|
||||
data_analyst = Agent(
|
||||
role='Data Analysis Expert',
|
||||
goal='Perform advanced analysis on collected data',
|
||||
backstory='I am an expert in statistical analysis and machine learning.',
|
||||
tools=[analysis_tool]
|
||||
)
|
||||
|
||||
report_generator = Agent(
|
||||
role='Report Generation Specialist',
|
||||
goal='Create comprehensive reports and visualizations',
|
||||
backstory='I excel at creating clear, actionable reports from complex data.',
|
||||
tools=[reporting_tool]
|
||||
)
|
||||
|
||||
# Create sequential tasks
|
||||
collection_task = Task(
|
||||
description="Collect market data for Q4 2024 analysis",
|
||||
agent=data_collector
|
||||
)
|
||||
|
||||
analysis_task = Task(
|
||||
description="Analyze collected data to identify trends and patterns",
|
||||
agent=data_analyst
|
||||
)
|
||||
|
||||
reporting_task = Task(
|
||||
description="Generate executive summary report with key insights and recommendations",
|
||||
agent=report_generator
|
||||
)
|
||||
|
||||
# Create a crew with sequential processing
|
||||
crew = Crew(
|
||||
agents=[data_collector, data_analyst, report_generator],
|
||||
tasks=[collection_task, analysis_task, reporting_task],
|
||||
process=Process.sequential,
|
||||
verbose=2
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Distributed Crew Orchestration
|
||||
- Coordinate multiple specialized crew automations to handle complex, multi-stage workflows
|
||||
- Enable seamless handoffs between different automation services for comprehensive task execution
|
||||
- Scale processing by distributing workloads across multiple CrewAI Platform automations
|
||||
|
||||
### Cross-Platform Integration
|
||||
- Bridge CrewAI agents with CrewAI Platform automations for hybrid local-cloud workflows
|
||||
- Leverage specialized automations while maintaining local control and orchestration
|
||||
- Enable secure collaboration between local agents and cloud-based automation services
|
||||
|
||||
### Enterprise Automation Pipelines
|
||||
- Create enterprise-grade automation pipelines that combine local intelligence with cloud processing power
|
||||
- Implement complex business workflows that span multiple automation services
|
||||
- Enable scalable, repeatable processes for data analysis, reporting, and decision-making
|
||||
|
||||
### Dynamic Workflow Composition
|
||||
- Dynamically compose workflows by chaining different automation services based on task requirements
|
||||
- Enable adaptive processing where the choice of automation depends on data characteristics or business rules
|
||||
- Create flexible, reusable automation components that can be combined in various ways
|
||||
|
||||
### Specialized Domain Processing
|
||||
- Access domain-specific automations (financial analysis, legal research, technical documentation) from general-purpose agents
|
||||
- Leverage pre-built, specialized crew automations without rebuilding complex domain logic
|
||||
- Enable agents to access expert-level capabilities through targeted automation services
|
||||
|
||||
## Custom Input Schema
|
||||
|
||||
When defining `crew_inputs`, use Pydantic Field objects to specify the input parameters:
|
||||
|
||||
```python
|
||||
from pydantic import Field
|
||||
|
||||
crew_inputs = {
|
||||
"required_param": Field(..., description="This parameter is required"),
|
||||
"optional_param": Field(default="default_value", description="This parameter is optional"),
|
||||
"typed_param": Field(..., description="Integer parameter", ge=1, le=100) # With validation
|
||||
}
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
The tool provides comprehensive error handling for common scenarios:
|
||||
|
||||
- **API Connection Errors**: Network connectivity issues with CrewAI Platform
|
||||
- **Authentication Errors**: Invalid or expired bearer tokens
|
||||
- **Timeout Errors**: Tasks that exceed the maximum polling time
|
||||
- **Task Failures**: Crew automations that fail during execution
|
||||
- **Input Validation Errors**: Invalid parameters passed to automation endpoints
|
||||
|
||||
## API Endpoints
|
||||
|
||||
The tool interacts with two main API endpoints:
|
||||
|
||||
- `POST {crew_api_url}/kickoff`: Starts a new crew automation task
|
||||
- `GET {crew_api_url}/status/{crew_id}`: Checks the status of a running task
|
||||
|
||||
## Notes
|
||||
|
||||
- The tool automatically polls the status endpoint every second until completion or timeout
|
||||
- Successful tasks return the result directly, while failed tasks return error information
|
||||
- Bearer tokens should be kept secure and not hardcoded in production environments
|
||||
- Consider using environment variables for sensitive configuration like bearer tokens
|
||||
- Custom input schemas must be compatible with the target crew automation's expected parameters
|
||||
72
docs/pt-BR/tools/integration/overview.mdx
Normal file
72
docs/pt-BR/tools/integration/overview.mdx
Normal file
@@ -0,0 +1,72 @@
|
||||
---
|
||||
title: "Visão Geral"
|
||||
description: "Conecte agentes CrewAI com automações externas e serviços de IA gerenciados"
|
||||
icon: "plug"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
As ferramentas de integração permitem que seus agentes deleguem trabalho para outras plataformas de automação e serviços de IA gerenciados. Use-as quando o fluxo precisar invocar uma automação já publicada no CrewAI Platform ou quando for necessário direcionar tarefas para provedores especializados, como Amazon Bedrock.
|
||||
|
||||
## **Ferramentas Disponíveis**
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Ferramenta de Execução de Automação CrewAI" icon="robot" href="/pt-BR/tools/integration/crewaiautomationtool">
|
||||
Invoque automações ativas do CrewAI Platform, envie entradas personalizadas e acompanhe o resultado diretamente do seu agente.
|
||||
</Card>
|
||||
|
||||
<Card title="Ferramenta Bedrock Invoke Agent" icon="aws" href="/pt-BR/tools/integration/bedrockinvokeagenttool">
|
||||
Acesse agentes do Amazon Bedrock a partir das suas crews, reutilize guardrails existentes da AWS e traga as respostas de volta ao fluxo atual.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## **Casos de Uso Comuns**
|
||||
|
||||
- **Encadear automações**: Inicie uma automação do CrewAI a partir de outra crew ou flow
|
||||
- **Hand-off corporativo**: Direcione tarefas para agentes Bedrock que já incorporam políticas e guardrails internos
|
||||
- **Workflows híbridos**: Combine o raciocínio do CrewAI com sistemas externos que expõem APIs de agente
|
||||
- **Tarefas demoradas**: Faça polling de automações externas e mescle o resultado final na execução atual
|
||||
|
||||
## **Exemplo de Início Rápido**
|
||||
|
||||
```python
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import InvokeCrewAIAutomationTool
|
||||
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
|
||||
|
||||
# Automação externa
|
||||
analysis_automation = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://analysis-crew.acme.crewai.com",
|
||||
crew_bearer_token="YOUR_BEARER_TOKEN",
|
||||
crew_name="Analysis Automation",
|
||||
crew_description="Executa o pipeline de análise em produção",
|
||||
)
|
||||
|
||||
# Agente gerenciado no Bedrock
|
||||
knowledge_router = BedrockInvokeAgentTool(
|
||||
agent_id="bedrock-agent-id",
|
||||
agent_alias_id="prod",
|
||||
)
|
||||
|
||||
automation_strategist = Agent(
|
||||
role="Estrategista de Automação",
|
||||
goal="Orquestrar automações externas e resumir os resultados",
|
||||
backstory="Você coordena fluxos corporativos e sabe quando delegar tarefas a serviços especializados.",
|
||||
tools=[analysis_automation, knowledge_router],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
execute_playbook = Task(
|
||||
description="Execute a automação de análise e peça ao agente Bedrock pontos principais para a diretoria.",
|
||||
agent=automation_strategist,
|
||||
)
|
||||
|
||||
Crew(agents=[automation_strategist], tasks=[execute_playbook]).kickoff()
|
||||
```
|
||||
|
||||
## **Boas Práticas**
|
||||
|
||||
- **Proteja credenciais**: Armazene tokens e chaves de API em variáveis de ambiente ou no gerenciador de segredos
|
||||
- **Planeje a latência**: Automações externas podem levar mais tempo — configure intervalos e timeouts adequados
|
||||
- **Reutilize sessões**: Agentes Bedrock aceitam IDs de sessão para manter contexto entre chamadas
|
||||
- **Valide respostas**: Normalize a saída remota (JSON, texto, códigos de status) antes de enviá-la a etapas seguintes
|
||||
- **Monitore o uso**: Acompanhe logs no CrewAI Platform ou no AWS CloudWatch para evitar estouros de quota e falhas
|
||||
111
docs/pt-BR/tools/search-research/arxivpapertool.mdx
Normal file
111
docs/pt-BR/tools/search-research/arxivpapertool.mdx
Normal file
@@ -0,0 +1,111 @@
|
||||
---
|
||||
title: Arxiv Paper Tool
|
||||
description: The `ArxivPaperTool` searches arXiv for papers matching a query and optionally downloads PDFs.
|
||||
icon: box-archive
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `ArxivPaperTool`
|
||||
|
||||
## Description
|
||||
|
||||
The `ArxivPaperTool` queries the arXiv API for academic papers and returns compact, readable results. It can also optionally download PDFs to disk.
|
||||
|
||||
## Installation
|
||||
|
||||
This tool has no special installation beyond `crewai-tools`.
|
||||
|
||||
```shell
|
||||
uv add crewai-tools
|
||||
```
|
||||
|
||||
No API key is required. This tool uses the public arXiv Atom API.
|
||||
|
||||
## Steps to Get Started
|
||||
|
||||
1. Initialize the tool.
|
||||
2. Provide a `search_query` (e.g., "transformer neural network").
|
||||
3. Optionally set `max_results` (1–100) and enable PDF downloads in the constructor.
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import ArxivPaperTool
|
||||
|
||||
tool = ArxivPaperTool(
|
||||
download_pdfs=False,
|
||||
save_dir="./arxiv_pdfs",
|
||||
use_title_as_filename=True,
|
||||
)
|
||||
|
||||
agent = Agent(
|
||||
role="Researcher",
|
||||
goal="Find relevant arXiv papers",
|
||||
backstory="Expert at literature discovery",
|
||||
tools=[tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="Search arXiv for 'transformer neural network' and list top 5 results.",
|
||||
expected_output="A concise list of 5 relevant papers with titles, links, and summaries.",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(agents=[agent], tasks=[task])
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
### Direct usage (without Agent)
|
||||
|
||||
```python Code
|
||||
from crewai_tools import ArxivPaperTool
|
||||
|
||||
tool = ArxivPaperTool(
|
||||
download_pdfs=True,
|
||||
save_dir="./arxiv_pdfs",
|
||||
)
|
||||
print(tool.run(search_query="mixture of experts", max_results=3))
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### Initialization Parameters
|
||||
|
||||
- `download_pdfs` (bool, default `False`): Whether to download PDFs.
|
||||
- `save_dir` (str, default `./arxiv_pdfs`): Directory to save PDFs.
|
||||
- `use_title_as_filename` (bool, default `False`): Use paper titles for filenames.
|
||||
|
||||
### Run Parameters
|
||||
|
||||
- `search_query` (str, required): The arXiv search query.
|
||||
- `max_results` (int, default `5`, range 1–100): Number of results.
|
||||
|
||||
## Output format
|
||||
|
||||
The tool returns a human‑readable list of papers with:
|
||||
- Title
|
||||
- Link (abs page)
|
||||
- Snippet/summary (truncated)
|
||||
|
||||
When `download_pdfs=True`, PDFs are saved to disk and the summary mentions saved files.
|
||||
|
||||
## Usage Notes
|
||||
|
||||
- The tool returns formatted text with key metadata and links.
|
||||
- When `download_pdfs=True`, PDFs will be stored in `save_dir`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- If you receive a network timeout, re‑try or reduce `max_results`.
|
||||
- Invalid XML errors indicate an arXiv response parse issue; try a simpler query.
|
||||
- File system errors (e.g., permission denied) may occur when saving PDFs; ensure `save_dir` is writable.
|
||||
|
||||
## Related links
|
||||
|
||||
- arXiv API docs: https://info.arxiv.org/help/api/index.html
|
||||
|
||||
## Error Handling
|
||||
|
||||
- Network issues, invalid XML, and OS errors are handled with informative messages.
|
||||
79
docs/pt-BR/tools/search-research/databricks-query-tool.mdx
Normal file
79
docs/pt-BR/tools/search-research/databricks-query-tool.mdx
Normal file
@@ -0,0 +1,79 @@
|
||||
---
|
||||
title: Databricks SQL Query Tool
|
||||
description: The `DatabricksQueryTool` executes SQL queries against Databricks workspace tables.
|
||||
icon: trowel-bricks
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `DatabricksQueryTool`
|
||||
|
||||
## Description
|
||||
|
||||
Run SQL against Databricks workspace tables with either CLI profile or direct host/token authentication.
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
uv add crewai-tools[databricks-sdk]
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
- `DATABRICKS_CONFIG_PROFILE` or (`DATABRICKS_HOST` + `DATABRICKS_TOKEN`)
|
||||
|
||||
Create a personal access token and find host details in the Databricks workspace under User Settings → Developer.
|
||||
Docs: https://docs.databricks.com/en/dev-tools/auth/pat.html
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import DatabricksQueryTool
|
||||
|
||||
tool = DatabricksQueryTool(
|
||||
default_catalog="main",
|
||||
default_schema="default",
|
||||
)
|
||||
|
||||
agent = Agent(
|
||||
role="Data Analyst",
|
||||
goal="Query Databricks",
|
||||
tools=[tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="SELECT * FROM my_table LIMIT 10",
|
||||
expected_output="10 rows",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[agent],
|
||||
tasks=[task],
|
||||
verbose=True,
|
||||
)
|
||||
result = crew.kickoff()
|
||||
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
- `query` (required): SQL query to execute
|
||||
- `catalog` (optional): Override default catalog
|
||||
- `db_schema` (optional): Override default schema
|
||||
- `warehouse_id` (optional): Override default SQL warehouse
|
||||
- `row_limit` (optional): Maximum rows to return (default: 1000)
|
||||
|
||||
## Defaults on initialization
|
||||
|
||||
- `default_catalog`
|
||||
- `default_schema`
|
||||
- `default_warehouse_id`
|
||||
|
||||
### Error handling & tips
|
||||
|
||||
- Authentication errors: verify `DATABRICKS_HOST` begins with `https://` and token is valid.
|
||||
- Permissions: ensure your SQL warehouse and schema are accessible by your token.
|
||||
- Limits: long‑running queries should be avoided in agent loops; add filters/limits.
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: SerpApi Google Search Tool
|
||||
description: The `SerpApiGoogleSearchTool` performs Google searches using the SerpApi service.
|
||||
icon: google
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `SerpApiGoogleSearchTool`
|
||||
|
||||
## Description
|
||||
|
||||
Use the `SerpApiGoogleSearchTool` to run Google searches with SerpApi and retrieve structured results. Requires a SerpApi API key.
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
uv add crewai-tools[serpapi]
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
- `SERPAPI_API_KEY` (required): API key for SerpApi. Create one at https://serpapi.com/ (free tier available).
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import SerpApiGoogleSearchTool
|
||||
|
||||
tool = SerpApiGoogleSearchTool()
|
||||
|
||||
agent = Agent(
|
||||
role="Researcher",
|
||||
goal="Answer questions using Google search",
|
||||
backstory="Search specialist",
|
||||
tools=[tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="Search for the latest CrewAI releases",
|
||||
expected_output="A concise list of relevant results with titles and links",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(agents=[agent], tasks=[task])
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- Set `SERPAPI_API_KEY` in the environment. Create a key at https://serpapi.com/
|
||||
- See also Google Shopping via SerpApi: `/en/tools/search-research/serpapi-googleshoppingtool`
|
||||
|
||||
## Parameters
|
||||
|
||||
### Run Parameters
|
||||
|
||||
- `search_query` (str, required): The Google query.
|
||||
- `location` (str, optional): Geographic location parameter.
|
||||
|
||||
## Notes
|
||||
|
||||
- This tool wraps SerpApi and returns structured search results.
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: SerpApi Google Shopping Tool
|
||||
description: The `SerpApiGoogleShoppingTool` searches Google Shopping results using SerpApi.
|
||||
icon: cart-shopping
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `SerpApiGoogleShoppingTool`
|
||||
|
||||
## Description
|
||||
|
||||
Leverage `SerpApiGoogleShoppingTool` to query Google Shopping via SerpApi and retrieve product-oriented results.
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
uv add crewai-tools[serpapi]
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
- `SERPAPI_API_KEY` (required): API key for SerpApi. Create one at https://serpapi.com/ (free tier available).
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import SerpApiGoogleShoppingTool
|
||||
|
||||
tool = SerpApiGoogleShoppingTool()
|
||||
|
||||
agent = Agent(
|
||||
role="Shopping Researcher",
|
||||
goal="Find relevant products",
|
||||
backstory="Expert in product search",
|
||||
tools=[tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="Search Google Shopping for 'wireless noise-canceling headphones'",
|
||||
expected_output="Top relevant products with titles and links",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(agents=[agent], tasks=[task])
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- Set `SERPAPI_API_KEY` in the environment. Create a key at https://serpapi.com/
|
||||
- See also Google Web Search via SerpApi: `/en/tools/search-research/serpapi-googlesearchtool`
|
||||
|
||||
## Parameters
|
||||
|
||||
### Run Parameters
|
||||
|
||||
- `search_query` (str, required): Product search query.
|
||||
- `location` (str, optional): Geographic location parameter.
|
||||
140
docs/pt-BR/tools/search-research/tavilyextractortool.mdx
Normal file
140
docs/pt-BR/tools/search-research/tavilyextractortool.mdx
Normal file
@@ -0,0 +1,140 @@
|
||||
---
|
||||
title: "Tavily Extractor Tool"
|
||||
description: "Extract structured content from web pages using the Tavily API"
|
||||
icon: square-poll-horizontal
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
The `TavilyExtractorTool` allows CrewAI agents to extract structured content from web pages using the Tavily API. It can process single URLs or lists of URLs and provides options for controlling the extraction depth and including images.
|
||||
|
||||
## Installation
|
||||
|
||||
To use the `TavilyExtractorTool`, you need to install the `tavily-python` library:
|
||||
|
||||
```shell
|
||||
pip install 'crewai[tools]' tavily-python
|
||||
```
|
||||
|
||||
You also need to set your Tavily API key as an environment variable:
|
||||
|
||||
```bash
|
||||
export TAVILY_API_KEY='your-tavily-api-key'
|
||||
```
|
||||
|
||||
## Example Usage
|
||||
|
||||
Here's how to initialize and use the `TavilyExtractorTool` within a CrewAI agent:
|
||||
|
||||
```python
|
||||
import os
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import TavilyExtractorTool
|
||||
|
||||
# Ensure TAVILY_API_KEY is set in your environment
|
||||
# os.environ["TAVILY_API_KEY"] = "YOUR_API_KEY"
|
||||
|
||||
# Initialize the tool
|
||||
tavily_tool = TavilyExtractorTool()
|
||||
|
||||
# Create an agent that uses the tool
|
||||
extractor_agent = Agent(
|
||||
role='Web Content Extractor',
|
||||
goal='Extract key information from specified web pages',
|
||||
backstory='You are an expert at extracting relevant content from websites using the Tavily API.',
|
||||
tools=[tavily_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Define a task for the agent
|
||||
extract_task = Task(
|
||||
description='Extract the main content from the URL https://example.com using basic extraction depth.',
|
||||
expected_output='A JSON string containing the extracted content from the URL.',
|
||||
agent=extractor_agent
|
||||
)
|
||||
|
||||
# Create and run the crew
|
||||
crew = Crew(
|
||||
agents=[extractor_agent],
|
||||
tasks=[extract_task],
|
||||
verbose=2
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Configuration Options
|
||||
|
||||
The `TavilyExtractorTool` accepts the following arguments:
|
||||
|
||||
- `urls` (Union[List[str], str]): **Required**. A single URL string or a list of URL strings to extract data from.
|
||||
- `include_images` (Optional[bool]): Whether to include images in the extraction results. Defaults to `False`.
|
||||
- `extract_depth` (Literal["basic", "advanced"]): The depth of extraction. Use `"basic"` for faster, surface-level extraction or `"advanced"` for more comprehensive extraction. Defaults to `"basic"`.
|
||||
- `timeout` (int): The maximum time in seconds to wait for the extraction request to complete. Defaults to `60`.
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Multiple URLs with Advanced Extraction
|
||||
|
||||
```python
|
||||
# Example with multiple URLs and advanced extraction
|
||||
multi_extract_task = Task(
|
||||
description='Extract content from https://example.com and https://anotherexample.org using advanced extraction.',
|
||||
expected_output='A JSON string containing the extracted content from both URLs.',
|
||||
agent=extractor_agent
|
||||
)
|
||||
|
||||
# Configure the tool with custom parameters
|
||||
custom_extractor = TavilyExtractorTool(
|
||||
extract_depth='advanced',
|
||||
include_images=True,
|
||||
timeout=120
|
||||
)
|
||||
|
||||
agent_with_custom_tool = Agent(
|
||||
role="Advanced Content Extractor",
|
||||
goal="Extract comprehensive content with images",
|
||||
tools=[custom_extractor]
|
||||
)
|
||||
```
|
||||
|
||||
### Tool Parameters
|
||||
|
||||
You can customize the tool's behavior by setting parameters during initialization:
|
||||
|
||||
```python
|
||||
# Initialize with custom configuration
|
||||
extractor_tool = TavilyExtractorTool(
|
||||
extract_depth='advanced', # More comprehensive extraction
|
||||
include_images=True, # Include image results
|
||||
timeout=90 # Custom timeout
|
||||
)
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **Single or Multiple URLs**: Extract content from one URL or process multiple URLs in a single request
|
||||
- **Configurable Depth**: Choose between basic (fast) and advanced (comprehensive) extraction modes
|
||||
- **Image Support**: Optionally include images in the extraction results
|
||||
- **Structured Output**: Returns well-formatted JSON containing the extracted content
|
||||
- **Error Handling**: Robust handling of network timeouts and extraction errors
|
||||
|
||||
## Response Format
|
||||
|
||||
The tool returns a JSON string representing the structured data extracted from the provided URL(s). The exact structure depends on the content of the pages and the `extract_depth` used.
|
||||
|
||||
Common response elements include:
|
||||
- **Title**: The page title
|
||||
- **Content**: Main text content of the page
|
||||
- **Images**: Image URLs and metadata (when `include_images=True`)
|
||||
- **Metadata**: Additional page information like author, description, etc.
|
||||
|
||||
## Use Cases
|
||||
|
||||
- **Content Analysis**: Extract and analyze content from competitor websites
|
||||
- **Research**: Gather structured data from multiple sources for analysis
|
||||
- **Content Migration**: Extract content from existing websites for migration
|
||||
- **Monitoring**: Regular extraction of content for change detection
|
||||
- **Data Collection**: Systematic extraction of information from web sources
|
||||
|
||||
Refer to the [Tavily API documentation](https://docs.tavily.com/docs/tavily-api/python-sdk#extract) for detailed information about the response structure and available options.
|
||||
125
docs/pt-BR/tools/search-research/tavilysearchtool.mdx
Normal file
125
docs/pt-BR/tools/search-research/tavilysearchtool.mdx
Normal file
@@ -0,0 +1,125 @@
|
||||
---
|
||||
title: "Tavily Search Tool"
|
||||
description: "Perform comprehensive web searches using the Tavily Search API"
|
||||
icon: "magnifying-glass"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
The `TavilySearchTool` provides an interface to the Tavily Search API, enabling CrewAI agents to perform comprehensive web searches. It allows for specifying search depth, topics, time ranges, included/excluded domains, and whether to include direct answers, raw content, or images in the results.
|
||||
|
||||
## Installation
|
||||
|
||||
To use the `TavilySearchTool`, you need to install the `tavily-python` library:
|
||||
|
||||
```shell
|
||||
pip install 'crewai[tools]' tavily-python
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
Ensure your Tavily API key is set as an environment variable:
|
||||
|
||||
```bash
|
||||
export TAVILY_API_KEY='your_tavily_api_key'
|
||||
```
|
||||
|
||||
Get an API key at https://app.tavily.com/ (sign up, then create a key).
|
||||
|
||||
## Example Usage
|
||||
|
||||
Here's how to initialize and use the `TavilySearchTool` within a CrewAI agent:
|
||||
|
||||
```python
|
||||
import os
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import TavilySearchTool
|
||||
|
||||
# Ensure the TAVILY_API_KEY environment variable is set
|
||||
# os.environ["TAVILY_API_KEY"] = "YOUR_TAVILY_API_KEY"
|
||||
|
||||
# Initialize the tool
|
||||
tavily_tool = TavilySearchTool()
|
||||
|
||||
# Create an agent that uses the tool
|
||||
researcher = Agent(
|
||||
role='Market Researcher',
|
||||
goal='Find information about the latest AI trends',
|
||||
backstory='An expert market researcher specializing in technology.',
|
||||
tools=[tavily_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create a task for the agent
|
||||
research_task = Task(
|
||||
description='Search for the top 3 AI trends in 2024.',
|
||||
expected_output='A JSON report summarizing the top 3 AI trends found.',
|
||||
agent=researcher
|
||||
)
|
||||
|
||||
# Form the crew and kick it off
|
||||
crew = Crew(
|
||||
agents=[researcher],
|
||||
tasks=[research_task],
|
||||
verbose=2
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Configuration Options
|
||||
|
||||
The `TavilySearchTool` accepts the following arguments during initialization or when calling the `run` method:
|
||||
|
||||
- `query` (str): **Required**. The search query string.
|
||||
- `search_depth` (Literal["basic", "advanced"], optional): The depth of the search. Defaults to `"basic"`.
|
||||
- `topic` (Literal["general", "news", "finance"], optional): The topic to focus the search on. Defaults to `"general"`.
|
||||
- `time_range` (Literal["day", "week", "month", "year"], optional): The time range for the search. Defaults to `None`.
|
||||
- `days` (int, optional): The number of days to search back. Relevant if `time_range` is not set. Defaults to `7`.
|
||||
- `max_results` (int, optional): The maximum number of search results to return. Defaults to `5`.
|
||||
- `include_domains` (Sequence[str], optional): A list of domains to prioritize in the search. Defaults to `None`.
|
||||
- `exclude_domains` (Sequence[str], optional): A list of domains to exclude from the search. Defaults to `None`.
|
||||
- `include_answer` (Union[bool, Literal["basic", "advanced"]], optional): Whether to include a direct answer synthesized from the search results. Defaults to `False`.
|
||||
- `include_raw_content` (bool, optional): Whether to include the raw HTML content of the searched pages. Defaults to `False`.
|
||||
- `include_images` (bool, optional): Whether to include image results. Defaults to `False`.
|
||||
- `timeout` (int, optional): The request timeout in seconds. Defaults to `60`.
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
You can configure the tool with custom parameters:
|
||||
|
||||
```python
|
||||
# Example: Initialize with specific parameters
|
||||
custom_tavily_tool = TavilySearchTool(
|
||||
search_depth='advanced',
|
||||
max_results=10,
|
||||
include_answer=True
|
||||
)
|
||||
|
||||
# The agent will use these defaults
|
||||
agent_with_custom_tool = Agent(
|
||||
role="Advanced Researcher",
|
||||
goal="Conduct detailed research with comprehensive results",
|
||||
tools=[custom_tavily_tool]
|
||||
)
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **Comprehensive Search**: Access to Tavily's powerful search index
|
||||
- **Configurable Depth**: Choose between basic and advanced search modes
|
||||
- **Topic Filtering**: Focus searches on general, news, or finance topics
|
||||
- **Time Range Control**: Limit results to specific time periods
|
||||
- **Domain Control**: Include or exclude specific domains
|
||||
- **Direct Answers**: Get synthesized answers from search results
|
||||
- **Content Filtering**: Prevent context window issues with automatic content truncation
|
||||
|
||||
## Response Format
|
||||
|
||||
The tool returns search results as a JSON string containing:
|
||||
- Search results with titles, URLs, and content snippets
|
||||
- Optional direct answers to queries
|
||||
- Optional image results
|
||||
- Optional raw HTML content (when enabled)
|
||||
|
||||
Content for each result is automatically truncated to prevent context window issues while maintaining the most relevant information.
|
||||
30
docs/pt-BR/tools/tool-integrations/overview.mdx
Normal file
30
docs/pt-BR/tools/tool-integrations/overview.mdx
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
title: Overview
|
||||
description: Integrations for deploying and automating crews with external platforms
|
||||
icon: face-smile
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
## Available Integrations
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Bedrock Invoke Agent Tool"
|
||||
icon="cloud"
|
||||
href="/en/tools/tool-integrations/bedrockinvokeagenttool"
|
||||
color="#0891B2"
|
||||
>
|
||||
Invoke Amazon Bedrock Agents from CrewAI to orchestrate actions across AWS services.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
title="CrewAI Automation Tool"
|
||||
icon="bolt"
|
||||
href="/en/tools/tool-integrations/crewaiautomationtool"
|
||||
color="#7C3AED"
|
||||
>
|
||||
Automate deployment and operations by integrating CrewAI with external platforms and workflows.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
Use these integrations to connect CrewAI with your infrastructure and workflows.
|
||||
110
docs/pt-BR/tools/web-scraping/brightdata-tools.mdx
Normal file
110
docs/pt-BR/tools/web-scraping/brightdata-tools.mdx
Normal file
@@ -0,0 +1,110 @@
|
||||
---
|
||||
title: Bright Data Tools
|
||||
description: Bright Data integrations for SERP search, Web Unlocker scraping, and Dataset API.
|
||||
icon: spider
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# Bright Data Tools
|
||||
|
||||
This set of tools integrates Bright Data services for web extraction.
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
uv add crewai-tools requests aiohttp
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
- `BRIGHT_DATA_API_KEY` (required)
|
||||
- `BRIGHT_DATA_ZONE` (for SERP/Web Unlocker)
|
||||
|
||||
Create credentials at https://brightdata.com/ (sign up, then create an API token and zone).
|
||||
See their docs: https://developers.brightdata.com/
|
||||
|
||||
## Included Tools
|
||||
|
||||
- `BrightDataSearchTool`: SERP search (Google/Bing/Yandex) with geo/language/device options.
|
||||
- `BrightDataWebUnlockerTool`: Scrape pages with anti-bot bypass and rendering.
|
||||
- `BrightDataDatasetTool`: Run Dataset API jobs and fetch results.
|
||||
|
||||
## Examples
|
||||
|
||||
### SERP Search
|
||||
|
||||
```python Code
|
||||
from crewai_tools import BrightDataSearchTool
|
||||
|
||||
tool = BrightDataSearchTool(
|
||||
query="CrewAI",
|
||||
country="us",
|
||||
)
|
||||
|
||||
print(tool.run())
|
||||
```
|
||||
|
||||
### Web Unlocker
|
||||
|
||||
```python Code
|
||||
from crewai_tools import BrightDataWebUnlockerTool
|
||||
|
||||
tool = BrightDataWebUnlockerTool(
|
||||
url="https://example.com",
|
||||
format="markdown",
|
||||
)
|
||||
|
||||
print(tool.run(url="https://example.com"))
|
||||
```
|
||||
|
||||
### Dataset API
|
||||
|
||||
```python Code
|
||||
from crewai_tools import BrightDataDatasetTool
|
||||
|
||||
tool = BrightDataDatasetTool(
|
||||
dataset_type="ecommerce",
|
||||
url="https://example.com/product",
|
||||
)
|
||||
|
||||
print(tool.run())
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- 401/403: verify `BRIGHT_DATA_API_KEY` and `BRIGHT_DATA_ZONE`.
|
||||
- Empty/blocked content: enable rendering or try a different zone.
|
||||
|
||||
## Example
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import BrightDataSearchTool
|
||||
|
||||
tool = BrightDataSearchTool(
|
||||
query="CrewAI",
|
||||
country="us",
|
||||
)
|
||||
|
||||
agent = Agent(
|
||||
role="Web Researcher",
|
||||
goal="Search with Bright Data",
|
||||
backstory="Finds reliable results",
|
||||
tools=[tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
task = Task(
|
||||
description="Search for CrewAI and summarize top results",
|
||||
expected_output="Short summary with links",
|
||||
agent=agent,
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[agent],
|
||||
tasks=[task],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
101
docs/pt-BR/tools/web-scraping/serperscrapewebsitetool.mdx
Normal file
101
docs/pt-BR/tools/web-scraping/serperscrapewebsitetool.mdx
Normal file
@@ -0,0 +1,101 @@
|
||||
---
|
||||
title: Serper Scrape Website
|
||||
description: The `SerperScrapeWebsiteTool` is designed to scrape websites and extract clean, readable content using Serper's scraping API.
|
||||
icon: globe
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `SerperScrapeWebsiteTool`
|
||||
|
||||
## Description
|
||||
|
||||
This tool is designed to scrape website content and extract clean, readable text from any website URL. It utilizes the [serper.dev](https://serper.dev) scraping API to fetch and process web pages, optionally including markdown formatting for better structure and readability.
|
||||
|
||||
## Installation
|
||||
|
||||
To effectively use the `SerperScrapeWebsiteTool`, follow these steps:
|
||||
|
||||
1. **Package Installation**: Confirm that the `crewai[tools]` package is installed in your Python environment.
|
||||
2. **API Key Acquisition**: Acquire a `serper.dev` API key by registering for an account at `serper.dev`.
|
||||
3. **Environment Configuration**: Store your obtained API key in an environment variable named `SERPER_API_KEY` to facilitate its use by the tool.
|
||||
|
||||
To incorporate this tool into your project, follow the installation instructions below:
|
||||
|
||||
```shell
|
||||
pip install 'crewai[tools]'
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
The following example demonstrates how to initialize the tool and scrape a website:
|
||||
|
||||
```python Code
|
||||
from crewai_tools import SerperScrapeWebsiteTool
|
||||
|
||||
# Initialize the tool for website scraping capabilities
|
||||
tool = SerperScrapeWebsiteTool()
|
||||
|
||||
# Scrape a website with markdown formatting
|
||||
result = tool.run(url="https://example.com", include_markdown=True)
|
||||
```
|
||||
|
||||
## Arguments
|
||||
|
||||
The `SerperScrapeWebsiteTool` accepts the following arguments:
|
||||
|
||||
- **url**: Required. The URL of the website to scrape.
|
||||
- **include_markdown**: Optional. Whether to include markdown formatting in the scraped content. Defaults to `True`.
|
||||
|
||||
## Example with Parameters
|
||||
|
||||
Here is an example demonstrating how to use the tool with different parameters:
|
||||
|
||||
```python Code
|
||||
from crewai_tools import SerperScrapeWebsiteTool
|
||||
|
||||
tool = SerperScrapeWebsiteTool()
|
||||
|
||||
# Scrape with markdown formatting (default)
|
||||
markdown_result = tool.run(
|
||||
url="https://docs.crewai.com",
|
||||
include_markdown=True
|
||||
)
|
||||
|
||||
# Scrape without markdown formatting for plain text
|
||||
plain_result = tool.run(
|
||||
url="https://docs.crewai.com",
|
||||
include_markdown=False
|
||||
)
|
||||
|
||||
print("Markdown formatted content:")
|
||||
print(markdown_result)
|
||||
|
||||
print("\nPlain text content:")
|
||||
print(plain_result)
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
The `SerperScrapeWebsiteTool` is particularly useful for:
|
||||
|
||||
- **Content Analysis**: Extract and analyze website content for research purposes
|
||||
- **Data Collection**: Gather structured information from web pages
|
||||
- **Documentation Processing**: Convert web-based documentation into readable formats
|
||||
- **Competitive Analysis**: Scrape competitor websites for market research
|
||||
- **Content Migration**: Extract content from existing websites for migration purposes
|
||||
|
||||
## Error Handling
|
||||
|
||||
The tool includes comprehensive error handling for:
|
||||
|
||||
- **Network Issues**: Handles connection timeouts and network errors gracefully
|
||||
- **API Errors**: Provides detailed error messages for API-related issues
|
||||
- **Invalid URLs**: Validates and reports issues with malformed URLs
|
||||
- **Authentication**: Clear error messages for missing or invalid API keys
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- Always store your `SERPER_API_KEY` in environment variables, never hardcode it in your source code
|
||||
- Be mindful of rate limits imposed by the Serper API
|
||||
- Respect robots.txt and website terms of service when scraping content
|
||||
- Consider implementing delays between requests for large-scale scraping operations
|
||||
Reference in New Issue
Block a user