Pular para o conteúdo principal

Extensão - FAQ Dinâmica

  • Atualizado

Índice:

  1. Introdução
  2. Como funciona?
  3. Instalação e configuração
  4. Exemplo de Uso
  5. Configuração no Builder
  6. Fluxo de Homologação 
  7. Suporte

Introdução

A extensão FAQ Dinâmica foi desenvolvida visando facilitar a criação e manutenção de conteúdos de uma FAQ .

Esta solução otimiza o processo de construção de uma FAQ, sem a necessidade de utilização de IA (Inteligência Artificial), ou de soluções via scripts e regex para tratar a mensagem do usuário. A extensão permite a construção de uma skill de FAQ por uma interface intuitiva, otimizando o tempo de desenvolvimento da estrutura e facilitando a edição dos conteúdos cadastrados.

Como funciona?

A FAQ Dinâmica funciona com base em um sistema de palavras-chave cadastradas na interface do plugin, juntamente com outras informações. Ao identificar na mensagem do usuário alguma palavra-chave ou um termo similar, o contato inteligente irá responder com o conteúdo encontrado para aquele assunto, utilizando um componente do canal que o usuário estiver conversando. 

A extensão possui as seguintes funcionalidades:

  • Cadastro, edição, visualização e exclusão de palavras-chave;
  • Edição do score do Fuzzy Match (serviço usado para comparação das palavras-chave com o input do usuário);
  • Cópia das palavras cadastradas para outro bot/router;
  • Ativação e desativação das palavras-chave;

Ao entrar na tela do plugin, será exibido a seguinte tela:

 

1.png

Logo na barra superior temos as seguintes funcionalidades:

2.png

 

  1. Este botão abre a documentação de utilização do Plugin.
  2. Ao clicar neste botão, um pop-up com a funcionalidade de copiar as palavras-chave de um bot para outro será aberto. Para realizar a cópia é necessário informar a Key Authorization do bot de destino:

3.png

  1. Este botão atualiza a lista de palavras-chave cadastradas e o campo de score (item 4).
  2. No campo score é definido um número de 0 a 100 com valor de confiabilidade utilizado pelo Fuzzy Match para verificar se o input do usuário corresponde a alguma palavra-chave cadastrada.
  3. O botão “Adicionar Palavra-Chave” abre um formulário para cadastrar as informações de uma nova palavra-chave.

Quando houver palavras-chave cadastradas, o usuário passa a ter acesso às seguintes funcionalidades:

 

4.png

 

  1. Uma barra de pesquisa para procurar uma palavra-chave na lista.
  2. A quantidade de palavras-chave são exibidas logo abaixo da barra de pesquisa, limitado o cadastro de 150 palavras-chave por bot.
  3. Lista de palavras-chave cadastradas.

Ao passar o mouse sobre um dos itens na lista de palavras, um ícone de lixeira é exibido e ao clicar nele é possível excluir a palavra-chave.

5.png

Instalação e configuração

Para instalar a extensão acesse a Blip Store dentro de algum contato inteligente e procure por FAQ Dinâmica. Depois é só ativar a extensão e já estará disponível para uso no menu de extensões do bot/router.

Exemplo de Uso

Cadastro de palavras-chave

Para cadastrar uma palavra-chave, basta clicar no botão “Adicionar Palavra-Chave” no canto superior direito da tela.

5.1.png

 

O formulário de cadastro de novas palavras-chave será exibido.

 

6.png

7.png

 

  1. Palavra-Chave: Este campo é o id da palavra-chave, deve ser informado um nome sem caracteres especiais;
  2. Título: Neste campo deve ser informado como a palavra-chave será exibida ao usuário, grafia correta com caracteres especiais e letras maiúsculas e minúsculas;
  3. Exemplos: Neste campo pode ser cadastrado até 5 exemplos e/ou variações da palavra-chave. Este campo permite auxiliar no reconhecimento do input do usuário através do Fuzzy Match;
  4. Descrição: Neste campo deve ser informado o texto de resposta referente a palavra-chave cadastrada;
  5. Canais: Neste campo deve ser informado o canal onde o bot será utilizado. Ao habilitar o canal, um tipo de componente correspondente deve ser selecionado para o conteúdo ser exibido ao usuário conforme o componente e canal selecionado;
  6. Opções: Neste campo pode ser informado os possíveis assuntos e respostas referente a palavra-chave;
  7. Resposta: Conteúdo da resposta ou indicação de redirecionamento para a opção escolhida do usuário.

Ao finalizar o preenchimento do formulário e clicar no botão “Salvar”, a nova palavra-chave será exibida na interface do Plugin.

Configuração no Builder

Para que os conteúdos cadastrados na interface do plugin sejam exibidos para o usuário, a mensagem do usuário deve ser enviada para a API do Plugin.

A API possui dois endpoints:

1 - /keyword-input: endpoint que recebe o input do usuário e o canal (Blip Chat, WhatsApp) e retorna o conteúdo da palavra-chave encontrada, ou em casos que o input do usuário corresponda a duas palavras-chave, o endpoint irá retornar um menu com as palavras-chave encontradas.

No Builder deve ser configurado uma requisição HTTP da seguinte forma:

POST https://keywords.cs.blip.ai/api/Keyword/keyword-input

keyAuthorization: {{chave do bot que o plugin foi instalado}}




{

  "input": "{{input do usuário}}",

  "channel": "{{canal do usuário}}"

}

 

Para exibir o conteúdo retornado, pode ser utilizado a variável com a resposta da API em um conteúdo dinâmico no builder:

8.png

Exemplo de retorno (WhatsApp) quando apenas uma palavra-chave é encontrada:

9.png

Exemplo de retorno (WhatsApp) quando mais de uma palavra-chave é encontrada:

10.png

2 - /option-keyword: Esse endpoint deve ser utilizado quando o usuário receber o conteúdo com as opções de uma palavra-chave. O endpoint recebe a keyword (palavra-chave) encontrada pelo endpoint anterior, a opção selecionada, e o canal que o usuário estiver conversando. Será retornado o conteúdo da opção selecionada:

 

No builder deve ser configurado uma requisição HTTP da seguinte forma:

POST https://keywords.cs.blip.ai/api/Keyword/option-keyword

keyAuthorization: {{chave do bot que o plugin foi instalado}}




{

  "keyword": "{{keyword encontrada}}",

  "option": "{{opção selecionada}}",

  "channel": "{{canal do usuário}}"

}

Para exibir o conteúdo retornado, pode ser utilizado a variável com a resposta da API em um conteúdo dinâmico no builder:

11.png

Exemplo de retorno (WhatsApp) do endpoint:

12.png

Fluxo de Homologação 

Para ter acesso ao fluxo já montado, basta acessar o link.

 

Suporte

Em caso de dúvidas ou se encontrar algum problema com a extensão, entre em contato conosco pelo e-mail suporte.pluginfaq@blip.ai.

 

Para mais informações, acesse a discussão sobre o assunto em nossa comunidade ou os vídeos no nosso canal. 😃

 

Artigos relacionados