WIP: v1 docs (#3626)

(cherry picked from commit d46e20fa09bcd2f5916282f5553ddeb7183bd92c)
This commit is contained in:
Tony Kipkemboi
2025-10-01 10:25:28 -04:00
committed by GitHub
parent 0fe9352149
commit c793c829ea
96 changed files with 4291 additions and 710 deletions

View File

@@ -0,0 +1,158 @@
---
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>

View File

@@ -0,0 +1,105 @@
---
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>
![Visão Geral de Automações](/images/enterprise/automations-overview.png)
</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 Autodeploy (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>
![Implantação via GitHub](/images/enterprise/deploy-from-github.png)
</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>
![Implantação via ZIP](/images/enterprise/deploy-from-zip.png)
</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**: Redeploy, 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>
![Tabela de Automações](/images/enterprise/automations-table.png)
</Frame>
## Boas práticas
- Prefira implantações via GitHub para controle de versão e CI/CD
- Use redeploy para avançar após mudanças de código/config ou habilite autodeploy 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>

View File

@@ -0,0 +1,90 @@
---
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>
![Visão Geral do Crew Studio](/images/enterprise/crew-studio-overview.png)
</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>
![Construtor de Prompt](/images/enterprise/crew-studio-prompt.png)
</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 arrastaresoltar (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>
![Canvas Visual](/images/enterprise/crew-studio-canvas.png)
</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>
![Visão de Execução](/images/enterprise/crew-studio-execution.png)
</Frame>
## Publicar & Exportar
- <b>Publish</b> para implantar uma automação
- <b>Download</b> do códigofonte como ZIP para desenvolvimento local
<Frame>
![Publicar & Download](/images/enterprise/crew-studio-publish.png)
</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>
![Automação Publicada](/images/enterprise/crew-studio-published.png)
</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>

View File

@@ -0,0 +1,47 @@
---
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>
![Marketplace Visão Geral](/images/enterprise/marketplace-overview.png)
</Frame>
## Descoberta
- Navegue por categoria e capacidade
- Pesquise por nome ou palavrachave
## 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>
![Instalar & Configurar](/images/enterprise/marketplace-install.png)
</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>

View File

@@ -1,108 +0,0 @@
---
title: Repositório de Ferramentas
description: "Usando o Repositório de Ferramentas para gerenciar suas ferramentas"
icon: "toolbox"
mode: "wide"
---
## Visão geral
O Repositório de Ferramentas é um gerenciador de pacotes para ferramentas da CrewAI. Ele permite que usuários publiquem, instalem e gerenciem ferramentas que se integram com crews e flows da CrewAI.
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.
## Pré-requisitos
Antes de usar o Repositório de Ferramentas, certifique-se de que você possui:
- Uma conta [CrewAI Enterprise](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
## Instalando ferramentas
Para instalar uma ferramenta:
```bash
crewai tool install <nome-da-ferramenta>
```
Isso instala a ferramenta e a adiciona ao `pyproject.toml`.
## Criando e publicando ferramentas
Para criar um novo projeto de ferramenta:
```bash
crewai tool create <nome-da-ferramenta>
```
Isso gera um projeto de ferramenta estruturado localmente.
Após fazer alterações, inicialize um repositório Git e faça o commit do código:
```bash
git init
git add .
git commit -m "Initial version"
```
Para publicar a ferramenta:
```bash
crewai tool publish
```
Por padrão, as ferramentas são publicadas como privadas. Para tornar uma ferramenta pública:
```bash
crewai tool publish --public
```
Para mais detalhes sobre como construir ferramentas, acesse [Criando suas próprias ferramentas](https://docs.crewai.com/concepts/tools#creating-your-own-tools).
## Atualizando ferramentas
Para atualizar uma ferramenta publicada:
1. Modifique a ferramenta localmente
2. Atualize a versão no `pyproject.toml` (por exemplo, de `0.1.0` para `0.1.1`)
3. Faça o commit das alterações e publique
```bash
git commit -m "Atualizar versão para 0.1.1"
crewai tool publish
```
## Excluindo ferramentas
Para excluir uma ferramenta:
1. Acesse o [CrewAI Enterprise](https://app.crewai.com)
2. Navegue até **Ferramentas**
3. Selecione a ferramenta
4. Clique em **Excluir**
<Warning>
A exclusão é permanente. Ferramentas excluídas não podem ser restauradas ou reinstaladas.
</Warning>
## Verificações de segurança
Cada versão publicada passa por verificações automáticas de segurança e só fica disponível para instalação após aprovação.
Você pode verificar o status das verificações de segurança de uma ferramenta em:
`CrewAI Enterprise > 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>

View File

@@ -0,0 +1,236 @@
---
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>
![Ferramentas & Integrações](/images/enterprise/crew_connectors.png)
</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>
![Aplicativos](/images/enterprise/agent-apps.png)
</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>
![Token Enterprise](/images/enterprise/enterprise_action_auth_token.png)
</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>
![Filtrar Ações](/images/enterprise/filtering_enterprise_action_tools.png)
</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>
![Token de Usuário](/images/enterprise/user_bearer_token.png)
</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 — Ecommerce 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 Enterprise e use nos seus agentes.
<Tip>
Antes de executar os comandos abaixo, faça login na sua conta CrewAI Enterprise:
```bash
crewai login
```
</Tip>
<Frame>
![Ferramenta Interna](/images/enterprise/tools-integrations-internal.png)
</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>
![Configurações de Ferramenta](/images/enterprise/tool-configs.png)
</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>