Este proyecto es un chatbot el cual se comunica con el servicio de Watson Assistant, el cual es un servicio de inteligencia artificial que permite crear chatbots para que puedan interactuar con los usuarios de una manera más natural. Este chatbot es uno generico que habla de una empresa cualquiera, y que tiene como objetivo dar información sobre la empresa, sus productos y servicios, y también permite tramos con el seguro del coche.
La arquitectura de este proyecto es la siguiente:
- Backend: Spring Boot (Java)
- Frontend: Angular 8
El backend está implementado en Java con el framework Spring Boot. Este backend se encarga de comunicarse con el servicio de Watson Assistant, y de devolver la respuesta del chatbot via json por un metodo http GET.
El frontend está implementado en Angular 8. Este frontend se encarga de mostrar la interfaz de usuario, y de comunicarse con el backend para obtener la respuesta del chatbot.
Para instalar el backend, se debe ejecutar el siguiente comando:
mvn clean installPara instalar el frontend, se debe ejecutar el siguiente comando:
npm installPara ejecutar el backend, se debe ejecutar el siguiente comando:
mvn spring-boot:runEsto ejecutará el backend en el puerto 8080 a la escucha de peticiones http de tipo GET y con el metodo /send.
Para ejecutar el frontend, se debe ejecutar el siguiente comando:
ng serveo alternativamente puedes ejecutar lo siguiente
npm startEsto ejecutará el frontend en el puerto 4200 a la espera de un usuario que acceda a la aplicación.
Nota: Si quieres mandar mensajes por el frontend, debes ejecutar el backend antes que el frontend, ya que el frontend se conecta al backend para obtener la respuesta del chatbot.
El backend se configura mediante el fichero application.properties, el cual se encuentra en la ruta src/main/resources. En este fichero se debe configurar la url del servicio de Watson Assistant, la apikey y el workspaceid, además de la fecha de la version de Watson Assistant que se está utilizando.
application.properties sigue esta estructura en el archivo:
ibm.watson.assistant.apikey = APIKEY
ibm.watson.assistant.url = URL
ibm.watson.assistant.id = ID
ibm.watson.assistant.version = YYYY-MM-DDSimplemente sustituye con tus datos los valores de APIKEY, URL, ID y la version. La version debe ser la fecha de la version de Watson Assistant que se está utilizando y debe seguir el formato YYYY-MM-DD.
Frontend no requiere configuración especial.
Este bot de momento solo es capaz de responder con texto, imagenes y opciones de respuesta. Es posible que si tu bot de Watson Assistant tiene más opciones, el bot no las pueda responder.
Si quieres mandar otros tipos de mensajes, como por ejemplo, un audio, debes modificar el código del frontend para que pueda enviar el mensaje y recibir la respuesta del chatbot.
Para generar la documentación del backend, se debe ejecutar el siguiente comando:
mvn javadoc:javadocEsto generará la documentación en la ruta target/site/apidocs. Para ver la documentación, abre el fichero index.html que se encuentra en la ruta target/site/apidocs.
Para generar la documentación del frontend, se debe ejecutar el siguiente comando:
npm run compodocEsto generará la documentación en la ruta documentation. Para ver la documentación, abre el fichero index.html que se encuentra en la ruta documentation.
Asegurate de estar en las carpetas correspondientes antes de ejecutar los comandos.
Para generar la documentación del android, se debe ejecutar el siguiente comando:
./gradlew dokkaHtmlEsto generará la documentación en la ruta app/build/dokka/html. Para ver la documentación, abre el fichero index.html que se encuentra en la ruta.
Este proyecto está bajo la licencia GLP-3.0 - mira el fichero LICENSE para más detalles.
- Pablo Sánchez López - PSL2001