Code JavaScript Dialogflow Messenger

Dialogflow Messenger fournit des fonctions que vous pouvez appeler pour modifier son comportement.

renderCustomText

Cette fonction affiche un message texte simple, comme s'il provenait de l'agent sous la forme d'une réponse textuelle simple ou comme s'il avait été saisi par l'utilisateur final.

Arguments :

  • string: SMS
  • boolean : "true" pour un message de l'agent, "false" pour l'utilisateur final.

Retour:

  • void

Exemple :

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.renderCustomText('Custom text', true);

renderCustomCard

Cette fonction affiche une fiche personnalisée, comme si elle provenait du fulfillment Dialogflow.

Arguments :

  • payload: liste des réponses de charge utile personnalisées, définies dans la section Fulfillment.

Retour:

  • void

Exemple :

const dfMessenger = document.querySelector('df-messenger');
const payload = [
  {
    "type": "info",
    "title": "Info item title",
    "subtitle": "Info item subtitle",
    "image": {
      "rawUrl": "https://example.com/images/logo.png"
    },
    "anchor": {
      "href": "https://example.com",
      "target": "_blank"
    }
  }
];
dfMessenger.renderCustomCard(payload);

sendQuery

Cette fonction envoie une requête à l'API Dialogflow et attend la réponse. Cela simule efficacement une entrée d'utilisateur final qui est normalement fournie dans la boîte de dialogue de l'agent. La réponse sera traitée comme n'importe quelle requête d'utilisateur final.

Arguments :

  • string: requête textuelle

Retour:

  • Promise<void>: valeur renvoyée pour l'opération asynchrone

Exemple :

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendQuery('Describe shipping costs.');

sendRequest

Cette fonction envoie une requête à l'API Dialogflow et attend la réponse.

Arguments :

  • string: type de requête, compatible avec query (voir aussi sendQuery ci-dessus) et event (voir Événement personnalisé).
  • any: charge utile correspondant au type de requête, qui est actuellement une chaîne pour les deux types de requêtes compatibles

Retour:

  • Promise<void>: valeur renvoyée pour l'opération asynchrone

Exemple :

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendRequest('query', 'Describe shipping costs.');

setQueryParameters

Cette fonction définit des valeurs par défaut pour le champ queryParams de la requête detectIntent de l'API Dialogflow. D'autres méthodes Dialogflow Messenger peuvent remplacer les valeurs par défaut respectives dans les paramètres de requête.

Arguments :

  • object: données JSON. Pour obtenir le schéma des paramètres de requête, consultez la section QueryParameters.

Retour:

  • void

Exemple :

const dfMessenger = document.querySelector('df-messenger');
const queryParameters = {
  timeZone: "America/New_York"
};
dfMessenger.setQueryParameters(queryParameters);

setContext

Cette fonction envoie à Dialogflow des informations de personnalisation générative concernant l'utilisateur final. Ces informations seront conservées jusqu'à la fin de la session.

Arguments :

  • object: données JSON, consulter la documentation sur la personnalisation générative

Retour:

  • void

Exemple :

const dfMessenger = document.querySelector('df-messenger');
const metadata = {
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    {
      model: "Google Pixel 7",
    },
    {
      model: "Google Pixel Tablet",
    },
  ],
};
dfMessenger.setContext(metadata);

clearStorage

Cette fonction efface le stockage persistant de la boîte de dialogue de l'agent. L'état actuel de la boîte de dialogue de l'agent est également effacé.

Arguments :

  • aucun

Retour:

  • void

Exemple :

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearStorage();

clearAuthentication

Cette fonction efface l'authentification de la boîte de dialogue de l'agent.

Arguments :

  • aucun

Retour:

  • void

Exemple :

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearAuthentication();

startNewSession

Cette fonction démarre une nouvelle session dans la boîte de dialogue de l'agent. Il peut conserver ou réinitialiser l'historique actuel des messages. L'authentification des utilisateurs n'est pas effacée.

Arguments :

Nom Type Description
args object? Argument facultatif permettant de configurer la création de session.
args.retainHistory boolean? Indicateur facultatif permettant de conserver l'historique. Si cette règle est définie sur "True", l'historique est conservé. Dans le cas contraire, il est effacé.

Retour:

  • void

Exemple :

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.startNewSession({ retainHistory: true });

openChat

Cette fonction ouvre le chat. Appelez-le au niveau de l'élément df-messenger-chat-bubble pour ouvrir le chat. N'a aucun effet si le chat est déjà ouvert.

Arguments :

  • aucun

Retour:

  • void

Exemple :

const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.openChat();

closeChat

Cette fonction ferme le chat. Appelez-le au niveau de l'élément df-messenger-chat-bubble pour fermer le chat. N'a aucun effet si le chat est déjà fermé.

Arguments :

  • aucun

Retour:

  • void

Exemple :

const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.closeChat();

openMinChat

Fenêtre de chat réduite dans Dialogflow Messenger

Cette fonction ouvre une version réduite de la fenêtre de chat. Appelez-le au niveau de l'élément df-messenger-chat-bubble pour ouvrir le chat réduit. N'a aucun effet si le chat est déjà réduit.

Arguments :

Nom Type Description
args objet ? Argument facultatif permettant de configurer le chat réduit
args.anchor ? anchor facultatif permettant de configurer l'emplacement d'ouverture du chat réduit. Identique à l'attribut anchor de l'élément de bulle de chat. La valeur par défaut est left-top.
args.showActorImages boolean? Indicateur facultatif permettant d'afficher les images des acteurs (si spécifié dans l'élément df-messenger-chat-bubble). Valeur par défaut : "false".

Exemple :

const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.openMinChat({
  anchor: 'top-left'
});

closeMinChat

Ferme le chat réduit. Appelez-le au niveau de l'élément df-messenger-chat-bubble pour fermer le chat réduit. N'a aucun effet si le chat est déjà fermé.

Exemple :

const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.closeMinChat();