Esta página se ha traducido con Cloud Translation API.

Crear Fulfillment con webhook

Los webhooks de Dialogflow nos permiten controlar en gran medida el flujo de nuestro agente. En este tutorial, necesitas un webhook para validar las secuencias alfanuméricas recogidas en la intención "Sequence" (Secuencia). El webhook repetirá esa intención para recoger una secuencia larga en iteraciones más fáciles de gestionar.

Crear un webhook con el editor insertado

Dialogflow tiene un editor insertado en la consola que te permite escribir directamente código NodeJS, que luego se puede implementar para que se ejecute como un webhook en Cloud Functions.

Para crear un webhook con el editor insertado de Dialogflow, sigue estos pasos:

En la barra de navegación, haga clic en la pestaña Cumplimiento para ir a la página correspondiente.
Activa el botón del editor insertado.
Elimina el contenido de la pestaña package.json del editor insertado.

Copia y pega el contenido JSON que aparece a continuación en la pestaña package.json del editor insertado:

{
  "name": "DialogflowFirebaseWebhook",
  "description": "Firebase Webhook dependencies for a Dialogflow agent.",
  "version": "0.0.1",
  "private": true,
  "license": "Apache Version 2.0",
  "author": "Google Inc.",
  "engines": {
    "node": "10"
  },
  "scripts": {
    "lint": "semistandard --fix \"**/*.js\"",
    "start": "firebase deploy --only functions",
    "deploy": "firebase deploy --only functions"
  },
  "dependencies": {
    "firebase-functions": "^2.0.2",
    "firebase-admin": "^5.13.1"
  }
}

Elimina el código de la pestaña index.js del editor insertado.

Copie y pegue el código que aparece más abajo en la pestaña index.js del editor insertado:

/**
 * Copyright 2020 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

'use strict';

const functions = require('firebase-functions');

// TODO: set this to the minimum valid length for your sequence.
// There's no logic in here to enforce this length, but once the
// user has said this many digits, the slot-filling prompt will
// also instruct the user to say "that's all" to end the slot-filling.
const MIN_SEQUENCE_LENGTH = 10;

exports.dialogflowFirebaseFulfillment = functions.https.onRequest((request, response) => {
  let dfRequest = request.body;
  let action = dfRequest.queryResult.action;
  switch (action) {
    case 'handle-sequence':
      handleSequence(dfRequest, response);
      break;
    case 'validate-sequence':
      validateSequence(dfRequest, response);
      break;
    default:
      response.json({
        fulfillmentText: `Webhook for action "${action}" not implemented.`
      });
  }
});

////
// Helper functions

/* Send an SSML response.
 * @param request: Dialogflow WebhookRequest JSON with camelCase keys.
 *     See https://cloud.google.com/dialogflow/es/docs/reference/common-types#webhookrequest
 * @param response: Express JS response object
 * @param ssml: SSML string.
 * @example: sendSSML(request, response, 'hello')
 *     Will call response.json() with SSML payload '<speak>hello</speak>'
 */
function sendSSML(request, response, ssml) {
  ssml = `<speak>${ssml}</speak>`;

  if (request.originalDetectIntentRequest.source == 'GOOGLE_TELEPHONY') {
    // Dialogflow Phone Gateway Response
    // see https://cloud.google.com/dialogflow/es/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.Intent.Message.TelephonySynthesizeSpeech
    response.json({
      fulfillmentMessages: [{
        platform: 'TELEPHONY',
        telephonySynthesizeSpeech: {ssml: ssml}
      }]
    });
  }
  else {
    // Some CCAI telephony partners accept SSML in a plain text response.
    // Check your specific integration and customize the payload here.
    response.json({
      fulfillmentText: ssml
    });
  }
}

/* Extract an output context from the incoming WebhookRequest.
 * @param request: Dialogflow WebhookRequest JSON with camelCase keys.
 *     See https://cloud.google.com/dialogflow/es/docs/reference/common-types#webhookrequest
 * @param name: A string
 * @return: The context object if found, or undefined
 * @see: https://cloud.google.com/dialogflow/es/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.Context
 *     and note this webhook uses JSON camelCase instead of RPC snake_case.
 * @example:
 *     // Modify an existing output content
 *     let context = getOutputContext(request, 'some-context');
 *     context.lifespanCount = 5;
 *     context.parameters.some_parameter = 'new value';
 *     response.json({
 *       fulfillmentText: 'new value set',
 *       outputContexts: [context]
 *     });
 */
function getOutputContext(request, name) {
  return request.queryResult.outputContexts.find(
      context => context.name.endsWith(`/contexts/${name}`)
  );
}

////
// Action handler functions

/*
 * Fulfillment function for:
 *     actions: handle-sequence
 *     intents: "Sequence", "Sequence - Edit"
 * @param request: Dialogflow WebhookRequest JSON with camelCase keys.
 *     See https://cloud.google.com/dialogflow/es/docs/reference/common-types#webhookrequest
 * @param response: Express JS response object
 */
function handleSequence(request, response) {
  let parameters = request.queryResult.parameters;
  let isSlotFilling = !request.queryResult.allRequiredParamsPresent;
  let isEditing = getOutputContext(request, 'editing-sequence');
  console.log(request.queryResult.action + ': ' + JSON.stringify(parameters));

  if (isSlotFilling) {
    // Prompt the user for the sequence

    let verbatim = `<prosody rate="slow"><say-as interpret-as="verbatim">${parameters.existing_sequence}</say-as></prosody>`;

    if (!parameters.existing_sequence && !parameters.new_sequence) {
      // Initial prompt
      response.json({
        fulfillmentText: "What is your sequence? Please pause after a few characters so I can confirm as we go."
      });
    }
    else if (!isEditing) {
      // Confirm what the system heard with the user. We customize the response
      // according to how many sequences we've heard to make the prompts less
      // verbose.
      if (!parameters.previous_sequence) {
        // after the first input
        sendSSML(request, response,
            `Say "no" to correct me at any time. Otherwise, what comes after ${verbatim}`);
      }
      else if (parameters.existing_sequence.length < MIN_SEQUENCE_LENGTH) {
        // we know there are more characters to go
        sendSSML(request, response,
            `${verbatim} What's next?`);
      }
      else {
        // we might have all we need
        sendSSML(request, response,
            `${verbatim} What's next? Or say "that's all".`);
      }
    }
    else {
      // User just said "no"
      sendSSML(request, response,
          `Let's try again. What comes after ${verbatim}`);
    }
  }
  else {
    // Slot filling is complete.

    // Construct the full sequence.
    let sequence = (parameters.existing_sequence || '') + (parameters.new_sequence || '');

    // Trigger the follow up event to get back into slot filling for the
    // next sequence.
    response.json({
      followupEventInput: {
        name: 'continue-sequence',
        parameters: {
          existing_sequence: sequence,
          previous_sequence: parameters.existing_sequence || ''
        }
      }
    });

    // TODO: CHALLENGE: consider validating the sequence here.
    // The user has already confirmed existing_sequence, so if you find a unique
    // record in your database with this existing_sequence prefix, you could send
    // a followUpEventInput like 'validated-sequence' to skip to the next part
    // of the flow. You could either create a new intent for this event, or
    // reuse the "Sequence - done" intent. If you reuse the "done" intent, you
    // could add another parameter "assumed_sequence" with value
    // "#validated-sequence.sequence", then modify the validateSequence function
    // below to customize the response for this case.
  }
}

/*
 * Fulfillment function for:
 *     action: validate-sequence
 *     intents: "Sequence - Done"
 * @param request: Dialogflow WebhookRequest JSON with camelCase keys.
 *     See https://cloud.google.com/dialogflow/es/docs/reference/common-types#webhookrequest
 * @param response: Express JS response object
 */
function validateSequence(request, response) {
  let parameters = request.queryResult.parameters;
  // TODO: add logic to validate the sequence and customize your response
  let verbatim = `<say-as interpret-as="verbatim">${parameters.sequence}</say-as>`;
  sendSSML(request, response, `Thank you. Your sequence is ${verbatim}`);
}

Haz clic en DESPLEGAR.

Ahora deberías poder probar la integración llamando al agente. Si aún no lo has hecho, ahora es un buen momento para configurar una de las integraciones de telefonía con un solo clic de nuestros partners o para configurar Dialogflow Phone Gateway y probar tu agente por teléfono.

Información sobre el código

Como punto de entrada del webhook, la función dialogflowFirebaseFulfillment se llama cada vez que se activa el webhook. Con cada solicitud, Dialogflow envía el nombre de "action" que has especificado en la consola de Dialogflow para una intención. El código usa este nombre de acción para determinar qué función de webhook llamar: handleSequence o validateSequence.

Secuencia de controladores

handleSequence es la función principal de este tutorial. Es responsable de todos los aspectos de la secuencia de relleno de espacios, incluidos los siguientes:

Pronunciar las instrucciones iniciales cuando una sesión entra por primera vez en la intención.
Repetir la secuencia antes de pedir el siguiente conjunto.
Indicar a los usuarios finales cómo corregir el bot.
Reconocer cuándo hay suficientes dígitos para una secuencia válida e indicar al usuario final cómo finalizar la entrada (consulta `MIN_SEQUENCE_LENGTH' en el código).
Repetir la asignación de espacios para recoger varias secuencias parciales.
Concatenar las secuencias parciales en una secuencia larga.

Validar secuencia

validateSequence es donde debe añadir una conexión a su almacén de datos para validar la secuencia final y devolver un mensaje personalizado al usuario en función de esos datos. Por ejemplo, si estás creando un agente de búsqueda de pedidos, puedes personalizar la respuesta para que diga lo siguiente:

Thank you. Your order ${verbatim} will arrive on ${lookup.date} and will ${lookup.require_signature ? '' : 'not'} require a signature.

Donde lookup es un objeto que has encontrado en tu almacén de datos para este pedido.

Funciones auxiliares

En este ejemplo no se usa ninguna dependencia específica de Dialogflow. En su lugar, consulta la referencia de WebhookRequest para saber qué esperar en request.body y la referencia de WebhookResponse para saber qué responder con response.json({...}).

El código incluye dos funciones auxiliares para facilitar lo siguiente:

Envía el JSON de respuesta adecuado para la plataforma actual pasando una cadena a sendSSML.
Busca un contexto de Dialogflow activo en la solicitud pasando el nombre del contexto a getOutputContext.

Mejora adicional

Con esto, ya puedes empezar a usar webhooks en casos prácticos avanzados. Has diseñado un agente que puede repetir una secuencia de peticiones mientras un usuario final pronuncia su secuencia, asegurándole durante el proceso que el agente virtual le está escuchando correctamente.

Aquí tienes algunas ideas para mejorar aún más la experiencia:

Cambia algunas de las respuestas de la webhook para que coincidan con tu marca. Por ejemplo, en lugar de la petición genérica "¿Cuál es tu secuencia?", puedes editar el código para que diga "¿Cuál es tu número de pedido? Puedes encontrarlo en ...".
Añade otro contexto de salida a la intención "Sequence - Done" y, a continuación, crea algunas intenciones nuevas en ese contexto de entrada para permitir que los usuarios hagan preguntas de seguimiento sobre su pedido.
Si quieres profundizar en este caso práctico, consulta el TODO: CHALLENGE del código de ejemplo anterior para ver cómo puedes mejorar aún más la experiencia de tus usuarios.

Crear intents de flujo de secuencias

Crear Fulfillment con webhook Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.