Dialogflow: Node.js Client
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.
- Dialogflow Node.js Client API Reference
- github.com/dialogflow/dialogflow-nodejs-client-v2
- Dialogflow Documentation
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
-
Select or create a Cloud Platform project.
-
Enable billing for your project.
-
Enable the Dialogflow API.
-
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 | |
Detect Intent (Audio) | source code | |
Detect Intent (Streaming) | source code | |
Create Entity | source code | |
Delete Entity | source code | |
Create Intent | source code | |
Delete Intent | source code | |
Create Context | source code | |
Delete Context | source code | |
Create Session Entity Type | source code | |
Delete Session Entity Type | source code |
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