Índice:
- Introducción
- ¿Cómo funciona?
- Instalación y configuración
- Ejemplo de uso
- Configuración en el Builder
- Flujo de Pruebas
- Soporte
Introducción
La extensión de FAQ Dinámica fue desarrollada con el objetivo de facilitar la creación y mantenimiento de contenido para un FAQ.
Esta solución optimiza el proceso de construcción de un FAQ, sin la necesidad de utilizar IA (Inteligencia Artificial) ni soluciones mediante scripts y regex para procesar el mensaje del usuario. La extensión permite construir una habilidad de FAQ a través de una interfaz intuitiva, optimizando el tiempo de desarrollo de la estructura y facilitando la edición del contenido registrado.
¿Cómo funciona?
El FAQ Dinámico opera en base a un sistema de palabras clave que se registran en la interfaz del complemento, junto con otra información. Cuando se identifica en el mensaje del usuario alguna palabra clave o un término similar, el contacto inteligente responderá con el contenido encontrado para ese tema, utilizando un componente del canal con el que el usuario esté conversando.
La extensión cuenta con las siguientes funcionalidades:
- Registro, edición, visualización y eliminación de palabras clave.
- Edición del puntaje de coincidencia difusa (un servicio utilizado para comparar las palabras clave con la entrada del usuario).
- Copia de las palabras registradas para otro bot/router.
- Activación y desactivación de las palabras clave.
Al ingresar a la pantalla del complemento, se mostrará la siguiente interfaz:
En la barra superior encontramos las siguientes funcionalidades:
- Este botón abre la documentación de uso del complemento.
- Al hacer clic en este botón, se abrirá una ventana emergente con la función de copiar las palabras clave de un bot a otro. Para realizar la copia, es necesario proporcionar la Key Authorization del bot de destino.
- Este botón actualiza la lista de palabras clave registradas y el campo de puntaje (elemento 4).
- En el campo de puntaje se establece un número del 0 al 100 que indica la confiabilidad utilizada por Fuzzy Match para verificar si la entrada del usuario coincide con alguna palabra clave registrada.
- El botón "Agregar Palabra Clave" abre un formulario para registrar la información de una nueva palabra clave.
Cuando haya palabras clave registradas, el usuario tendrá acceso a las siguientes funcionalidades:
- Una barra de búsqueda para buscar una palabra clave dentro de la lista.
- La cantidad de palabras clave se muestra justo debajo de la barra de búsqueda, y el registro de palabras clave está limitado a 150 por bot.
- Lista de palabras clave registradas.
Al pasar el mouse sobre uno de los elementos de la lista de palabras clave, se muestra un ícono de papelera y al hacer clic en él es posible eliminar la palabra clave.
Instalación y configuración
Para instalar la extensión, accede a la Blip Store desde alguno de tus contactos inteligentes y busca "FAQ Dinámica". Luego, simplemente activa la extensión y estará disponible para su uso en el menú de extensiones del bot/router.
Ejemplo de uso
Registro de palabras clave
Para registrar una palabra clave, simplemente haz clic en el botón "Agregar Palabra Clave" en la esquina superior derecha de la pantalla.
Se mostrará el formulario de registro de nuevas palabras clave.
- Palabra Clave: Este campo es el ID de la palabra clave, se debe ingresar un nombre sin caracteres especiales;
- Título: En este campo se debe ingresar cómo se mostrará la palabra clave al usuario, con la ortografía correcta y utilizando mayúsculas y minúsculas;
- Ejemplos: En este campo se pueden registrar hasta 5 ejemplos o variaciones de la palabra clave. Este campo ayuda en el reconocimiento de la entrada del usuario mediante el uso de Fuzzy Match;
- Descripción: En este campo se debe ingresar el texto de respuesta relacionado con la palabra clave registrada;
- Canales: En este campo se debe indicar en qué canal se utilizará el bot. Al habilitar el canal, se debe seleccionar un tipo de componente correspondiente para que el contenido se muestre al usuario según el componente y canal seleccionados;
- Opciones: En este campo se pueden indicar los posibles temas y respuestas relacionados con la palabra clave;
- Respuesta: Contenido de la respuesta o indicación de redireccionamiento a la opción elegida por el usuario.
Una vez completado el formulario y al hacer clic en el botón "Guardar", la nueva palabra clave se mostrará en la interfaz del Plugin.
Configuración en el Builder
Para que los contenidos registrados en la interfaz del complemento se muestren al usuario, el mensaje del usuario debe enviarse a la API del Plugin.
La API tiene dos endpoints:
1 - /keyword-input: Endpoint que recibe la entrada del usuario y el canal (Blip Chat, WhatsApp, etc.) y devuelve el contenido de la palabra clave encontrada. En caso de que la entrada del usuario coincida con dos palabras clave, el endpoint devolverá un menú con las palabras clave encontradas.
En el Builder, debes configurar una solicitud HTTP de la siguiente manera:
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 mostrar el contenido devuelto, puedes utilizar la variable con la respuesta de la API dentro de un contenido dinámico en el Builder.
Ejemplo de respuesta (WhatsApp) cuando se encuentra una sola palabra clave:
Ejemplo de respuesta (WhatsApp) cuando se encuentran varias palabras clave:
2 - /option-keyword: Este endpoint debe utilizarse cuando el usuario recibe el contenido con las opciones de una palabra clave. El endpoint recibe la palabra clave encontrada (keyword), la opción seleccionada y el canal en el que el usuario está conversando. Se devolverá el contenido de la opción seleccionada.
En el Builder, debes configurar una solicitud HTTP de la siguiente manera:
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 mostrar el contenido devuelto, puedes utilizar la variable con la respuesta de la API dentro de un contenido dinámico en el Builder.
Ejemplo de respuesta (WhatsApp) del endpoint:
Flujo de Pruebas
Para acceder al flujo ya montado, simplemente acceda al enlace.
Soporte
Si tienes alguna pregunta o encuentras algún problema con la extensión, contáctanos por correo electrónico a suporte.pluginfaq@blip.ai.
Para obtener más información, acceda a la discusión sobre el tema en nuestra comunidad o los videos en nuestro canal. 😃