SessionsClient

A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent (or StreamingDetectIntent) method to determine user intent and respond.

Constructor

new SessionsClient(optionsopt)

Construct an instance of SessionsClient.

Parameters:

Name Type Attributes Description

options

object

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

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

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

keyFilename

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

number

The port on which to connect to the remote host.

projectId

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.

apiEndpoint

string

The domain name of the API remote host.

Members

(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

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	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 number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters.
`queryParams`	google.cloud.dialogflow.v2beta1.QueryParameters	The parameters of this query.
`queryInput`	google.cloud.dialogflow.v2beta1.QueryInput	Required. The input specification. It can be set to: an audio config which instructs the speech recognizer how to process the speech audio, a conversational query in the form of text, or an event that specifies which intent to trigger.
`outputAudioConfig`	google.cloud.dialogflow.v2beta1.OutputAudioConfig	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.
`outputAudioConfigMask`	google.protobuf.FieldMask	Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level. If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.
`inputAudio`	Buffer	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

Call options. See CallOptions for more details.

environmentPath(project, environment) → {string}

Return a fully-qualified environment resource name string.

Parameters:

Name	Type	Description
`project`	string
`environment`	string

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.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

matchEnvironmentFromEnvironmentName(environmentName) → {string}

Parse the environment from Environment resource.

Parameters:

Name	Type	Description
`environmentName`	string	A fully-qualified path representing Environment resource.

matchIntentFromProjectAgentIntentName(projectAgentIntentName) → {string}

Parse the intent from ProjectAgentIntent resource.

Parameters:

Name	Type	Description
`projectAgentIntentName`	string	A fully-qualified path representing project_agent_intent resource.

matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName) → {string}

Parse the intent from ProjectLocationAgentIntent resource.

Parameters:

Name	Type	Description
`projectLocationAgentIntentName`	string	A fully-qualified path representing project_location_agent_intent resource.

matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName) → {string}

Parse the location from ProjectLocationAgentIntent resource.

Parameters:

Name	Type	Description
`projectLocationAgentIntentName`	string	A fully-qualified path representing project_location_agent_intent resource.

matchLocationFromProjectLocationAgentName(projectLocationAgentName) → {string}

Parse the location from ProjectLocationAgent resource.

Parameters:

Name	Type	Description
`projectLocationAgentName`	string	A fully-qualified path representing project_location_agent resource.

matchLocationFromProjectLocationAgentSessionName(projectLocationAgentSessionName) → {string}

Parse the location from ProjectLocationAgentSession resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionName`	string	A fully-qualified path representing project_location_agent_session resource.

matchProjectFromEnvironmentName(environmentName) → {string}

Parse the project from Environment resource.

Parameters:

Name	Type	Description
`environmentName`	string	A fully-qualified path representing Environment resource.

matchProjectFromProjectAgentIntentName(projectAgentIntentName) → {string}

Parse the project from ProjectAgentIntent resource.

Parameters:

Name	Type	Description
`projectAgentIntentName`	string	A fully-qualified path representing project_agent_intent resource.

matchProjectFromProjectAgentName(projectAgentName) → {string}

Parse the project from ProjectAgent resource.

Parameters:

Name	Type	Description
`projectAgentName`	string	A fully-qualified path representing project_agent resource.

matchProjectFromProjectAgentSessionName(projectAgentSessionName) → {string}

Parse the project from ProjectAgentSession resource.

Parameters:

Name	Type	Description
`projectAgentSessionName`	string	A fully-qualified path representing project_agent_session resource.

matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName) → {string}

Parse the project from ProjectLocationAgentIntent resource.

Parameters:

Name	Type	Description
`projectLocationAgentIntentName`	string	A fully-qualified path representing project_location_agent_intent resource.

matchProjectFromProjectLocationAgentName(projectLocationAgentName) → {string}

Parse the project from ProjectLocationAgent resource.

Parameters:

Name	Type	Description
`projectLocationAgentName`	string	A fully-qualified path representing project_location_agent resource.

matchProjectFromProjectLocationAgentSessionName(projectLocationAgentSessionName) → {string}

Parse the project from ProjectLocationAgentSession resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionName`	string	A fully-qualified path representing project_location_agent_session resource.

matchSessionFromProjectAgentSessionName(projectAgentSessionName) → {string}

Parse the session from ProjectAgentSession resource.

Parameters:

Name	Type	Description
`projectAgentSessionName`	string	A fully-qualified path representing project_agent_session resource.

matchSessionFromProjectLocationAgentSessionName(projectLocationAgentSessionName) → {string}

Parse the session from ProjectLocationAgentSession resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionName`	string	A fully-qualified path representing project_location_agent_session resource.

projectAgentIntentPath(project, intent) → {string}

Return a fully-qualified projectAgentIntent resource name string.

Parameters:

Name	Type	Description
`project`	string
`intent`	string

projectAgentPath(project) → {string}

Return a fully-qualified projectAgent resource name string.

Parameters:

Name	Type	Description
`project`	string

projectAgentSessionPath(project, session) → {string}

Return a fully-qualified projectAgentSession resource name string.

Parameters:

Name	Type	Description
`project`	string
`session`	string

projectLocationAgentIntentPath(project, location, intent) → {string}

Return a fully-qualified projectLocationAgentIntent resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`intent`	string

projectLocationAgentPath(project, location) → {string}

Return a fully-qualified projectLocationAgent resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

projectLocationAgentSessionPath(project, location, session) → {string}

Return a fully-qualified projectLocationAgentSession resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`session`	string

streamingDetectIntent(optionsopt) → {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).

Parameters:

Name	Type	Attributes	Description
`options`	object	<optional>	Call options. See CallOptions for more details.