trufi-association/chat-bot-report

Tutorial de Reportes a través de Chatbot

Sobre RapidPro y Textit

RapidPro es un proyecto creado por UNICEF y es completamente de código abierto. Para efectos prácticos, utilizamos un hosting de este proyecto llamado TextIt, pero puedes crear toda la plataforma de trabajo enteramente desde cero utilizando el código abierto. Todos los detalles y el código fuente del proyecto RapidPro se pueden encontrar en su repositorio de GitHub: https://github.com/rapidpro/rapidpro

Flujos a TextIt o RapidPro

La lógica de interacción está diseñada en flujos, estos flujos contienen las interacciones con los usuarios, esta interacción es posible realizarla en diferentes canales, la versión del proyecto TUMI CAF está configurada para trabajar en WhatsApp, puede acceder aquí

La lógica de interacción puede ser usada también en Telegram, además de WhatsApp.

Este repositorio contiene flujos exportados en formato JSON para ser utilizados en TextIt o cualquier proyecto basado en la plataforma RapidPro. A continuación, encontrarás una guía paso a paso para importar estos flujos a tu instancia de TextIt o RapidPro.

Requisitos

Antes de comenzar, asegúrate de tener lo siguiente:

1. Una cuenta en TextIt o en una instancia de RapidPro.
2. Acceso al editor de flujos en la plataforma.
3. El archivo JSON que contiene los flujos exportados de este repositorio.

Pasos para importar flujos

1. Inicia sesión en tu cuenta de TextIt o RapidPro.
2. Ve al editor de flujos haciendo clic en el menú "Flujos" en la parte superior de la página.
3. Haz clic en el botón "Importar" en la esquina superior derecha.
4. Selecciona el archivo JSON que contiene los flujos exportados de este repositorio.
5. Confirma la importación haciendo clic en "Importar" en la ventana emergente.
6. Espera a que la plataforma importe los flujos y luego aparecerán en la lista de flujos disponibles.
7. Puedes encontrar más información de como hacer esto en la plataforma en TextIt aquí

Personalizar flujos

Una vez importados los flujos, es posible que necesites personalizarlos según tus necesidades. Para hacerlo, sigue estos pasos:

1. Haz clic en el flujo que deseas editar en la lista de flujos disponibles.
2. Realiza las modificaciones necesarias utilizando el editor de flujos.
3. Guarda tus cambios haciendo clic en el botón "Guardar" en la esquina superior derecha.
4. Si es necesario, repite estos pasos para cada flujo que desees personalizar.

Notas adicionales

• Asegúrate de conectar correctamente los flujos importados a tus canales de comunicación (por ejemplo, números de teléfono, cuentas de redes sociales, etc.).
• Verifica que las palabras clave, etiquetas y otras configuraciones específicas del flujo sean las adecuadas para tu caso de uso.
• No olvides probar tus flujos antes de usarlos en un entorno de producción.

Crear una copia de la base de datos Airtable

Este proyecto utiliza una base de datos Airtable como parte de su infraestructura. Para replicar la base de datos en tu propia cuenta de Airtable, sigue los pasos a continuación:

Paso 1: Crear una cuenta en Airtable

Si aún no tienes una cuenta en Airtable, sigue estos pasos para crear una:

1. Ve a Airtable.com.
2. Haz clic en "Registrarse" en la parte superior derecha de la pantalla.
3. Puedes registrarte con tu dirección de correo electrónico o utilizando una cuenta de Google, Apple o Microsoft. Sigue las instrucciones en pantalla para completar el proceso de registro.

Paso 2: Acceder al enlace del template

Haz clic en el siguiente enlace para acceder al template de la base de datos Airtable que se utilizará en este proyecto:

Template de Airtable

Paso 3: Copiar el template a tu cuenta de Airtable

1. Una vez que hayas accedido al enlace del template, verás una vista previa de la base de datos.
2. Haz clic en el botón "Usar plantilla" en la esquina superior derecha.
3. En la ventana emergente, elige un nombre para la base de datos y selecciona el espacio de trabajo en el que deseas crearla.
4. Haz clic en "Usar plantilla" para crear una copia de la base de datos en tu cuenta de Airtable.

Paso 4: Personalizar la base de datos (opcional)

Una vez que hayas creado la copia de la base de datos, puedes personalizarla según tus necesidades. Para hacerlo, sigue estos pasos:

1. Abre la base de datos que acabas de crear en tu cuenta de Airtable.
2. Personaliza los campos, vistas y configuraciones según tus necesidades.
3. No olvides guardar los cambios realizados en la base de datos.

Paso 5: Conectar la base de datos a tu proyecto

Después de replicar y personalizar la base de datos, necesitarás conectarla a tu proyecto. Consulta la documentación de Airtable API y la biblioteca que estés utilizando en tu proyecto (por ejemplo, airtable.js, Airtable.py, etc.) para obtener instrucciones sobre cómo hacerlo.

Configurar la API key de Airtable en TextIt/RapidPro

Este proyecto utiliza la API de Airtable para interactuar con la base de datos. Para configurar la API key en TextIt/RapidPro, sigue los pasos a continuación:

Paso 1: Obtener la API key de Airtable

1. Inicia sesión en tu cuenta de Airtable.
2. Haz clic en tu imagen de perfil en la esquina superior derecha y selecciona "Cuenta".
3. En la sección "API key", verás tu clave de API personal. Si no tienes una clave de API, haz clic en "Generar clave de API" para crear una.
4. Copia la clave de API generada (por ejemplo, keyXXXXXXXXX).

Nota: Mantén tu API key en secreto, ya que permite el acceso a tus bases de datos en Airtable.

Paso 2: Crear una variable global en TextIt/RapidPro

1. Inicia sesión en tu cuenta de TextIt o RapidPro.
2. Ve a la página de "Variables Globales" haciendo clic en el menú "Cuentas" en la parte superior de la página y luego selecciona "Variables Globales".
3. Haz clic en el botón "Crear" en la esquina superior derecha.
4. Introduce un nombre para la variable global, debe tener el nombre, apikey.
5. En el campo "Valor", pega la clave de API de Airtable que copiaste en el Paso 1, asegurándote de agregar el prefijo "Bearer " antes de la clave de API (por ejemplo, Bearer keyXXXXXXXXX).
6. Haz clic en "Crear" para guardar la variable global.

Los flujos en este proyecto ya están preconfigurados para usar la variable @globals.apikey en las llamadas a la API de Airtable. Con la variable global configurada, tus flujos deberían funcionar correctamente con la base de datos de Airtable.

Uso del canal de WhatsApp en nuestro proyecto

Nuestro proyecto se basa en el canal de WhatsApp para la comunicación. Para acceder a la API de WhatsApp, utilizamos una plataforma intermediaria llamada 360dialog.com. Sin embargo, es posible hacer la conexión con otros operadores como Twilio.

Creación de una cuenta en 360dialog y configuración de Facebook Business

Para utilizar el canal de WhatsApp a través de 360dialog, es necesario crear una cuenta y configurar Facebook Business. A continuación, se presentan los pasos generales para hacerlo:

1. Ve al sitio web de 360dialog y crea una cuenta siguiendo las instrucciones en pantalla.

2. Una vez que hayas creado una cuenta en 360dialog, debes vincularla a Facebook Business. Para ello, sigue los pasos proporcionados por 360dialog en su documentación oficial.

3. Asegúrate de tener una cuenta de Facebook Business y de seguir las instrucciones para configurarla correctamente. Esto incluye la creación y configuración de una página de empresa y la vinculación de la cuenta de 360dialog a tu cuenta de Facebook Business.

4. Durante el proceso de configuración de Facebook Business, es necesario registrar el número de teléfono que se utilizará para el canal de WhatsApp. Facebook puede solicitar información adicional sobre tu empresa, como datos de contacto y documentación que respalde la verificación de la información proporcionada.

5. Facebook revisará la información proporcionada y, una vez aprobada, podrás utilizar el número de teléfono registrado en tu proyecto de TextIt/RapidPro a través de la plataforma 360dialog.

Nota: El proceso de revisión y verificación de la información de tu empresa por parte de Facebook puede llevar tiempo. Por lo tanto, es importante comenzar este proceso con suficiente anticipación para evitar retrasos en la implementación de tu proyecto.

Estructura del Árbol de Categorías

El árbol de categorías se encuentra en una tabla de Airtable. Los campos clave de la tabla son:

• ID: El identificador único de cada categoría.
• ID_categoria_padre: Enlace a la misma tabla, indica el ID de la categoría padre para establecer la relación jerárquica.
• Categoria: Nombre de la categoría.
• Coloquial: Nombre alternativo de la categoría en el idioma local de la región donde se utiliza.
• Pregunta: Texto de la pregunta relacionada con cada categoría.
• pregunta_victima: Texto de la pregunta relacionada con las víctimas en categorías específicas.
• pregunta_involucrado: Texto de la pregunta relacionada con los involucrados en categorías específicas.

Navegación y Jerarquía

Las categorías base no tienen un ID de padres y se deja por defecto el valor cero. La jerarquía y navegación se establecen mediante la relación entre los campos ID y ID_categoria_padre. El chatbot utiliza esta información para crear e interactuar automáticamente con las categorías.

Importancia de la Configuración Correcta

Es crucial asegurarse de que las categorías, nombres y relaciones padre-hijo estén bien configurados, ya que la interacción y navegación del chatbot dependen completamente de esto.

Uso de la Información Coloquial

El campo Coloquial contiene información sobre cómo se escribe la categoría en el idioma local de la región. Si no se proporciona un nombre coloquial, el chatbot utilizará el valor del campo Categoria tal cual.

Preguntas Personalizadas por Categoría

El campo Pregunta contiene el texto de la pregunta relacionada con cada categoría. Esto permite personalizar la pregunta en función de la categoría, ya sea una propuesta, un reclamo, una sugerencia o una felicitación.

Actores Viales

Además, se ha agregado una tabla llamada "actores viales" para almacenar información sobre las víctimas y los involucrados en cada categoría específica. Los campos de esta tabla son:

1. Peatón
2. Pasajero
3. Conductor automóvil
4. Conductor taxi
5. Conductor vehículo de transporte público
6. Conductor motociclista
7. Conductor Patineta
8. Conductor Ciclomotor
9. Conductor Taxi-ciclomotor
10. Conductor Carga pesada
11. Ciclista
12. Nadie (solo daños)

Referencia de Actores Viales en Reportes

Para cada reporte, se desea tener referencias a los actores viales involucrados. Si una categoría requiere información sobre víctimas e involucrados, se realizan las preguntas correspondientes. Para habilitar estas preguntas en una categoría, se deben completar los campos "pregunta_victima" y "pregunta_involucrado" en la tabla de Árbol de Categorías.

Una vez que se realice la pregunta, las respuestas se guardarán como referencias en los campos "victima" e "involucrados" de la tabla de reportes.

Recuerda proporcionar el texto de la pregunta específicamente en los campos "pregunta

Versatilidad del Chatbot

El chatbot es muy versátil en términos de adaptabilidad a diferentes ciudades o regiones. Las categorías pueden ser creadas y modificadas fácilmente en la tabla de Airtable para adaptarse a las necesidades específicas de cada caso de uso.

Dashboard

Nuestro proyecto incluye un dashboard para visualizar y analizar los datos recolectados a través de nuestra plataforma. En esta sección, explicaremos cómo hacer la conexión con el dashboard y cómo ponerlo en funcionamiento.

¿Por qué elegimos Looker?

Decidimos utilizar Looker debido a sus múltiples ventajas, como la facilidad de uso, la capacidad para conectarse a diversas fuentes de datos, y sus potentes herramientas de visualización y análisis. Además, Looker es una solución de Business Intelligence (BI) de Google Cloud, lo que garantiza un rendimiento y una escalabilidad excepcionales.

Dashboard de prueba

Hemos creado un dashboard de prueba con datos recolectados en la ciudad de Bogotá. Puedes acceder a este dashboard público en el siguiente enlace:

Dashboard de prueba

Nota de seguridad: Para proteger la privacidad de los usuarios y la información, este dashboard no comparte ninguna información personal de las personas que han reportado eventos. En lugar de ello, se muestra una agregación de datos para identificar áreas donde se han presentado eventos relevantes.

Crear tu propio dashboard

Para ayudarte a crear tu propio dashboard, hemos preparado una plantilla que puedes encontrar en el siguiente enlace:

Plantilla de dashboard

Para crear una copia de la plantilla, haz clic en los tres puntos en la esquina superior derecha y selecciona "Crear una copia". A continuación, podrás trabajar con la fuente de datos para personalizar tu propio dashboard.

Conectar el dashboard a tu fuente de datos en Airtable

Para conectar el dashboard a tu fuente de datos en Airtable, sigue los mismos pasos que utilizaste para conectar TextIt con Airtable. Utiliza la API key que creaste previamente para establecer la conexión entre las dos plataformas.

Existen varios proveedores de conectividad que pueden ayudarte a conectar Looker con Airtable. Puedes elegir el que mejor se adapte a tus necesidades y al plan que desees utilizar.

Para obtener más información sobre cómo personalizar y visualizar tus datos en el dashboard, consulta la documentación oficial de Looker en el siguiente enlace:

Documentación de Looker

Soporte

Si tienes alguna pregunta o necesitas ayuda, no dudes en abrir un issue en este repositorio.