Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.omnitechsolucoes.com.br/llms.txt

Use this file to discover all available pages before exploring further.

As Ferramentas Personalizadas Durante a Chamada permitem que seu assistente de IA interaja com sistemas externos em tempo real. Seja para consultar estoque, validar dados de clientes ou buscar informações atualizadas, essas ferramentas tornam sua IA mais poderosa e conectada.

​
Visão Geral

As Ferramentas Personalizadas Durante a Chamada permitem que seu assistente de IA:
  • Realize chamadas de API em tempo real durante a conversa
  • Consulte ou envie dados para seus sistemas
  • Tome decisões com base em informações atualizadas
  • Forneça respostas precisas e em tempo real aos clientes

Principais Benefícios

  • Não exige código – basta configurar o endpoint da API e os parâmetros
  • A IA entende automaticamente quando e como utilizar as ferramentas
  • Acesso a dados em tempo real durante a chamada
  • Integração transparente com seus sistemas existentes

​
Configurando Sua Ferramenta

​
1. Configuração Básica

Configuração Principal da Ferramenta
1

Acessar Criação de Ferramenta

Navegue até Ferramentas Durante a Chamada e clique em Criar Ferramenta Personalizada
2

Configurar Informações Principais

Preencha os dados essenciais:
  • Nome: Utilize letras minúsculas e underline (ex.: check_order_status)
  • Descrição: Explique quando e como a IA deve usar esta ferramenta
  • Endpoint: URL da sua API (ex.: https://api.suaempresa.com/pedidos)
  • Timeout: Tempo máximo de espera por resposta (em segundos)
  • Método: Escolha entre GET, POST, PUT, PATCH ou DELETE
3

Adicionar Headers

Headers comuns que podem ser necessários:
Content-Type: application/json
Authorization: Bearer seu_token

​
2. Configuração de Variáveis

Configuração de Variáveis
1

Definir Parâmetros

São as informações que a IA irá coletar durante a chamada:
Name: order_number
Type: string
Description: "Número do pedido com 10 dígitos informado pelo cliente"
2

Definir Regras de Validação

Inclua exigências de formato na descrição:
"Data no formato dd/mm/aaaa"
"Telefone sem espaços"
"Endereço de e-mail para confirmação"

​
Entendendo os Tipos de Parâmetros

String

Valores textuais como nomes, endereços ou números de referência
Type: string
Examples: "João Silva", "Rua Exemplo, 123"

Number

Valores numéricos como quantidades, valores ou IDs
Type: number
Examples: 42, 99.99

true_false

Valores booleanos para situações de sim ou não
Type: true_false
Examples: true, false

Ajuda de Formatação

Inclua instruções de formato diretamente na descrição
"Data no formato dd/mm/aaaa"
"Telefone sem espaços"

​
Endpoints Dinâmicos

Ao utilizar variáveis na URL do endpoint, certifique-se de envolvê-las com chaves e utilizar exatamente o mesmo nome do parâmetro configurado.
Você pode tornar seus endpoints dinâmicos utilizando variáveis: 
URL básica:
https://api.exemplo.com/pedidos/status

Com variáveis:
https://api.exemplo.com/pedidos/{order_id}/status
A IA substituirá automaticamente {order_id} pelo valor real coletado durante a conversa.

Testes Facilitados
<Card title="Testes Automáticos" icon="vial"> Clique em **Testar Ferramenta** para executar um teste com dados fictícios: - Parâmetros string: "test" - Parâmetros numéricos: 1 - Parâmetros booleanos: true
Você visualizará o código de resposta e o corpo da resposta para validar o funcionamento.
</Card>

Recurso Avançado: Integração com Plataforma de Automação
<Note> Precisa de lógicas mais complexas? Conecte sua ferramenta à plataforma de automação para criar fluxos avançados. </Note>
Para integrações avançadas e fluxos complexos, combine ferramentas personalizadas com nossa Plataforma de Automação.

Como criar integrações avançadas:
Na plataforma de automação:

Crie um novo fluxo

Adicione um gatilho de webhook

Construa a lógica (chamadas de API, transformações de dados, etc.)

Finalize com Return Response

Na ferramenta personalizada:

Utilize a URL do webhook como endpoint

Adicione /sync ao final

Exemplo: https://automation.omnitech.ai/webhook/abc123/sync

Isso permite:

Transformar dados antes/depois das chamadas de API

Executar múltiplas chamadas de API em sequência

Aplicar regras de negócio complexas

Tratar erros de forma controlada

Exemplos Reais de Uso
<AccordionGroup> <Accordion title="Consulta de Pedido" icon="magnifying-glass"> ```yaml Name: check_order Endpoint: https://api.sualoja.com/pedidos/{order_number} Parameters: - Name: order_number Type: string Description: "Referência do pedido (formato: ORD-XXXXX)" ```
A IA irá:
1. Solicitar o número do pedido
2. Consultar o status
3. Informar prazos e situação ao cliente
</Accordion> <Accordion title="Disponibilidade de Agenda" icon="calendar"> ```yaml Name: check_slots Endpoint: https://api.calendario.com/disponibilidade Parameters: - Name: service Type: string Description: "Tipo de serviço (corte, massagem, consulta)" - Name: date Type: string Description: "Data desejada (dd/mm/aaaa)" ```
A IA irá:
1. Perguntar o serviço desejado
2. Coletar a data preferida
3. Informar horários disponíveis
</Accordion> <Accordion title="Validação de Cliente" icon="shield-check"> ```yaml Name: verify_customer Endpoint: https://api.crm.com/verify Parameters: - Name: phone Type: string Description: "Número de telefone com 10 dígitos" - Name: email Type: string Description: "Endereço de e-mail para validação" ```
A IA irá:
1. Coletar dados de contato
2. Validar no CRM
3. Prosseguir conforme o resultado
</Accordion> </AccordionGroup>
Configurando o Uso pela IA
<Info> A IA precisa de instruções claras no prompt de sistema para utilizar corretamente as ferramentas personalizadas. </Info>
Exemplo de trecho de prompt:
Quando usar a ferramenta check_order:
1. Cliente pergunta sobre status do pedido
2. Menciona entrega ou rastreamento
3. Quer saber onde está o pedido

Como utilizar:
1. Solicitar número do pedido se não informado
2. Validar formato (ORD-XXXXX)
3. Usar a ferramenta para consultar o status
4. Explicar o resultado de forma simples
<Tip> Teste suas ferramentas com diferentes fluxos de conversa para garantir que a IA lide bem com todos os cenários. Comece com chamadas de teste simples antes de colocar em produção. </Tip> ```