Skip to content

Overview

La variable prismeai vous permet d'interagir avec le chat et d'écouter ses événements. Dans l'objet window, un objet prismeai est disponible après l'injection du bot. Celui-ci propose les méthodes suivantes :

Action API

Agrandir le chat

prismeai.action({ type: 'toggle', value: true })

Ouvre le chat

prismeai.action({ type: 'toggle', value: false })

Ferme le chat

Réinitialiser la conversatiion

prismeai.action({ type: 'resetConversation' })

Ceci va vider le chat, supprimer la conversation, et en créer une nouvelle.

Envoyer du texte dans le chat

prismeai.action({ type: 'text', value: 'Some text message' })

Envoie 'Some text message' dans le chat comme si l'utilisateur l'avait envoyé.

Envoyer un event dans le chat

prismeai.action({ type: 'event', value: {
    text: 'Some text message',
    event: 'Event name'
  }
})
Envoie un event dans le chat.

Envoyer du contenu dans un panel

prismeai.action({ type: 'pushPanelItems', value: 
  [
    {
      title: 'this is the panel title',
      text: '<p>this is the panel content </p>',
      isActive: true
    },
    {
      title: 'this is the second page title',
      text: '<p>this is the second page panel content </p>',
      isActive: true
    }
  ]
});

Ceci créé deux nouveau panneaux dans la section latérale. Pour les affficher il faut ouvrir le panel via la méthode ci-dessous "Ouvrir ou fermer le panel"

Ouvrir ou fermer le panel

prismeai.action({ type: 'togglePanel', value: false })

Cet exemple ferme le panneau latéral. Spécifier "value" à true pour l'ouvrir à la place.

Ecouter les évènements du chat

Elements cliqués

prismeai.on('click', callback)

Créé une écoute sur l'évènement "click". La méthode fournie en second paramètre se déclenchera lors d'un click sur certain éléments du bot, spécifiés ci-dessous dans les propriétés que la méthode de callback reçoit :

Message

Cet objet est défini si un message du chat a été cliqué. Il contient les propriétés suivantes : - type: peut être button, event, link ou linkInText. Ce dernier corresponds à un lien inclut dans un message texte. - text: le contenu texte de l'élément cliquable, ou le message texte entier si il s'agit d'un linkInText. - value: l'url, si il s'agit d'un lien ou d'un linkInText. L'évènement à déclencher pour un "event", et le texte à déclencher si il s'agit d'un "button". - fromFAQ: Vaut 'true' si l'élément était affiché dans un panel depuis la FAQ, sinon 'false'. Indisponible pour "linkInText".

FAQ

L'objet FAQ est défini si l'interaction provient d'une page de FAQ. Ses propriétés sont :

  • intentName: Nom de l'intention.
  • question: phrase de désambiguïsation.
  • responseText: Le premier message texte de cette intention.
  • response: Les éléments affichés dans un panel lors du clic sur cet élément de FAQ.

Action

Cette valeur peut être : - stopSpeaking: Quand l'enregistrement audio s'arrête - stopRecording: Sur app mobile, quand l'enregistrement audio s'arrête - voiceRecognition: Sur app mobile, quand l'enregistrement audio commence

Message reçu par l'utilisateur

prismeai.on('messageReceived', callback)

Cet évènement contient un objet message, aux propriétés suivantes :

  • botName: nom du bot
  • confidence: le score de confiance du NLU
  • intent: le nom de l'intention