dialogflow 0.9.0 » Class: SessionEntityTypesClient

v2beta1.SessionEntityTypesClient

class   static

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level.

For more information about entity types, see the Dialogflow documentation.

Constructor

SessionEntityTypesClient

new SessionEntityTypesClient(options)

Construct an instance of SessionEntityTypesClient.

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

createSessionEntityType

createSessionEntityType(request, options, callback) returns Promise

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

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 session entity type 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. sessionEntityType Object Required. The session entity type to create. This object should have the same structure as SessionEntityType
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 SessionEntityType.

Returns

Promise 

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

Example

const dialogflow = require('dialogflow');

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

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

deleteSessionEntityType

deleteSessionEntityType(request, options, callback) returns Promise

Deletes the specified session entity type.

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 entity type to delete. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
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.v2beta1.SessionEntityTypesClient({
  // optional auth parameters.
});

const formattedName = client.sessionEntityTypePath('[PROJECT]', '[SESSION]', '[ENTITY_TYPE]');
client.deleteSessionEntityType({name: formattedName}).catch(err => {
  console.error(err);
});

environmentSessionEntityTypePath

environmentSessionEntityTypePath(project, environment, user, session, entityType) returns String

Return a fully-qualified environment_session_entity_type resource name string.

Parameter
project	String
environment	String
user	String
session	String
entityType	String

Returns

String 

environmentSessionPath

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

Return a fully-qualified environment_session resource name string.

Parameter
project	String
environment	String
user	String
session	String

Returns

String 

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.

getSessionEntityType

getSessionEntityType(request, options, callback) returns Promise

Retrieves the specified session entity type.

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 session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
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 SessionEntityType.

Returns

Promise 

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

Example

const dialogflow = require('dialogflow');

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

const formattedName = client.sessionEntityTypePath('[PROJECT]', '[SESSION]', '[ENTITY_TYPE]');
client.getSessionEntityType({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

listSessionEntityTypes

listSessionEntityTypes(request, options, callback) returns Promise

Returns the list of all session entity types 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 session entity types 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 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 SessionEntityType. 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 ListSessionEntityTypesResponse.

Returns

Promise 

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

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of SessionEntityType 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 ListSessionEntityTypesResponse.

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

Example

const dialogflow = require('dialogflow');

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

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

client.listSessionEntityTypes({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.listSessionEntityTypes(nextRequest, options).then(callback);
  }
}
client.listSessionEntityTypes({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listSessionEntityTypesStream

listSessionEntityTypesStream(request, options) returns Stream

Equivalent to listSessionEntityTypes, but returns a NodeJS Stream object.

This fetches the paged responses for listSessionEntityTypes 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 session entity types 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 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 SessionEntityType on 'data' event.

Example

const dialogflow = require('dialogflow');

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

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

matchEntityTypeFromEnvironmentSessionEntityTypeName

matchEntityTypeFromEnvironmentSessionEntityTypeName(environmentSessionEntityTypeName) returns String

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameter
environmentSessionEntityTypeName	String A fully-qualified path representing a environment_session_entity_type resources.

Returns

String 

• A string representing the entity_type.

matchEntityTypeFromSessionEntityTypeName

matchEntityTypeFromSessionEntityTypeName(sessionEntityTypeName) returns String

Parse the sessionEntityTypeName from a session_entity_type resource.

Parameter
sessionEntityTypeName	String A fully-qualified path representing a session_entity_type resources.

Returns

String 

• A string representing the entity_type.

matchEnvironmentFromEnvironmentSessionEntityTypeName

matchEnvironmentFromEnvironmentSessionEntityTypeName(environmentSessionEntityTypeName) returns String

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameter
environmentSessionEntityTypeName	String A fully-qualified path representing a environment_session_entity_type resources.

Returns

String 

• A string representing the environment.

matchEnvironmentFromEnvironmentSessionName

matchEnvironmentFromEnvironmentSessionName(environmentSessionName) returns String

Parse the environmentSessionName from a environment_session resource.

Parameter
environmentSessionName	String A fully-qualified path representing a environment_session resources.

Returns

String 

• A string representing the environment.

matchProjectFromEnvironmentSessionEntityTypeName

matchProjectFromEnvironmentSessionEntityTypeName(environmentSessionEntityTypeName) returns String

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameter
environmentSessionEntityTypeName	String A fully-qualified path representing a environment_session_entity_type resources.

Returns

String 

• A string representing the project.

matchProjectFromEnvironmentSessionName

matchProjectFromEnvironmentSessionName(environmentSessionName) returns String

Parse the environmentSessionName from a environment_session resource.

Parameter
environmentSessionName	String A fully-qualified path representing a environment_session resources.

Returns

String 

• A string representing the project.

matchProjectFromSessionEntityTypeName

matchProjectFromSessionEntityTypeName(sessionEntityTypeName) returns String

Parse the sessionEntityTypeName from a session_entity_type resource.

Parameter
sessionEntityTypeName	String A fully-qualified path representing a session_entity_type 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.

matchSessionFromEnvironmentSessionEntityTypeName

matchSessionFromEnvironmentSessionEntityTypeName(environmentSessionEntityTypeName) returns String

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameter
environmentSessionEntityTypeName	String A fully-qualified path representing a environment_session_entity_type resources.

Returns

String 

• A string representing the session.

matchSessionFromEnvironmentSessionName

matchSessionFromEnvironmentSessionName(environmentSessionName) returns String

Parse the environmentSessionName from a environment_session resource.

Parameter
environmentSessionName	String A fully-qualified path representing a environment_session resources.

Returns

String 

• A string representing the session.

matchSessionFromSessionEntityTypeName

matchSessionFromSessionEntityTypeName(sessionEntityTypeName) returns String

Parse the sessionEntityTypeName from a session_entity_type resource.

Parameter
sessionEntityTypeName	String A fully-qualified path representing a session_entity_type 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.

matchUserFromEnvironmentSessionEntityTypeName

matchUserFromEnvironmentSessionEntityTypeName(environmentSessionEntityTypeName) returns String

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameter
environmentSessionEntityTypeName	String A fully-qualified path representing a environment_session_entity_type resources.

Returns

String 

• A string representing the user.

matchUserFromEnvironmentSessionName

matchUserFromEnvironmentSessionName(environmentSessionName) returns String

Parse the environmentSessionName from a environment_session resource.

Parameter
environmentSessionName	String A fully-qualified path representing a environment_session resources.

Returns

String 

• A string representing the user.

sessionEntityTypePath

sessionEntityTypePath(project, session, entityType) returns String

Return a fully-qualified session_entity_type resource name string.

Parameter
project	String
session	String
entityType	String

Returns

String 

sessionPath

sessionPath(project, session) returns String

Return a fully-qualified session resource name string.

Parameter
project	String
session	String

Returns

String 

updateSessionEntityType

updateSessionEntityType(request, options, callback) returns Promise

Updates the specified session entity type.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter sessionEntityType Object Required. The entity type to update. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. This object should have the same structure as SessionEntityType 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 SessionEntityType.

Returns

Promise 

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

Example

const dialogflow = require('dialogflow');

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

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