11 déc. 2019 23:38:37 Thomas Dumont avatar

Intégrer un chatbot BotPress


Logo BotPress

Introduction

Ce guide présente la façon d'intégrer un Chatbot propulsé par la plate-forme BotPress dans un site Lutece.

vue du bot

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 BotPress les seules informations nécessaires sont son identifiant et l'adresse du serveur

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 à Botpress. Elle peut être utilisée avec d'autres technologies de chatbot et permet une grande souplesse de personnalisation.
  • Le plugin BotPress qui permet d'instancier des bots sur l'interface du plugin ChatBot et assurant la communication avec des serveurs BotPress via l'API Converse. Les différents types de réponse tels que QuickReplies peuvent être gérés par ce plugin.

Nouvelles dépendances dans le POM du site

Ajouter les dépendances des plugins dans le POM du site :

<dependency>
    <groupId>fr.paris.lutece.plugins</groupId>
    <artifactId>plugin-botpress</artifactId>
    <version>1.0.1</version>
    <type>lutece-plugin</type>
</dependency>
<dependency>
    <groupId>fr.paris.lutece.plugins</groupId>
    <artifactId>plugin-chatbot</artifactId>
    <version>1.0.4</version>
    <type>lutece-plugin</type>
</dependency>

Administration et utilisation

Déclarer un bot BotPress dans le Back Office de Lutece

Dans le Back Office de Lutèce cliquer sur le menu Gérer les bots BotPress puis sur Ajouter un bot et remplir les champs suivants :

Déclaration du Bot

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