README.md

Google Assistant SDK: Node.js Client

Node.js idiomatic client for Google Assistant SDK (unofficial).

The Google Assistant SDK lets you add hotword detection, voice control, natural language understanding and Google’s smarts to your devices. Your device captures an utterance (a spoken audio request, such as What's on my calendar?), sends it to the Google Assistant, and receives a spoken audio response in addition to the raw text of the utterance.

• Google Assistant SDK Node.js Client API Reference
• github.com/Dabolus/nodejs-assistant
• Google Assistant SDK 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
  • Installing the client library
  • Using the client library
• Samples
• Contributing
• License

Quickstart

Before you begin

Some configuration steps are needed to make this library work correctly, for example creating a Cloud Platform project, creating a device and generating OAuth2 credentials. Please, follow the Google Assistant Library for Python guide to get started quickly.

Installing the client library

npm install --save nodejs-assistant

Using the client library

// Imports the Google Cloud client library
const {Assistant, AssistantLanguage} = require('nodejs-assistant');

// Your credentials
const credentials = require('path-to-your-credentials.json');

// Creates a client
const assistant = new Assistant(/* required credentials */ {
  type: 'authorized_user',
  client_id: credentials.client_id,
  client_secret: credentials.client_secret,
  refresh_token: credentials.refresh_token,
}, /* additional, optional options */ {
  locale: AssistantLanguage.ITALIAN, // Defaults to AssistantLanguage.ENGLISH (en-US)
  deviceId: 'your device id',
  deviceModelId: 'your device model id',
});

// Sends a text query to the assistant
assistant.query('Hi!')
  .then(response => {
    // response contains all the fields returned by the assistant, such as the text and audio
    console.log(`Response: ${response.text}`);
    // response.audio is a Buffer containing the audio response by the assistant
  })
  .catch(err => {
    console.error('ERROR: ', err);
  });

Head over the API docs for more information.

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample	Source Code	Try it
Quickstart	source code
Text Conversation	source code
Audio Conversation	source code

You might also want to check out Google Assistant Desktop (Unofficial) for a more concrete example.

Contributing

Contributions welcome! See the Contributing Guide.

License

MIT

See LICENSE