Tarefas
Guia detalhado sobre como gerenciar e criar tarefas dentro do framework CrewAI.
Visão Geral
No framework CrewAI, uma Task
(Tarefa) é uma atribuição específica executada por um Agent
(Agente).
As tarefas fornecem todos os detalhes necessários para sua execução, como descrição, agente responsável, ferramentas exigidas e mais, facilitando uma ampla gama de complexidades de ação.
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.
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 Construtor Visual de Tarefas permite:
- Criação de tarefas via arrastar-e-soltar
- Visualização de dependências e fluxo de tarefas
- Testes e validações em tempo real
- Fácil compartilhamento e colaboração
Fluxo de Execução de Tarefas
As tarefas podem ser executadas de duas maneiras:
- Sequencial: As tarefas são executadas na ordem em que são definidas
- Hierárquica: As tarefas são atribuídas aos agentes com base em seus papéis e especialidades
O fluxo de execução é definido ao criar o crew:
Atributos da Tarefa
Atributo | Parâmetros | Tipo | Descrição |
---|---|---|---|
Descrição | description | str | Uma declaração clara e concisa do que a tarefa envolve. |
Saída Esperada | expected_output | str | Uma descrição detalhada de como deve ser o resultado da tarefa concluída. |
Nome (opcional) | name | Optional[str] | Um identificador de nome para a tarefa. |
Agente (opcional) | agent | Optional[BaseAgent] | O agente responsável por executar a tarefa. |
Ferramentas (opcional) | tools | List[BaseTool] | As ferramentas/recursos que o agente pode usar para esta tarefa. |
Contexto (opcional) | context | Optional[List["Task"]] | Outras tarefas cujas saídas serão usadas como contexto para esta tarefa. |
Execução Assíncrona (opc.) | async_execution | Optional[bool] | Se a tarefa deve ser executada de forma assíncrona. O padrão é False. |
Input Humano (opcional) | human_input | Optional[bool] | Se a tarefa deve ter uma revisão humana da resposta final do agente. O padrão é False. |
Markdown (opcional) | markdown | Optional[bool] | Se a tarefa deve instruir o agente a retornar a resposta final formatada em Markdown. O padrão é False. |
Config (opcional) | config | Optional[Dict[str, Any]] | Parâmetros de configuração específicos da tarefa. |
Arquivo de Saída (opcional) | output_file | Optional[str] | Caminho do arquivo para armazenar a saída da tarefa. |
Saída JSON (opcional) | output_json | Optional[Type[BaseModel]] | Um modelo Pydantic para estruturar a saída em JSON. |
Output Pydantic (opcional) | output_pydantic | Optional[Type[BaseModel]] | Um modelo Pydantic para a saída da tarefa. |
Callback (opcional) | callback | Optional[Any] | Função/objeto a ser executado após a conclusão da tarefa. |
Criando Tarefas
Existem duas maneiras de criar tarefas no CrewAI: utilizando configuração YAML (recomendado) ou definindo-as diretamente no código.
Configuração YAML (Recomendado)
Utilizar configuração YAML oferece uma forma mais limpa e de fácil manutenção para definir tarefas. Recomendamos fortemente esse método em seus projetos CrewAI.
Após criar seu projeto CrewAI conforme indicado na seção Instalação, navegue até o arquivo src/latest_ai_development/config/tasks.yaml
e modifique o template para refletir os requisitos específicos das tarefas.
Variáveis em seus arquivos YAML (como {topic}
) serão substituídas por valores vindos dos seus inputs ao executar o crew:
Veja um exemplo de configuração de tarefas usando YAML:
Para usar essa configuração YAML em seu código, crie uma classe crew que herda de CrewBase
:
Os nomes usados em seus arquivos YAML (agents.yaml
e tasks.yaml
) devem corresponder aos nomes dos métodos no seu código Python.
Definição Direta no Código (Alternativa)
Alternativamente, você pode definir tarefas diretamente no seu código sem usar configuração YAML:
Especifique diretamente um agent
para a tarefa ou permita que o processo hierarchical
do CrewAI decida com base em papéis, disponibilidade, etc.
Saída da Tarefa
Compreender as saídas das tarefas é crucial para construir fluxos de trabalho de IA eficazes. O CrewAI oferece uma maneira estruturada de lidar com resultados usando a classe TaskOutput
, que suporta múltiplos formatos de saída e pode ser facilmente passada entre tarefas.
A saída de uma tarefa no framework CrewAI é encapsulada na classe TaskOutput
. Essa classe fornece uma maneira estruturada de acessar os resultados da tarefa, incluindo vários formatos como saída bruta, JSON e modelos Pydantic.
Por padrão, o TaskOutput
incluirá apenas a saída raw
. Um TaskOutput
só terá as saídas pydantic
ou json_dict
se o objeto original da Task
estiver configurado com output_pydantic
ou output_json
, respectivamente.
Atributos do Task Output
Atributo | Parâmetros | Tipo | Descrição |
---|---|---|---|
Description | description | str | Descrição da tarefa. |
Summary | summary | Optional[str] | Resumo da tarefa, gerado automaticamente a partir das primeiras 10 palavras da descrição. |
Raw | raw | str | Saída bruta da tarefa. Este é o formato padrão da saída. |
Pydantic | pydantic | Optional[BaseModel] | Objeto modelo Pydantic representando a saída da tarefa de forma estruturada. |
JSON Dict | json_dict | Optional[Dict[str, Any]] | Dicionário representando a saída da tarefa em JSON. |
Agent | agent | str | O agente que executou a tarefa. |
Output Format | output_format | OutputFormat | O formato da saída da tarefa, podendo ser RAW, JSON e Pydantic. O padrão é RAW. |
Métodos e Propriedades da Tarefa
Método/Propriedade | Descrição |
---|---|
json | Retorna a representação da saída da tarefa em JSON como string, se o formato de saída for JSON. |
to_dict | Converte as saídas JSON e Pydantic para um dicionário. |
str | Retorna a representação em string da saída da tarefa, priorizando Pydantic, depois JSON, depois raw. |
Acessando Saídas das Tarefas
Uma vez que a tarefa é executada, sua saída pode ser acessada pelo atributo output
do objeto Task
. A classe TaskOutput
oferece várias formas de interagir e apresentar esse resultado.
Exemplo
Formatação Markdown na Saída
O parâmetro markdown
ativa a formatação automática em markdown na saída das tarefas. Quando configurado como True
, a tarefa irá instruir o agente a formatar a resposta final utilizando a sintaxe Markdown correta.
Usando Formatação Markdown
Quando markdown=True
, o agente recebe instruções extras para formatar a saída usando:
#
para títulos**texto**
para negrito*texto*
para itálico-
ou*
para bullet points`código`
para código inline
Configuração YAML com Markdown
Benefícios da Saída Markdown
- Formatação Consistente: Garante que todas as saídas sigam as convenções de markdown
- Maior Legibilidade: Conteúdo estruturado com títulos, listas e ênfase
- Pronto para Documentação: A saída pode ser usada diretamente em sistemas de documentação
- Compatibilidade Multi-plataforma: Markdown é universalmente suportado
As instruções de formatação em markdown são adicionadas automaticamente ao prompt da tarefa quando markdown=True
, então não é necessário detalhar os requisitos de formatação na descrição da tarefa.
Dependências de Tarefas e Contexto
As tarefas podem depender da saída de outras tarefas utilizando o atributo context
. Por exemplo:
Guardrails em Tarefas
Guardrails (trilhas de proteção) de tarefas fornecem uma maneira de validar e transformar as saídas das tarefas antes que elas sejam passadas para a próxima tarefa. Esse recurso assegura a qualidade dos dados e oferece feedback aos agentes quando sua saída não atende a critérios específicos.
Usando Guardrails em Tarefas
Para adicionar um guardrail a uma tarefa, forneça uma função de validação por meio do parâmetro guardrail
:
Requisitos da Função Guardrail
-
Assinatura da Função:
- Deve aceitar exatamente um parâmetro (a saída da tarefa)
- Deve retornar uma tupla
(bool, Any)
- Type hints são recomendados, mas opcionais
-
Valores de Retorno:
- Em caso de sucesso: retorna uma tupla
(True, resultado_validado)
- Em caso de falha: retorna uma tupla
(False, "mensagem de erro explicando a falha")
- Em caso de sucesso: retorna uma tupla
LLMGuardrail
A classe LLMGuardrail
oferece um mecanismo robusto para validação das saídas das tarefas.
Melhores Práticas de Tratamento de Erros
- Respostas de Erro Estruturadas:
-
Categorias de Erro:
- Use códigos de erro específicos
- Inclua contexto relevante
- Forneça feedback acionável
-
Cadeia de Validação:
Tratamento dos Resultados do Guardrail
Quando um guardrail retorna (False, erro)
:
- O erro é enviado de volta para o agente
- O agente tenta corrigir o problema
- O processo se repete até:
- O guardrail retornar
(True, resultado)
- O número máximo de tentativas ser atingido
- O guardrail retornar
Exemplo com manipulação de tentativas:
Obtendo Saídas Estruturadas e Consistentes das Tarefas
É importante também observar que a saída da última tarefa de um crew se torna a saída final do próprio crew.
Usando output_pydantic
A propriedade output_pydantic
permite que você defina um modelo Pydantic que a saída da tarefa deve seguir. Isso garante que a saída seja não apenas estruturada, mas também validada de acordo com o modelo.
Veja um exemplo de uso do output_pydantic:
Neste exemplo:
- Um modelo Pydantic Blog é definido com os campos title e content.
- A tarefa task1 utiliza a propriedade output_pydantic para especificar que sua saída deve seguir o modelo Blog.
- Após executar o crew, você pode acessar a saída estruturada de várias formas, como mostrado.
Explicação sobre o acesso à saída
- Indexação estilo dicionário: Acesse os campos diretamente usando result[“nome_do_campo”]. Isso funciona porque a classe CrewOutput implementa o método getitem.
- Diretamente do modelo Pydantic: Acesse os atributos diretamente do objeto result.pydantic.
- Usando o método to_dict(): Converta a saída para um dicionário e acesse os campos.
- Imprimindo o objeto inteiro: Simplesmente imprima o objeto result para ver a saída estruturada.
Usando output_json
A propriedade output_json
permite definir o formato de saída esperado em JSON. Isso garante que a saída da tarefa seja uma estrutura JSON válida que pode ser facilmente analisada e utilizada na aplicação.
Veja um exemplo de uso do output_json
:
Neste exemplo:
- Um modelo Pydantic Blog é definido com os campos title e content, usado para especificar a estrutura do JSON de saída.
- A tarefa task1 utiliza a propriedade output_json para indicar que espera uma saída JSON que segue o modelo Blog.
- Após executar o crew, você pode acessar a saída estruturada em JSON conforme demonstrado.
Explicação sobre o acesso à saída
- Acessando propriedades via indexação de dicionário: Você pode acessar os campos diretamente usando result[“nome_do_campo”]. Isso é possível pois a classe CrewOutput implementa o método getitem, permitindo tratar a saída como um dicionário. Nesse caso, estamos acessando title e content do resultado.
- Imprimindo o objeto Blog inteiro: Ao imprimir result, você obterá a representação em string do objeto CrewOutput. Como o método str é implementado para retornar a saída em JSON, isso exibirá toda a saída como uma string formatada representando o objeto Blog.
Utilizando output_pydantic
ou output_json
, você garante que suas tarefas produzam saídas em um formato estruturado e consistente, facilitando o processamento e uso dos dados na sua aplicação ou entre múltiplas tarefas.
Integrando Ferramentas com Tarefas
Utilize ferramentas do CrewAI Toolkit e LangChain Tools para ampliar o desempenho das tarefas e aprimorar a interação dos agentes.
Criando uma Tarefa com Ferramentas
Isso demonstra como tarefas com ferramentas específicas podem sobrescrever o conjunto padrão de um agente para uma execução mais personalizada da tarefa.
Referenciando Outras Tarefas
No CrewAI, a saída de uma tarefa é automaticamente repassada para a próxima, mas você pode definir explicitamente de quais tarefas a saída deve ser utilizada como contexto por outra, inclusive múltiplas saídas.
É útil especialmente quando você precisa que uma tarefa dependa do resultado de outra que não é executada imediatamente antes dela. Isso é feito pelo atributo context
:
Execução Assíncrona
Você pode definir que uma tarefa seja executada de forma assíncrona. Isso significa que o crew não aguardará sua conclusão para seguir para a próxima tarefa. É útil para tarefas demoradas, ou que não são cruciais para as seguintes.
Depois, utilize o atributo context
para indicar, em uma tarefa futura, que ela deve aguardar os resultados da tarefa assíncrona.
Mecanismo de Callback
A função callback é executada após a conclusão da tarefa, permitindo acionar ações ou notificações baseadas no resultado da tarefa.
Acessando a Saída de uma Tarefa Específica
Assim que um crew finaliza sua execução, você pode acessar a saída de uma tarefa específica por meio do atributo output
do objeto da tarefa:
Mecanismo de Sobrescrição de Ferramentas
Especificar ferramentas em uma tarefa permite a adaptação dinâmica das capacidades do agente, destacando a flexibilidade do CrewAI.
Mecanismos de Validação e Tratamento de Erros
Ao criar e executar tarefas, determinados mecanismos de validação garantem a robustez e confiabilidade dos atributos das tarefas. Isso inclui, mas não se limita a:
- Garantir que apenas um tipo de saída seja definido por tarefa para manter expectativas de saída claras.
- Impedir a atribuição manual do atributo
id
, preservando a integridade do sistema de identificadores únicos.
Estas validações colaboram para a consistência e confiabilidade das execuções de tarefas no framework CrewAI.
Guardrails em Tarefas
Guardrails de tarefas oferecem uma maneira poderosa de validar, transformar ou filtrar as saídas das tarefas antes de serem encaminhadas à próxima. São funções opcionais que executam antes do início da próxima tarefa, garantindo que as saídas estejam em conformidade com requisitos ou formatos esperados.
Uso Básico
Defina sua própria lógica de validação
Use uma abordagem no-code para validação
Usando YAML
Use modelos customizados para geração de código
Como Guardrails Funcionam
- Atributo Opcional: Guardrails são opcionais por tarefa, permitindo adicionar validação só onde for necessário.
- Momento de Execução: A função guardrail é executada antes do início da próxima tarefa, garantindo fluxo de dados válido entre tarefas.
- Formato de Retorno: Guardrails devem retornar uma tupla
(sucesso, dados)
:- Se
sucesso
éTrue
,dados
é o resultado validado/transformado - Se
sucesso
éFalse
,dados
é a mensagem de erro
- Se
- Roteamento do Resultado:
- Sucesso (
True
): o resultado é automaticamente passado para a próxima tarefa - Falha (
False
): o erro é enviado de volta ao agente para gerar uma nova resposta
- Sucesso (
Casos Comuns de Uso
Validação de Formato de Dados
Filtragem de Conteúdo
Transformação de Dados
Recursos Avançados
Encadeando Múltiplas Validações
Lógica Customizada de Retentativas
Criando Diretórios ao Salvar Arquivos
Agora é possível especificar se uma tarefa deve criar diretórios ao salvar sua saída em arquivo. Isso é útil para organizar outputs e garantir que os caminhos estejam corretos.
Veja o vídeo abaixo para aprender como utilizar saídas estruturadas no CrewAI:
Conclusão
Tarefas são a força motriz por trás das ações dos agentes no CrewAI. Ao definir corretamente as tarefas e seus resultados, você prepara seus agentes de IA para trabalhar de forma eficaz, seja de forma independente ou colaborativa. Equipar tarefas com as ferramentas adequadas, compreender o processo de execução e seguir práticas sólidas de validação são fundamentais para maximizar o potencial do CrewAI, assegurando que os agentes estejam devidamente preparados para suas atribuições e que as tarefas sejam executadas conforme o esperado.