Cx client for Node.js

Downloads in past


3663.1.18 days ago2 years agoMinified + gzip package size for @google-cloud/dialogflow-cx in KB


Google Cloud Platform logorelease level npm version
Cx client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explainedexplained.
Table of contents:
Before you begin Installing the client library Using the client library


Before you begin

  1. Select or create a Cloud Platform projectprojects.
  2. Enable billing for your projectbilling.
  3. Enable the Dialogflow CX API APIenableapi.
  4. Set up authentication with a service accountauth so you can access the
API from your local workstation.

Installing the client library

npm install @google-cloud/dialogflow-cx

Using the client library

 * TODO(developer): Uncomment these variables before running the sample.
// const projectId = 'my-project';
// const location = 'global';
// const agentId = 'my-agent';
// const audioFileName = '/path/to/audio.raw';
// const encoding = 'AUDIO_ENCODING_LINEAR_16';
// const sampleRateHertz = 16000;
// const languageCode = 'en'

// Imports the Google Cloud Some API library
const {SessionsClient} = require('@google-cloud/dialogflow-cx');
 * Example for regional endpoint:
 *   const location = 'us-central1'
 *   const client = new SessionsClient({apiEndpoint: 'us-central1-dialogflow.googleapis.com'})
const client = new SessionsClient();

const fs = require('fs');
const util = require('util');
// Assumes uuid module has been installed from npm,
// npm i uuid:
const {v4} = require('uuid');

async function detectIntentAudio() {
  const sessionId = v4();
  const sessionPath = client.projectLocationAgentSessionPath(

  // Read the content of the audio file and send it as part of the request.
  const readFile = util.promisify(fs.readFile);
  const inputAudio = await readFile(audioFileName);

  const request = {
    session: sessionPath,
    queryInput: {
      audio: {
        config: {
          audioEncoding: encoding,
          sampleRateHertz: sampleRateHertz,
        audio: inputAudio,
  const [response] = await client.detectIntent(request);
  console.log(`User Query: ${response.queryResult.transcript}`);
  for (const message of response.queryResult.responseMessages) {
    if (message.text) {
      console.log(`Agent Response: ${message.text.text}`);
  if (response.queryResult.match.intent) {
      `Matched Intent: ${response.queryResult.match.intent.displayName}`
    `Current Page: ${response.queryResult.currentPage.displayName}`



Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Configure-webhook-to-set-form-parameter-as-optional-or-required | source code | !Open in Cloud Shellshellimg | | Create-agent | source code | !Open in Cloud Shellshellimg | | Create-page | source code | !Open in Cloud Shellshellimg | | Delete-page | source code | !Open in Cloud Shellshellimg | | Detect-intent-audio | source code | !Open in Cloud Shellshellimg | | Detect-intent-disabled-webhook | source code | !Open in Cloud Shellshellimg | | Detect-intent-event | source code | !Open in Cloud Shellshellimg | | Detect-intent-streaming | source code | !Open in Cloud Shellshellimg | | Detect-intent-synthesize-tts-response | source code | !Open in Cloud Shellshellimg | | Detect-intent-text | source code | !Open in Cloud Shellshellimg | | Detect-intent-with-intent-input | source code | !Open in Cloud Shellshellimg | | Detect-intent-with-sentiment-analysis | source code | !Open in Cloud Shellshellimg | | List-intents | source code | !Open in Cloud Shellshellimg | | List-page | source code | !Open in Cloud Shellshellimg | | List-testcase-results | source code | !Open in Cloud Shellshellimg | | List Training Phrases | source code | !Open in Cloud Shellshellimg | | Long-running-operation | source code | !Open in Cloud Shellshellimg | | Quickstart | source code | !Open in Cloud Shellshellimg | | Streaming-detect-intent-partial-response | source code | !Open in Cloud Shellshellimg | | Update-intent | source code | !Open in Cloud Shellshellimg | | Webhook-configure-session-parameters | source code | !Open in Cloud Shellshellimg | | Webhook-validate-form-parameter | source code | !Open in Cloud Shellshellimg | | Webhooks | source code | !Open in Cloud Shellshellimg |
The Dialogflow CX API Node.js Client API Referenceclient-docs documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:
  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/dialogflow-cx@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.
This library is considered to be 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 stable libraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stageslaunchstages


Contributions welcome! See the Contributing Guide.
Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.


Apache Version 2.0