Como integrar o Dialogflow ao BigQuery

Neste artigo, veremos como o Dialogflow se conecta ao BigQuery e armazena as informações coletadas durante a conversa. Usaremos o mesmo agente criado nos laboratórios anteriores "Scheduling Scheduler". No projeto do GCP do agente, criaremos um conjunto de dados e uma tabela no BigQuery. Em seguida, editaremos o fulfillment original com os conjuntos de dados do BigQuery e os códigos de tabela. Por fim, vamos testar se as interações estão sendo gravadas no BigQuery.

Este é o diagrama de sequência dos eventos do usuário até o fulfillment e o BigQuery.

O que você vai aprender

  • Como criar um conjunto de dados e uma tabela no BigQuery
  • Como configurar os detalhes de conexão do BigQuery no fulfillment do Dialogflow.
  • Como testar o fulfillment

Prerequisites

  • Conceitos básicos e elementos do Dialogflow. Para ver os tutoriais introdutórios do Dialogflow, que abordam o design básico de conversa, confira estes vídeos:
  • Criar um bot de chat do Agendamento de horários com o Dialogflow
  • Noções básicas sobre entidades no Dialogflow.
  • fulfillment: integrar o Dialogflow ao Google Agenda
  1. Navegue até o Console do Google Cloud.
  2. No Console do Cloud, acesse o ícone de menu ☰ > Big Data > BigQuery
  3. Em "Resources", no painel à esquerda, clique no ID do projeto. Depois de selecionar uma opção, você verá "CREATE DATASET" à direita.
  4. Clique em CRIAR CONJUNTO DE DADOS e dê um nome a ele.

  1. Depois que o conjunto de dados for criado, clique nele no painel esquerdo. Você verá a opção "CREATE TABLE" à direita.
  2. Clique em "Criar tabela", forneça o nome da tabela e clique em "Criar tabela" na parte inferior da tela.

  1. Depois de criar a tabela, clique nela no painel à esquerda. Você verá o botão "Editar esquema" no lado direito.
  2. Clique no botão "Edit Schema" e no botão "Add Field". Adicione o campo "date" e o mesmo repita para "time" e "type".
  3. Anote os valores de "DatasetID" e "tableID"

  1. Abra o agente do Dialogflow e ative o editor in-line de fulfillment. Consulte o laboratório anterior se precisar de ajuda com isso .
  1. Verifique se o arquivo "package.json" no editor in-line de fulfillment do Dialogflow contém uma dependência do BigQuery. "@google-cloud/bigquery": "0.12.0". Use a versão mais recente do BigQuery quando estiver seguindo este artigo.
  2. No index.js, crie a função "addToBigQuery" para adicionar a data, a hora e o tipo de compromisso à tabela do BigQuery.
  3. Adicione projectID, datasetID e tableID na seção "TODO" do arquivo index.js para conectar corretamente sua tabela do BigQuery e o conjunto de dados ao fulfillment.
{
  "name": "dialogflowFirebaseFulfillment",
  "description": "Dialogflow fulfillment for the bike shop sample",
  "version": "0.0.1",
  "private": true,
  "license": "Apache Version 2.0",
  "author": "Google Inc.",
  "engines": {
    "node": "6"
  },
  "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",
    "actions-on-google": "2.2.0", 
    "googleapis": "^27.0.0",
    "dialogflow-fulfillment": "0.5.0",
    "@google-cloud/bigquery": "^0.12.0"
  }
}
'use strict';

const functions = require('firebase-functions');
const {google} = require('googleapis');
const {WebhookClient} = require('dialogflow-fulfillment');
const BIGQUERY = require('@google-cloud/bigquery');


// Enter your calendar ID below and service account JSON below
const calendarId = "XXXXXXXXXXXXXXXXXX@group.calendar.google.com";
const serviceAccount = {}; // Starts with {"type": "service_account",...

// Set up Google Calendar Service account credentials
const serviceAccountAuth = new google.auth.JWT({
  email: serviceAccount.client_email,
  key: serviceAccount.private_key,
  scopes: 'https://www.googleapis.com/auth/calendar'
});

const calendar = google.calendar('v3');
process.env.DEBUG = 'dialogflow:*'; // enables lib debugging statements

const timeZone = 'America/Los_Angeles';
const timeZoneOffset = '-07:00';

exports.dialogflowFirebaseFulfillment = functions.https.onRequest((request, response) => {
  const agent = new WebhookClient({ request, response });
  console.log("Parameters", agent.parameters);
  const appointment_type = agent.parameters.AppointmentType;

// Function to create appointment in calendar  
function makeAppointment (agent) {
    // Calculate appointment start and end datetimes (end = +1hr from start)
    const dateTimeStart = new Date(Date.parse(agent.parameters.date.split('T')[0] + 'T' + agent.parameters.time.split('T')[1].split('-')[0] + timeZoneOffset));
    const dateTimeEnd = new Date(new Date(dateTimeStart).setHours(dateTimeStart.getHours() + 1));
    const appointmentTimeString = dateTimeStart.toLocaleString(
      'en-US',
      { month: 'long', day: 'numeric', hour: 'numeric', timeZone: timeZone }
    );
  
// Check the availability of the time, and make an appointment if there is time on the calendar
    return createCalendarEvent(dateTimeStart, dateTimeEnd, appointment_type).then(() => {
      agent.add(`Ok, let me see if we can fit you in. ${appointmentTimeString} is fine!.`);

// Insert data into a table
      addToBigQuery(agent, appointment_type);
    }).catch(() => {
      agent.add(`I'm sorry, there are no slots available for ${appointmentTimeString}.`);
    });
  }

  let intentMap = new Map();
  intentMap.set('Schedule Appointment', makeAppointment);
  agent.handleRequest(intentMap);
});

//Add data to BigQuery
function addToBigQuery(agent, appointment_type) {
    const date_bq = agent.parameters.date.split('T')[0];
    const time_bq = agent.parameters.time.split('T')[1].split('-')[0];
    /**
    * TODO(developer): Uncomment the following lines before running the sample.
    */
    //const projectId = '<INSERT your own project ID here>'; 
    //const datasetId = "<INSERT your own dataset name here>";
    //const tableId = "<INSERT your own table name here>";
    const bigquery = new BIGQUERY({
      projectId: projectId
    });
   const rows = [{date: date_bq, time: time_bq, type: appointment_type}];
  
   bigquery
  .dataset(datasetId)
  .table(tableId)
  .insert(rows)
  .then(() => {
    console.log(`Inserted ${rows.length} rows`);
  })
  .catch(err => {
    if (err && err.name === 'PartialFailureError') {
      if (err.errors && err.errors.length > 0) {
        console.log('Insert errors:');
        err.errors.forEach(err => console.error(err));
      }
    } else {
      console.error('ERROR:', err);
    }
  });
  agent.add(`Added ${date_bq} and ${time_bq} into the table`);
}

// Function to create appointment in google calendar  
function createCalendarEvent (dateTimeStart, dateTimeEnd, appointment_type) {
  return new Promise((resolve, reject) => {
    calendar.events.list({
      auth: serviceAccountAuth, // List events for time period
      calendarId: calendarId,
      timeMin: dateTimeStart.toISOString(),
      timeMax: dateTimeEnd.toISOString()
    }, (err, calendarResponse) => {
      // Check if there is a event already on the Calendar
      if (err || calendarResponse.data.items.length > 0) {
        reject(err || new Error('Requested time conflicts with another appointment'));
      } else {
        // Create event for the requested time period
        calendar.events.insert({ auth: serviceAccountAuth,
          calendarId: calendarId,
          resource: {summary: appointment_type +' Appointment', description: appointment_type,
            start: {dateTime: dateTimeStart},
            end: {dateTime: dateTimeEnd}}
        }, (err, event) => {
          err ? reject(err) : resolve(event);
        }
        );
      }
    });
  });
}

Entender a sequência de eventos do código

  1. O mapa de intents chama a função "makeScheduling" para agendar um horário no Google Agenda.
  2. Na mesma função, é feita uma chamada para a função "addToBigQuery" a fim de enviar os dados a serem conectados ao BigQuery.

Vamos testar nosso bot de chat. Você pode testá-lo no simulador ou usar a integração da Web ou do Google Home que aprendemos em artigos anteriores.

  • Usuário: "agende um horário para registro do veículo amanhã às 14h"
  • Resposta do bot de chat: quoi! Tudo bem, vamos ver se podemos atender você. 6 de agosto, 14h.

  • Verifique a tabela do BigQuery após a resposta. Usar consulta "SELECT * FROM `projectID.datasetID.tableID`"

Se você pretende fazer os outros laboratórios da série, não faça a limpeza agora. Depois de concluir todos os laboratórios da série, faça isso.

Exclua o agente do Dialogflow

  • Clique no ícone de engrenagem ao lado do agente.

  • Na guia General, role até a parte inferior e clique em Delete this Agent.
  • Digite EXCLUIR na janela exibida e clique em Excluir.

Você criou um bot de chat e o integrou ao BigQuery para receber insights. Agora você é um desenvolvedor de bots de chat.

Confira estes outros recursos: