v2.ContextsClient

class   static

A context represents additional information included with user input or with an intent returned by the Dialogflow API. Contexts are helpful for differentiating user input which may be vague or have a different meaning depending on additional details from your application such as user setting and preferences, previous user input, where the user is in your application, geographic location, and so on.

You can include contexts as input parameters of a DetectIntent (or StreamingDetectIntent) request, or as output contexts included in the returned intent. Contexts expire when an intent is matched, after the number of DetectIntent requests specified by the lifespan_count parameter, or after 20 minutes if no intents are matched for a DetectIntent request.

For more information about contexts, see the Dialogflow documentation.

Constructor

ContextsClient

new ContextsClient(options)

Construct an instance of ContextsClient.

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

contextPath

contextPath(project, session, context) returns String

Return a fully-qualified context resource name string.

Parameter

project

String

session

String

context

String
Returns

String 

createContext

createContext(request, options, callback) returns Promise

Creates a context.

If the specified context already exists, overrides the context.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The session to create a context for. Format: projects/<Project ID>/agent/sessions/<Session ID>.

context

Object

Required. The context to create.

This object should have the same structure as Context

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 Context.
Returns

Promise 

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

Example 

const dialogflow = require('dialogflow');

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

const formattedParent = client.sessionPath('[PROJECT]', '[SESSION]');
const context = {};
const request = {
  parent: formattedParent,
  context: context,
};
client.createContext(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

deleteAllContexts

deleteAllContexts(request, options, callback) returns Promise

Deletes all active contexts in the specified session.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The name of the session to delete all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID>.

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)

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

Promise 

  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example 

const dialogflow = require('dialogflow');

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

const formattedParent = client.sessionPath('[PROJECT]', '[SESSION]');
client.deleteAllContexts({parent: formattedParent}).catch(err => {
  console.error(err);
});

deleteContext

deleteContext(request, options, callback) returns Promise

Deletes the specified context.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required. The name of the context to delete. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>.

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)

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

Promise 

  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example 

const dialogflow = require('dialogflow');

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

const formattedName = client.contextPath('[PROJECT]', '[SESSION]', '[CONTEXT]');
client.deleteContext({name: formattedName}).catch(err => {
  console.error(err);
});

getContext

getContext(request, options, callback) returns Promise

Retrieves the specified context.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required. The name of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>.

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 Context.
Returns

Promise 

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

Example 

const dialogflow = require('dialogflow');

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

const formattedName = client.contextPath('[PROJECT]', '[SESSION]', '[CONTEXT]');
client.getContext({name: formattedName})
  .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.

listContexts

listContexts(request, options, callback) returns Promise

Returns the list of all contexts in the specified session.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID>.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

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 Array, nullable Object, nullable Object)

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

The second parameter to the callback is Array of Context.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListContextsResponse.
Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of Context.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Context in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListContextsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example 

const dialogflow = require('dialogflow');

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

// Iterate over all elements.
const formattedParent = client.sessionPath('[PROJECT]', '[SESSION]');

client.listContexts({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.sessionPath('[PROJECT]', '[SESSION]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listContexts(nextRequest, options).then(callback);
  }
}
client.listContexts({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listContextsStream

listContextsStream(request, options) returns Stream

Equivalent to listContexts, but returns a NodeJS Stream object.

This fetches the paged responses for listContexts continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID>.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

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.
See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing Context on 'data' event.

Example 

const dialogflow = require('dialogflow');

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

const formattedParent = client.sessionPath('[PROJECT]', '[SESSION]');
client.listContextsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

matchContextFromContextName

matchContextFromContextName(contextName) returns String

Parse the contextName from a context resource.

Parameter

contextName

String

A fully-qualified path representing a context resources.
Returns

String 

  • A string representing the context.

matchProjectFromContextName

matchProjectFromContextName(contextName) returns String

Parse the contextName from a context resource.

Parameter

contextName

String

A fully-qualified path representing a context resources.
Returns

String 

  • A string representing the project.

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.

matchSessionFromContextName

matchSessionFromContextName(contextName) returns String

Parse the contextName from a context resource.

Parameter

contextName

String

A fully-qualified path representing a context resources.
Returns

String 

  • A string representing the session.

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 

updateContext

updateContext(request, options, callback) returns Promise

Updates the specified context.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

context

Object

Required. The context to update.

This object should have the same structure as Context

updateMask

Optional

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

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 Context.
Returns

Promise 

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

Example 

const dialogflow = require('dialogflow');

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

const context = {};
client.updateContext({context: context})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });