Como integrar o Dialogflow ao BigQuery

1. Introdução

Neste artigo, vamos aprender como o Dialogflow se conecta ao BigQuery e armazena as informações coletadas durante a experiência de conversa. Vamos usar o mesmo agente que criamos nos laboratórios anteriores " Agendador de consultas". No projeto do GCP do agente, vamos criar um conjunto de dados e uma tabela no BigQuery. Em seguida, vamos editar o atendimento original com os IDs do conjunto de dados e da tabela do BigQuery. Por fim, vamos testar para ver se as interações estão sendo registradas no BigQuery.

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

O que você vai aprender

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

Pré-requisitos

• Conceitos e construções básicos do Dialogflow. Para vídeos tutoriais introdutórios do Dialogflow que abordam o design conversacional básico, confira os seguintes vídeos:

• Crie um chatbot de agendamento de horários usando o Dialogflow.

• Como entender as entidades no Dialogflow.

• Atendimento: integre o Dialogflow ao Google Agenda.

2. Criar conjunto de dados e tabela no BigQuery

1. Navegue até o Console do Google Cloud.
2. No console do Cloud, acesse o ícone de menu ☰ > Big Data > BigQuery.
3. Em "Recursos" no painel esquerdo, clique no ID do projeto. Depois de selecionado, você vai ver "CRIAR CONJUNTO DE DADOS" à direita.
4. Clique em CRIAR CONJUNTO DE DADOS e dê um nome a ele.

5. Depois que o conjunto de dados for criado, clique nele no painel à esquerda. Clique em "CREATE TABLE" à direita.
6. Clique em "CRIAR TABELA", informe o nome da tabela e clique em "Criar tabela" na parte de baixo da tela.

7. Depois que a tabela for criada, clique nela no painel à esquerda. O botão Editar esquema vai aparecer no lado direito.
8. Clique no botão "Editar esquema" e em "Adicionar campo". Adicione o campo date e repita o processo para time e type.
9. Anote o DatasetID e o tableID.

3. Adicionar detalhes da conexão do BigQuery ao fulfillment do Dialogflow

1. Abra o agente do Dialogflow e ative o editor in-line de fulfillment. Consulte o laboratório anterior se precisar de ajuda .

Consulte o codelab anterior Entender o atendimento integrando o Dialogflow ao Google Agenda se precisar de ajuda para ativar o atendimento.

2. Verifique se o package.json no editor inline 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 ao seguir este artigo.
3. Em index.js, crie a função "addToBigQuery" para adicionar a data, a hora e o tipo de consulta à tabela do BigQuery.
4. 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.

package.json

{
  "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"
  }
}

Index.js

'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 = "[e-mail]";
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 makeAppointment" para agendar um horário no Google Agenda.
2. Na mesma função, uma chamada é feita para a função "addToBigQuery" para enviar os dados a serem registrados no BigQuery.

4. Teste seu chatbot e a tabela do BigQuery.

Vamos testar nosso chatbot no simulador ou usar a integração com a Web ou o Google Home que aprendemos em artigos anteriores.

• Usuário: "Marque um horário para o registro do veículo às 14h de amanhã"
• Resposta do chatbot: "Ok, vamos ver se conseguimos encaixar você. 6 de agosto, às 14h, está ótimo!"

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

5. Limpeza

Se você pretende fazer os outros laboratórios desta série, não faça a revisão dos dados agora. Faça isso depois de concluir todos os laboratórios da série.

Excluir o agente do Dialogflow

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

• Na guia Geral, role até a parte de baixo e clique em Excluir este agente.
• Digite DELETE na janela que aparece e clique em Excluir.

6. Parabéns!

Você criou um chatbot e o integrou ao BigQuery para receber insights. Você já sabe como desenvolver um chatbot.

Confira estes outros recursos:

Próximas etapas:

Confira os seguintes codelabs desta série para saber mais sobre como criar um chatbot com o Dialogflow e desenvolver integrações.

• Criar um front-end personalizado do Dialogflow com o Django
• Integrar a API Google Vision ao Dialogflow

• Veja os exemplos de código na página do Dialogflow no Github.