Webhook Boilerplate (using Dialogflow) in Node.js

License: Apache License 2.0

JavaScript 100.00%

dialogflow-webhook-boilerplate-nodejs's Introduction

Actions on Google: Webhook Boilerplate

⚠️ Warning: Conversational Actions will be deprecated on June 13, 2023. For more information, see Conversational Actions Sunset.

This sample demonstrates the base webhook required for building Actions on Google for use on Google Assistant -- using the Node.js client library and deployed on Cloud Functions for Firebase.

⚠️ This code sample was built using Dialogflow. We now recommend using Actions Builder or the Actions SDK to develop, test, and deploy Conversational Actions.

Setup Instructions

Select only one of the options below.

Option 1: Add to Dialogflow

Select the button below and follow prompts to create a new agent:

Option 2: Dialogflow Console and Firebase CLI

Prerequisites

Node.js and NPM
- We recommend installing using NVM
Install the Firebase CLI
- We recommend using version 6.5.0, npm install -g [email protected]
- Run firebase login with your Google account

Configuration

Actions Console

From the Actions on Google Console, New project (this will become your Project ID) > Create project > under More options > Conversational
From the top navigation menu under Develop > Actions (left nav) > Add your first action > BUILD (this will bring you to the Dialogflow console) > Select language and time zone > CREATE.
From the left menu > select Intents > Default Welcome Intent, scroll down to the end of the page and under Fulfillment > Enable Webhook > Save.
- This will allow you to have the welcome intent be a basic webhook intent to test.

Firebase Deployment

On your local machine, in the functions directory, run npm install
Run firebase deploy --project {PROJECT_ID} to deploy the function
- To find your Project ID: In Dialogflow console under Settings ⚙ > General tab > Project ID.

Dialogflow Console

Return to the Dialogflow Console > select Fulfillment > Enable Webhook > Set URL to the Function URL that was returned after the deploy command > SAVE.
```
Function URL (dialogflowFirebaseFulfillment): https://${REGION}-${PROJECT_ID}.cloudfunctions.net/dialogflowFirebaseFulfillment
```
From the left navigation menu, click Integrations > Integration Settings under Google Assistant > Enable Auto-preview changes > Test to open the Actions on Google simulator then say or type Talk to my test app.

Running this Sample

You can test your Action on any Google Assistant-enabled device on which the Assistant is signed into the same account used to create this project. Just say or type, “OK Google, talk to my test app”.
You can also use the Actions on Google Console simulator to test most features and preview on-device behavior.

References & Issues

Questions? Go to StackOverflow, Assistant Developer Community on Reddit or Support.
For bugs, please report an issue on Github.
Actions on Google Documentation
Actions on Google Codelabs

Make Contributions

Please read and follow the steps in the CONTRIBUTING.md.

License

See LICENSE.

Terms

Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the Google APIs Terms of Service.

dialogflow-webhook-boilerplate-nodejs's People

Contributors

Stargazers

Watchers

dialogflow-webhook-boilerplate-nodejs's Issues

Failed at the [email protected] start script 'functions deploy yourAction --trigger-http'.

i followed the step that in detail page, but when run gcloud app deploy, it throw below error trace:
Updating service [default]...failed.
ERROR: (gcloud.app.deploy) Error Response: [9]
Application startup error:

[email protected] start /app
functions deploy yourAction --trigger-http

sh: 1: functions: not found

npm ERR! Linux 3.16.0-4-amd64
npm ERR! argv "/nodejs/bin/node" "/nodejs/bin/npm" "start"
npm ERR! node v6.0.0
npm ERR! npm v3.8.6
npm ERR! file sh
npm ERR! code ELIFECYCLE
npm ERR! errno ENOENT
npm ERR! syscall spawn
npm ERR! [email protected] start: functions deploy yourAction --trigger-http
npm ERR! spawn ENOENT
npm ERR!
npm ERR! Failed at the [email protected] start script 'functions deploy yourAction --trigger-http'.
npm ERR! Make sure you have the latest version of node.js and npm installed.
npm ERR! If you do, this is most likely a problem with the apiai-webhook-template-nodejs package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR! functions deploy yourAction --trigger-http
npm ERR! You can get information on how to open an issue for this project with:
npm ERR! npm bugs apiai-webhook-template-nodejs
npm ERR! Or if that isn't available, you can get their info via:
npm ERR! npm owner ls apiai-webhook-template-nodejs
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR! /app/npm-debug.log

Queries selected from lists not recognized by assistant to trigger intents

I ran into an issue using a list item in the simulator and iOS assistant app.
When selecting a response from a list, after the title of the list item is sent as a query, the default fallback intent is given rather than the intended intent.
Worth noting is that if I include a suggestion chip set to send the same query and select it from the same conversation state, it will trigger the desired intent.
Also, if the conversation state changes so that the list is not the latest item in the conversation, then selecting the list item will trigger the desired intent.

Not getting "Hello, World!" message

Instead of the 'Hello, World!' message, I get a response found listed for the Default Welcome Intent in Dialogflow. I then tried deleting the test responses in Dialogflow, but that causes another error. Any help would be appreciated. Catching up on the V2 API, specifically for webhooks.

actions-on-google / dialogflow-webhook-boilerplate-nodejs Goto Github PK