ContextsClient

ContextsClient

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

new ContextsClient(optionsopt)

Construct an instance of ContextsClient.

Parameters:
Name Type Attributes Description
options object <optional>

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

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

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 number <optional>

The port on which to connect to the remote host.
projectId string <optional>

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 function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

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

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

contextPath(project, session, context) → {String}

Return a fully-qualified context resource name string.

Parameters:
Name Type Description
project String
session String
context String
Source:

createContext(request, optionsopt, callbackopt) → {Promise}

Creates a context.

If the specified context already exists, overrides the context.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The session to create a context for. 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 assume default '-' user.
context Object

Required. The context to create.

This object should have the same structure as Context
options Object <optional>

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 <optional>

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

The second parameter to the callback is an object representing Context.
Source:
Example
const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.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(request, optionsopt, callbackopt) → {Promise}

Deletes all active contexts in the specified session.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the session to delete all contexts from. 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 assume default '-' user.
options Object <optional>

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 <optional>

The function which will be called with the result of the API call.
Source:
Example
const dialogflow = require('dialogflow');

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

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

deleteContext(request, optionsopt, callbackopt) → {Promise}

Deletes the specified context.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the context to delete. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
options Object <optional>

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 <optional>

The function which will be called with the result of the API call.
Source:
Example
const dialogflow = require('dialogflow');

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

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

environmentContextPath(project, environment, user, session, context) → {String}

Return a fully-qualified environment_context resource name string.

Parameters:
Name Type Description
project String
environment String
user String
session String
context String
Source:

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

Return a fully-qualified environment_session resource name string.

Parameters:
Name Type Description
project String
environment String
user String
session String
Source:

getContext(request, optionsopt, callbackopt) → {Promise}

Retrieves the specified context.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
options Object <optional>

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 <optional>

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

The second parameter to the callback is an object representing Context.
Source:
Example
const dialogflow = require('dialogflow');

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

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

listContexts(request, optionsopt, callbackopt) → {Promise}

Returns the list of all contexts in the specified session.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The session to list all contexts from. 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 assume default '-' user.
pageSize number <optional>

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 Object <optional>

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 <optional>

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.
Source:
Example
const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.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(request, optionsopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The session to list all contexts from. 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 assume default '-' user.
pageSize number <optional>

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 Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Source:
See:
Example
const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.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(contextName) → {String}

Parse the contextName from a context resource.

Parameters:
Name Type Description
contextName String

A fully-qualified path representing a context resources.
Source:

matchContextFromEnvironmentContextName(environmentContextName) → {String}

Parse the environmentContextName from a environment_context resource.

Parameters:
Name Type Description
environmentContextName String

A fully-qualified path representing a environment_context resources.
Source:

matchEnvironmentFromEnvironmentContextName(environmentContextName) → {String}

Parse the environmentContextName from a environment_context resource.

Parameters:
Name Type Description
environmentContextName String

A fully-qualified path representing a environment_context resources.
Source:

matchEnvironmentFromEnvironmentSessionName(environmentSessionName) → {String}

Parse the environmentSessionName from a environment_session resource.

Parameters:
Name Type Description
environmentSessionName String

A fully-qualified path representing a environment_session resources.
Source:

matchProjectFromContextName(contextName) → {String}

Parse the contextName from a context resource.

Parameters:
Name Type Description
contextName String

A fully-qualified path representing a context resources.
Source:

matchProjectFromEnvironmentContextName(environmentContextName) → {String}

Parse the environmentContextName from a environment_context resource.

Parameters:
Name Type Description
environmentContextName String

A fully-qualified path representing a environment_context resources.
Source:

matchProjectFromEnvironmentSessionName(environmentSessionName) → {String}

Parse the environmentSessionName from a environment_session resource.

Parameters:
Name Type Description
environmentSessionName String

A fully-qualified path representing a environment_session resources.
Source:

matchProjectFromSessionName(sessionName) → {String}

Parse the sessionName from a session resource.

Parameters:
Name Type Description
sessionName String

A fully-qualified path representing a session resources.
Source:

matchSessionFromContextName(contextName) → {String}

Parse the contextName from a context resource.

Parameters:
Name Type Description
contextName String

A fully-qualified path representing a context resources.
Source:

matchSessionFromEnvironmentContextName(environmentContextName) → {String}

Parse the environmentContextName from a environment_context resource.

Parameters:
Name Type Description
environmentContextName String

A fully-qualified path representing a environment_context resources.
Source:

matchSessionFromEnvironmentSessionName(environmentSessionName) → {String}

Parse the environmentSessionName from a environment_session resource.

Parameters:
Name Type Description
environmentSessionName String

A fully-qualified path representing a environment_session resources.
Source:

matchSessionFromSessionName(sessionName) → {String}

Parse the sessionName from a session resource.

Parameters:
Name Type Description
sessionName String

A fully-qualified path representing a session resources.
Source:

matchUserFromEnvironmentContextName(environmentContextName) → {String}

Parse the environmentContextName from a environment_context resource.

Parameters:
Name Type Description
environmentContextName String

A fully-qualified path representing a environment_context resources.
Source:

matchUserFromEnvironmentSessionName(environmentSessionName) → {String}

Parse the environmentSessionName from a environment_session resource.

Parameters:
Name Type Description
environmentSessionName String

A fully-qualified path representing a environment_session resources.
Source:

sessionPath(project, session) → {String}

Return a fully-qualified session resource name string.

Parameters:
Name Type Description
project String
session String
Source:

updateContext(request, optionsopt, callbackopt) → {Promise}

Updates the specified context.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
context Object

Required. The context to update.

This object should have the same structure as Context
updateMask Object <optional>

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask
options Object <optional>

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 <optional>

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

The second parameter to the callback is an object representing Context.
Source:
Example
const dialogflow = require('dialogflow');

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

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