new SessionsClient([options])

Construct an instance of SessionsClient.

Parameters

Name Type Optional Description

options

 

Yes

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

Values in options have the following properties:

Name Type Optional Description

credentials

 

Yes

Credentials object.

credentials.client_email

 

Yes

credentials.private_key

 

Yes

email

 

Yes

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

keyFilename

 

Yes

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

 

Yes

The port on which to connect to the remote host.

projectId

 

Yes

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

 

Yes

Custom promise module to use instead of native Promises.

servicePath

 

Yes

The domain name of the API remote host.

Properties

static

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

static

port

The port for this API service.

static

scopes

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

static

servicePath

The DNS address for this API service.

Methods

detectIntent(request[, options][, callback]) → 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.

Example

const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.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);
  });

Parameters

Name Type Optional Description

request

Object

 

The request object that will be sent.

Values in request have the following properties:

Name Type Optional Description

session

string

 

Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we are using "-". It’s up to the API caller to choose an appropriate Session ID and User Id. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

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

Object

Yes

Optional. The parameters of this query.

This object should have the same structure as QueryParameters

outputAudioConfig

Object

Yes

Optional. Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

This object should have the same structure as OutputAudioConfig

inputAudio

Buffer

Yes

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

Object

Yes

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

callback

function(nullable Error, nullable Object)

Yes

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.

environmentSessionPath(project, environment, user, session) → String

Return a fully-qualified environment_session resource name string.

Parameters

Name Type Optional Description

project

String

 

environment

String

 

user

String

 

session

String

 

Returns

String 

getProjectId(callback)

Return the project ID used by this class.

Parameter

Name Type Optional Description

callback

function(Error, string)

 

the callback to be called with the current project Id.

matchEnvironmentFromEnvironmentSessionName(environmentSessionName) → String

Parse the environmentSessionName from a environment_session resource.

Parameter

Name Type Optional Description

environmentSessionName

String

 

A fully-qualified path representing a environment_session resources.

Returns

String 

  • A string representing the environment.

matchProjectFromEnvironmentSessionName(environmentSessionName) → String

Parse the environmentSessionName from a environment_session resource.

Parameter

Name Type Optional Description

environmentSessionName

String

 

A fully-qualified path representing a environment_session resources.

Returns

String 

  • A string representing the project.

matchProjectFromSessionName(sessionName) → String

Parse the sessionName from a session resource.

Parameter

Name Type Optional Description

sessionName

String

 

A fully-qualified path representing a session resources.

Returns

String 

  • A string representing the project.

matchSessionFromEnvironmentSessionName(environmentSessionName) → String

Parse the environmentSessionName from a environment_session resource.

Parameter

Name Type Optional Description

environmentSessionName

String

 

A fully-qualified path representing a environment_session resources.

Returns

String 

  • A string representing the session.

matchSessionFromSessionName(sessionName) → String

Parse the sessionName from a session resource.

Parameter

Name Type Optional Description

sessionName

String

 

A fully-qualified path representing a session resources.

Returns

String 

  • A string representing the session.

matchUserFromEnvironmentSessionName(environmentSessionName) → String

Parse the environmentSessionName from a environment_session resource.

Parameter

Name Type Optional Description

environmentSessionName

String

 

A fully-qualified path representing a environment_session resources.

Returns

String 

  • A string representing the user.

sessionPath(project, session) → String

Return a fully-qualified session resource name string.

Parameters

Name Type Optional Description

project

String

 

session

String

 

Returns

String 

streamingDetectIntent([options]) → 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).

Example

const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.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);

Parameter

Name Type Optional Description

options

Object

Yes

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.