Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

dialogflow

0.8.2 • Public • Published
Google Cloud Platform logo

Dialogflow: Node.js Client

release level npm version codecov

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.

Using the client library

  1. Select or create a Cloud Platform project.

  2. Enable billing for your project.

  3. Enable the Dialogflow API.

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

  5. Install the client library:

     npm install --save dialogflow
    
  6. Try an example:

 
const dialogflow = require('dialogflow');
const uuid = require('uuid');
 
/**
 * Send a query to the dialogflow agent, and return the query result.
 * @param {string} projectId The project to be used
 */
async function runSample(projectId = 'your-project-id') {
  // A unique identifier for the given session
  const sessionId = uuid.v4();
 
  // Create a new session
  const sessionClient = new dialogflow.SessionsClient();
  const sessionPath = sessionClient.sessionPath(projectId, sessionId);
 
  // The text query request.
  const request = {
    session: sessionPath,
    queryInput: {
      text: {
        // The query to send to the dialogflow agent
        text: 'hello',
        // The language used by the client (en-US)
        languageCode: 'en-US',
      },
    },
  };
 
  // Send request and log result
  const responses = await sessionClient.detectIntent(request);
  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.`);
  }
}

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

What's Next

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

install

npm i dialogflow

Downloadsweekly downloads

12,710

version

0.8.2

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability