SessionsClient

SessionsClient

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

Constructor

new SessionsClient(optionsopt, gaxInstanceopt)

Construct an instance of SessionsClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

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.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new SessionsClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

agentGenerativeSettingsPath(project, location, agent) → {string}

Return a fully-qualified agentGenerativeSettings resource name string.

Parameters:
Name Type Description
project string
location string
agent string
Returns:
Type Description
string

Resource name string.

agentPath(project, location, agent) → {string}

Return a fully-qualified agent resource name string.

Parameters:
Name Type Description
project string
location string
agent string
Returns:
Type Description
string

Resource name string.

agentValidationResultPath(project, location, agent) → {string}

Return a fully-qualified agentValidationResult resource name string.

Parameters:
Name Type Description
project string
location string
agent string
Returns:
Type Description
string

Resource name string.

changelogPath(project, location, agent, changelog) → {string}

Return a fully-qualified changelog resource name string.

Parameters:
Name Type Description
project string
location string
agent string
changelog string
Returns:
Type Description
string

Resource name string.

close() → {Promise}

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

A promise that resolves when the client is closed.

continuousTestResultPath(project, location, agent, environment, continuous_test_result) → {string}

Return a fully-qualified continuousTestResult resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
continuous_test_result string
Returns:
Type Description
string

Resource name string.

deploymentPath(project, location, agent, environment, deployment) → {string}

Return a fully-qualified deployment resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
deployment string
Returns:
Type Description
string

Resource name string.

entityTypePath(project, location, agent, entity_type) → {string}

Return a fully-qualified entityType resource name string.

Parameters:
Name Type Description
project string
location string
agent string
entity_type string
Returns:
Type Description
string

Resource name string.

environmentPath(project, location, agent, environment) → {string}

Return a fully-qualified environment resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
Returns:
Type Description
string

Resource name string.

examplePath(project, location, agent, playbook, example) → {string}

Return a fully-qualified example resource name string.

Parameters:
Name Type Description
project string
location string
agent string
playbook string
example string
Returns:
Type Description
string

Resource name string.

experimentPath(project, location, agent, environment, experiment) → {string}

Return a fully-qualified experiment resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
experiment string
Returns:
Type Description
string

Resource name string.

flowPath(project, location, agent, flow) → {string}

Return a fully-qualified flow resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
Returns:
Type Description
string

Resource name string.

flowValidationResultPath(project, location, agent, flow) → {string}

Return a fully-qualified flowValidationResult resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
Returns:
Type Description
string

Resource name string.

generatorPath(project, location, agent, generator) → {string}

Return a fully-qualified generator resource name string.

Parameters:
Name Type Description
project string
location string
agent string
generator string
Returns:
Type Description
string

Resource name string.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the 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.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

intentPath(project, location, agent, intent) → {string}

Return a fully-qualified intent resource name string.

Parameters:
Name Type Description
project string
location string
agent string
intent string
Returns:
Type Description
string

Resource name string.

listLocationsAsync(request, optionsopt) → {Object}

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName) → {string}

Parse the agent from AgentGenerativeSettings resource.

Parameters:
Name Type Description
agentGenerativeSettingsName string

A fully-qualified path representing AgentGenerativeSettings resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromAgentName(agentName) → {string}

Parse the agent from Agent resource.

Parameters:
Name Type Description
agentName string

A fully-qualified path representing Agent resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromAgentValidationResultName(agentValidationResultName) → {string}

Parse the agent from AgentValidationResult resource.

Parameters:
Name Type Description
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromChangelogName(changelogName) → {string}

Parse the agent from Changelog resource.

Parameters:
Name Type Description
changelogName string

A fully-qualified path representing Changelog resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the agent from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromDeploymentName(deploymentName) → {string}

Parse the agent from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromEntityTypeName(entityTypeName) → {string}

Parse the agent from EntityType resource.

Parameters:
Name Type Description
entityTypeName string

A fully-qualified path representing EntityType resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromEnvironmentName(environmentName) → {string}

Parse the agent from Environment resource.

Parameters:
Name Type Description
environmentName string

A fully-qualified path representing Environment resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromExampleName(exampleName) → {string}

Parse the agent from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromExperimentName(experimentName) → {string}

Parse the agent from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromFlowName(flowName) → {string}

Parse the agent from Flow resource.

Parameters:
Name Type Description
flowName string

A fully-qualified path representing Flow resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromFlowValidationResultName(flowValidationResultName) → {string}

Parse the agent from FlowValidationResult resource.

Parameters:
Name Type Description
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromGeneratorName(generatorName) → {string}

Parse the agent from Generator resource.

Parameters:
Name Type Description
generatorName string

A fully-qualified path representing Generator resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromIntentName(intentName) → {string}

Parse the agent from Intent resource.

Parameters:
Name Type Description
intentName string

A fully-qualified path representing Intent resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromPageName(pageName) → {string}

Parse the agent from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromPlaybookName(playbookName) → {string}

Parse the agent from Playbook resource.

Parameters:
Name Type Description
playbookName string

A fully-qualified path representing Playbook resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromPlaybookVersionName(playbookVersionName) → {string}

Parse the agent from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName) → {string}

Parse the agent from ProjectLocationAgentEnvironmentSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionName string

A fully-qualified path representing project_location_agent_environment_session resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the agent from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the agent from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentSessionName(projectLocationAgentSessionName) → {string}

Parse the agent from ProjectLocationAgentSession resource.

Parameters:
Name Type Description
projectLocationAgentSessionName string

A fully-qualified path representing project_location_agent_session resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName) → {string}

Parse the agent from ProjectLocationAgentTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_transition_route_group resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromTestCaseName(testCaseName) → {string}

Parse the agent from TestCase resource.

Parameters:
Name Type Description
testCaseName string

A fully-qualified path representing TestCase resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromTestCaseResultName(testCaseResultName) → {string}

Parse the agent from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromToolName(toolName) → {string}

Parse the agent from Tool resource.

Parameters:
Name Type Description
toolName string

A fully-qualified path representing Tool resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromVersionName(versionName) → {string}

Parse the agent from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromWebhookName(webhookName) → {string}

Parse the agent from Webhook resource.

Parameters:
Name Type Description
webhookName string

A fully-qualified path representing Webhook resource.
Returns:
Type Description
string

A string representing the agent.

matchChangelogFromChangelogName(changelogName) → {string}

Parse the changelog from Changelog resource.

Parameters:
Name Type Description
changelogName string

A fully-qualified path representing Changelog resource.
Returns:
Type Description
string

A string representing the changelog.

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) → {string}

Parse the collection from ProjectLocationCollectionDataStore resource.

Parameters:
Name Type Description
projectLocationCollectionDataStoreName string

A fully-qualified path representing project_location_collection_data_store resource.
Returns:
Type Description
string

A string representing the collection.

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the continuous_test_result from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the continuous_test_result.

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) → {string}

Parse the data_store from ProjectLocationCollectionDataStore resource.

Parameters:
Name Type Description
projectLocationCollectionDataStoreName string

A fully-qualified path representing project_location_collection_data_store resource.
Returns:
Type Description
string

A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName) → {string}

Parse the data_store from ProjectLocationDataStore resource.

Parameters:
Name Type Description
projectLocationDataStoreName string

A fully-qualified path representing project_location_data_store resource.
Returns:
Type Description
string

A string representing the data_store.

matchDeploymentFromDeploymentName(deploymentName) → {string}

Parse the deployment from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the deployment.

matchEntityTypeFromEntityTypeName(entityTypeName) → {string}

Parse the entity_type from EntityType resource.

Parameters:
Name Type Description
entityTypeName string

A fully-qualified path representing EntityType resource.
Returns:
Type Description
string

A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the entity_type from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the entity_type from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the entity_type.

matchEnvironmentFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the environment from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the environment.

matchEnvironmentFromDeploymentName(deploymentName) → {string}

Parse the environment from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the environment.

matchEnvironmentFromEnvironmentName(environmentName) → {string}

Parse the environment from Environment resource.

Parameters:
Name Type Description
environmentName string

A fully-qualified path representing Environment resource.
Returns:
Type Description
string

A string representing the environment.

matchEnvironmentFromExperimentName(experimentName) → {string}

Parse the environment from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName) → {string}

Parse the environment from ProjectLocationAgentEnvironmentSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionName string

A fully-qualified path representing project_location_agent_environment_session resource.
Returns:
Type Description
string

A string representing the environment.

matchExampleFromExampleName(exampleName) → {string}

Parse the example from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the example.

matchExperimentFromExperimentName(experimentName) → {string}

Parse the experiment from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the experiment.

matchFlowFromFlowName(flowName) → {string}

Parse the flow from Flow resource.

Parameters:
Name Type Description
flowName string

A fully-qualified path representing Flow resource.
Returns:
Type Description
string

A string representing the flow.

matchFlowFromFlowValidationResultName(flowValidationResultName) → {string}

Parse the flow from FlowValidationResult resource.

Parameters:
Name Type Description
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.
Returns:
Type Description
string

A string representing the flow.

matchFlowFromPageName(pageName) → {string}

Parse the flow from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the flow.

matchFlowFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the flow from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the flow.

matchFlowFromVersionName(versionName) → {string}

Parse the flow from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the flow.

matchGeneratorFromGeneratorName(generatorName) → {string}

Parse the generator from Generator resource.

Parameters:
Name Type Description
generatorName string

A fully-qualified path representing Generator resource.
Returns:
Type Description
string

A string representing the generator.

matchIntentFromIntentName(intentName) → {string}

Parse the intent from Intent resource.

Parameters:
Name Type Description
intentName string

A fully-qualified path representing Intent resource.
Returns:
Type Description
string

A string representing the intent.

matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName) → {string}

Parse the location from AgentGenerativeSettings resource.

Parameters:
Name Type Description
agentGenerativeSettingsName string

A fully-qualified path representing AgentGenerativeSettings resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromAgentName(agentName) → {string}

Parse the location from Agent resource.

Parameters:
Name Type Description
agentName string

A fully-qualified path representing Agent resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromAgentValidationResultName(agentValidationResultName) → {string}

Parse the location from AgentValidationResult resource.

Parameters:
Name Type Description
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromChangelogName(changelogName) → {string}

Parse the location from Changelog resource.

Parameters:
Name Type Description
changelogName string

A fully-qualified path representing Changelog resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the location from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromDeploymentName(deploymentName) → {string}

Parse the location from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromEntityTypeName(entityTypeName) → {string}

Parse the location from EntityType resource.

Parameters:
Name Type Description
entityTypeName string

A fully-qualified path representing EntityType resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromEnvironmentName(environmentName) → {string}

Parse the location from Environment resource.

Parameters:
Name Type Description
environmentName string

A fully-qualified path representing Environment resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromExampleName(exampleName) → {string}

Parse the location from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromExperimentName(experimentName) → {string}

Parse the location from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFlowName(flowName) → {string}

Parse the location from Flow resource.

Parameters:
Name Type Description
flowName string

A fully-qualified path representing Flow resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFlowValidationResultName(flowValidationResultName) → {string}

Parse the location from FlowValidationResult resource.

Parameters:
Name Type Description
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromGeneratorName(generatorName) → {string}

Parse the location from Generator resource.

Parameters:
Name Type Description
generatorName string

A fully-qualified path representing Generator resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromIntentName(intentName) → {string}

Parse the location from Intent resource.

Parameters:
Name Type Description
intentName string

A fully-qualified path representing Intent resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromPageName(pageName) → {string}

Parse the location from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromPlaybookName(playbookName) → {string}

Parse the location from Playbook resource.

Parameters:
Name Type Description
playbookName string

A fully-qualified path representing Playbook resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromPlaybookVersionName(playbookVersionName) → {string}

Parse the location from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName) → {string}

Parse the location from ProjectLocationAgentEnvironmentSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionName string

A fully-qualified path representing project_location_agent_environment_session resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the location from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the location.

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.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName) → {string}

Parse the location from ProjectLocationAgentTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_transition_route_group resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) → {string}

Parse the location from ProjectLocationCollectionDataStore resource.

Parameters:
Name Type Description
projectLocationCollectionDataStoreName string

A fully-qualified path representing project_location_collection_data_store resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName) → {string}

Parse the location from ProjectLocationDataStore resource.

Parameters:
Name Type Description
projectLocationDataStoreName string

A fully-qualified path representing project_location_data_store resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromSecuritySettingsName(securitySettingsName) → {string}

Parse the location from SecuritySettings resource.

Parameters:
Name Type Description
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTestCaseName(testCaseName) → {string}

Parse the location from TestCase resource.

Parameters:
Name Type Description
testCaseName string

A fully-qualified path representing TestCase resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTestCaseResultName(testCaseResultName) → {string}

Parse the location from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromToolName(toolName) → {string}

Parse the location from Tool resource.

Parameters:
Name Type Description
toolName string

A fully-qualified path representing Tool resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromVersionName(versionName) → {string}

Parse the location from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromWebhookName(webhookName) → {string}

Parse the location from Webhook resource.

Parameters:
Name Type Description
webhookName string

A fully-qualified path representing Webhook resource.
Returns:
Type Description
string

A string representing the location.

matchPageFromPageName(pageName) → {string}

Parse the page from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the page.

matchPlaybookFromExampleName(exampleName) → {string}

Parse the playbook from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the playbook.

matchPlaybookFromPlaybookName(playbookName) → {string}

Parse the playbook from Playbook resource.

Parameters:
Name Type Description
playbookName string

A fully-qualified path representing Playbook resource.
Returns:
Type Description
string

A string representing the playbook.

matchPlaybookFromPlaybookVersionName(playbookVersionName) → {string}

Parse the playbook from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the playbook.

matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName) → {string}

Parse the project from AgentGenerativeSettings resource.

Parameters:
Name Type Description
agentGenerativeSettingsName string

A fully-qualified path representing AgentGenerativeSettings resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromAgentName(agentName) → {string}

Parse the project from Agent resource.

Parameters:
Name Type Description
agentName string

A fully-qualified path representing Agent resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromAgentValidationResultName(agentValidationResultName) → {string}

Parse the project from AgentValidationResult resource.

Parameters:
Name Type Description
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromChangelogName(changelogName) → {string}

Parse the project from Changelog resource.

Parameters:
Name Type Description
changelogName string

A fully-qualified path representing Changelog resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the project from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromDeploymentName(deploymentName) → {string}

Parse the project from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromEntityTypeName(entityTypeName) → {string}

Parse the project from EntityType resource.

Parameters:
Name Type Description
entityTypeName string

A fully-qualified path representing EntityType resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromEnvironmentName(environmentName) → {string}

Parse the project from Environment resource.

Parameters:
Name Type Description
environmentName string

A fully-qualified path representing Environment resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromExampleName(exampleName) → {string}

Parse the project from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromExperimentName(experimentName) → {string}

Parse the project from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromFlowName(flowName) → {string}

Parse the project from Flow resource.

Parameters:
Name Type Description
flowName string

A fully-qualified path representing Flow resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromFlowValidationResultName(flowValidationResultName) → {string}

Parse the project from FlowValidationResult resource.

Parameters:
Name Type Description
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromGeneratorName(generatorName) → {string}

Parse the project from Generator resource.

Parameters:
Name Type Description
generatorName string

A fully-qualified path representing Generator resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromIntentName(intentName) → {string}

Parse the project from Intent resource.

Parameters:
Name Type Description
intentName string

A fully-qualified path representing Intent resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPageName(pageName) → {string}

Parse the project from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPlaybookName(playbookName) → {string}

Parse the project from Playbook resource.

Parameters:
Name Type Description
playbookName string

A fully-qualified path representing Playbook resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPlaybookVersionName(playbookVersionName) → {string}

Parse the project from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the project from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName) → {string}

Parse the project from ProjectLocationAgentEnvironmentSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionName string

A fully-qualified path representing project_location_agent_environment_session resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the project from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the project from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the project.

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.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName) → {string}

Parse the project from ProjectLocationAgentTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_transition_route_group resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) → {string}

Parse the project from ProjectLocationCollectionDataStore resource.

Parameters:
Name Type Description
projectLocationCollectionDataStoreName string

A fully-qualified path representing project_location_collection_data_store resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName) → {string}

Parse the project from ProjectLocationDataStore resource.

Parameters:
Name Type Description
projectLocationDataStoreName string

A fully-qualified path representing project_location_data_store resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromSecuritySettingsName(securitySettingsName) → {string}

Parse the project from SecuritySettings resource.

Parameters:
Name Type Description
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTestCaseName(testCaseName) → {string}

Parse the project from TestCase resource.

Parameters:
Name Type Description
testCaseName string

A fully-qualified path representing TestCase resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTestCaseResultName(testCaseResultName) → {string}

Parse the project from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromToolName(toolName) → {string}

Parse the project from Tool resource.

Parameters:
Name Type Description
toolName string

A fully-qualified path representing Tool resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromVersionName(versionName) → {string}

Parse the project from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromWebhookName(webhookName) → {string}

Parse the project from Webhook resource.

Parameters:
Name Type Description
webhookName string

A fully-qualified path representing Webhook resource.
Returns:
Type Description
string

A string representing the project.

matchResultFromTestCaseResultName(testCaseResultName) → {string}

Parse the result from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the result.

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName) → {string}

Parse the security_settings from SecuritySettings resource.

Parameters:
Name Type Description
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.
Returns:
Type Description
string

A string representing the security_settings.

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the session from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the session.

matchSessionFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName) → {string}

Parse the session from ProjectLocationAgentEnvironmentSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionName string

A fully-qualified path representing project_location_agent_environment_session resource.
Returns:
Type Description
string

A string representing the session.

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the session from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the session.

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.
Returns:
Type Description
string

A string representing the session.

matchTestCaseFromTestCaseName(testCaseName) → {string}

Parse the test_case from TestCase resource.

Parameters:
Name Type Description
testCaseName string

A fully-qualified path representing TestCase resource.
Returns:
Type Description
string

A string representing the test_case.

matchTestCaseFromTestCaseResultName(testCaseResultName) → {string}

Parse the test_case from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the test_case.

matchToolFromToolName(toolName) → {string}

Parse the tool from Tool resource.

Parameters:
Name Type Description
toolName string

A fully-qualified path representing Tool resource.
Returns:
Type Description
string

A string representing the tool.

matchTransitionRouteGroupFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the transition_route_group from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the transition_route_group.

matchTransitionRouteGroupFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName) → {string}

Parse the transition_route_group from ProjectLocationAgentTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_transition_route_group resource.
Returns:
Type Description
string

A string representing the transition_route_group.

matchVersionFromPlaybookVersionName(playbookVersionName) → {string}

Parse the version from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the version.

matchVersionFromVersionName(versionName) → {string}

Parse the version from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the version.

matchWebhookFromWebhookName(webhookName) → {string}

Parse the webhook from Webhook resource.

Parameters:
Name Type Description
webhookName string

A fully-qualified path representing Webhook resource.
Returns:
Type Description
string

A string representing the webhook.

pagePath(project, location, agent, flow, page) → {string}

Return a fully-qualified page resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
page string
Returns:
Type Description
string

Resource name string.

playbookPath(project, location, agent, playbook) → {string}

Return a fully-qualified playbook resource name string.

Parameters:
Name Type Description
project string
location string
agent string
playbook string
Returns:
Type Description
string

Resource name string.

playbookVersionPath(project, location, agent, playbook, version) → {string}

Return a fully-qualified playbookVersion resource name string.

Parameters:
Name Type Description
project string
location string
agent string
playbook string
version string
Returns:
Type Description
string

Resource name string.

projectLocationAgentEnvironmentSessionEntityTypePath(project, location, agent, environment, session, entity_type) → {string}

Return a fully-qualified projectLocationAgentEnvironmentSessionEntityType resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
session string
entity_type string
Returns:
Type Description
string

Resource name string.

projectLocationAgentEnvironmentSessionPath(project, location, agent, environment, session) → {string}

Return a fully-qualified projectLocationAgentEnvironmentSession resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
session string
Returns:
Type Description
string

Resource name string.

projectLocationAgentFlowTransitionRouteGroupPath(project, location, agent, flow, transition_route_group) → {string}

Return a fully-qualified projectLocationAgentFlowTransitionRouteGroup resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
transition_route_group string
Returns:
Type Description
string

Resource name string.

projectLocationAgentSessionEntityTypePath(project, location, agent, session, entity_type) → {string}

Return a fully-qualified projectLocationAgentSessionEntityType resource name string.

Parameters:
Name Type Description
project string
location string
agent string
session string
entity_type string
Returns:
Type Description
string

Resource name string.

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

Return a fully-qualified projectLocationAgentSession resource name string.

Parameters:
Name Type Description
project string
location string
agent string
session string
Returns:
Type Description
string

Resource name string.

projectLocationAgentTransitionRouteGroupPath(project, location, agent, transition_route_group) → {string}

Return a fully-qualified projectLocationAgentTransitionRouteGroup resource name string.

Parameters:
Name Type Description
project string
location string
agent string
transition_route_group string
Returns:
Type Description
string

Resource name string.

projectLocationCollectionDataStorePath(project, location, collection, data_store) → {string}

Return a fully-qualified projectLocationCollectionDataStore resource name string.

Parameters:
Name Type Description
project string
location string
collection string
data_store string
Returns:
Type Description
string

Resource name string.

projectLocationDataStorePath(project, location, data_store) → {string}

Return a fully-qualified projectLocationDataStore resource name string.

Parameters:
Name Type Description
project string
location string
data_store string
Returns:
Type Description
string

Resource name string.

securitySettingsPath(project, location, security_settings) → {string}

Return a fully-qualified securitySettings resource name string.

Parameters:
Name Type Description
project string
location string
security_settings string
Returns:
Type Description
string

Resource name string.

serverStreamingDetectIntent(request, optionsopt) → {Stream}

Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.

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>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters.

For more information, see the sessions guide.

Note: Always use agent versions for production traffic. See Versions and environments.
queryParams google.cloud.dialogflow.cx.v3beta1.QueryParameters

The parameters of this query.
queryInput google.cloud.dialogflow.cx.v3beta1.QueryInput

Required. The input specification.
outputAudioConfig google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig

Instructs the speech synthesizer how to generate the output audio.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits DetectIntentResponse on 'data' event. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the session this query is sent to.
   *  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   *  ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
   *  ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
   *  If `Environment ID` is not specified, we assume default 'draft'
   *  environment.
   *  It's up to the API caller to choose an appropriate `Session ID`. It can be
   *  a random number or some type of session identifiers (preferably hashed).
   *  The length of the `Session ID` must not exceed 36 characters.
   *  For more information, see the sessions
   *  guide (https://cloud.google.com/dialogflow/cx/docs/concept/session).
   *  Note: Always use agent versions for production traffic.
   *  See Versions and
   *  environments (https://cloud.google.com/dialogflow/cx/docs/concept/version).
   */
  // const session = 'abc123'
  /**
   *  The parameters of this query.
   */
  // const queryParams = {}
  /**
   *  Required. The input specification.
   */
  // const queryInput = {}
  /**
   *  Instructs the speech synthesizer how to generate the output audio.
   */
  // const outputAudioConfig = {}

  // Imports the Cx library
  const {SessionsClient} = require('@google-cloud/dialogflow-cx').v3beta1;

  // Instantiates a client
  const cxClient = new SessionsClient();

  async function callServerStreamingDetectIntent() {
    // Construct request
    const request = {
      session,
      queryInput,
    };

    // Run request
    const stream = await cxClient.serverStreamingDetectIntent(request);
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
  }

  callServerStreamingDetectIntent();

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

Note: Always use agent versions for production traffic. See Versions and environments.

Parameters:
Name Type Attributes Description
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The name of the session this query is sent to.
   *  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   *  ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
   *  ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
   *  If `Environment ID` is not specified, we assume default 'draft'
   *  environment.
   *  It's up to the API caller to choose an appropriate `Session ID`. It can be
   *  a random number or some type of session identifiers (preferably hashed).
   *  The length of the `Session ID` must not exceed 36 characters.
   *  Note: session must be set in the first request.
   *  For more information, see the sessions
   *  guide (https://cloud.google.com/dialogflow/cx/docs/concept/session).
   *  Note: Always use agent versions for production traffic.
   *  See Versions and
   *  environments (https://cloud.google.com/dialogflow/cx/docs/concept/version).
   */
  // const session = 'abc123'
  /**
   *  The parameters of this query.
   */
  // const queryParams = {}
  /**
   *  Required. The input specification.
   */
  // const queryInput = {}
  /**
   *  Instructs the speech synthesizer how to generate the output audio.
   */
  // const outputAudioConfig = {}
  /**
   *  Enable partial detect intent response. If this flag is not enabled,
   *  response stream still contains only one final `DetectIntentResponse` even
   *  if some `Fulfillment`s in the agent have been configured to return partial
   *  responses.
   */
  // const enablePartialResponse = true
  /**
   *  If true, `StreamingDetectIntentResponse.debugging_info` will get populated.
   */
  // const enableDebuggingInfo = true

  // Imports the Cx library
  const {SessionsClient} = require('@google-cloud/dialogflow-cx').v3beta1;

  // Instantiates a client
  const cxClient = new SessionsClient();

  async function callStreamingDetectIntent() {
    // Construct request
    const request = {
      queryInput,
    };

    // Run request
    const stream = await cxClient.streamingDetectIntent();
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
    stream.write(request);
    stream.end();
  }

  callStreamingDetectIntent();

testCasePath(project, location, agent, test_case) → {string}

Return a fully-qualified testCase resource name string.

Parameters:
Name Type Description
project string
location string
agent string
test_case string
Returns:
Type Description
string

Resource name string.

testCaseResultPath(project, location, agent, test_case, result) → {string}

Return a fully-qualified testCaseResult resource name string.

Parameters:
Name Type Description
project string
location string
agent string
test_case string
result string
Returns:
Type Description
string

Resource name string.

toolPath(project, location, agent, tool) → {string}

Return a fully-qualified tool resource name string.

Parameters:
Name Type Description
project string
location string
agent string
tool string
Returns:
Type Description
string

Resource name string.

versionPath(project, location, agent, flow, version) → {string}

Return a fully-qualified version resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
version string
Returns:
Type Description
string

Resource name string.

webhookPath(project, location, agent, webhook) → {string}

Return a fully-qualified webhook resource name string.

Parameters:
Name Type Description
project string
location string
agent string
webhook string
Returns:
Type Description
string

Resource name string.