1.2.0 • Published 1 year ago

dialogflow v1.2.0

Weekly downloads
20,945
License
Apache-2.0
Repository
github
Last release
1 year ago

Dialogflow API: Node.js Client

release level npm version codecov

IMPORTANT NOTE

Version 2.0.0 renames dialogflow to @google-cloud/dialogflow on npm, along with introducing TypeScript types.

Dialogflow API client for Node.js

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.
  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.

Installing the client library

npm install dialogflow

Using the client library

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.

SampleSource CodeTry it
Detect Intent (Text)source codeOpen in Cloud Shell
Create Knowledge Basesource codeOpen in Cloud Shell
Get Knowledge Basesource codeOpen in Cloud Shell
list Knowledge Basesource codeOpen in Cloud Shell
list Knowledge Basesource codeOpen in Cloud Shell
create Documentsource codeOpen in Cloud Shell
list Documentssource codeOpen in Cloud Shell
Get Documentsource codeOpen in Cloud Shell
delete Documentsource codeOpen in Cloud Shell
detect Intent with sentiment analysissource codeOpen in Cloud Shell
detect Intent with text-to-speech responsesource codeOpen in Cloud Shell
detect Intent with Knowledge Basesource codeOpen in Cloud Shell
Detect Intent (Audio)source codeOpen in Cloud Shell
Detect Intent (Streaming)source codeOpen in Cloud Shell
Create Entitysource codeOpen in Cloud Shell
Delete Entitysource codeOpen in Cloud Shell
Create Intentsource codeOpen in Cloud Shell
Delete Intentsource codeOpen in Cloud Shell
Create Contextsource codeOpen in Cloud Shell
Delete Contextsource codeOpen in Cloud Shell
Create Session Entity Typesource codeOpen in Cloud Shell
Delete Session Entity Typesource codeOpen in Cloud Shell

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

Versioning

This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE

1.2.0

1 year ago

1.1.2

1 year ago

1.1.1

1 year ago

1.1.0

1 year ago

1.0.0

2 years ago

0.14.1

2 years ago

0.14.0

2 years ago

0.13.0

2 years ago

0.12.2

2 years ago

0.12.1

2 years ago

0.12.0

2 years ago

0.11.0

2 years ago

0.10.3

2 years ago

0.10.2

2 years ago

0.10.1

2 years ago

0.10.0

2 years ago

0.9.1

2 years ago

0.9.0

2 years ago

0.8.2

2 years ago

0.8.0

2 years ago

0.7.0

3 years ago

0.6.0

3 years ago

0.5.0

3 years ago

0.4.0

3 years ago

0.3.0

3 years ago

0.2.1

3 years ago

0.2.0

3 years ago

0.1.0

4 years ago

4.0.3

4 years ago