Class v2.SessionsClient (3.3.0)

A service used for session interactions.

For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). v2

Package

@google-cloud/dialogflow!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of SessionsClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

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

Property Value

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

sessionsStub

sessionsStub?: Promise<{
        [name: string]: Function;
    }>;

Property Value

Type	Description
Promise<{ [name: string]: Function; }>

Methods

agentPath(project)

agentPath(project: string): string;

Return a fully-qualified agent resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
string	{string} Resource name string.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

detectIntent(request, options)

detectIntent(request: protos.google.cloud.dialogflow.v2.IDetectIntentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2.IDetectIntentResponse, protos.google.cloud.dialogflow.v2.IDetectIntentRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.v2.IDetectIntentRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.dialogflow.v2.IDetectIntentResponse, protos.google.cloud.dialogflow.v2.IDetectIntentRequest \| undefined, {} \| undefined]>

detectIntent(request, options, callback)

detectIntent(request: protos.google.cloud.dialogflow.v2.IDetectIntentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IDetectIntentResponse, protos.google.cloud.dialogflow.v2.IDetectIntentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.v2.IDetectIntentRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.dialogflow.v2.IDetectIntentResponse, protos.google.cloud.dialogflow.v2.IDetectIntentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

detectIntent(request, callback)

detectIntent(request: protos.google.cloud.dialogflow.v2.IDetectIntentRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IDetectIntentResponse, protos.google.cloud.dialogflow.v2.IDetectIntentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.v2.IDetectIntentRequest`
callback	`Callback<protos.google.cloud.dialogflow.v2.IDetectIntentResponse, protos.google.cloud.dialogflow.v2.IDetectIntentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

entityTypePath(project, entityType)

entityTypePath(project: string, entityType: string): string;

Return a fully-qualified entityType resource name string.

Parameters

Name	Description
project	`string`
entityType	`string`

Returns

Type	Description
string	{string} Resource name string.

environmentPath(project, environment)

environmentPath(project: string, environment: string): string;

Return a fully-qualified environment resource name string.

Parameters

Name	Description
project	`string`
environment	`string`

Returns

Type	Description
string	{string} Resource name string.

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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.

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

intentPath(project, intent)

intentPath(project: string, intent: string): string;

Return a fully-qualified intent resource name string.

Parameters

Name	Description
project	`string`
intent	`string`

Returns

Type	Description
string	{string} Resource name string.

matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the context from ProjectAgentEnvironmentUserSessionContext resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionContextName	`string` A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns

Type	Description
string \| number	{string} A string representing the context.

matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName)

matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;

Parse the context from ProjectAgentSessionContext resource.

Parameter

Name	Description
projectAgentSessionContextName	`string` A fully-qualified path representing project_agent_session_context resource.

Returns

Type	Description
string \| number	{string} A string representing the context.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the entity_type.

matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionEntityTypeName	`string` A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the entity_type.

matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectAgentSessionEntityType resource.

Parameter

Name	Description
projectAgentSessionEntityTypeName	`string` A fully-qualified path representing project_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the entity_type.

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

Parse the environment from Environment resource.

Parameter

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

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionContextName	`string` A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionEntityTypeName	`string` A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName)

matchEnvironmentFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName: string): string | number;

Parse the environment from ProjectAgentEnvironmentUserSession resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionName	`string` A fully-qualified path representing project_agent_environment_user_session resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchIntentFromIntentName(intentName)

matchIntentFromIntentName(intentName: string): string | number;

Parse the intent from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the intent.

matchProjectFromAgentName(agentName)

matchProjectFromAgentName(agentName: string): string | number;

Parse the project from Agent resource.

Parameter

Name	Description
agentName	`string` A fully-qualified path representing Agent resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromEntityTypeName(entityTypeName)

matchProjectFromEntityTypeName(entityTypeName: string): string | number;

Parse the project from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

Parse the project from Environment resource.

Parameter

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

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromIntentName(intentName)

matchProjectFromIntentName(intentName: string): string | number;

Parse the project from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the project from ProjectAgentEnvironmentUserSessionContext resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionContextName	`string` A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionEntityTypeName	`string` A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName)

matchProjectFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName: string): string | number;

Parse the project from ProjectAgentEnvironmentUserSession resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionName	`string` A fully-qualified path representing project_agent_environment_user_session resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName)

matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;

Parse the project from ProjectAgentSessionContext resource.

Parameter

Name	Description
projectAgentSessionContextName	`string` A fully-qualified path representing project_agent_session_context resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;

Parse the project from ProjectAgentSessionEntityType resource.

Parameter

Name	Description
projectAgentSessionEntityTypeName	`string` A fully-qualified path representing project_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectAgentSessionName(projectAgentSessionName)

matchProjectFromProjectAgentSessionName(projectAgentSessionName: string): string | number;

Parse the project from ProjectAgentSession resource.

Parameter

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

Returns

Type	Description
string \| number	{string} A string representing the project.

matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the session from ProjectAgentEnvironmentUserSessionContext resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionContextName	`string` A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns

Type	Description
string \| number	{string} A string representing the session.

matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionEntityTypeName	`string` A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the session.

matchSessionFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName)

matchSessionFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName: string): string | number;

Parse the session from ProjectAgentEnvironmentUserSession resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionName	`string` A fully-qualified path representing project_agent_environment_user_session resource.

Returns

Type	Description
string \| number	{string} A string representing the session.

matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName)

matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;

Parse the session from ProjectAgentSessionContext resource.

Parameter

Name	Description
projectAgentSessionContextName	`string` A fully-qualified path representing project_agent_session_context resource.

Returns

Type	Description
string \| number	{string} A string representing the session.

matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;

Parse the session from ProjectAgentSessionEntityType resource.

Parameter

Name	Description
projectAgentSessionEntityTypeName	`string` A fully-qualified path representing project_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the session.

matchSessionFromProjectAgentSessionName(projectAgentSessionName)

matchSessionFromProjectAgentSessionName(projectAgentSessionName: string): string | number;

Parse the session from ProjectAgentSession resource.

Parameter

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

Returns

Type	Description
string \| number	{string} A string representing the session.

matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the user from ProjectAgentEnvironmentUserSessionContext resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionContextName	`string` A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns

Type	Description
string \| number	{string} A string representing the user.

matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionEntityTypeName	`string` A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the user.

matchUserFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName)

matchUserFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName: string): string | number;

Parse the user from ProjectAgentEnvironmentUserSession resource.

Parameter

Name	Description
projectAgentEnvironmentUserSessionName	`string` A fully-qualified path representing project_agent_environment_user_session resource.

Returns

Type	Description
string \| number	{string} A string representing the user.

projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context)

projectAgentEnvironmentUserSessionContextPath(project: string, environment: string, user: string, session: string, context: string): string;

Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.

Parameters

Name	Description
project	`string`
environment	`string`
user	`string`
session	`string`
context	`string`

Returns

Type	Description
string	{string} Resource name string.

projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entityType)

projectAgentEnvironmentUserSessionEntityTypePath(project: string, environment: string, user: string, session: string, entityType: string): string;

Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.

Parameters

Name	Description
project	`string`
environment	`string`
user	`string`
session	`string`
entityType	`string`

Returns

Type	Description
string	{string} Resource name string.

projectAgentEnvironmentUserSessionPath(project, environment, user, session)

projectAgentEnvironmentUserSessionPath(project: string, environment: string, user: string, session: string): string;

Return a fully-qualified projectAgentEnvironmentUserSession resource name string.

Parameters

Name	Description
project	`string`
environment	`string`
user	`string`
session	`string`

Returns

Type	Description
string	{string} Resource name string.

projectAgentSessionContextPath(project, session, context)

projectAgentSessionContextPath(project: string, session: string, context: string): string;

Return a fully-qualified projectAgentSessionContext resource name string.

Parameters

Name	Description
project	`string`
session	`string`
context	`string`

Returns

Type	Description
string	{string} Resource name string.

projectAgentSessionEntityTypePath(project, session, entityType)

projectAgentSessionEntityTypePath(project: string, session: string, entityType: string): string;

Return a fully-qualified projectAgentSessionEntityType resource name string.

Parameters

Name	Description
project	`string`
session	`string`
entityType	`string`

Returns

Type	Description
string	{string} Resource name string.

projectAgentSessionPath(project, session)

projectAgentSessionPath(project: string, session: string): string;

Return a fully-qualified projectAgentSession resource name string.

Parameters

Name	Description
project	`string`
session	`string`

Returns

Type	Description
string	{string} Resource name string.

streamingDetectIntent(options)

streamingDetectIntent(options?: CallOptions): gax.CancellableStream;

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).

Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

Parameter

Name	Description
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

gax.CancellableStream

{Stream} An object stream which is both readable and writable. It accepts objects representing [StreamingDetectIntentRequest] for write() method, and will emit objects representing [StreamingDetectIntentResponse] on 'data' event asynchronously. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming) for more details and examples.