Node.js client for Dialogflow: Design and integrate a conversational user interface into your applications and devices.
Clone or download
Permalink
Failed to load latest commit information.
.circleci Update CI config (#180) Oct 3, 2018
.github Configure kokoro CI (#171) Sep 24, 2018
.kokoro build: fix codecov uploading on Kokoro (#183) Oct 15, 2018
protos/google/cloud/dialogflow Run the synth generator and update config (#161) Sep 19, 2018
samples fix(samples): Fixed typo in example (#179) Oct 3, 2018
src Enable prefer-const in the eslint config (#167) Sep 20, 2018
system-test build: add empty file in system-test (#138) Jul 18, 2018
test Run the synth generator and update config (#161) Sep 19, 2018
.cloud-repo-tools.json Beta features PR (#144) Aug 8, 2018
.eslintignore Dialogflow API (#5) Nov 15, 2017
.eslintrc.yml Enable prefer-const in the eslint config (#167) Sep 20, 2018
.gitignore Run the synth generator and update config (#161) Sep 19, 2018
.jsdoc.js Run the synth generator and update config (#161) Sep 19, 2018
.mailmap docs: regenerated scaffolding (#31) Mar 29, 2018
.nycrc Dialogflow API (#5) Nov 15, 2017
.prettierignore Dialogflow API (#5) Nov 15, 2017
.prettierrc Dialogflow API (#5) Nov 15, 2017
CHANGELOG.md Release v0.7.0 (#178) Oct 2, 2018
CODE_OF_CONDUCT.md Dialogflow API (#5) Nov 15, 2017
CONTRIBUTORS Regenerate GAPIC for V1 and V2Beta1 using synth.py (#110) Jun 18, 2018
LICENSE Dialogflow API (#5) Nov 15, 2017
README.md docs: Strip dynamic badges from README (#184) Oct 18, 2018
codecov.yaml Update CI config (#180) Oct 3, 2018
package.json Release v0.7.0 (#178) Oct 2, 2018
renovate.json chore: adding config for Renovate (#37) Apr 6, 2018
synth.py Run the synth generator and update config (#161) Sep 19, 2018

README.md

Google Cloud Platform logo

Dialogflow: Node.js Client

release level

Node.js idiomatic client for Dialogflow.

Dialogflow is an enterprise-grade NLU platform that makes it easy for developers to design and integrate conversational user interfaces into mobile apps, web applications, devices, and bots.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.

    Go to the projects page

  2. Enable billing for your project.

    Enable billing

  3. Enable the Dialogflow API.

    Enable the API

  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install --save dialogflow

Using the client library

// You can find your project ID in your Dialogflow agent settings
const projectId = 'ENTER_PROJECT_ID_HERE'; //https://dialogflow.com/docs/agents#settings
const sessionId = 'quickstart-session-id';
const query = 'hello';
const languageCode = 'en-US';

// Instantiate a DialogFlow client.
const dialogflow = require('dialogflow');
const sessionClient = new dialogflow.SessionsClient();

// Define session path
const sessionPath = sessionClient.sessionPath(projectId, sessionId);

// The text query request.
const request = {
  session: sessionPath,
  queryInput: {
    text: {
      text: query,
      languageCode: languageCode,
    },
  },
};

// Send request and log result
sessionClient
  .detectIntent(request)
  .then(responses => {
    console.log('Detected intent');
    const result = responses[0].queryResult;
    console.log(`  Query: ${result.queryText}`);
    console.log(`  Response: ${result.fulfillmentText}`);
    if (result.intent) {
      console.log(`  Intent: ${result.intent.displayName}`);
    } else {
      console.log(`  No intent matched.`);
    }
  })
  .catch(err => {
    console.error('ERROR:', err);
  });

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample Source Code Try it
Detect Intent (Text) source code Open in Cloud Shell
Create Knowledge Base source code Open in Cloud Shell
Get Knowledge Base source code Open in Cloud Shell
list Knowledge Base source code Open in Cloud Shell
list Knowledge Base source code Open in Cloud Shell
create Document source code Open in Cloud Shell
list Documents source code Open in Cloud Shell
Get Document source code Open in Cloud Shell
delete Document source code Open in Cloud Shell
detect Intent with sentiment analysis source code Open in Cloud Shell
detect Intent with text-to-speech response source code Open in Cloud Shell
detect Intent with Knowledge Base source code Open in Cloud Shell
Detect Intent (Audio) source code Open in Cloud Shell
Detect Intent (Streaming) source code Open in Cloud Shell
Create Entity source code Open in Cloud Shell
Delete Entity source code Open in Cloud Shell
Create Intent source code Open in Cloud Shell
Delete Intent source code Open in Cloud Shell
Create Context source code Open in Cloud Shell
Delete Context source code Open in Cloud Shell
Create Session Entity Type source code Open in Cloud Shell
Delete Session Entity Type source code Open in Cloud Shell

The Dialogflow Node.js Client API Reference documentation also contains samples.

Versioning

This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE