Nemo's Parental Misguidance
    Wondering what’s next for npm?Check out our public roadmap! »

    @google-cloud/dialogflow-cx
    TypeScript icon, indicating that this package has built-in type declarations

    2.9.0 • Public • Published

    Google Cloud Platform logo

    Dialogflow CX API: Node.js Client

    release level npm version codecov

    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 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 CX API 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 @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(
        projectId,
        location,
        agentId,
        sessionId
      );
    
      // 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,
          },
          languageCode,
        },
      };
      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) {
        console.log(
          `Matched Intent: ${response.queryResult.match.intent.displayName}`
        );
      }
      console.log(
        `Current Page: ${response.queryResult.currentPage.displayName}`
      );
    }
    
    detectIntentAudio();

    Samples

    Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

    Sample Source Code Try it
    Detect-intent-audio source code Open in Cloud Shell
    Detect-intent-streaming source code Open in Cloud Shell
    Detect-intent-text source code Open in Cloud Shell
    List-intents source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell

    The Dialogflow CX API Node.js Client API Reference 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.

    Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

    Legacy Node.js versions are supported as a best effort:

    • Legacy versions will not be tested in continuous integration.
    • Some security patches may not be able to be backported.
    • Dependencies will not be kept up-to-date, and features will not be backported.

    Legacy tags available

    • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

    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.

    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 template in this directory.

    License

    Apache Version 2.0

    See LICENSE

    Install

    npm i @google-cloud/dialogflow-cx

    DownloadsWeekly Downloads

    1,883

    Version

    2.9.0

    License

    Apache-2.0

    Unpacked Size

    18.2 MB

    Total Files

    164

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar