Pular para o conteúdo principal

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 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.Task Builder ScreenshotO 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:
Code

Atributos da Tarefa

Criando Tarefas

Existem duas formas comuns de criar tarefas no CrewAI: usando configuração JSONC (recomendado para novas crews) ou definindo-as diretamente no código.

Configuração JSONC (Recomendado)

Novos projetos criados com crewai create crew <name> definem tarefas no crew.jsonc.
crew.jsonc
Cada tarefa precisa de description e expected_output. O valor de agent deve corresponder a um agente listado em agents. context referencia nomes de tarefas anteriores; referências futuras são rejeitadas. Campos comuns incluem name, agent, context, output_file, tools, human_input, async_execution, guardrail, guardrails, markdown, output_json, output_pydantic e response_model.

Configuração YAML Clássica

Projetos clássicos criados com crewai create crew <name> --classic usam config/tasks.yaml e uma classe @CrewBase em crew.py. A configuração YAML continua suportada para projetos existentes em Python/YAML e para equipes que preferem definir tarefas a partir de uma classe @CrewBase. Após criar um projeto clássico, navegue até o arquivo src/<project_name>/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:
Code
Veja um exemplo de configuração de tarefas usando YAML:
tasks.yaml
Para usar essa configuração YAML em seu código, crie uma classe crew que herda de CrewBase:
crew.py
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:
task.py
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

Métodos e Propriedades da Tarefa

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

Code

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

Code
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
  • linguagem ``` para blocos de código

Configuração YAML com Markdown

tasks.yaml

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:
Code

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. Guardrails são implementados como funções Python que contêm lógica de validação customizada, proporcionando controle total sobre o processo de validação e garantindo resultados confiáveis e determinísticos.

Guardrails Baseados em Função

Para adicionar um guardrail baseado em função a uma tarefa, forneça uma função de validação por meio do parâmetro guardrail:
Code

Requisitos da Função Guardrail

  1. 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
  2. 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")

Melhores Práticas de Tratamento de Erros

  1. Respostas de Erro Estruturadas:
Code
  1. Categorias de Erro:
    • Use códigos de erro específicos
    • Inclua contexto relevante
    • Forneça feedback acionável
  2. Cadeia de Validação:
Code

Tratamento dos Resultados do Guardrail

Quando um guardrail retorna (False, erro):
  1. O erro é enviado de volta para o agente
  2. O agente tenta corrigir o problema
  3. O processo se repete até:
    • O guardrail retornar (True, resultado)
    • O número máximo de tentativas ser atingido
Exemplo com manipulação de tentativas:
Code

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:
Code
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

  1. 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.
  2. Diretamente do modelo Pydantic: Acesse os atributos diretamente do objeto result.pydantic.
  3. Usando o método to_dict(): Converta a saída para um dicionário e acesse os campos.
  4. 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:
Code
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

  1. 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.
  2. 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

Code
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:
Code

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.
Code

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.
Code

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:
Code

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

Code
Code

Use modelos customizados para geração de código

Code

Como Guardrails Funcionam

  1. Atributo Opcional: Guardrails são opcionais por tarefa, permitindo adicionar validação só onde for necessário.
  2. 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.
  3. 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
  4. 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

Casos Comuns de Uso

Validação de Formato de Dados

Code

Filtragem de Conteúdo

Code

Transformação de Dados

Code

Recursos Avançados

Encadeando Múltiplas Validações

Code

Lógica Customizada de Retentativas

Code

Criando Diretórios ao Salvar Arquivos

O parâmetro create_directory controla se o CrewAI deve criar automaticamente diretórios ao salvar saídas de tarefas em arquivos. Este recurso é particularmente útil para organizar outputs e garantir que os caminhos de arquivos estejam estruturados corretamente, especialmente ao trabalhar com hierarquias de projetos complexas.

Comportamento Padrão

Por padrão, create_directory=True, o que significa que o CrewAI criará automaticamente qualquer diretório ausente no caminho do arquivo de saída:
Code

Desabilitando a Criação de Diretórios

Se você quiser evitar a criação automática de diretórios e garantir que o diretório já exista, defina create_directory=False:
Code

Configuração YAML

Você também pode configurar este comportamento em suas definições de tarefas YAML:
tasks.yaml

Casos de Uso

Criação Automática de Diretórios (create_directory=True):
  • Ambientes de desenvolvimento e prototipagem
  • Geração dinâmica de relatórios com pastas baseadas em datas
  • Fluxos de trabalho automatizados onde a estrutura de diretórios pode variar
  • Aplicações multi-tenant com pastas específicas do usuário
Gerenciamento Manual de Diretórios (create_directory=False):
  • Ambientes de produção com controles rígidos do sistema de arquivos
  • Aplicações sensíveis à segurança onde diretórios devem ser pré-configurados
  • Sistemas com requisitos específicos de permissão
  • Ambientes de conformidade onde a criação de diretórios é auditada

Tratamento de Erros

Quando create_directory=False e o diretório não existe, o CrewAI gerará um RuntimeError:
Code
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.