Coder Social home page Coder Social logo

global19-atlassian-net / covid19-rapid-response-demo Goto Github PK

View Code? Open in Web Editor NEW

This project forked from qkwikiot/covid19-rapid-response-demo

0.0 2.0 0.0 4.54 MB

This freely available template gives you everything you need to program chat or voice bots with the latest COVID-19 responses and guidance from public health authorities like the CDC and WHO.

Home Page: https://cloud.google.com/solutions/contact-center/covid19-rapid-response/

License: Apache License 2.0

Makefile 1.67% JavaScript 40.24% Dockerfile 0.74% TypeScript 32.79% HTML 5.34% CSS 11.24% Go 5.18% Python 2.79%

covid19-rapid-response-demo's Introduction

Verily Pathfinder Virtual Agent Template for COVID-19

Verily, in partnership with Google Cloud, has launched a curated Dialogflow template for health systems and hospitals, enabling chat or voice bots to answer questions about COVID-19 symptoms and provide the latest guidance from public health authorities like the Centers for Disease Control and Prevention and World Health Organization (WHO).

It can:

  • Automatically answer frequently asked questions about COVID-19
  • Help users understand possible symptoms and severity
  • Guide users to relevant information from public health authorities

You can:

  • Launch your bot faster with curated content
  • Customize to match your website and add content to address your organization and community needs
  • Provide up-to-date information about COVID-19 to your community, which is updated regularly by Verily

Information on COVID-19 changes frequently. Check release dates and review content before launching your bot.

Agent Deployment

Verily provides the Dialogflow Verily COVID-19 Pathfinder virtual agent template (the "Template"), so you can import it into your own agent and make changes to fit your needs.

Import the Dialogflow Verily COVID-19 Pathfinder Virtual Agent Template into Your Agent

  1. Download the Dialogflow COVID-19 Agent Template
  2. Create a new agent.
  3. Click the Settings icon.
  4. Select the Export and Import tab, then click the IMPORT FROM ZIP button to import the agent template. Import Agent Screenshot

Import and Deploy Fulfillment into Your Agent

Please note there are three special intents (coronavirus.closure and coronavirus.confirmed_cases and coronavirus.death) which require you to set up the Google Maps API and BigQuery API. Please follow up step 8-10 to set up the APIs.

  1. Download Fulfillment from Dialogflow COVID-19 Fulfillment..
  2. Click "Fulfillment" in the left sidebar.
  3. Toggle the switch to enable the Inline Editor. Inline Editor Screenshot.
  4. Follow the instruction on the screen to enable fulfillment via Cloud Functions and enable billing for the Cloud project.
  5. Go to the Google Cloud Console and select Cloud Functions on the left panel. Cloud Function Screenshot
  6. Select the fulfillment and click Edit button. Cloud Function Edit Screenshot
  7. Under the "Source code" section, select "ZIP upload" and upload the fulfillment zip file downloaded at step 1. Then select a Stage bucket (you may need to create one if it hasn't been created yet).
  8. [Optional] Follow Quickstart to enable Google Maps Places API if you haven't done so. Go to GCP API & Services->Credentials component to creat an API key for calling the Google Maps API (More detailed instructions are listed at Get an API Key. Create API Key Screenshot
  9. Set GOOGLE_MAPS_API_KEY environment variable to the API key when deploy Cloud Function. (More details can be found at Cloud Function Updating Environment Variable) Set Maps API Key Screenshot
  10. [Optional] To use metrics for COVID-19, Enable the BigQuery API by selecting your project.

Integrate with Verily Pathfinder Virtual Agent Template for COVID-19

Interact with the Dialogflow Console

Type your text query input in the Dialogflow Simulator. Please note that custom payload of response may not show up on Dialogflow Console, you can click DIAGNOSTIC INFO to get more information about the response. Dialogflow Console Screenshot

Integrate with Dialogflow Messenger

  1. Go to the Dialogflow Console.
  2. Select your agent.
  3. Click Integrations in the left sidebar menu.
  4. Enable the Dialogflow Messenger integration.
  5. Open the agent's web page using the provided link. This page provides a text chat interface. Type your input query and press enter. The agent responds with the response from your agent. Dialogflow Messenger Screenshot
  6. [Optional] You may also embed the Dialogflow Messenger into your website by following the instructions.

Integrate with this Chat App

This chat application provides a front end chat interface to a Dialogflow Agent. Please note this chat app not an official Google product.

A screenshot of the chatbot talking with a COVID-19 bot.

Integrate with Twilio to provide the agent over SMS [optional]

You can deploy a Twilio to Dialogflow "bridge" running serverless Cloud Run to expose your agent over SMS. See the these instructions.

Requirements

  • A GCP Project with existing Dialogflow Agent setup in a project we'll refer to as PROJECTDIALOGFLOW
  • A second GCP project that will host this application using AppEngine we'll refer to as PROJECTAPPENGINE
  • You must login to gcloud as a user that has access to both projects.
  • Install gcloud SDK
  • Install node.js
  • Install make
Requirements for development
  • run npm install -g @angular/cli

Setup

  • In /Makefile set PROJECTDIALOGFLOW and PROJECTAPPENGINE
  • In /server/app.yaml Set PROJECTDIALOGFLOW
  • Run make init
  • To develop, you will need a need a service account and credentials. To do this run make serviceaccount
Explanation

Running make init will do the following:

  • Enable API access on PROJECTAPPENGINE
  • Intialize AppEngine on PROJECTAPPENGINE
  • Enable Cloud Run service account to deploy to AppEngine on PROJECTAPPENGINE
  • Enable AppEngine on PROJECTAPPENGINE service account to call Dialogflow on PROJECTDIALOGFLOW
  • Create service account for Dialogflow
  • Grant service account access to PROJECTDIALOGFLOW
  • Download key for service account.
  • Install node_modules.
  • Create Angular builder for Cloud Build

To Develop

  • Run export GOOGLE_APPLICATION_CREDENTIALS=[replace with the path to this app]/creds/creds.json
  • Run make dev

To Deploy

  • Run make deploy

Interaction with Dialogflow API

You can follow this quick start to interact with your agent using Dialogflow API.

Integrate Your Agent with Text-based Third-Party Conversation Platform

Dialogflow has integrated with various text-based conversation platforms such as Facebook, Telegram, Line, Slack, etc. You can follow instructions at Integration Page to set up an integration for each platform.

Integrate with Dialogflow phone Gateway

Dialogflow provides a one-click integration for a telephone interface to your agent by selecting a phone number hosted by Google. See our documentation for detailed instructions. Please note that if you expect your virtual agent to have a high call volume, request a toll-free phone number during the set up.

Verily COVID-19 Pathfinder virtual agent template

Terms of Use

The Verily COVID-19 Pathfinder virtual agent template (this "Template") and accompanying integration guide is provided by Verily Life Sciences LLC (in "/agent-template/" of this repository). By downloading, accessing or using the Verily COVID-19 Pathfinder virtual agent template you acknowledge and agree that you are authorized to accept these terms and conditions applicable to the Template on behalf of the individual or entity that will be using this Template and will communicate these terms and conditions to all users of the Template for compliance. You acknowledge and agree that the information in the Template does not contain or constitute medical advice and only contains guidance from publicly accepted, publicly available sources, such as the Centers for Disease Control and Prevention, the World Health Organization, Johns Hopkins, the American Heart Association, the American Diabetes Association, and the American Lung Association. The Template was designed for U.S. audiences. Prior to using the content of the Template, you are responsible for reviewing and approving each of the responses within the Template and will only provide the content to your web service users if you approve of the content. The Template by Verily Life Sciences LLC is subject to copyright and licensed to you under the CC-BY 4.0 License (a.k.a., the "Creative Commons Attribution 4.0 International Public License") including the disclaimer of warranties therein. Your use of this Template indicates your acceptance of all of the above stated and referenced terms and conditions. If you have a concern related to the content of the Template you can contact the Verily Life Sciences LLC support team via the following email address: [email protected]

Verily COVID-19 Pathfinder virtual agent template ("Template") versions:

  • Version 2.0.0 is available at commit 1d61e4672fa24eb2cec1083c69b00fba255dd6f9, released on April 7, 2020 based on information locked on April 4, 2020.
  • Version 3.0.0 is available at commit a9019b290c9d5f9cb006d3422f87a8dfdf4dfb10, released on April 10, 2020 based on information locked on April 4, 2020.
  • Version 3.1.0 is available at commit cd4738b899644ee4643a67c07dcd461d308a4ed1, released on April 11, 2020 based on information locked on April 7, 2020.
  • Version 3.2.0 is available at commit 1713158df677c34cb5adc200cc1bc9aa9cdf23af, released on April 17, 2020 based on information locked on April 14, 2020.
  • Version 4.0.0 is available at commit d99e6e28e543dd557846dd89a40b5893a6102523, released on April 28, 2020 based on information locked on April 20, 2020.
  • Version 4.1.0 is available at commit da7989b37bd38703248f2dd6f815402805d8201b, released on May 7, 2020 based on information locked on April 27, 2020.
  • Version 4.2.0 is available at commit ee049824a12ed9f1bca1b1008bc3b31c5b8ee9ef released on May 13, 2020 based on information locked on May 8, 2020.
  • Version 4.3.0 is available at commit 7ea18963a54271e697b4c484bb3bfacb332219b2 released on Jun 5, 2020 based on information locked on May 26, 2020.
  • Version 4.4.0 is available at commit 6b474c2c0067d50ba8839a1a0db5cbc4e5e1b519 released on July 24, 2020 based on information locked on Jun 8, 2020.
  • Version 4.5.0 is available at commit 84e70e81d6763283f0d1677287d0da93c6179549 released on August 13, 2020 based on information locked on Aug 3, 2020.

User Guide

USER_GUIDE.pdf

Release Notes

RELEASE_NOTES.pdf

Google Cloud Disclaimer:

The contents of this GitHub directory (except for Verily's directory /agent-template/ as referenced above) are provided under the Apache 2.0 license. The information in these files is for information use only and does not contain or constitute medical advice; it contains references to and integration guidance for the Verily COVID-19 Pathfinder virtual agent template. Any implementation of Verily COVID-19 Pathfinder virtual agent template and the information contained therein may not be accurate, consistent and/or up-to-date.

covid19-rapid-response-demo's People

Contributors

dependabot[bot] avatar geoffreyb-google avatar ptone avatar ruiscosta avatar tpryan avatar tyhu-google avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.