Passar para o conteúdo principal

Como configurar uma ação de API REST

Atualizado há mais de 3 semanas

Resumo

Este artigo o guiará pelo processo de configuração de uma ação de API REST no Wati. Você aprenderá a escolher o gatilho correto, selecionar um tipo de evento, se necessário, e adicionar a ação corretamente às instruções do seu agente de IA para que funcione conforme esperado.

Instruções

Uma ação de API REST só funciona quando está configurada corretamente e adicionada às instruções do seu agente de IA. O processo de configuração tem 3 etapas principais:

  1. Escolha como a ação deve ser acionada

  2. Selecione um tipo de evento (se aplicável)

  3. Adicione a ação de API REST às instruções do seu agente de IA

Siga os passos abaixo para concluir a configuração.

Etapa 1: Escolha um tipo de gatilho

Ao criar uma ação de API REST, a primeira decisão é como ela deve ser acionada.

Existem 2 tipos de gatilhos disponíveis:

Gatilho baseado em intenção

Este gatilho é usado quando você deseja que a ação seja executada com base no que o usuário diz.

  • Acionado quando o agente de IA detecta uma intenção específica do usuário durante uma conversa

  • Útil para ações como enviar dados quando um usuário pede um demonstração ou compartilha interesse

Comportamento do parâmetro: Podem ser usados placeholders dinâmicos para a configuração da API.

Modo de gatilho: Atualmente, apenas agent_decides é suportado. Isso significa que o agente de IA decide quando executar a ação com base no contexto da conversa.

Gatilho baseado em evento

Este gatilho é executado automaticamente quando um evento pré-definido ocorre.

  • Acionado sem depender da intenção do usuário

  • Útil para ações impulsionadas pelo sistema, como feedback ou envio de formulários

Etapa 2: Selecione um tipo de evento (somente baseado em evento)

Se você escolher Evento como o tipo de gatilho, você deve selecionar um dos tipos de eventos suportados.

Atualmente, o Astra suporta os seguintes tipos de eventos:

Feedback positivo recebido (polegar para cima)

  • Acionado quando um usuário clica na opção de polegar para cima

  • Suporta apenas parâmetros estáticos

Feedback negativo recebido (polegar para baixo)

  • Acionado quando um usuário clica na opção de polegar para baixo

  • Suporta apenas parâmetros estáticos

Formulário enviado

  • Acionado quando um usuário envia um Formulário Personalizado

  • Suporta parâmetros dinâmicos passados dos campos do formulário

Lead capturado

  • Acionado quando as informações de lead são coletadas durante uma conversa

  • Usa uma estrutura de corpo de solicitação fixa

Escolha o tipo de evento que melhor se adequa ao momento em que você deseja que a ação de API REST seja executada.

Etapa 3: Adicione a ação de API REST às instruções do agente de IA

Criar uma ação de API REST não é suficiente por si só. A ação não funcionará até que seja adicionada às instruções do seu agente de IA.

Requisito para todas as ações de API REST

  • Adicione a ação de API REST à configuração de instruções do agente

Se a ação não for incluída nas instruções, ela nunca será acionada.

Requisito adicional para “Formulário enviado”

Se você estiver usando o tipo de evento Formulário enviado, há um requisito adicional:

  • Você também deve adicionar o Formulário Personalizado relacionado às instruções do agente

  • Ambos a ação de API REST e o Formulário Personalizado devem ser incluídos

Se um deles estiver faltando, a ação de API REST não será acionada corretamente.

Aqui está uma visão geral rápida do que integrar dependendo do tipo de evento:

Tipo de Evento

O que Integrar

Polegar para cima / Polegar para baixo

Ação de API REST apenas

Formulário enviado

Ação de API REST + Formulário Personalizado

Lead capturado

Ação de API REST apenas

Intenção

Ação de API REST apenas

Lista de Verificação Final

Antes de publicar seu agente de IA, certifique-se de que:

  • Um tipo de gatilho foi selecionado

  • Um tipo de evento foi escolhido (se baseado em evento)

  • A ação de API REST foi adicionada às instruções do agente

  • O Formulário Personalizado foi adicionado ao usar Formulário enviado

Uma vez que todas essas etapas sejam concluídas, a ação de API REST estará pronta para ser executada automaticamente durante conversas.

Respondeu à sua pergunta?