dilogflow-helper

bunch of dialogflow helper functions such as for making developer entity and session entity and many more using dialogflow v2 rest api

note: this module can not be installed/used in browser (i.e: react or angular) since one or more dependencies (i.e: googleapis) are designed to run only in nodejs environment.

Install:

npm i dialogflow-helper

contribute:

Feel free to fork and make pull requests Or if you are passionate and want to have direct access to the repo Just let me know I will add you as collaborator after signing a simple agreement document

install

npm i dialogflow-helper

if you wanted to install the latest nightly version npm i https://github.com/malikasinger1/dialogflow-helper.git
Warning: latest nightly version may have bugs, open issue in repo if you notice any bug in any version

initialize

init(cert: object, debug: boolean)

debug parameter is optional, default value is false, enabling debug will give extra logs

To run example quickly:

install ts-node: https://www.npmjs.com/package/ts-node clone this repository goto example folder, run command ts-node test.ts dont forget to replace credentials before running example

Usage (es6/typescript):

import {init, nodejsClient, agent, entityEntryInterface, entityv1, userEntityv2 } from 'dialogflow-helper'

initialize the helper library replace this json with your own service account

init({
    "type": "service_account",
    "project_id": "abc-project id",
    "client_email": "dialogflow-xxxx@bilal-assistant.iam.gserviceaccount.com",
    "private_key": "adfadfsdfsdfsdfsdf"
}, true)

please store your service account credentials only in environment varibales only, otherwise it is not safe

please also make sure your service account have following permission:

1)Dialogflow API Client (if you are using only detect intent)
Can call all methods on sessions and conversations resources as well as their descendants.

2) Dialogflow API Admin (if you are using create and delete intent along with detect intent)
Can query for intent; read & write session properties; read & write agent properties.

to talk with chatbot through nodejs

nodejsClient.detectIntent("abcSession123", "hey chatbot read surah fatiha", {}).then((response: any) => {
    console.log("response: ", response.fulfillmentText)
})

to read intent list make sure you have enough IAM permission goto https://console.cloud.google.com/iam-admin/iam?authuser=0&project= look for service account you are using and make sure it is set to "Dialogflow API Admin" anything less then admin will not work

agent.getAllIntents().then(allIntents => {
    console.log("allIntents: ", allIntents)
})

agent.getIntent("ed90f12e-0391-475c-bf43-c13cfb363f7f").then(intent=>{
    console.log("intent: ", intent);
}) 

when you get all intents look last part of each intent name is id of that intent

// {
//     "name": "projects/bilal-assistant/agent/intents/ed90f12e-0391-475c-bf43-c13cfb363f7f",
//     "displayName": "quranAction.readSurah",
//     "priority": 500000,
//     "webhookState": "WEBHOOK_STATE_ENABLED",
//     "parameters": ...
//      ...
//   }

there are some other functions, I will put the full examples later sometime, pull request are most welcome

Best, M.Inzamam Malik, malikasinger@gmail.com.