Skip to main content
As Tools são as consultas que a Software House configura para que o Plug4ia responda perguntas pelo WhatsApp. Cada Tool pertence a um ERP, possui um agente responsável, uma descrição e uma consulta SQL. Quando o usuário faz uma pergunta, o Plug4ia usa a descrição das Tools para escolher a consulta mais adequada e buscar os dados no ambiente integrado da empresa.
A qualidade da resposta depende diretamente da Tool cadastrada. Nome, descrição e SQL precisam deixar claro qual pergunta a consulta responde.

Campos da Tool

Agentes disponíveis

Selecione o agente que melhor representa o assunto da consulta.

Criando uma Tool

1

Acesse Tools

No menu lateral, clique em Tools.
2

Clique em Nova Tool

O formulário de cadastro será aberto.
3

Selecione o ERP e o agente

Escolha o ERP da consulta e o agente responsável pelo assunto.
4

Informe nome e descrição

Use uma descrição objetiva, escrita como uma explicação do que a consulta responde.Exemplo: “Retorna o total de vendas por dia em um período informado pelo usuário.”
5

Configure a consulta SQL

Escreva a SQL no campo Consulta SQL.
6

Ative e salve

Marque Tool ativa quando a consulta já estiver validada e clique em Salvar tool.

Regras para consulta SQL

As consultas devem ser de leitura e retornar apenas os dados necessários para a resposta.
Valide cada SQL antes de ativar a Tool. A consulta será usada para responder usuários reais pelo WhatsApp.

Parâmetros na SQL

Use parâmetros para permitir que o Plug4ia preencha valores conforme a pergunta do usuário. Parâmetros encontrados no catálogo atual:
Use nomes claros nos parâmetros. Isso ajuda a relacionar a pergunta do usuário com os filtros da consulta.
O catálogo atual usa principalmente @data_ini, @data_fim e @erp_empresa_id. Ao criar novas Tools, mantenha esse padrão sempre que possível para facilitar manutenção e reaproveitamento.

Exemplo: resumo de vendas

Nome da Tool: vendas_completo Agente: Agente de Vendas Descrição: Retorna quantidade de vendas, total faturado e ticket médio entre duas datas.
Perguntas que essa Tool pode responder:

Exemplo: produtos mais vendidos

Nome da Tool: top_produtos_mais_vendidos Agente: Agente de Vendas Descrição: Ranking de produtos mais vendidos por receita, margem ou quantidade.
Perguntas que essa Tool pode responder:

Exemplo: contas a receber por período

Nome da Tool: contas_receber_clientes_periodo Agente: Agente de Contas a Receber Descrição: Retorna documentos de contas a receber com saldo em aberto que vencem dentro de um período.
Perguntas que essa Tool pode responder:

Exemplo: consulta de produto por código

Nome da Tool: consulta_produto_codigo Agente: Agente de Produtos Descrição: Detalhes de produto com preços, margem, grupo e estoque filtrando por ID ou código EAN.
Perguntas que essa Tool pode responder:

Exemplo: compras por período

Nome da Tool: compras_resumo_periodo Agente: Agente de Compras Descrição: Total de compras, quantidade de notas e ticket médio de compra no período.
Perguntas que essa Tool pode responder:

Exemplo: contas a pagar a vencer

Nome da Tool: contas_pagar_documentos_a_vencer Agente: Agente de Contas a Pagar Descrição: Documentos com saldo que vencem no período informado.
Perguntas que essa Tool pode responder:

Boas práticas para descrições

Uma boa descrição ajuda o Plug4ia a escolher a Tool correta.

Ativando e desativando Tools

Use o status para controlar se a consulta está disponível.
  • Ativa: pode ser usada para responder perguntas.
  • Inativa: permanece cadastrada, mas não deve ser usada nas respostas.
Ao desativar uma Tool, perguntas que dependem dela podem deixar de ser respondidas.

Filtros e manutenção

Na tela de Tools, você pode filtrar por:
  • Nome.
  • Descrição.
  • ERP.
  • Agente.
  • Status.
Também é possível visualizar detalhes, copiar a SQL, editar ou excluir uma Tool.
Excluir uma Tool remove a consulta do portal. Se você só precisa suspender o uso temporariamente, inative a Tool.