dialogflow-state-handler
v0.1.2
Published
Dialogflow Fulfillment Library for Node.js
Downloads
7
Maintainers
Readme
Dialogflow State Handler
This project is a modification of the dialogflow-fulfillment package with the aim of fixing two main problems.
- Patching bugs and issues from the original package that were not completed when the library became unmaintained.
- Adding helpful methods to allow easy state management and deeper conversations.
New Features
In addition to bug fixes and what's available in the original package, this project adds:
- 2 additional fields to the constructor
- views - A JSON file containing replies that can be accessed using the new "reply" method.
- variables - A file containing exported functions that allow templated responses.
- State handler methods
- A new reply method (see below) for templated responses and state handling
Views, Variables and Templating
One of the main benefits of this project is the easy ability to create manageable and templated responses. Rather than having all of your responses scattered around a project, they can be easily managed in one file, and called from multiple locations. You can also easily fill a response with variables as seen below.
Variables
// TypeScript - variables.ts
export const DOB = () => "25th of December";
or
export const DOB = (agent:IDialogflowAgent) => agent.data.DOB;
// JavaScript - variables.js
module.exports.DOB = () => "25th of December";
or
module.exports.DOB = (agent) => agent.data.DOB;
Views
//views.json
{ "User.DateOfBirth" : [ "My date of birth is {DOB}" ] }
Response
const agent = new WebhookClient({ request, response, views, variables });
agent.reply("User.DateOfBirth")
Output
My date of birth is 25th of December
Dialogflow Fulfillment Library
The Dialogflow Fulfillment Library allows you to connect natural language understanding and processing to your own systems, APIs, and databases. Using Fulfillment, you can surface commands and information from your services to your users through a natural conversational interface.
Dialogflow Fulfillment makes creating fulfillment for Dialogflow v1 and v2 agents for 8 chat and voice platforms on Node.js easy and simple.
Supported features
- Text
- Cards
- Images
- Suggestion Chips (Quick Replies)
- Payloads (Platform-specific responses)
This library is intended to help build Node.js Dialogflow Fulfillment for multiple integrations including Google Assistant, Slack, Facebook, Telegram, Kik, Skype, Line, and Viber. See the reference documentation for more: https://dialogflow.com/docs/reference/fulfillment-library/webhook-client
If only building Dialogflow Fulfillment for the Google Assistant and no other integrations, use the Actions of Google NPM module (actions-on-google) which supports all Actions on Google features.
Setup Instructions
// Import the appropriate class
const { WebhookClient } = require('dialogflow-state-handler');
//Create an instance
const agent = new WebhookClient({request: request, response: response, views: views, variables: variables});
Samples
| Name | Language | | ------------------------------------ |:---------------------------------| | Dialogflow Fulfillment & Actions on Google | Node.js | | Dialogflow & Firebase's Firestore DB | Node.js | | Bike Shop-Google Calendar API| Node.js| | Temperature Trivia | Node.js | | Multi-language/locale| Node.js | | Dialogflow's Inline Editor Template| Node.js |
References & Issues
- Questions? Try StackOverflow or Dialogflow Developer Community.
- For bugs, please report an issue on Github.
- Dialogflow Documentation.
- Dialogflow WebhookClient class reference doc.
- Dialogflow rich response classes reference doc.
- For more info on Actions on Google NPM module
- For more info on Building Actions on Google with Dialogflow Agents Documentation
Limitations
No verification for platforms-specific incompatible response combinations (i.e. multiple cards are not supported in a single Actions on Google response).