JavaScript de Dialogflow CX Messenger

Dialogflow CX Messenger proporciona funciones a las que puedes llamar para modificar su comportamiento.

renderCustomText

Esta función renderiza un mensaje de texto simple, como si proviniera del agente como respuesta de texto simple o si el usuario final lo ingresó.

Argumentos:

  • string: mensaje de texto
  • boolean: true para un mensaje del agente, false para el usuario final

Devolución:

  • void

Por ejemplo:

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

renderCustomCard

Esta función renderiza una tarjeta personalizada, como si proviniera del cumplimiento de Dialogflow CX.

Argumentos:

  • payload: una lista de respuestas de carga útil personalizadas, que se definen en la sección Cumplimiento.

Devolución:

  • void

Por ejemplo:

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

Esta función envía una consulta a la API de Dialogflow CX y espera la respuesta. Esto simula de manera efectiva una entrada del usuario final que normalmente se proporciona al diálogo del agente. La respuesta se manejará como lo haría cualquier consulta del usuario final.

Argumentos:

  • string: consulta de texto

Devolución:

  • Promise<void>: valor de devolución para la operación asíncrona

Por ejemplo:

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

sendRequest

Esta función envía una solicitud a la API de Dialogflow CX y espera la respuesta.

Argumentos:

  • string: tipo de solicitud, admite query (consulta también sendQuery más arriba) y event (consulta evento personalizado)
  • any: carga útil que corresponde al tipo de solicitud, que actualmente es una cadena para ambos tipos de solicitudes admitidos

Devolución:

  • Promise<void>: valor de devolución para la operación asíncrona

Por ejemplo:

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

setQueryParameters

Esta función establece valores predeterminados para el queryParams campo de la solicitud detectIntent de la API de Dialogflow CX. Otros métodos de Dialogflow CX Messenger pueden reemplazar los valores predeterminados respectivos en los parámetros de consulta.

Argumentos:

  • object: datos JSON. Para el esquema de los parámetros de consulta, consulta QueryParameters

Devolución:

  • void

Por ejemplo:

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

setContext

Esta función envía información de personalización generativa sobre el usuario final a Dialogflow CX. Esta información persistirá durante el resto de la sesión.

Argumentos:

  • object: datos JSON, consulta la documentación de personalización generativa

Devolución:

  • void

Por ejemplo:

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

Esta función borra el almacenamiento persistente del diálogo del agente. También borra el estado actual del diálogo del agente. De forma predeterminada, conserva el estado de autenticación del usuario. Usa el args opcional para personalizar este comportamiento.

Argumentos:

Nombre Tipo Descripción
args object? Argumento opcional para configurar la operación de almacenamiento claro.
args.clearAuthentication boolean? Marca opcional para borrar el estado de autenticación. Si se establece en true, se borrará el estado de autenticación; de lo contrario, se conservará.

Devolución:

  • void

Por ejemplo:

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

clearAuthentication

Esta función borra la autenticación del diálogo del agente.

Argumentos:

  • ninguno

Devolución:

  • void

Por ejemplo:

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

startNewSession

Esta función inicia una sesión nueva dentro del diálogo del agente. De forma predeterminada, borra el historial de mensajes, pero conserva el estado de autenticación del usuario. Usa el args opcional para personalizar este comportamiento.

Argumentos:

Nombre Tipo Descripción
args object? Argumento opcional para configurar la creación de la sesión nueva.
args.retainHistory boolean? Marca opcional para conservar el historial. Si se establece en true, se conservará el historial; de lo contrario, se borrará.
args.clearAuthentication boolean? Marca opcional para borrar el estado de autenticación. Si se establece en true, se borrará el estado de autenticación; de lo contrario, se conservará.

Devolución:

  • void

Por ejemplo:

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

openChat

Esta función abre el chat. Llámalo en el elemento df-messenger-chat-bubble para abrir el chat. No hace nada si el chat ya está abierto.

Argumentos:

  • ninguno

Devolución:

  • void

Por ejemplo:

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

closeChat

Esta función cierra el chat. Llámalo en el elemento df-messenger-chat-bubble para cerrar el chat. No hace nada si el chat ya está cerrado.

Argumentos:

  • ninguno

Devolución:

  • void

Por ejemplo:

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

openMinChat

Chat minimizado de Dialogflow CX Messenger

Esta función abre la ventana de chat en una versión minimizada. Llámalo en el elemento df-messenger-chat-bubble para abrir el chat minimizado. No hace nada si el chat ya está minimizado.

Argumentos:

Nombre Tipo Descripción
args object? Argumento opcional para configurar el chat minimizado
args.anchor string? anchor opcional para configurar dónde se abre el chat minimizado. La misma lógica que el atributo anchor en el elemento de burbuja de chat. El valor predeterminado es left-top.
args.showActorImages boolean? Marca opcional para mostrar imágenes de actores (si se especifican en el elemento df-messenger-chat-bubble). La configuración predeterminada es "false".

Ejemplo:

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

closeMinChat

Cierra el chat minimizado. Llámalo en el elemento df-messenger-chat-bubble para cerrar el chat minimizado. No hace nada si el chat ya está cerrado.

Ejemplo:

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