Intégrer un chatbot Recast
Introduction
Ce guide présente la façon d'intégrer un Chatbot propulsé par la plate-forme Recast.ai dans un site Lutece.
Trois modes d'intégration sont envisageables :
- mode 1 : Le chat se présente sous la forme d'une page Web (XPage classique)
- mode 2 : Le chat se présente dans une une popup qui s'ouvre par un bouton en bas à droite de n'importe quelle page du site
- mode 3 : Le chat est intégré en iframe dans un autre site
Pour intégrer un bot Recast la seule information nécessaire est l'Access Token de celui-ci.
Inclure la fonctionnalité
Composants nécessaires
Les plugins nécessaires sont :
- Le plugin ChatBot qui propose l'interface conversationnelle utilisateur en mode page web, popup ou contenu à intégrer en iframe. Cette interface n'est pas liée à Recast et peut être utilisée avec d'autres chatbot.
- Le plugin Recast qui assure la communication avec la plate-forme Recast en encapsulant notamment les appels à l'API DIalog. Par ailleurs, ce plugin permet d'interpréter tous les types de message de réponse spécifiques à Recast : card, quickReplies, picture, video...
- Le plugin Recast Bots qui permet de créer des instances de bots et les publier sur l'interface du plugin ChatBot.
Nouvelles dépendances dans le POM du site
Ajouter ainsi les dépendances des plugins dans le pom du site :
<dependency> <groupId>fr.paris.lutece.plugins</groupId> <artifactId>plugin-chatbot</artifactId> <version>1.0.4</version> <type>lutece-plugin</type> </dependency> <dependency> <groupId>fr.paris.lutece.plugins</groupId> <artifactId>plugin-recast</artifactId> <version>1.0.2</version> <type>lutece-plugin</type> </dependency> <dependency> <groupId>fr.paris.lutece.plugins</groupId> <artifactId>plugin-recastbots</artifactId> <version>1.0.2</version> <type>lutece-plugin</type> </dependency>
Administration et utilisation
Déclarer un bot Recast dans le Back Office de Lutece
Dans le BackOffice de Lutèce, cliquer sur le menu Gérer les bots Recast puis cliquer sur Ajouter un bot et remplir les champs suivants :
Utilisation du Bot
Mode 1 : page web
L'accès à la page web se fait via l'URL suivante :
https://myhost/jsp/site/Portal.jsp?page=chatbot
Mode 2 : Intégration via une popup
Cette intégration se fait en ajoutant le bookmark du PageInclude proposé par le plugin ChatBot dans le gabarit HTML du site (fichier WEB-INF/templates/site/page_frameset.html).
Il faut donc ajouter la ligne suivante dans ce fichier avant la fermeture de la balise body :
${chat_popup_include}
Mode 3 : Intégration IFRAME
L'URL à mettre en source de l'IFRAME est la suivante :
https://myhost/jsp/site/Portal.jsp?page=chatbot&view=bot&bot=mybot&standalone=true&lang=fr