SessionEntityTypesClient

SessionEntityTypesClient

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.

Session entity methods do not work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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

Constructor

new SessionEntityTypesClient(optionsopt)

Construct an instance of SessionEntityTypesClient.

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

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

Creates a session entity type.

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

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 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 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 SessionEntityType.
Source:
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(request, optionsopt, callbackopt) → {Promise}

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 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 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.SessionEntityTypesClient({
  // optional auth parameters.
});

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

environmentSessionEntityTypePath(project, environment, user, session, entityType) → {String}

Return a fully-qualified environment_session_entity_type resource name string.

Parameters:
Name Type Description
project String
environment String
user String
session String
entityType 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:

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:

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

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 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 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 SessionEntityType.
Source:
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(request, optionsopt, callbackopt) → {Promise}

Returns the list of all session entity types in the specified session.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 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 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 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.
Source:
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(request, optionsopt) → {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.

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 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 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.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(environmentSessionEntityTypeName) → {String}

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameters:
Name Type Description
environmentSessionEntityTypeName String

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

matchEntityTypeFromSessionEntityTypeName(sessionEntityTypeName) → {String}

Parse the sessionEntityTypeName from a session_entity_type resource.

Parameters:
Name Type Description
sessionEntityTypeName String

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

matchEnvironmentFromEnvironmentSessionEntityTypeName(environmentSessionEntityTypeName) → {String}

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameters:
Name Type Description
environmentSessionEntityTypeName String

A fully-qualified path representing a environment_session_entity_type 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:

matchProjectFromEnvironmentSessionEntityTypeName(environmentSessionEntityTypeName) → {String}

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameters:
Name Type Description
environmentSessionEntityTypeName String

A fully-qualified path representing a environment_session_entity_type 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:

matchProjectFromSessionEntityTypeName(sessionEntityTypeName) → {String}

Parse the sessionEntityTypeName from a session_entity_type resource.

Parameters:
Name Type Description
sessionEntityTypeName String

A fully-qualified path representing a session_entity_type 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:

matchSessionFromEnvironmentSessionEntityTypeName(environmentSessionEntityTypeName) → {String}

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameters:
Name Type Description
environmentSessionEntityTypeName String

A fully-qualified path representing a environment_session_entity_type 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:

matchSessionFromSessionEntityTypeName(sessionEntityTypeName) → {String}

Parse the sessionEntityTypeName from a session_entity_type resource.

Parameters:
Name Type Description
sessionEntityTypeName String

A fully-qualified path representing a session_entity_type 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:

matchUserFromEnvironmentSessionEntityTypeName(environmentSessionEntityTypeName) → {String}

Parse the environmentSessionEntityTypeName from a environment_session_entity_type resource.

Parameters:
Name Type Description
environmentSessionEntityTypeName String

A fully-qualified path representing a environment_session_entity_type 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:

sessionEntityTypePath(project, session, entityType) → {String}

Return a fully-qualified session_entity_type resource name string.

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

sessionPath(project, session) → {String}

Return a fully-qualified session resource name string.

Parameters:
Name Type Description
project String
session String
Source:

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

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
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 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 SessionEntityType.
Source:
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);
  });