Constructor

SessionsClient

new SessionsClient(options)

Construct an instance of SessionsClient.

Parameter

options

Optional

object

The configuration object. See the subsequent parameters for more details.

Values in options have the following properties:

Parameter

credentials

Optional

object

Credentials object.

credentials.client_email

Optional

string

credentials.private_key

Optional

string

email

Optional

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

Optional

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

Optional

number

The port on which to connect to the remote host.

projectId

Optional

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

promise

Optional

function()

Custom promise module to use instead of native Promises.

servicePath

Optional

string

The domain name of the API remote host.

Properties

port

static

The port for this API service.

scopes

static

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static

The DNS address for this API service.

Methods

detectIntent

detectIntent(request, options, callback) returns Promise

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

session

string

Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>. It's up to the API caller to choose an appropriate session ID. It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 bytes.

queryInput

Object

Required. The input specification. It can be set to:

  1. an audio config which instructs the speech recognizer how to process the speech audio,

  2. a conversational query in the form of text, or

  3. an event that specifies which intent to trigger.

    This object should have the same structure as QueryInput

queryParams

Optional

Object

Optional. The parameters of this query.

This object should have the same structure as QueryParameters

inputAudio

Optional

string

Optional. The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing DetectIntentResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing DetectIntentResponse. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const dialogflow = require('dialogflow');

const client = new dialogflow.v2.SessionsClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[SESSION]');
const queryInput = {};
const request = {
  session: formattedSession,
  queryInput: queryInput,
};
client.detectIntent(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId

getProjectId(callback)

Return the project ID used by this class.

Parameter

callback

function(Error, string)

the callback to be called with the current project Id.

matchProjectFromSessionName

matchProjectFromSessionName(sessionName) returns String

Parse the sessionName from a session resource.

Parameter

sessionName

String

A fully-qualified path representing a session resources.

Returns

String 

  • A string representing the project.

matchSessionFromSessionName

matchSessionFromSessionName(sessionName) returns String

Parse the sessionName from a session resource.

Parameter

sessionName

String

A fully-qualified path representing a session resources.

Returns

String 

  • A string representing the session.

sessionPath

sessionPath(project, session) returns String

Return a fully-qualified session resource name string.

Parameter

project

String

session

String

Returns

String 

streamingDetectIntent

streamingDetectIntent(options) returns Stream

Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

Parameter

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns

Stream 

An object stream which is both readable and writable. It accepts objects representing StreamingDetectIntentRequest for write() method, and will emit objects representing StreamingDetectIntentResponse on 'data' event asynchronously.

Example

const dialogflow = require('dialogflow');

const client = new dialogflow.v2.SessionsClient({
  // optional auth parameters.
});

const stream = client.streamingDetectIntent().on('data', response => {
  // doThingsWith(response)
});
const session = '';
const queryInput = {};
const request = {
  session: session,
  queryInput: queryInput,
};
// Write request objects.
stream.write(request);