mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-10 00:28:31 +00:00
Add pt-BR docs translation (#3039)
* docs: add pt-br translations Powered by a CrewAI Flow https://github.com/danielfsbarreto/docs_translator * Update mcp/overview.mdx brazilian docs Its en-US counterpart was updated after I did a pass, so now it includes the new section about @CrewBase
This commit is contained in:
Daniel Barreto
187
docs/pt-BR/tools/cloud-storage/bedrockinvokeagenttool.mdx
Normal file
187
docs/pt-BR/tools/cloud-storage/bedrockinvokeagenttool.mdx
Normal file
@@ -0,0 +1,187 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
||||
# `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
|
||||
165
docs/pt-BR/tools/cloud-storage/bedrockkbretriever.mdx
Normal file
165
docs/pt-BR/tools/cloud-storage/bedrockkbretriever.mdx
Normal file
@@ -0,0 +1,165 @@
|
||||
---
|
||||
title: 'Bedrock Knowledge Base Retriever'
|
||||
description: 'Recupere informações das Bases de Conhecimento do Amazon Bedrock usando consultas em linguagem natural'
|
||||
icon: aws
|
||||
---
|
||||
|
||||
# `BedrockKBRetrieverTool`
|
||||
|
||||
A `BedrockKBRetrieverTool` permite que agentes CrewAI recuperem informações das Bases de Conhecimento do Amazon Bedrock usando consultas em linguagem natural.
|
||||
|
||||
## Instalação
|
||||
|
||||
```bash
|
||||
uv pip install 'crewai[tools]'
|
||||
```
|
||||
|
||||
## Requisitos
|
||||
|
||||
- Credenciais AWS configuradas (via variáveis de ambiente ou AWS CLI)
|
||||
- Pacotes `boto3` e `python-dotenv`
|
||||
- Acesso à Base de Conhecimento do Amazon Bedrock
|
||||
|
||||
## Uso
|
||||
|
||||
Veja como utilizar a ferramenta com um agente CrewAI:
|
||||
|
||||
```python {2, 4-17}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools.aws.bedrock.knowledge_base.retriever_tool import BedrockKBRetrieverTool
|
||||
|
||||
# Initialize the tool
|
||||
kb_tool = BedrockKBRetrieverTool(
|
||||
knowledge_base_id="your-kb-id",
|
||||
number_of_results=5
|
||||
)
|
||||
|
||||
# Create a CrewAI agent that uses the tool
|
||||
researcher = Agent(
|
||||
role='Knowledge Base Researcher',
|
||||
goal='Find information about company policies',
|
||||
backstory='I am a researcher specialized in retrieving and analyzing company documentation.',
|
||||
tools=[kb_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create a task for the agent
|
||||
research_task = Task(
|
||||
description="Find our company's remote work policy and summarize the key points.",
|
||||
agent=researcher
|
||||
)
|
||||
|
||||
# Create a crew with the agent
|
||||
crew = Crew(
|
||||
agents=[researcher],
|
||||
tasks=[research_task],
|
||||
verbose=2
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Argumentos da Ferramenta
|
||||
|
||||
| Argumento | Tipo | Obrigatório | Padrão | Descrição |
|
||||
|:----------|:-----|:------------|:-------|:----------|
|
||||
| **knowledge_base_id** | `str` | Sim | Nenhum | O identificador único da base de conhecimento (0-10 caracteres alfanuméricos) |
|
||||
| **number_of_results** | `int` | Não | 5 | Número máximo de resultados a serem retornados |
|
||||
| **retrieval_configuration** | `dict` | Não | Nenhum | Configurações personalizadas para a consulta da base de conhecimento |
|
||||
| **guardrail_configuration** | `dict` | Não | Nenhum | Configurações de filtragem de conteúdo |
|
||||
| **next_token** | `str` | Não | Nenhum | Token para paginação |
|
||||
|
||||
## Variáveis de Ambiente
|
||||
|
||||
```bash
|
||||
BEDROCK_KB_ID=your-knowledge-base-id # Alternativa ao uso de knowledge_base_id
|
||||
AWS_REGION=your-aws-region # Padrão: us-east-1
|
||||
AWS_ACCESS_KEY_ID=your-access-key # Obrigatório para autenticação AWS
|
||||
AWS_SECRET_ACCESS_KEY=your-secret-key # Obrigatório para autenticação AWS
|
||||
```
|
||||
|
||||
## Formato da Resposta
|
||||
|
||||
A ferramenta retorna resultados em formato JSON:
|
||||
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"content": "Retrieved text content",
|
||||
"content_type": "text",
|
||||
"source_type": "S3",
|
||||
"source_uri": "s3://bucket/document.pdf",
|
||||
"score": 0.95,
|
||||
"metadata": {
|
||||
"additional": "metadata"
|
||||
}
|
||||
}
|
||||
],
|
||||
"nextToken": "pagination-token",
|
||||
"guardrailAction": "NONE"
|
||||
}
|
||||
```
|
||||
|
||||
## Uso Avançado
|
||||
|
||||
### Configuração de Recuperação Personalizada
|
||||
|
||||
```python
|
||||
kb_tool = BedrockKBRetrieverTool(
|
||||
knowledge_base_id="your-kb-id",
|
||||
retrieval_configuration={
|
||||
"vectorSearchConfiguration": {
|
||||
"numberOfResults": 10,
|
||||
"overrideSearchType": "HYBRID"
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
policy_expert = Agent(
|
||||
role='Policy Expert',
|
||||
goal='Analyze company policies in detail',
|
||||
backstory='I am an expert in corporate policy analysis with deep knowledge of regulatory requirements.',
|
||||
tools=[kb_tool]
|
||||
)
|
||||
```
|
||||
|
||||
## Fontes de Dados Suportadas
|
||||
|
||||
- Amazon S3
|
||||
- Confluence
|
||||
- Salesforce
|
||||
- SharePoint
|
||||
- Páginas web
|
||||
- Locais de documentos personalizados
|
||||
- Amazon Kendra
|
||||
- Bancos de dados SQL
|
||||
|
||||
## Casos de Uso
|
||||
|
||||
### Integração de Conhecimento Corporativo
|
||||
- Permita que agentes CrewAI acessem o conhecimento proprietário da sua organização sem expor dados sensíveis
|
||||
- Permita que agentes tomem decisões baseadas nas políticas, procedimentos e documentações específicas da sua empresa
|
||||
- Crie agentes capazes de responder perguntas com base na sua documentação interna mantendo a segurança dos dados
|
||||
|
||||
### Conhecimento Especializado de Domínio
|
||||
- Conecte agentes CrewAI a bases de conhecimento específicas do domínio (jurídico, médico, técnico) sem re-treinamento de modelos
|
||||
- Aproveite repositórios de conhecimento existentes que já são mantidos no seu ambiente AWS
|
||||
- Combine o raciocínio do CrewAI com informações de domínio provenientes das suas bases de conhecimento
|
||||
|
||||
### Tomada de Decisão Orientada por Dados
|
||||
- Baseie as respostas dos agentes CrewAI nos dados reais da sua empresa, e não apenas em conhecimento geral
|
||||
- Assegure que os agentes forneçam recomendações baseadas no contexto e documentação do seu negócio
|
||||
- Reduza alucinações ao recuperar informações factuais das suas bases de conhecimento
|
||||
|
||||
### Acesso Escalável à Informação
|
||||
- Acesse terabytes de conhecimento organizacional sem precisar incorporar tudo aos seus modelos
|
||||
- Consulte dinamicamente apenas as informações relevantes conforme a necessidade de cada tarefa
|
||||
- Aproveite a infraestrutura escalável da AWS para lidar com grandes bases de conhecimento de forma eficiente
|
||||
|
||||
### Conformidade e Governança
|
||||
- Garanta que agentes CrewAI forneçam respostas alinhadas com a documentação aprovada da sua empresa
|
||||
- Crie trilhas de auditoria das fontes de informação usadas pelos agentes
|
||||
- Mantenha controle sobre quais fontes de informação os seus agentes podem acessar
|
||||
51
docs/pt-BR/tools/cloud-storage/overview.mdx
Normal file
51
docs/pt-BR/tools/cloud-storage/overview.mdx
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
title: "Visão Geral"
|
||||
description: "Interaja com serviços em nuvem, sistemas de armazenamento e plataformas de IA baseadas em nuvem"
|
||||
icon: "face-smile"
|
||||
---
|
||||
|
||||
Essas ferramentas permitem que seus agentes interajam com serviços em nuvem, acessem o armazenamento em nuvem e aproveitem plataformas de IA baseadas em nuvem para operações em escala.
|
||||
|
||||
## **Ferramentas Disponíveis**
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="S3 Reader Tool" icon="cloud" href="/pt-BR/tools/cloud-storage/s3readertool">
|
||||
Leia arquivos e dados de buckets Amazon S3.
|
||||
</Card>
|
||||
|
||||
<Card title="S3 Writer Tool" icon="cloud-arrow-up" href="/pt-BR/tools/cloud-storage/s3writertool">
|
||||
Escreva e faça upload de arquivos para o armazenamento Amazon S3.
|
||||
</Card>
|
||||
|
||||
<Card title="Bedrock Invoke Agent" icon="aws" href="/pt-BR/tools/cloud-storage/bedrockinvokeagenttool">
|
||||
Acione agentes Amazon Bedrock para tarefas orientadas por IA.
|
||||
</Card>
|
||||
|
||||
<Card title="Bedrock KB Retriever" icon="database" href="/pt-BR/tools/cloud-storage/bedrockkbretriever">
|
||||
Recupere informações das bases de conhecimento Amazon Bedrock.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## **Casos de Uso Comuns**
|
||||
|
||||
- **Armazenamento de Arquivos**: Armazene e recupere arquivos de sistemas de armazenamento em nuvem
|
||||
- **Backup de Dados**: Faça backup de dados importantes no armazenamento em nuvem
|
||||
- **Serviços de IA**: Acesse modelos e serviços de IA baseados em nuvem
|
||||
- **Recuperação de Conhecimento**: Consulte bases de conhecimento hospedadas na nuvem
|
||||
- **Operações Escaláveis**: Aproveite a infraestrutura de nuvem para processamento
|
||||
|
||||
```python
|
||||
from crewai_tools import S3ReaderTool, S3WriterTool, BedrockInvokeAgentTool
|
||||
|
||||
# Create cloud tools
|
||||
s3_reader = S3ReaderTool()
|
||||
s3_writer = S3WriterTool()
|
||||
bedrock_agent = BedrockInvokeAgentTool()
|
||||
|
||||
# Add to your agent
|
||||
agent = Agent(
|
||||
role="Cloud Operations Specialist",
|
||||
tools=[s3_reader, s3_writer, bedrock_agent],
|
||||
goal="Manage cloud resources and AI services"
|
||||
)
|
||||
```
|
||||
144
docs/pt-BR/tools/cloud-storage/s3readertool.mdx
Normal file
144
docs/pt-BR/tools/cloud-storage/s3readertool.mdx
Normal file
@@ -0,0 +1,144 @@
|
||||
---
|
||||
title: S3 Reader Tool
|
||||
description: O `S3ReaderTool` permite que agentes CrewAI leiam arquivos de buckets Amazon S3.
|
||||
icon: aws
|
||||
---
|
||||
|
||||
# `S3ReaderTool`
|
||||
|
||||
## Descrição
|
||||
|
||||
O `S3ReaderTool` foi projetado para ler arquivos de buckets Amazon S3. Esta ferramenta permite que os agentes CrewAI acessem e recuperem conteúdos armazenados no S3, tornando-a ideal para fluxos de trabalho que exigem leitura de dados, arquivos de configuração ou qualquer outro conteúdo armazenado no AWS S3.
|
||||
|
||||
## Instalação
|
||||
|
||||
Para utilizar esta ferramenta, é necessário instalar as dependências requeridas:
|
||||
|
||||
```shell
|
||||
uv add boto3
|
||||
```
|
||||
|
||||
## Passos para Começar
|
||||
|
||||
Para usar o `S3ReaderTool` efetivamente, siga estes passos:
|
||||
|
||||
1. **Instale as Dependências**: Instale os pacotes necessários usando o comando acima.
|
||||
2. **Configure as Credenciais AWS**: Defina suas credenciais AWS como variáveis de ambiente.
|
||||
3. **Inicialize a Ferramenta**: Crie uma instância da ferramenta.
|
||||
4. **Especifique o Caminho S3**: Forneça o caminho S3 do arquivo que deseja ler.
|
||||
|
||||
## Exemplo
|
||||
|
||||
O exemplo a seguir demonstra como utilizar o `S3ReaderTool` para ler um arquivo de um bucket S3:
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools.aws.s3 import S3ReaderTool
|
||||
|
||||
# Initialize the tool
|
||||
s3_reader_tool = S3ReaderTool()
|
||||
|
||||
# Define an agent that uses the tool
|
||||
file_reader_agent = Agent(
|
||||
role="File Reader",
|
||||
goal="Read files from S3 buckets",
|
||||
backstory="An expert in retrieving and processing files from cloud storage.",
|
||||
tools=[s3_reader_tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
# Example task to read a configuration file
|
||||
read_task = Task(
|
||||
description="Read the configuration file from {my_bucket} and summarize its contents.",
|
||||
expected_output="A summary of the configuration file contents.",
|
||||
agent=file_reader_agent,
|
||||
)
|
||||
|
||||
# Create and run the crew
|
||||
crew = Crew(agents=[file_reader_agent], tasks=[read_task])
|
||||
result = crew.kickoff(inputs={"my_bucket": "s3://my-bucket/config/app-config.json"})
|
||||
```
|
||||
|
||||
## Parâmetros
|
||||
|
||||
O `S3ReaderTool` aceita o seguinte parâmetro quando utilizado por um agente:
|
||||
|
||||
- **file_path**: Obrigatório. O caminho do arquivo S3 no formato `s3://nome-do-bucket/nome-do-arquivo`.
|
||||
|
||||
## Credenciais AWS
|
||||
|
||||
A ferramenta requer credenciais AWS para acessar buckets S3. Você pode configurar essas credenciais usando variáveis de ambiente:
|
||||
|
||||
- **CREW_AWS_REGION**: Região AWS onde seu bucket S3 está localizado. O padrão é `us-east-1`.
|
||||
- **CREW_AWS_ACCESS_KEY_ID**: Sua AWS access key ID.
|
||||
- **CREW_AWS_SEC_ACCESS_KEY**: Sua AWS secret access key.
|
||||
|
||||
## Uso
|
||||
|
||||
Ao utilizar o `S3ReaderTool` com um agente, o agente deverá fornecer o caminho do arquivo S3:
|
||||
|
||||
```python Code
|
||||
# Example of using the tool with an agent
|
||||
file_reader_agent = Agent(
|
||||
role="File Reader",
|
||||
goal="Read files from S3 buckets",
|
||||
backstory="An expert in retrieving and processing files from cloud storage.",
|
||||
tools=[s3_reader_tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
# Create a task for the agent to read a specific file
|
||||
read_config_task = Task(
|
||||
description="Read the application configuration file from {my_bucket} and extract the database connection settings.",
|
||||
expected_output="The database connection settings from the configuration file.",
|
||||
agent=file_reader_agent,
|
||||
)
|
||||
|
||||
# Run the task
|
||||
crew = Crew(agents=[file_reader_agent], tasks=[read_config_task])
|
||||
result = crew.kickoff(inputs={"my_bucket": "s3://my-bucket/config/app-config.json"})
|
||||
```
|
||||
|
||||
## Tratamento de Erros
|
||||
|
||||
O `S3ReaderTool` inclui tratamento para erros comuns do S3:
|
||||
|
||||
- Formato inválido de caminho S3
|
||||
- Arquivos ausentes ou inacessíveis
|
||||
- Problemas de permissão
|
||||
- Problemas com credenciais AWS
|
||||
|
||||
Quando um erro ocorre, a ferramenta retorna uma mensagem de erro com detalhes sobre o problema.
|
||||
|
||||
## Detalhes da Implementação
|
||||
|
||||
O `S3ReaderTool` utiliza o AWS SDK for Python (boto3) para interagir com o S3:
|
||||
|
||||
```python Code
|
||||
class S3ReaderTool(BaseTool):
|
||||
name: str = "S3 Reader Tool"
|
||||
description: str = "Reads a file from Amazon S3 given an S3 file path"
|
||||
|
||||
def _run(self, file_path: str) -> str:
|
||||
try:
|
||||
bucket_name, object_key = self._parse_s3_path(file_path)
|
||||
|
||||
s3 = boto3.client(
|
||||
's3',
|
||||
region_name=os.getenv('CREW_AWS_REGION', 'us-east-1'),
|
||||
aws_access_key_id=os.getenv('CREW_AWS_ACCESS_KEY_ID'),
|
||||
aws_secret_access_key=os.getenv('CREW_AWS_SEC_ACCESS_KEY')
|
||||
)
|
||||
|
||||
# Read file content from S3
|
||||
response = s3.get_object(Bucket=bucket_name, Key=object_key)
|
||||
file_content = response['Body'].read().decode('utf-8')
|
||||
|
||||
return file_content
|
||||
except ClientError as e:
|
||||
return f"Error reading file from S3: {str(e)}"
|
||||
```
|
||||
|
||||
## Conclusão
|
||||
|
||||
O `S3ReaderTool` oferece uma maneira simples de ler arquivos de buckets Amazon S3. Ao permitir que agentes acessem conteúdos armazenados no S3, facilita fluxos de trabalho que necessitam de acesso a arquivos na nuvem. Esta ferramenta é especialmente útil para processamento de dados, gestão de configurações e qualquer tarefa que envolva a obtenção de informações do armazenamento AWS S3.
|
||||
150
docs/pt-BR/tools/cloud-storage/s3writertool.mdx
Normal file
150
docs/pt-BR/tools/cloud-storage/s3writertool.mdx
Normal file
@@ -0,0 +1,150 @@
|
||||
---
|
||||
title: Ferramenta S3 Writer
|
||||
description: A `S3WriterTool` permite que agentes CrewAI escrevam conteúdo em arquivos em buckets Amazon S3.
|
||||
icon: aws
|
||||
---
|
||||
|
||||
# `S3WriterTool`
|
||||
|
||||
## Descrição
|
||||
|
||||
A `S3WriterTool` foi projetada para escrever conteúdo em arquivos em buckets Amazon S3. Esta ferramenta permite que agentes CrewAI criem ou atualizem arquivos no S3, tornando-a ideal para fluxos de trabalho que exigem armazenamento de dados, salvamento de arquivos de configuração ou persistência de qualquer outro conteúdo no armazenamento AWS S3.
|
||||
|
||||
## Instalação
|
||||
|
||||
Para usar esta ferramenta, você precisa instalar as dependências necessárias:
|
||||
|
||||
```shell
|
||||
uv add boto3
|
||||
```
|
||||
|
||||
## Passos para Começar
|
||||
|
||||
Para usar a `S3WriterTool` de forma eficaz, siga estes passos:
|
||||
|
||||
1. **Instale as Dependências**: Instale os pacotes necessários usando o comando acima.
|
||||
2. **Configure as Credenciais AWS**: Defina suas credenciais AWS como variáveis de ambiente.
|
||||
3. **Inicialize a Ferramenta**: Crie uma instância da ferramenta.
|
||||
4. **Especifique o Caminho no S3 e o Conteúdo**: Forneça o caminho no S3 onde deseja gravar o arquivo e o conteúdo a ser escrito.
|
||||
|
||||
## Exemplo
|
||||
|
||||
O exemplo a seguir demonstra como usar a `S3WriterTool` para gravar conteúdo em um arquivo em um bucket S3:
|
||||
|
||||
```python Code
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools.aws.s3 import S3WriterTool
|
||||
|
||||
# Initialize the tool
|
||||
s3_writer_tool = S3WriterTool()
|
||||
|
||||
# Define an agent that uses the tool
|
||||
file_writer_agent = Agent(
|
||||
role="File Writer",
|
||||
goal="Write content to files in S3 buckets",
|
||||
backstory="An expert in storing and managing files in cloud storage.",
|
||||
tools=[s3_writer_tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
# Example task to write a report
|
||||
write_task = Task(
|
||||
description="Generate a summary report of the quarterly sales data and save it to {my_bucket}.",
|
||||
expected_output="Confirmation that the report was successfully saved to S3.",
|
||||
agent=file_writer_agent,
|
||||
)
|
||||
|
||||
# Create and run the crew
|
||||
crew = Crew(agents=[file_writer_agent], tasks=[write_task])
|
||||
result = crew.kickoff(inputs={"my_bucket": "s3://my-bucket/reports/quarterly-summary.txt"})
|
||||
```
|
||||
|
||||
## Parâmetros
|
||||
|
||||
A `S3WriterTool` aceita os seguintes parâmetros quando utilizada por um agente:
|
||||
|
||||
- **file_path**: Obrigatório. O caminho do arquivo S3 no formato `s3://bucket-name/file-name`.
|
||||
- **content**: Obrigatório. O conteúdo a ser escrito no arquivo.
|
||||
|
||||
## Credenciais AWS
|
||||
|
||||
A ferramenta requer credenciais AWS para acessar os buckets S3. Você pode configurar essas credenciais usando variáveis de ambiente:
|
||||
|
||||
- **CREW_AWS_REGION**: A região AWS onde seu bucket S3 está localizado. O padrão é `us-east-1`.
|
||||
- **CREW_AWS_ACCESS_KEY_ID**: Sua AWS access key ID.
|
||||
- **CREW_AWS_SEC_ACCESS_KEY**: Sua AWS secret access key.
|
||||
|
||||
## Uso
|
||||
|
||||
Ao usar a `S3WriterTool` com um agente, o agente precisará fornecer tanto o caminho do arquivo no S3 quanto o conteúdo a ser gravado:
|
||||
|
||||
```python Code
|
||||
# Example of using the tool with an agent
|
||||
file_writer_agent = Agent(
|
||||
role="File Writer",
|
||||
goal="Write content to files in S3 buckets",
|
||||
backstory="An expert in storing and managing files in cloud storage.",
|
||||
tools=[s3_writer_tool],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
# Create a task for the agent to write a specific file
|
||||
write_config_task = Task(
|
||||
description="""
|
||||
Create a configuration file with the following database settings:
|
||||
- host: db.example.com
|
||||
- port: 5432
|
||||
- username: app_user
|
||||
- password: secure_password
|
||||
|
||||
Save this configuration as JSON to {my_bucket}.
|
||||
""",
|
||||
expected_output="Confirmation that the configuration file was successfully saved to S3.",
|
||||
agent=file_writer_agent,
|
||||
)
|
||||
|
||||
# Run the task
|
||||
crew = Crew(agents=[file_writer_agent], tasks=[write_config_task])
|
||||
result = crew.kickoff(inputs={"my_bucket": "s3://my-bucket/config/db-config.json"})
|
||||
```
|
||||
|
||||
## Tratamento de Erros
|
||||
|
||||
A `S3WriterTool` inclui tratamento de erros para problemas comuns no S3:
|
||||
|
||||
- Formato de caminho S3 inválido
|
||||
- Problemas de permissão (ex: sem acesso de gravação ao bucket)
|
||||
- Problemas com credenciais AWS
|
||||
- Bucket inexistente
|
||||
|
||||
Quando ocorre um erro, a ferramenta retorna uma mensagem de erro que inclui detalhes sobre o problema.
|
||||
|
||||
## Detalhes de Implementação
|
||||
|
||||
A `S3WriterTool` utiliza o AWS SDK para Python (boto3) para interagir com o S3:
|
||||
|
||||
```python Code
|
||||
class S3WriterTool(BaseTool):
|
||||
name: str = "S3 Writer Tool"
|
||||
description: str = "Writes content to a file in Amazon S3 given an S3 file path"
|
||||
|
||||
def _run(self, file_path: str, content: str) -> str:
|
||||
try:
|
||||
bucket_name, object_key = self._parse_s3_path(file_path)
|
||||
|
||||
s3 = boto3.client(
|
||||
's3',
|
||||
region_name=os.getenv('CREW_AWS_REGION', 'us-east-1'),
|
||||
aws_access_key_id=os.getenv('CREW_AWS_ACCESS_KEY_ID'),
|
||||
aws_secret_access_key=os.getenv('CREW_AWS_SEC_ACCESS_KEY')
|
||||
)
|
||||
|
||||
s3.put_object(Bucket=bucket_name, Key=object_key, Body=content.encode('utf-8'))
|
||||
return f"Successfully wrote content to {file_path}"
|
||||
except ClientError as e:
|
||||
return f"Error writing file to S3: {str(e)}"
|
||||
```
|
||||
|
||||
## Conclusão
|
||||
|
||||
A `S3WriterTool` oferece uma maneira direta de gravar conteúdo em arquivos em buckets Amazon S3. Ao permitir que agentes criem e atualizem arquivos no S3, ela facilita fluxos de trabalho que exigem armazenamento de arquivos em nuvem. Esta ferramenta é particularmente útil para persistência de dados, gerenciamento de configurações, geração de relatórios e qualquer tarefa que envolva armazenar informações no AWS S3.
|
||||
Reference in New Issue
Block a user