Package com.google.cloud.dialogflow.cx.v3beta1 (0.25.0)

A client to Dialogflow API

The interfaces provided are listed below, along with usage samples.

AgentsClient

Service Description: Service for managing Agents.

Sample for AgentsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AgentsClient agentsClient = AgentsClient.create()) {
   AgentName name = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   Agent response = agentsClient.getAgent(name);
 }

ChangelogsClient

Service Description: Service for managing Changelogs.

Sample for ChangelogsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ChangelogName name = ChangelogName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]");
   Changelog response = changelogsClient.getChangelog(name);
 }

DeploymentsClient

Service Description: Service for managing Deployments.

Sample for DeploymentsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
   DeploymentName name =
       DeploymentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[DEPLOYMENT]");
   Deployment response = deploymentsClient.getDeployment(name);
 }

EntityTypesClient

Service Description: Service for managing EntityTypes.

Sample for EntityTypesClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]");
   EntityType response = entityTypesClient.getEntityType(name);
 }

EnvironmentsClient

Service Description: Service for managing Environments.

Sample for EnvironmentsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   EnvironmentName name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
   Environment response = environmentsClient.getEnvironment(name);
 }

ExperimentsClient

Service Description: Service for managing Experiments.

Sample for ExperimentsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
   ExperimentName name =
       ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]");
   Experiment response = experimentsClient.getExperiment(name);
 }

FlowsClient

Service Description: Service for managing Flows.

Sample for FlowsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FlowsClient flowsClient = FlowsClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   Flow flow = Flow.newBuilder().build();
   Flow response = flowsClient.createFlow(parent, flow);
 }

IntentsClient

Service Description: Service for managing Intents.

Sample for IntentsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (IntentsClient intentsClient = IntentsClient.create()) {
   IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]");
   Intent response = intentsClient.getIntent(name);
 }

PagesClient

Service Description: Service for managing Pages.

Sample for PagesClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PagesClient pagesClient = PagesClient.create()) {
   PageName name = PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]");
   Page response = pagesClient.getPage(name);
 }

SecuritySettingsServiceClient

Service Description: Service for managing security settings for Dialogflow.

Sample for SecuritySettingsServiceClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
   SecuritySettings response =
       securitySettingsServiceClient.createSecuritySettings(parent, securitySettings);
 }

SessionsClient

Service Description: 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.

Sample for SessionsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SessionsClient sessionsClient = SessionsClient.create()) {
   DetectIntentRequest request =
       DetectIntentRequest.newBuilder()
           .setSession(
               SessionName.ofProjectLocationAgentSessionName(
                       "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
                   .toString())
           .setQueryParams(QueryParameters.newBuilder().build())
           .setQueryInput(QueryInput.newBuilder().build())
           .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
           .build();
   DetectIntentResponse response = sessionsClient.detectIntent(request);
 }

SessionEntityTypesClient

Service Description: Service for managing SessionEntityTypes.

Sample for SessionEntityTypesClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityTypeName name =
       SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
           "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
   SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name);
 }

TestCasesClient

Service Description: Service for managing Test Cases and Test Case Results.

Sample for TestCasesClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TestCasesClient testCasesClient = TestCasesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   testCasesClient.batchDeleteTestCases(parent);
 }

TransitionRouteGroupsClient

Service Description: Service for managing TransitionRouteGroups.

Sample for TransitionRouteGroupsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   TransitionRouteGroupName name =
       TransitionRouteGroupName.of(
           "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]");
   TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name);
 }

VersionsClient

Service Description: Service for managing Versions.

Sample for VersionsClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VersionsClient versionsClient = VersionsClient.create()) {
   VersionName name =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]");
   Version response = versionsClient.getVersion(name);
 }

WebhooksClient

Service Description: Service for managing Webhooks.

Sample for WebhooksClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WebhooksClient webhooksClient = WebhooksClient.create()) {
   WebhookName name = WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
   Webhook response = webhooksClient.getWebhook(name);
 }

Classes

AdvancedSettings

Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.

Protobuf type google.cloud.dialogflow.cx.v3beta1.AdvancedSettings

AdvancedSettings.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.AdvancedSettings

AdvancedSettings.LoggingSettings

Define behaviors on logging.

Protobuf type google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.LoggingSettings

AdvancedSettings.LoggingSettings.Builder

Define behaviors on logging.

Protobuf type google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.LoggingSettings

AdvancedSettingsProto

Agent

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..

Protobuf type google.cloud.dialogflow.cx.v3beta1.Agent

Agent.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.Agent

AgentName

AgentName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}.

AgentProto

AgentValidationResult

The response message for Agents.GetAgentValidationResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.AgentValidationResult

AgentValidationResult.Builder

The response message for Agents.GetAgentValidationResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.AgentValidationResult

AgentValidationResultName

AgentValidationResultName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/validationResult.

AgentsClient

Service Description: Service for managing Agents.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AgentsClient agentsClient = AgentsClient.create()) {
   AgentName name = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   Agent response = agentsClient.getAgent(name);
 }

Note: close() needs to be called on the AgentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AgentsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AgentsSettings agentsSettings =
     AgentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AgentsClient agentsClient = AgentsClient.create(agentsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AgentsSettings agentsSettings = AgentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 AgentsClient agentsClient = AgentsClient.create(agentsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AgentsSettings agentsSettings = AgentsSettings.newHttpJsonBuilder().build();
 AgentsClient agentsClient = AgentsClient.create(agentsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

AgentsClient.ListAgentsFixedSizeCollection

AgentsClient.ListAgentsPage

AgentsClient.ListAgentsPagedResponse

AgentsClient.ListLocationsFixedSizeCollection

AgentsClient.ListLocationsPage

AgentsClient.ListLocationsPagedResponse

AgentsGrpc

Service for managing Agents.

AgentsGrpc.AgentsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Agents.

Service for managing Agents.

AgentsGrpc.AgentsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Agents.

Service for managing Agents.

AgentsGrpc.AgentsImplBase

Base class for the server implementation of the service Agents.

Service for managing Agents.

AgentsGrpc.AgentsStub

A stub to allow clients to do asynchronous rpc calls to service Agents.

Service for managing Agents.

AgentsSettings

Settings class to configure an instance of AgentsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getAgent to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AgentsSettings.Builder agentsSettingsBuilder = AgentsSettings.newBuilder();
 agentsSettingsBuilder
     .getAgentSettings()
     .setRetrySettings(
         agentsSettingsBuilder
             .getAgentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AgentsSettings agentsSettings = agentsSettingsBuilder.build();

AgentsSettings.Builder

Builder for AgentsSettings.

AudioConfigProto

AudioInput

Represents the natural speech audio to be processed.

Protobuf type google.cloud.dialogflow.cx.v3beta1.AudioInput

AudioInput.Builder

Represents the natural speech audio to be processed.

Protobuf type google.cloud.dialogflow.cx.v3beta1.AudioInput

BatchDeleteTestCasesRequest

The request message for TestCases.BatchDeleteTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.BatchDeleteTestCasesRequest

BatchDeleteTestCasesRequest.Builder

The request message for TestCases.BatchDeleteTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.BatchDeleteTestCasesRequest

BatchRunTestCasesMetadata

Metadata returned for the TestCases.BatchRunTestCases long running operation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.BatchRunTestCasesMetadata

BatchRunTestCasesMetadata.Builder

Metadata returned for the TestCases.BatchRunTestCases long running operation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.BatchRunTestCasesMetadata

BatchRunTestCasesRequest

The request message for TestCases.BatchRunTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.BatchRunTestCasesRequest

BatchRunTestCasesRequest.Builder

The request message for TestCases.BatchRunTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.BatchRunTestCasesRequest

BatchRunTestCasesResponse

The response message for TestCases.BatchRunTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.BatchRunTestCasesResponse

BatchRunTestCasesResponse.Builder

The response message for TestCases.BatchRunTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.BatchRunTestCasesResponse

CalculateCoverageRequest

The request message for TestCases.CalculateCoverage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CalculateCoverageRequest

CalculateCoverageRequest.Builder

The request message for TestCases.CalculateCoverage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CalculateCoverageRequest

CalculateCoverageResponse

The response message for TestCases.CalculateCoverage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CalculateCoverageResponse

CalculateCoverageResponse.Builder

The response message for TestCases.CalculateCoverage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CalculateCoverageResponse

Changelog

Changelogs represents a change made to a given agent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Changelog

Changelog.Builder

Changelogs represents a change made to a given agent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Changelog

ChangelogName

ChangelogName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/changelogs/{changelog}.

ChangelogProto

ChangelogsClient

Service Description: Service for managing Changelogs.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ChangelogName name = ChangelogName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]");
   Changelog response = changelogsClient.getChangelog(name);
 }

Note: close() needs to be called on the ChangelogsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of ChangelogsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ChangelogsSettings changelogsSettings =
     ChangelogsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ChangelogsClient changelogsClient = ChangelogsClient.create(changelogsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ChangelogsSettings changelogsSettings =
     ChangelogsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ChangelogsClient changelogsClient = ChangelogsClient.create(changelogsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ChangelogsSettings changelogsSettings = ChangelogsSettings.newHttpJsonBuilder().build();
 ChangelogsClient changelogsClient = ChangelogsClient.create(changelogsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

ChangelogsClient.ListChangelogsFixedSizeCollection

ChangelogsClient.ListChangelogsPage

ChangelogsClient.ListChangelogsPagedResponse

ChangelogsClient.ListLocationsFixedSizeCollection

ChangelogsClient.ListLocationsPage

ChangelogsClient.ListLocationsPagedResponse

ChangelogsGrpc

Service for managing Changelogs.

ChangelogsGrpc.ChangelogsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Changelogs.

Service for managing Changelogs.

ChangelogsGrpc.ChangelogsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Changelogs.

Service for managing Changelogs.

ChangelogsGrpc.ChangelogsImplBase

Base class for the server implementation of the service Changelogs.

Service for managing Changelogs.

ChangelogsGrpc.ChangelogsStub

A stub to allow clients to do asynchronous rpc calls to service Changelogs.

Service for managing Changelogs.

ChangelogsSettings

Settings class to configure an instance of ChangelogsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getChangelog to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ChangelogsSettings.Builder changelogsSettingsBuilder = ChangelogsSettings.newBuilder();
 changelogsSettingsBuilder
     .getChangelogSettings()
     .setRetrySettings(
         changelogsSettingsBuilder
             .getChangelogSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ChangelogsSettings changelogsSettings = changelogsSettingsBuilder.build();

ChangelogsSettings.Builder

Builder for ChangelogsSettings.

CompareVersionsRequest

The request message for Versions.CompareVersions.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CompareVersionsRequest

CompareVersionsRequest.Builder

The request message for Versions.CompareVersions.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CompareVersionsRequest

CompareVersionsResponse

The response message for Versions.CompareVersions.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CompareVersionsResponse

CompareVersionsResponse.Builder

The response message for Versions.CompareVersions.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CompareVersionsResponse

ContinuousTestResult

Represents a result from running a test case in an agent environment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ContinuousTestResult

ContinuousTestResult.Builder

Represents a result from running a test case in an agent environment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ContinuousTestResult

ContinuousTestResultName

ContinuousTestResultName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/continuousTestResults/{continuous_test_result}.

ConversationTurn

One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ConversationTurn

ConversationTurn.Builder

One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ConversationTurn

ConversationTurn.UserInput

The input from the human user.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ConversationTurn.UserInput

ConversationTurn.UserInput.Builder

The input from the human user.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ConversationTurn.UserInput

ConversationTurn.VirtualAgentOutput

The output from the virtual agent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ConversationTurn.VirtualAgentOutput

ConversationTurn.VirtualAgentOutput.Builder

The output from the virtual agent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ConversationTurn.VirtualAgentOutput

CreateAgentRequest

The request message for Agents.CreateAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateAgentRequest

CreateAgentRequest.Builder

The request message for Agents.CreateAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateAgentRequest

CreateEntityTypeRequest

The request message for EntityTypes.CreateEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateEntityTypeRequest

CreateEntityTypeRequest.Builder

The request message for EntityTypes.CreateEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateEntityTypeRequest

CreateEnvironmentRequest

The request message for Environments.CreateEnvironment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateEnvironmentRequest

CreateEnvironmentRequest.Builder

The request message for Environments.CreateEnvironment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateEnvironmentRequest

CreateExperimentRequest

The request message for Experiments.CreateExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateExperimentRequest

CreateExperimentRequest.Builder

The request message for Experiments.CreateExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateExperimentRequest

CreateFlowRequest

The request message for Flows.CreateFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateFlowRequest

CreateFlowRequest.Builder

The request message for Flows.CreateFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateFlowRequest

CreateIntentRequest

The request message for Intents.CreateIntent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateIntentRequest

CreateIntentRequest.Builder

The request message for Intents.CreateIntent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateIntentRequest

CreatePageRequest

The request message for Pages.CreatePage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreatePageRequest

CreatePageRequest.Builder

The request message for Pages.CreatePage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreatePageRequest

CreateSecuritySettingsRequest

The request message for [SecuritySettings.CreateSecuritySettings][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateSecuritySettingsRequest

CreateSecuritySettingsRequest.Builder

The request message for [SecuritySettings.CreateSecuritySettings][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateSecuritySettingsRequest

CreateSessionEntityTypeRequest

The request message for SessionEntityTypes.CreateSessionEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateSessionEntityTypeRequest

CreateSessionEntityTypeRequest.Builder

The request message for SessionEntityTypes.CreateSessionEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateSessionEntityTypeRequest

CreateTestCaseRequest

The request message for TestCases.CreateTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateTestCaseRequest

CreateTestCaseRequest.Builder

The request message for TestCases.CreateTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateTestCaseRequest

CreateTransitionRouteGroupRequest

The request message for TransitionRouteGroups.CreateTransitionRouteGroup.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateTransitionRouteGroupRequest

CreateTransitionRouteGroupRequest.Builder

The request message for TransitionRouteGroups.CreateTransitionRouteGroup.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateTransitionRouteGroupRequest

CreateVersionOperationMetadata

Metadata associated with the long running operation for Versions.CreateVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateVersionOperationMetadata

CreateVersionOperationMetadata.Builder

Metadata associated with the long running operation for Versions.CreateVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateVersionOperationMetadata

CreateVersionRequest

The request message for Versions.CreateVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateVersionRequest

CreateVersionRequest.Builder

The request message for Versions.CreateVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateVersionRequest

CreateWebhookRequest

The request message for Webhooks.CreateWebhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateWebhookRequest

CreateWebhookRequest.Builder

The request message for Webhooks.CreateWebhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.CreateWebhookRequest

DeleteAgentRequest

The request message for Agents.DeleteAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteAgentRequest

DeleteAgentRequest.Builder

The request message for Agents.DeleteAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteAgentRequest

DeleteEntityTypeRequest

The request message for EntityTypes.DeleteEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteEntityTypeRequest

DeleteEntityTypeRequest.Builder

The request message for EntityTypes.DeleteEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteEntityTypeRequest

DeleteEnvironmentRequest

The request message for Environments.DeleteEnvironment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteEnvironmentRequest

DeleteEnvironmentRequest.Builder

The request message for Environments.DeleteEnvironment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteEnvironmentRequest

DeleteExperimentRequest

The request message for Experiments.DeleteExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteExperimentRequest

DeleteExperimentRequest.Builder

The request message for Experiments.DeleteExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteExperimentRequest

DeleteFlowRequest

The request message for Flows.DeleteFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteFlowRequest

DeleteFlowRequest.Builder

The request message for Flows.DeleteFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteFlowRequest

DeleteIntentRequest

The request message for Intents.DeleteIntent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteIntentRequest

DeleteIntentRequest.Builder

The request message for Intents.DeleteIntent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteIntentRequest

DeletePageRequest

The request message for Pages.DeletePage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeletePageRequest

DeletePageRequest.Builder

The request message for Pages.DeletePage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeletePageRequest

DeleteSecuritySettingsRequest

The request message for [SecuritySettings.DeleteSecuritySettings][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteSecuritySettingsRequest

DeleteSecuritySettingsRequest.Builder

The request message for [SecuritySettings.DeleteSecuritySettings][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteSecuritySettingsRequest

DeleteSessionEntityTypeRequest

The request message for SessionEntityTypes.DeleteSessionEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteSessionEntityTypeRequest

DeleteSessionEntityTypeRequest.Builder

The request message for SessionEntityTypes.DeleteSessionEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteSessionEntityTypeRequest

DeleteTransitionRouteGroupRequest

The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteTransitionRouteGroupRequest

DeleteTransitionRouteGroupRequest.Builder

The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteTransitionRouteGroupRequest

DeleteVersionRequest

The request message for Versions.DeleteVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteVersionRequest

DeleteVersionRequest.Builder

The request message for Versions.DeleteVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteVersionRequest

DeleteWebhookRequest

The request message for Webhooks.DeleteWebhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteWebhookRequest

DeleteWebhookRequest.Builder

The request message for Webhooks.DeleteWebhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeleteWebhookRequest

DeployFlowMetadata

Metadata returned for the Environments.DeployFlow long running operation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeployFlowMetadata

DeployFlowMetadata.Builder

Metadata returned for the Environments.DeployFlow long running operation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeployFlowMetadata

DeployFlowRequest

The request message for Environments.DeployFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeployFlowRequest

DeployFlowRequest.Builder

The request message for Environments.DeployFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeployFlowRequest

DeployFlowResponse

The response message for Environments.DeployFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeployFlowResponse

DeployFlowResponse.Builder

The response message for Environments.DeployFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DeployFlowResponse

Deployment

Represents a deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Deployment

Deployment.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.Deployment

Deployment.Result

Result of the deployment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Deployment.Result

Deployment.Result.Builder

Result of the deployment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Deployment.Result

DeploymentName

DeploymentName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment}.

DeploymentProto

DeploymentsClient

Service Description: Service for managing Deployments.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
   DeploymentName name =
       DeploymentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[DEPLOYMENT]");
   Deployment response = deploymentsClient.getDeployment(name);
 }

Note: close() needs to be called on the DeploymentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of DeploymentsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DeploymentsSettings deploymentsSettings =
     DeploymentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DeploymentsClient deploymentsClient = DeploymentsClient.create(deploymentsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DeploymentsSettings deploymentsSettings =
     DeploymentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 DeploymentsClient deploymentsClient = DeploymentsClient.create(deploymentsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DeploymentsSettings deploymentsSettings = DeploymentsSettings.newHttpJsonBuilder().build();
 DeploymentsClient deploymentsClient = DeploymentsClient.create(deploymentsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DeploymentsClient.ListDeploymentsFixedSizeCollection

DeploymentsClient.ListDeploymentsPage

DeploymentsClient.ListDeploymentsPagedResponse

DeploymentsClient.ListLocationsFixedSizeCollection

DeploymentsClient.ListLocationsPage

DeploymentsClient.ListLocationsPagedResponse

DeploymentsGrpc

Service for managing Deployments.

DeploymentsGrpc.DeploymentsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Deployments.

Service for managing Deployments.

DeploymentsGrpc.DeploymentsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Deployments.

Service for managing Deployments.

DeploymentsGrpc.DeploymentsImplBase

Base class for the server implementation of the service Deployments.

Service for managing Deployments.

DeploymentsGrpc.DeploymentsStub

A stub to allow clients to do asynchronous rpc calls to service Deployments.

Service for managing Deployments.

DeploymentsSettings

Settings class to configure an instance of DeploymentsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getDeployment to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DeploymentsSettings.Builder deploymentsSettingsBuilder = DeploymentsSettings.newBuilder();
 deploymentsSettingsBuilder
     .getDeploymentSettings()
     .setRetrySettings(
         deploymentsSettingsBuilder
             .getDeploymentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DeploymentsSettings deploymentsSettings = deploymentsSettingsBuilder.build();

DeploymentsSettings.Builder

Builder for DeploymentsSettings.

DetectIntentRequest

The request to detect user's intent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DetectIntentRequest

DetectIntentRequest.Builder

The request to detect user's intent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DetectIntentRequest

DetectIntentResponse

The message returned from the DetectIntent method.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse

DetectIntentResponse.Builder

The message returned from the DetectIntent method.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse

DtmfInput

Represents the input for dtmf event.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DtmfInput

DtmfInput.Builder

Represents the input for dtmf event.

Protobuf type google.cloud.dialogflow.cx.v3beta1.DtmfInput

EntityType

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application. When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on. There are three types of entities:

System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the EntityType type.
Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a pizza.sauce entity for red or white pizza sauce, a pizza.cheese entity for the different types of cheese on a pizza, a pizza.topping entity for different toppings, and so on. A custom entity is represented by the EntityType type.
User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the SessionEntityType type. For more information about entity types, see the Dialogflow documentation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EntityType

EntityType.Builder

System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the EntityType type.
Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a pizza.sauce entity for red or white pizza sauce, a pizza.cheese entity for the different types of cheese on a pizza, a pizza.topping entity for different toppings, and so on. A custom entity is represented by the EntityType type.
User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the SessionEntityType type. For more information about entity types, see the Dialogflow documentation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EntityType

EntityType.Entity

An entity entry for an associated entity type.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EntityType.Entity

EntityType.Entity.Builder

An entity entry for an associated entity type.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EntityType.Entity

EntityType.ExcludedPhrase

An excluded entity phrase that should not be matched.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase

EntityType.ExcludedPhrase.Builder

An excluded entity phrase that should not be matched.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase

EntityTypeName

EntityTypeName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/entityTypes/{entity_type}.

EntityTypeProto

EntityTypesClient

Service Description: Service for managing EntityTypes.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]");
   EntityType response = entityTypesClient.getEntityType(name);
 }

Note: close() needs to be called on the EntityTypesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of EntityTypesSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EntityTypesSettings entityTypesSettings =
     EntityTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EntityTypesSettings entityTypesSettings =
     EntityTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EntityTypesSettings entityTypesSettings = EntityTypesSettings.newHttpJsonBuilder().build();
 EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

EntityTypesClient.ListEntityTypesFixedSizeCollection

EntityTypesClient.ListEntityTypesPage

EntityTypesClient.ListEntityTypesPagedResponse

EntityTypesClient.ListLocationsFixedSizeCollection

EntityTypesClient.ListLocationsPage

EntityTypesClient.ListLocationsPagedResponse

EntityTypesGrpc

Service for managing EntityTypes.

EntityTypesGrpc.EntityTypesBlockingStub

A stub to allow clients to do synchronous rpc calls to service EntityTypes.

Service for managing EntityTypes.

EntityTypesGrpc.EntityTypesFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service EntityTypes.

Service for managing EntityTypes.

EntityTypesGrpc.EntityTypesImplBase

Base class for the server implementation of the service EntityTypes.

Service for managing EntityTypes.

EntityTypesGrpc.EntityTypesStub

A stub to allow clients to do asynchronous rpc calls to service EntityTypes.

Service for managing EntityTypes.

EntityTypesSettings

Settings class to configure an instance of EntityTypesClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getEntityType to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EntityTypesSettings.Builder entityTypesSettingsBuilder = EntityTypesSettings.newBuilder();
 entityTypesSettingsBuilder
     .getEntityTypeSettings()
     .setRetrySettings(
         entityTypesSettingsBuilder
             .getEntityTypeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EntityTypesSettings entityTypesSettings = entityTypesSettingsBuilder.build();

EntityTypesSettings.Builder

Builder for EntityTypesSettings.

Environment

Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Environment

Environment.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.Environment

Environment.TestCasesConfig

The configuration for continuous tests.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Environment.TestCasesConfig

Environment.TestCasesConfig.Builder

The configuration for continuous tests.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Environment.TestCasesConfig

Environment.VersionConfig

Configuration for the version.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Environment.VersionConfig

Environment.VersionConfig.Builder

Configuration for the version.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Environment.VersionConfig

Environment.WebhookConfig

Configuration for webhooks.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Environment.WebhookConfig

Environment.WebhookConfig.Builder

Configuration for webhooks.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Environment.WebhookConfig

EnvironmentName

EnvironmentName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

EnvironmentProto

EnvironmentsClient

Service Description: Service for managing Environments.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   EnvironmentName name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
   Environment response = environmentsClient.getEnvironment(name);
 }

Note: close() needs to be called on the EnvironmentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of EnvironmentsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EnvironmentsSettings environmentsSettings =
     EnvironmentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EnvironmentsSettings environmentsSettings =
     EnvironmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EnvironmentsSettings environmentsSettings = EnvironmentsSettings.newHttpJsonBuilder().build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

EnvironmentsClient.ListContinuousTestResultsFixedSizeCollection

EnvironmentsClient.ListContinuousTestResultsPage

EnvironmentsClient.ListContinuousTestResultsPagedResponse

EnvironmentsClient.ListEnvironmentsFixedSizeCollection

EnvironmentsClient.ListEnvironmentsPage

EnvironmentsClient.ListEnvironmentsPagedResponse

EnvironmentsClient.ListLocationsFixedSizeCollection

EnvironmentsClient.ListLocationsPage

EnvironmentsClient.ListLocationsPagedResponse

EnvironmentsClient.LookupEnvironmentHistoryFixedSizeCollection

EnvironmentsClient.LookupEnvironmentHistoryPage

EnvironmentsClient.LookupEnvironmentHistoryPagedResponse

EnvironmentsGrpc

Service for managing Environments.

EnvironmentsGrpc.EnvironmentsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Environments.

Service for managing Environments.

EnvironmentsGrpc.EnvironmentsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Environments.

Service for managing Environments.

EnvironmentsGrpc.EnvironmentsImplBase

Base class for the server implementation of the service Environments.

Service for managing Environments.

EnvironmentsGrpc.EnvironmentsStub

A stub to allow clients to do asynchronous rpc calls to service Environments.

Service for managing Environments.

EnvironmentsSettings

Settings class to configure an instance of EnvironmentsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getEnvironment to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EnvironmentsSettings.Builder environmentsSettingsBuilder = EnvironmentsSettings.newBuilder();
 environmentsSettingsBuilder
     .getEnvironmentSettings()
     .setRetrySettings(
         environmentsSettingsBuilder
             .getEnvironmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EnvironmentsSettings environmentsSettings = environmentsSettingsBuilder.build();

EnvironmentsSettings.Builder

Builder for EnvironmentsSettings.

EventHandler

An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order:

If there is a trigger_fulfillment associated with the event, it will be called.
If there is a target_page associated with the event, the session will transition into the specified page.
If there is a target_flow associated with the event, the session will transition into the specified flow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EventHandler

EventHandler.Builder

An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order:

If there is a trigger_fulfillment associated with the event, it will be called.
If there is a target_page associated with the event, the session will transition into the specified page.
If there is a target_flow associated with the event, the session will transition into the specified flow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EventHandler

EventInput

Represents the event to trigger.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EventInput

EventInput.Builder

Represents the event to trigger.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EventInput

Experiment

Represents an experiment in an environment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment

Experiment.Builder

Represents an experiment in an environment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment

Experiment.Definition

Definition of the experiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Definition

Experiment.Definition.Builder

Definition of the experiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Definition

Experiment.Result

The inference result which includes an objective metric to optimize and the confidence interval.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Result

Experiment.Result.Builder

The inference result which includes an objective metric to optimize and the confidence interval.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Result

Experiment.Result.ConfidenceInterval

A confidence interval is a range of possible values for the experiment objective you are trying to measure.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Result.ConfidenceInterval

Experiment.Result.ConfidenceInterval.Builder

A confidence interval is a range of possible values for the experiment objective you are trying to measure.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Result.ConfidenceInterval

Experiment.Result.Metric

Metric and corresponding confidence intervals.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Result.Metric

Experiment.Result.Metric.Builder

Metric and corresponding confidence intervals.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Result.Metric

Experiment.Result.VersionMetrics

Version variant and associated metrics.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Result.VersionMetrics

Experiment.Result.VersionMetrics.Builder

Version variant and associated metrics.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Experiment.Result.VersionMetrics

ExperimentName

ExperimentName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/experiments/{experiment}.

ExperimentProto

ExperimentsClient

Service Description: Service for managing Experiments.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
   ExperimentName name =
       ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]");
   Experiment response = experimentsClient.getExperiment(name);
 }

Note: close() needs to be called on the ExperimentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of ExperimentsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ExperimentsSettings experimentsSettings =
     ExperimentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ExperimentsClient experimentsClient = ExperimentsClient.create(experimentsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ExperimentsSettings experimentsSettings =
     ExperimentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ExperimentsClient experimentsClient = ExperimentsClient.create(experimentsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ExperimentsSettings experimentsSettings = ExperimentsSettings.newHttpJsonBuilder().build();
 ExperimentsClient experimentsClient = ExperimentsClient.create(experimentsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

ExperimentsClient.ListExperimentsFixedSizeCollection

ExperimentsClient.ListExperimentsPage

ExperimentsClient.ListExperimentsPagedResponse

ExperimentsClient.ListLocationsFixedSizeCollection

ExperimentsClient.ListLocationsPage

ExperimentsClient.ListLocationsPagedResponse

ExperimentsGrpc

Service for managing Experiments.

ExperimentsGrpc.ExperimentsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Experiments.

Service for managing Experiments.

ExperimentsGrpc.ExperimentsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Experiments.

Service for managing Experiments.

ExperimentsGrpc.ExperimentsImplBase

Base class for the server implementation of the service Experiments.

Service for managing Experiments.

ExperimentsGrpc.ExperimentsStub

A stub to allow clients to do asynchronous rpc calls to service Experiments.

Service for managing Experiments.

ExperimentsSettings

Settings class to configure an instance of ExperimentsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getExperiment to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ExperimentsSettings.Builder experimentsSettingsBuilder = ExperimentsSettings.newBuilder();
 experimentsSettingsBuilder
     .getExperimentSettings()
     .setRetrySettings(
         experimentsSettingsBuilder
             .getExperimentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ExperimentsSettings experimentsSettings = experimentsSettingsBuilder.build();

ExperimentsSettings.Builder

Builder for ExperimentsSettings.

ExportAgentRequest

The request message for Agents.ExportAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportAgentRequest

ExportAgentRequest.Builder

The request message for Agents.ExportAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportAgentRequest

ExportAgentResponse

The response message for Agents.ExportAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse

ExportAgentResponse.Builder

The response message for Agents.ExportAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse

ExportFlowRequest

The request message for Flows.ExportFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportFlowRequest

ExportFlowRequest.Builder

The request message for Flows.ExportFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportFlowRequest

ExportFlowResponse

The response message for Flows.ExportFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportFlowResponse

ExportFlowResponse.Builder

The response message for Flows.ExportFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportFlowResponse

ExportTestCasesMetadata

Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportTestCasesMetadata

ExportTestCasesMetadata.Builder

Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportTestCasesMetadata

ExportTestCasesRequest

The request message for TestCases.ExportTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportTestCasesRequest

ExportTestCasesRequest.Builder

The request message for TestCases.ExportTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportTestCasesRequest

ExportTestCasesResponse

The response message for TestCases.ExportTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportTestCasesResponse

ExportTestCasesResponse.Builder

The response message for TestCases.ExportTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ExportTestCasesResponse

Flow

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Flow

Flow.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.Flow

FlowName

FlowName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/flows/{flow}.

FlowProto

FlowValidationResult

The response message for Flows.GetFlowValidationResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.FlowValidationResult

FlowValidationResult.Builder

The response message for Flows.GetFlowValidationResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.FlowValidationResult

FlowValidationResultName

FlowValidationResultName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult.

FlowsClient

Service Description: Service for managing Flows.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FlowsClient flowsClient = FlowsClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   Flow flow = Flow.newBuilder().build();
   Flow response = flowsClient.createFlow(parent, flow);
 }

Note: close() needs to be called on the FlowsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of FlowsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FlowsSettings flowsSettings =
     FlowsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FlowsClient flowsClient = FlowsClient.create(flowsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FlowsSettings flowsSettings = FlowsSettings.newBuilder().setEndpoint(myEndpoint).build();
 FlowsClient flowsClient = FlowsClient.create(flowsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FlowsSettings flowsSettings = FlowsSettings.newHttpJsonBuilder().build();
 FlowsClient flowsClient = FlowsClient.create(flowsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

FlowsClient.ListFlowsFixedSizeCollection

FlowsClient.ListFlowsPage

FlowsClient.ListFlowsPagedResponse

FlowsClient.ListLocationsFixedSizeCollection

FlowsClient.ListLocationsPage

FlowsClient.ListLocationsPagedResponse

FlowsGrpc

Service for managing Flows.

FlowsGrpc.FlowsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Flows.

Service for managing Flows.

FlowsGrpc.FlowsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Flows.

Service for managing Flows.

FlowsGrpc.FlowsImplBase

Base class for the server implementation of the service Flows.

Service for managing Flows.

FlowsGrpc.FlowsStub

A stub to allow clients to do asynchronous rpc calls to service Flows.

Service for managing Flows.

FlowsSettings

Settings class to configure an instance of FlowsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createFlow to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FlowsSettings.Builder flowsSettingsBuilder = FlowsSettings.newBuilder();
 flowsSettingsBuilder
     .createFlowSettings()
     .setRetrySettings(
         flowsSettingsBuilder
             .createFlowSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 FlowsSettings flowsSettings = flowsSettingsBuilder.build();

FlowsSettings.Builder

Builder for FlowsSettings.

Form

A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Form

Form.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.Form

Form.Parameter

Represents a form parameter.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Form.Parameter

Form.Parameter.Builder

Represents a form parameter.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Form.Parameter

Form.Parameter.FillBehavior

Configuration for how the filling of a parameter should be handled.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior

Form.Parameter.FillBehavior.Builder

Configuration for how the filling of a parameter should be handled.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior

FulfillIntentRequest

Request of [FulfillIntent][]

Protobuf type google.cloud.dialogflow.cx.v3beta1.FulfillIntentRequest

FulfillIntentRequest.Builder

Request of [FulfillIntent][]

Protobuf type google.cloud.dialogflow.cx.v3beta1.FulfillIntentRequest

FulfillIntentResponse

Response of [FulfillIntent][]

Protobuf type google.cloud.dialogflow.cx.v3beta1.FulfillIntentResponse

FulfillIntentResponse.Builder

Response of [FulfillIntent][]

Protobuf type google.cloud.dialogflow.cx.v3beta1.FulfillIntentResponse

Fulfillment

A fulfillment can do one or more of the following actions at the same time:

Generate rich message responses.
Set parameter values.
Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment

Fulfillment.Builder

A fulfillment can do one or more of the following actions at the same time:

Generate rich message responses.
Set parameter values.
Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment

Fulfillment.ConditionalCases

A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases

Fulfillment.ConditionalCases.Builder

A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases

Fulfillment.ConditionalCases.Case

Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases.Case

Fulfillment.ConditionalCases.Case.Builder

Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases.Case

Fulfillment.ConditionalCases.Case.CaseContent

The list of messages or conditional cases to activate for this case.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases.Case.CaseContent

Fulfillment.ConditionalCases.Case.CaseContent.Builder

The list of messages or conditional cases to activate for this case.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases.Case.CaseContent

Fulfillment.SetParameterAction

Setting a parameter value.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction

Fulfillment.SetParameterAction.Builder

Setting a parameter value.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction

FulfillmentProto

GcsDestination

Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GcsDestination

GcsDestination.Builder

Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GcsDestination

GcsProto

GetAgentRequest

The request message for Agents.GetAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetAgentRequest

GetAgentRequest.Builder

The request message for Agents.GetAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetAgentRequest

GetAgentValidationResultRequest

The request message for Agents.GetAgentValidationResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetAgentValidationResultRequest

GetAgentValidationResultRequest.Builder

The request message for Agents.GetAgentValidationResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetAgentValidationResultRequest

GetChangelogRequest

The request message for Changelogs.GetChangelog.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetChangelogRequest

GetChangelogRequest.Builder

The request message for Changelogs.GetChangelog.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetChangelogRequest

GetDeploymentRequest

The request message for Deployments.GetDeployment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetDeploymentRequest

GetDeploymentRequest.Builder

The request message for Deployments.GetDeployment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetDeploymentRequest

GetEntityTypeRequest

The request message for EntityTypes.GetEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetEntityTypeRequest

GetEntityTypeRequest.Builder

The request message for EntityTypes.GetEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetEntityTypeRequest

GetEnvironmentRequest

The request message for Environments.GetEnvironment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetEnvironmentRequest

GetEnvironmentRequest.Builder

The request message for Environments.GetEnvironment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetEnvironmentRequest

GetExperimentRequest

The request message for Experiments.GetExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetExperimentRequest

GetExperimentRequest.Builder

The request message for Experiments.GetExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetExperimentRequest

GetFlowRequest

The response message for Flows.GetFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetFlowRequest

GetFlowRequest.Builder

The response message for Flows.GetFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetFlowRequest

GetFlowValidationResultRequest

The request message for Flows.GetFlowValidationResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetFlowValidationResultRequest

GetFlowValidationResultRequest.Builder

The request message for Flows.GetFlowValidationResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetFlowValidationResultRequest

GetIntentRequest

The request message for Intents.GetIntent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetIntentRequest

GetIntentRequest.Builder

The request message for Intents.GetIntent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetIntentRequest

GetPageRequest

The request message for Pages.GetPage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetPageRequest

GetPageRequest.Builder

The request message for Pages.GetPage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetPageRequest

GetSecuritySettingsRequest

The request message for SecuritySettingsService.GetSecuritySettings.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetSecuritySettingsRequest

GetSecuritySettingsRequest.Builder

The request message for SecuritySettingsService.GetSecuritySettings.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetSecuritySettingsRequest

GetSessionEntityTypeRequest

The request message for SessionEntityTypes.GetSessionEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetSessionEntityTypeRequest

GetSessionEntityTypeRequest.Builder

The request message for SessionEntityTypes.GetSessionEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetSessionEntityTypeRequest

GetTestCaseRequest

The request message for TestCases.GetTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetTestCaseRequest

GetTestCaseRequest.Builder

The request message for TestCases.GetTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetTestCaseRequest

GetTestCaseResultRequest

The request message for TestCases.GetTestCaseResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetTestCaseResultRequest

GetTestCaseResultRequest.Builder

The request message for TestCases.GetTestCaseResult.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetTestCaseResultRequest

GetTransitionRouteGroupRequest

The request message for TransitionRouteGroups.GetTransitionRouteGroup.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetTransitionRouteGroupRequest

GetTransitionRouteGroupRequest.Builder

The request message for TransitionRouteGroups.GetTransitionRouteGroup.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetTransitionRouteGroupRequest

GetVersionRequest

The request message for Versions.GetVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetVersionRequest

GetVersionRequest.Builder

The request message for Versions.GetVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetVersionRequest

GetWebhookRequest

The request message for Webhooks.GetWebhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetWebhookRequest

GetWebhookRequest.Builder

The request message for Webhooks.GetWebhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.GetWebhookRequest

ImportFlowRequest

The request message for Flows.ImportFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportFlowRequest

ImportFlowRequest.Builder

The request message for Flows.ImportFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportFlowRequest

ImportFlowResponse

The response message for Flows.ImportFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportFlowResponse

ImportFlowResponse.Builder

The response message for Flows.ImportFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportFlowResponse

ImportTestCasesMetadata

Metadata returned for the TestCases.ImportTestCases long running operation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportTestCasesMetadata

ImportTestCasesMetadata.Builder

Metadata returned for the TestCases.ImportTestCases long running operation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportTestCasesMetadata

ImportTestCasesRequest

The request message for TestCases.ImportTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportTestCasesRequest

ImportTestCasesRequest.Builder

The request message for TestCases.ImportTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportTestCasesRequest

ImportTestCasesResponse

The response message for TestCases.ImportTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportTestCasesResponse

ImportTestCasesResponse.Builder

The response message for TestCases.ImportTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ImportTestCasesResponse

InputAudioConfig

Instructs the speech recognizer on how to process the audio content.

Protobuf type google.cloud.dialogflow.cx.v3beta1.InputAudioConfig

InputAudioConfig.Builder

Instructs the speech recognizer on how to process the audio content.

Protobuf type google.cloud.dialogflow.cx.v3beta1.InputAudioConfig

Intent

An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Intent

Intent.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.Intent

Intent.Parameter

Represents an intent parameter.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Intent.Parameter

Intent.Parameter.Builder

Represents an intent parameter.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Intent.Parameter

Intent.TrainingPhrase

Represents an example that the agent is trained on to identify the intent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase

Intent.TrainingPhrase.Builder

Represents an example that the agent is trained on to identify the intent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase

Intent.TrainingPhrase.Part

Represents a part of a training phrase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase.Part

Intent.TrainingPhrase.Part.Builder

Represents a part of a training phrase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase.Part

IntentCoverage

Intent coverage represents the percentage of all possible intents in the agent that are triggered in any of a parent's test cases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.IntentCoverage

IntentCoverage.Builder

Intent coverage represents the percentage of all possible intents in the agent that are triggered in any of a parent's test cases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.IntentCoverage

IntentCoverage.Intent

The agent's intent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.IntentCoverage.Intent

IntentCoverage.Intent.Builder

The agent's intent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.IntentCoverage.Intent

IntentInput

Represents the intent to trigger programmatically rather than as a result of natural language processing.

Protobuf type google.cloud.dialogflow.cx.v3beta1.IntentInput

IntentInput.Builder

Represents the intent to trigger programmatically rather than as a result of natural language processing.

Protobuf type google.cloud.dialogflow.cx.v3beta1.IntentInput

IntentName

IntentName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/intents/{intent}.

IntentProto

IntentsClient

Service Description: Service for managing Intents.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (IntentsClient intentsClient = IntentsClient.create()) {
   IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]");
   Intent response = intentsClient.getIntent(name);
 }

Note: close() needs to be called on the IntentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of IntentsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 IntentsSettings intentsSettings =
     IntentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 IntentsClient intentsClient = IntentsClient.create(intentsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 IntentsSettings intentsSettings = IntentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 IntentsClient intentsClient = IntentsClient.create(intentsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 IntentsSettings intentsSettings = IntentsSettings.newHttpJsonBuilder().build();
 IntentsClient intentsClient = IntentsClient.create(intentsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

IntentsClient.ListIntentsFixedSizeCollection

IntentsClient.ListIntentsPage

IntentsClient.ListIntentsPagedResponse

IntentsClient.ListLocationsFixedSizeCollection

IntentsClient.ListLocationsPage

IntentsClient.ListLocationsPagedResponse

IntentsGrpc

Service for managing Intents.

IntentsGrpc.IntentsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Intents.

Service for managing Intents.

IntentsGrpc.IntentsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Intents.

Service for managing Intents.

IntentsGrpc.IntentsImplBase

Base class for the server implementation of the service Intents.

Service for managing Intents.

IntentsGrpc.IntentsStub

A stub to allow clients to do asynchronous rpc calls to service Intents.

Service for managing Intents.

IntentsSettings

Settings class to configure an instance of IntentsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getIntent to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 IntentsSettings.Builder intentsSettingsBuilder = IntentsSettings.newBuilder();
 intentsSettingsBuilder
     .getIntentSettings()
     .setRetrySettings(
         intentsSettingsBuilder
             .getIntentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IntentsSettings intentsSettings = intentsSettingsBuilder.build();

IntentsSettings.Builder

Builder for IntentsSettings.

ListAgentsRequest

The request message for Agents.ListAgents.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListAgentsRequest

ListAgentsRequest.Builder

The request message for Agents.ListAgents.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListAgentsRequest

ListAgentsResponse

The response message for Agents.ListAgents.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListAgentsResponse

ListAgentsResponse.Builder

The response message for Agents.ListAgents.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListAgentsResponse

ListChangelogsRequest

The request message for Changelogs.ListChangelogs.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListChangelogsRequest

ListChangelogsRequest.Builder

The request message for Changelogs.ListChangelogs.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListChangelogsRequest

ListChangelogsResponse

The response message for Changelogs.ListChangelogs.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListChangelogsResponse

ListChangelogsResponse.Builder

The response message for Changelogs.ListChangelogs.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListChangelogsResponse

ListContinuousTestResultsRequest

The request message for Environments.ListContinuousTestResults.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListContinuousTestResultsRequest

ListContinuousTestResultsRequest.Builder

The request message for Environments.ListContinuousTestResults.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListContinuousTestResultsRequest

ListContinuousTestResultsResponse

The response message for [Environments.ListTestCaseResults][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListContinuousTestResultsResponse

ListContinuousTestResultsResponse.Builder

The response message for [Environments.ListTestCaseResults][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListContinuousTestResultsResponse

ListDeploymentsRequest

The request message for Deployments.ListDeployments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListDeploymentsRequest

ListDeploymentsRequest.Builder

The request message for Deployments.ListDeployments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListDeploymentsRequest

ListDeploymentsResponse

The response message for Deployments.ListDeployments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListDeploymentsResponse

ListDeploymentsResponse.Builder

The response message for Deployments.ListDeployments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListDeploymentsResponse

ListEntityTypesRequest

The request message for EntityTypes.ListEntityTypes.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListEntityTypesRequest

ListEntityTypesRequest.Builder

The request message for EntityTypes.ListEntityTypes.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListEntityTypesRequest

ListEntityTypesResponse

The response message for EntityTypes.ListEntityTypes.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListEntityTypesResponse

ListEntityTypesResponse.Builder

The response message for EntityTypes.ListEntityTypes.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListEntityTypesResponse

ListEnvironmentsRequest

The request message for Environments.ListEnvironments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListEnvironmentsRequest

ListEnvironmentsRequest.Builder

The request message for Environments.ListEnvironments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListEnvironmentsRequest

ListEnvironmentsResponse

The response message for Environments.ListEnvironments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListEnvironmentsResponse

ListEnvironmentsResponse.Builder

The response message for Environments.ListEnvironments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListEnvironmentsResponse

ListExperimentsRequest

The request message for Experiments.ListExperiments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListExperimentsRequest

ListExperimentsRequest.Builder

The request message for Experiments.ListExperiments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListExperimentsRequest

ListExperimentsResponse

The response message for Experiments.ListExperiments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListExperimentsResponse

ListExperimentsResponse.Builder

The response message for Experiments.ListExperiments.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListExperimentsResponse

ListFlowsRequest

The request message for Flows.ListFlows.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListFlowsRequest

ListFlowsRequest.Builder

The request message for Flows.ListFlows.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListFlowsRequest

ListFlowsResponse

The response message for Flows.ListFlows.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListFlowsResponse

ListFlowsResponse.Builder

The response message for Flows.ListFlows.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListFlowsResponse

ListIntentsRequest

The request message for Intents.ListIntents.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListIntentsRequest

ListIntentsRequest.Builder

The request message for Intents.ListIntents.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListIntentsRequest

ListIntentsResponse

The response message for Intents.ListIntents.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListIntentsResponse

ListIntentsResponse.Builder

The response message for Intents.ListIntents.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListIntentsResponse

ListPagesRequest

The request message for Pages.ListPages.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListPagesRequest

ListPagesRequest.Builder

The request message for Pages.ListPages.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListPagesRequest

ListPagesResponse

The response message for Pages.ListPages.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListPagesResponse

ListPagesResponse.Builder

The response message for Pages.ListPages.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListPagesResponse

ListSecuritySettingsRequest

The request message for [SecuritySettings.ListSecuritySettings][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListSecuritySettingsRequest

ListSecuritySettingsRequest.Builder

The request message for [SecuritySettings.ListSecuritySettings][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListSecuritySettingsRequest

ListSecuritySettingsResponse

The response message for [SecuritySettings.ListSecuritySettings][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListSecuritySettingsResponse

ListSecuritySettingsResponse.Builder

The response message for [SecuritySettings.ListSecuritySettings][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListSecuritySettingsResponse

ListSessionEntityTypesRequest

The request message for SessionEntityTypes.ListSessionEntityTypes.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListSessionEntityTypesRequest

ListSessionEntityTypesRequest.Builder

The request message for SessionEntityTypes.ListSessionEntityTypes.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListSessionEntityTypesRequest

ListSessionEntityTypesResponse

The response message for SessionEntityTypes.ListSessionEntityTypes.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListSessionEntityTypesResponse

ListSessionEntityTypesResponse.Builder

The response message for SessionEntityTypes.ListSessionEntityTypes.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListSessionEntityTypesResponse

ListTestCaseResultsRequest

The request message for TestCases.ListTestCaseResults.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTestCaseResultsRequest

ListTestCaseResultsRequest.Builder

The request message for TestCases.ListTestCaseResults.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTestCaseResultsRequest

ListTestCaseResultsResponse

The response message for TestCases.ListTestCaseResults.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTestCaseResultsResponse

ListTestCaseResultsResponse.Builder

The response message for TestCases.ListTestCaseResults.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTestCaseResultsResponse

ListTestCasesRequest

The request message for TestCases.ListTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTestCasesRequest

ListTestCasesRequest.Builder

The request message for TestCases.ListTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTestCasesRequest

ListTestCasesResponse

The response message for TestCases.ListTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTestCasesResponse

ListTestCasesResponse.Builder

The response message for TestCases.ListTestCases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTestCasesResponse

ListTransitionRouteGroupsRequest

The request message for TransitionRouteGroups.ListTransitionRouteGroups.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTransitionRouteGroupsRequest

ListTransitionRouteGroupsRequest.Builder

The request message for TransitionRouteGroups.ListTransitionRouteGroups.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTransitionRouteGroupsRequest

ListTransitionRouteGroupsResponse

The response message for TransitionRouteGroups.ListTransitionRouteGroups.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTransitionRouteGroupsResponse

ListTransitionRouteGroupsResponse.Builder

The response message for TransitionRouteGroups.ListTransitionRouteGroups.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListTransitionRouteGroupsResponse

ListVersionsRequest

The request message for Versions.ListVersions.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListVersionsRequest

ListVersionsRequest.Builder

The request message for Versions.ListVersions.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListVersionsRequest

ListVersionsResponse

The response message for Versions.ListVersions.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListVersionsResponse

ListVersionsResponse.Builder

The response message for Versions.ListVersions.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListVersionsResponse

ListWebhooksRequest

The request message for Webhooks.ListWebhooks.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListWebhooksRequest

ListWebhooksRequest.Builder

The request message for Webhooks.ListWebhooks.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListWebhooksRequest

ListWebhooksResponse

The response message for Webhooks.ListWebhooks.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListWebhooksResponse

ListWebhooksResponse.Builder

The response message for Webhooks.ListWebhooks.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ListWebhooksResponse

LoadVersionRequest

The request message for Versions.LoadVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.LoadVersionRequest

LoadVersionRequest.Builder

The request message for Versions.LoadVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.LoadVersionRequest

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

LookupEnvironmentHistoryRequest

The request message for Environments.LookupEnvironmentHistory.

Protobuf type google.cloud.dialogflow.cx.v3beta1.LookupEnvironmentHistoryRequest

LookupEnvironmentHistoryRequest.Builder

The request message for Environments.LookupEnvironmentHistory.

Protobuf type google.cloud.dialogflow.cx.v3beta1.LookupEnvironmentHistoryRequest

LookupEnvironmentHistoryResponse

The response message for Environments.LookupEnvironmentHistory.

Protobuf type google.cloud.dialogflow.cx.v3beta1.LookupEnvironmentHistoryResponse

LookupEnvironmentHistoryResponse.Builder

The response message for Environments.LookupEnvironmentHistory.

Protobuf type google.cloud.dialogflow.cx.v3beta1.LookupEnvironmentHistoryResponse

Match

Represents one match result of [MatchIntent][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.Match

Match.Builder

Represents one match result of [MatchIntent][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.Match

MatchIntentRequest

Request of [MatchIntent][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.MatchIntentRequest

MatchIntentRequest.Builder

Request of [MatchIntent][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.MatchIntentRequest

MatchIntentResponse

Response of [MatchIntent][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.MatchIntentResponse

MatchIntentResponse.Builder

Response of [MatchIntent][].

Protobuf type google.cloud.dialogflow.cx.v3beta1.MatchIntentResponse

NluSettings

Settings related to NLU.

Protobuf type google.cloud.dialogflow.cx.v3beta1.NluSettings

NluSettings.Builder

Settings related to NLU.

Protobuf type google.cloud.dialogflow.cx.v3beta1.NluSettings

OutputAudioConfig

Instructs the speech synthesizer how to generate the output audio content.

Protobuf type google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig

OutputAudioConfig.Builder

Instructs the speech synthesizer how to generate the output audio content.

Protobuf type google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig

Page

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the Page guide.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Page

Page.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.Page

PageInfo

Represents page information communicated to and from the webhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.PageInfo

PageInfo.Builder

Represents page information communicated to and from the webhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.PageInfo

PageInfo.FormInfo

Represents form information.

Protobuf type google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo

PageInfo.FormInfo.Builder

Represents form information.

Protobuf type google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo

PageInfo.FormInfo.ParameterInfo

Represents parameter information.

Protobuf type google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo.ParameterInfo

PageInfo.FormInfo.ParameterInfo.Builder

Represents parameter information.

Protobuf type google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo.ParameterInfo

PageName

PageName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/pages/{page}.

PageProto

PagesClient

Service Description: Service for managing Pages.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PagesClient pagesClient = PagesClient.create()) {
   PageName name = PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]");
   Page response = pagesClient.getPage(name);
 }

Note: close() needs to be called on the PagesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of PagesSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PagesSettings pagesSettings =
     PagesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PagesClient pagesClient = PagesClient.create(pagesSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PagesSettings pagesSettings = PagesSettings.newBuilder().setEndpoint(myEndpoint).build();
 PagesClient pagesClient = PagesClient.create(pagesSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PagesSettings pagesSettings = PagesSettings.newHttpJsonBuilder().build();
 PagesClient pagesClient = PagesClient.create(pagesSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

PagesClient.ListLocationsFixedSizeCollection

PagesClient.ListLocationsPage

PagesClient.ListLocationsPagedResponse

PagesClient.ListPagesFixedSizeCollection

PagesClient.ListPagesPage

PagesClient.ListPagesPagedResponse

PagesGrpc

Service for managing Pages.

PagesGrpc.PagesBlockingStub

A stub to allow clients to do synchronous rpc calls to service Pages.

Service for managing Pages.

PagesGrpc.PagesFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Pages.

Service for managing Pages.

PagesGrpc.PagesImplBase

Base class for the server implementation of the service Pages.

Service for managing Pages.

PagesGrpc.PagesStub

A stub to allow clients to do asynchronous rpc calls to service Pages.

Service for managing Pages.

PagesSettings

Settings class to configure an instance of PagesClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getPage to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PagesSettings.Builder pagesSettingsBuilder = PagesSettings.newBuilder();
 pagesSettingsBuilder
     .getPageSettings()
     .setRetrySettings(
         pagesSettingsBuilder
             .getPageSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PagesSettings pagesSettings = pagesSettingsBuilder.build();

PagesSettings.Builder

Builder for PagesSettings.

QueryInput

Represents the query input. It can contain one of:

A conversational query in the form of text.
An intent query that specifies which intent to trigger.
Natural language speech audio to be processed.
An event to be triggered.

Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryInput

QueryInput.Builder

Represents the query input. It can contain one of:

A conversational query in the form of text.
An intent query that specifies which intent to trigger.
Natural language speech audio to be processed.
An event to be triggered.

Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryInput

QueryParameters

Represents the parameters of a conversational query.

Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryParameters

QueryParameters.Builder

Represents the parameters of a conversational query.

Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryParameters

QueryResult

Represents the result of a conversational query.

Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryResult

QueryResult.Builder

Represents the result of a conversational query.

Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryResult

ResourceName

Resource name and display name.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResourceName

ResourceName.Builder

Resource name and display name.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResourceName

ResponseMessage

Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows:

If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis.
If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design.
Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage

ResponseMessage.Builder

Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows:

If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis.
If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design.
Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage

ResponseMessage.ConversationSuccess

Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example:

In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded.
In a webhook response when you determine that you handled the customer issue.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess

ResponseMessage.ConversationSuccess.Builder

In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded.
In a webhook response when you determine that you handled the customer issue.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess

ResponseMessage.EndInteraction

Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.EndInteraction

ResponseMessage.EndInteraction.Builder

Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.EndInteraction

ResponseMessage.LiveAgentHandoff

Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example:

In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.
In a webhook response when you determine that the customer issue can only be handled by a human.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff

ResponseMessage.LiveAgentHandoff.Builder

In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.
In a webhook response when you determine that the customer issue can only be handled by a human.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff

ResponseMessage.MixedAudio

Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.MixedAudio

ResponseMessage.MixedAudio.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.MixedAudio

ResponseMessage.MixedAudio.Segment

Represents one segment of audio.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.MixedAudio.Segment

ResponseMessage.MixedAudio.Segment.Builder

Represents one segment of audio.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.MixedAudio.Segment

ResponseMessage.OutputAudioText

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.OutputAudioText

ResponseMessage.OutputAudioText.Builder

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.OutputAudioText

ResponseMessage.PlayAudio

Specifies an audio clip to be played by the client as part of the response.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.PlayAudio

ResponseMessage.PlayAudio.Builder

Specifies an audio clip to be played by the client as part of the response.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.PlayAudio

ResponseMessage.TelephonyTransferCall

Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.TelephonyTransferCall

ResponseMessage.TelephonyTransferCall.Builder

Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.TelephonyTransferCall

ResponseMessage.Text

The text response message.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text

ResponseMessage.Text.Builder

The text response message.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text

ResponseMessageProto

RestoreAgentRequest

The request message for Agents.RestoreAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RestoreAgentRequest

RestoreAgentRequest.Builder

The request message for Agents.RestoreAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RestoreAgentRequest

RolloutConfig

The configuration for auto rollout.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RolloutConfig

RolloutConfig.Builder

The configuration for auto rollout.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RolloutConfig

RolloutConfig.RolloutStep

A single rollout step with specified traffic allocation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RolloutConfig.RolloutStep

RolloutConfig.RolloutStep.Builder

A single rollout step with specified traffic allocation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RolloutConfig.RolloutStep

RolloutState

State of the auto-rollout process.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RolloutState

RolloutState.Builder

State of the auto-rollout process.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RolloutState

RunContinuousTestMetadata

Metadata returned for the Environments.RunContinuousTest long running operation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunContinuousTestMetadata

RunContinuousTestMetadata.Builder

Metadata returned for the Environments.RunContinuousTest long running operation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunContinuousTestMetadata

RunContinuousTestRequest

The request message for Environments.RunContinuousTest.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunContinuousTestRequest

RunContinuousTestRequest.Builder

The request message for Environments.RunContinuousTest.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunContinuousTestRequest

RunContinuousTestResponse

The response message for Environments.RunContinuousTest.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunContinuousTestResponse

RunContinuousTestResponse.Builder

The response message for Environments.RunContinuousTest.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunContinuousTestResponse

RunTestCaseMetadata

Metadata returned for the TestCases.RunTestCase long running operation. This message currently has no fields.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata

RunTestCaseMetadata.Builder

Metadata returned for the TestCases.RunTestCase long running operation. This message currently has no fields.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata

RunTestCaseRequest

The request message for TestCases.RunTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunTestCaseRequest

RunTestCaseRequest.Builder

The request message for TestCases.RunTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunTestCaseRequest

RunTestCaseResponse

The response message for TestCases.RunTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse

RunTestCaseResponse.Builder

The response message for TestCases.RunTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse

SecuritySettings

Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SecuritySettings

SecuritySettings.AudioExportSettings

Settings for exporting audio.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings

SecuritySettings.AudioExportSettings.Builder

Settings for exporting audio.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings

SecuritySettings.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.SecuritySettings

SecuritySettings.InsightsExportSettings

Settings for exporting conversations to Insights.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SecuritySettings.InsightsExportSettings

SecuritySettings.InsightsExportSettings.Builder

Settings for exporting conversations to Insights.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SecuritySettings.InsightsExportSettings

SecuritySettingsName

SecuritySettingsName.Builder

Builder for projects/{project}/locations/{location}/securitySettings/{security_settings}.

SecuritySettingsProto

SecuritySettingsServiceClient

Service Description: Service for managing security settings for Dialogflow.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
   SecuritySettings response =
       securitySettingsServiceClient.createSecuritySettings(parent, securitySettings);
 }

Note: close() needs to be called on the SecuritySettingsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of SecuritySettingsServiceSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SecuritySettingsServiceSettings securitySettingsServiceSettings =
     SecuritySettingsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create(securitySettingsServiceSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SecuritySettingsServiceSettings securitySettingsServiceSettings =
     SecuritySettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create(securitySettingsServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SecuritySettingsServiceSettings securitySettingsServiceSettings =
     SecuritySettingsServiceSettings.newHttpJsonBuilder().build();
 SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create(securitySettingsServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

SecuritySettingsServiceClient.ListLocationsFixedSizeCollection

SecuritySettingsServiceClient.ListLocationsPage

SecuritySettingsServiceClient.ListLocationsPagedResponse

SecuritySettingsServiceClient.ListSecuritySettingsFixedSizeCollection

SecuritySettingsServiceClient.ListSecuritySettingsPage

SecuritySettingsServiceClient.ListSecuritySettingsPagedResponse

SecuritySettingsServiceGrpc

Service for managing security settings for Dialogflow.

SecuritySettingsServiceGrpc.SecuritySettingsServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service SecuritySettingsService.

Service for managing security settings for Dialogflow.

SecuritySettingsServiceGrpc.SecuritySettingsServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service SecuritySettingsService.

Service for managing security settings for Dialogflow.

SecuritySettingsServiceGrpc.SecuritySettingsServiceImplBase

Base class for the server implementation of the service SecuritySettingsService.

Service for managing security settings for Dialogflow.

SecuritySettingsServiceGrpc.SecuritySettingsServiceStub

A stub to allow clients to do asynchronous rpc calls to service SecuritySettingsService.

Service for managing security settings for Dialogflow.

SecuritySettingsServiceSettings

Settings class to configure an instance of SecuritySettingsServiceClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createSecuritySettings to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SecuritySettingsServiceSettings.Builder securitySettingsServiceSettingsBuilder =
     SecuritySettingsServiceSettings.newBuilder();
 securitySettingsServiceSettingsBuilder
     .createSecuritySettingsSettings()
     .setRetrySettings(
         securitySettingsServiceSettingsBuilder
             .createSecuritySettingsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SecuritySettingsServiceSettings securitySettingsServiceSettings =
     securitySettingsServiceSettingsBuilder.build();

SecuritySettingsServiceSettings.Builder

Builder for SecuritySettingsServiceSettings.

SentimentAnalysisResult

The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SentimentAnalysisResult

SentimentAnalysisResult.Builder

The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SentimentAnalysisResult

SessionEntityType

Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the Dialogflow documentation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SessionEntityType

SessionEntityType.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.SessionEntityType

SessionEntityTypeName

SessionEntityTypeName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}.

SessionEntityTypeName.ProjectLocationAgentEnvironmentSessionEntityTypeBuilder

Builder for projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type}.

SessionEntityTypeProto

SessionEntityTypesClient

Service Description: Service for managing SessionEntityTypes.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityTypeName name =
       SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
           "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
   SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name);
 }

Note: close() needs to be called on the SessionEntityTypesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of SessionEntityTypesSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SessionEntityTypesSettings sessionEntityTypesSettings =
     SessionEntityTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SessionEntityTypesClient sessionEntityTypesClient =
     SessionEntityTypesClient.create(sessionEntityTypesSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SessionEntityTypesSettings sessionEntityTypesSettings =
     SessionEntityTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 SessionEntityTypesClient sessionEntityTypesClient =
     SessionEntityTypesClient.create(sessionEntityTypesSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SessionEntityTypesSettings sessionEntityTypesSettings =
     SessionEntityTypesSettings.newHttpJsonBuilder().build();
 SessionEntityTypesClient sessionEntityTypesClient =
     SessionEntityTypesClient.create(sessionEntityTypesSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

SessionEntityTypesClient.ListLocationsFixedSizeCollection

SessionEntityTypesClient.ListLocationsPage

SessionEntityTypesClient.ListLocationsPagedResponse

SessionEntityTypesClient.ListSessionEntityTypesFixedSizeCollection

SessionEntityTypesClient.ListSessionEntityTypesPage

SessionEntityTypesClient.ListSessionEntityTypesPagedResponse

SessionEntityTypesGrpc

Service for managing SessionEntityTypes.

SessionEntityTypesGrpc.SessionEntityTypesBlockingStub

A stub to allow clients to do synchronous rpc calls to service SessionEntityTypes.

Service for managing SessionEntityTypes.

SessionEntityTypesGrpc.SessionEntityTypesFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service SessionEntityTypes.

Service for managing SessionEntityTypes.

SessionEntityTypesGrpc.SessionEntityTypesImplBase

Base class for the server implementation of the service SessionEntityTypes.

Service for managing SessionEntityTypes.

SessionEntityTypesGrpc.SessionEntityTypesStub

A stub to allow clients to do asynchronous rpc calls to service SessionEntityTypes.

Service for managing SessionEntityTypes.

SessionEntityTypesSettings

Settings class to configure an instance of SessionEntityTypesClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getSessionEntityType to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SessionEntityTypesSettings.Builder sessionEntityTypesSettingsBuilder =
     SessionEntityTypesSettings.newBuilder();
 sessionEntityTypesSettingsBuilder
     .getSessionEntityTypeSettings()
     .setRetrySettings(
         sessionEntityTypesSettingsBuilder
             .getSessionEntityTypeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SessionEntityTypesSettings sessionEntityTypesSettings =
     sessionEntityTypesSettingsBuilder.build();

SessionEntityTypesSettings.Builder

Builder for SessionEntityTypesSettings.

SessionInfo

Represents session information communicated to and from the webhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SessionInfo

SessionInfo.Builder

Represents session information communicated to and from the webhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SessionInfo

SessionName

SessionName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/sessions/{session}.

SessionName.ProjectLocationAgentEnvironmentSessionBuilder

Builder for projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}.

SessionProto

SessionsClient

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SessionsClient sessionsClient = SessionsClient.create()) {
   DetectIntentRequest request =
       DetectIntentRequest.newBuilder()
           .setSession(
               SessionName.ofProjectLocationAgentSessionName(
                       "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
                   .toString())
           .setQueryParams(QueryParameters.newBuilder().build())
           .setQueryInput(QueryInput.newBuilder().build())
           .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
           .build();
   DetectIntentResponse response = sessionsClient.detectIntent(request);
 }

Note: close() needs to be called on the SessionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of SessionsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SessionsSettings sessionsSettings =
     SessionsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SessionsSettings sessionsSettings =
     SessionsSettings.newBuilder().setEndpoint(myEndpoint).build();
 SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SessionsSettings sessionsSettings = SessionsSettings.newHttpJsonBuilder().build();
 SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

SessionsClient.ListLocationsFixedSizeCollection

SessionsClient.ListLocationsPage

SessionsClient.ListLocationsPagedResponse

SessionsGrpc

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.

SessionsGrpc.SessionsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Sessions.

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.

SessionsGrpc.SessionsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Sessions.

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.

SessionsGrpc.SessionsImplBase

Base class for the server implementation of the service Sessions.

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.

SessionsGrpc.SessionsStub

A stub to allow clients to do asynchronous rpc calls to service Sessions.

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.

SessionsSettings

Settings class to configure an instance of SessionsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of detectIntent to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SessionsSettings.Builder sessionsSettingsBuilder = SessionsSettings.newBuilder();
 sessionsSettingsBuilder
     .detectIntentSettings()
     .setRetrySettings(
         sessionsSettingsBuilder
             .detectIntentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SessionsSettings sessionsSettings = sessionsSettingsBuilder.build();

SessionsSettings.Builder

Builder for SessionsSettings.

SpeechToTextSettings

Settings related to speech recognition.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings

SpeechToTextSettings.Builder

Settings related to speech recognition.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings

SpeechWordInfo

Information for a word recognized by the speech recognizer.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SpeechWordInfo

SpeechWordInfo.Builder

Information for a word recognized by the speech recognizer.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SpeechWordInfo

StartExperimentRequest

The request message for Experiments.StartExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.StartExperimentRequest

StartExperimentRequest.Builder

The request message for Experiments.StartExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.StartExperimentRequest

StopExperimentRequest

The request message for Experiments.StopExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.StopExperimentRequest

StopExperimentRequest.Builder

The request message for Experiments.StopExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.StopExperimentRequest

StreamingDetectIntentRequest

The top-level message sent by the client to the Sessions.StreamingDetectIntent method. Multiple request messages should be sent in order:

The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config.
If query_input was set to query_input.audio.config, all subsequent messages must contain query_input.audio.audio to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with query_input.text. However, note that:
- Dialogflow will bill you for the audio duration so far.
- Dialogflow discards all Speech recognition results in favor of the input text.
- Dialogflow will use the language code from the first message. After you sent all input, you must half-close or abort the request stream.

Protobuf type google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest

StreamingDetectIntentRequest.Builder

The top-level message sent by the client to the Sessions.StreamingDetectIntent method. Multiple request messages should be sent in order:

The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config.
If query_input was set to query_input.audio.config, all subsequent messages must contain query_input.audio.audio to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with query_input.text. However, note that:
- Dialogflow will bill you for the audio duration so far.
- Dialogflow discards all Speech recognition results in favor of the input text.
- Dialogflow will use the language code from the first message. After you sent all input, you must half-close or abort the request stream.

Protobuf type google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest

StreamingDetectIntentResponse

The top-level message returned from the StreamingDetectIntent method. Multiple response messages (N) can be returned in order. The first (N-1) responses set either the recognition_result or detect_intent_response field, depending on the request:

If the StreamingDetectIntentRequest.query_input.audio field was set, and the StreamingDetectIntentRequest.enable_partial_response field was false, the recognition_result field is populated for each of the (N-1) responses. See the StreamingRecognitionResult message for details about the result message sequence.
If the StreamingDetectIntentRequest.enable_partial_response field was true, the detect_intent_response field is populated for each of the (N-1) responses, where 1 <= N <= 4. These responses set the DetectIntentResponse.response_type field to PARTIAL. For the final Nth response message, the detect_intent_response is fully populated, and DetectIntentResponse.response_type is set to FINAL.

Protobuf type google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentResponse

StreamingDetectIntentResponse.Builder

If the StreamingDetectIntentRequest.query_input.audio field was set, and the StreamingDetectIntentRequest.enable_partial_response field was false, the recognition_result field is populated for each of the (N-1) responses. See the StreamingRecognitionResult message for details about the result message sequence.
If the StreamingDetectIntentRequest.enable_partial_response field was true, the detect_intent_response field is populated for each of the (N-1) responses, where 1 <= N <= 4. These responses set the DetectIntentResponse.response_type field to PARTIAL. For the final Nth response message, the detect_intent_response is fully populated, and DetectIntentResponse.response_type is set to FINAL.

Protobuf type google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentResponse

StreamingRecognitionResult

Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance. While end-user audio is being processed, Dialogflow sends a series of results. Each result may contain a transcript value. A transcript represents a portion of the utterance. While the recognizer is processing audio, transcript values may be interim values or finalized values. Once a transcript is finalized, the is_final value is set to true and processing continues for the next transcript. If StreamingDetectIntentRequest.query_input.audio.config.single_utterance was true, and the recognizer has completed processing audio, the message_type value is set to END_OF_SINGLE_UTTERANCE and the following (last) result contains the last finalized transcript. The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results. In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.

Num	transcript	message_type	is_final
1	"tube"	TRANSCRIPT	false
2	"to be a"	TRANSCRIPT	false
3	"to be"	TRANSCRIPT	false
4	"to be or not to be"	TRANSCRIPT	true
5	"that's"	TRANSCRIPT	false
6	"that is	TRANSCRIPT	false
7	unset	END_OF_SINGLE_UTTERANCE	unset
8	" that is the question"	TRANSCRIPT	true

Concatenating the finalized transcripts withis_final` set to true, the complete utterance becomes "to be or not to be that is the question".

Protobuf type google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult

StreamingRecognitionResult.Builder

Num	transcript	message_type	is_final
1	"tube"	TRANSCRIPT	false
2	"to be a"	TRANSCRIPT	false
3	"to be"	TRANSCRIPT	false
4	"to be or not to be"	TRANSCRIPT	true
5	"that's"	TRANSCRIPT	false
6	"that is	TRANSCRIPT	false
7	unset	END_OF_SINGLE_UTTERANCE	unset
8	" that is the question"	TRANSCRIPT	true

Concatenating the finalized transcripts withis_final` set to true, the complete utterance becomes "to be or not to be that is the question".

Protobuf type google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult

SynthesizeSpeechConfig

Configuration of how speech should be synthesized.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig

SynthesizeSpeechConfig.Builder

Configuration of how speech should be synthesized.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig

TestCase

Represents a test case.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestCase

TestCase.Builder

Represents a test case.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestCase

TestCaseError

Error info for importing a test.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestCaseError

TestCaseError.Builder

Error info for importing a test.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestCaseError

TestCaseName

TestCaseName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}.

TestCaseProto

TestCaseResult

Represents a result from running a test case in an agent environment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestCaseResult

TestCaseResult.Builder

Represents a result from running a test case in an agent environment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestCaseResult

TestCaseResultName

TestCaseResultName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}/results/{result}.

TestCasesClient

Service Description: Service for managing Test Cases and Test Case Results.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TestCasesClient testCasesClient = TestCasesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   testCasesClient.batchDeleteTestCases(parent);
 }

Note: close() needs to be called on the TestCasesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of TestCasesSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TestCasesSettings testCasesSettings =
     TestCasesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TestCasesClient testCasesClient = TestCasesClient.create(testCasesSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TestCasesSettings testCasesSettings =
     TestCasesSettings.newBuilder().setEndpoint(myEndpoint).build();
 TestCasesClient testCasesClient = TestCasesClient.create(testCasesSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TestCasesSettings testCasesSettings = TestCasesSettings.newHttpJsonBuilder().build();
 TestCasesClient testCasesClient = TestCasesClient.create(testCasesSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

TestCasesClient.ListLocationsFixedSizeCollection

TestCasesClient.ListLocationsPage

TestCasesClient.ListLocationsPagedResponse

TestCasesClient.ListTestCaseResultsFixedSizeCollection

TestCasesClient.ListTestCaseResultsPage

TestCasesClient.ListTestCaseResultsPagedResponse

TestCasesClient.ListTestCasesFixedSizeCollection

TestCasesClient.ListTestCasesPage

TestCasesClient.ListTestCasesPagedResponse

TestCasesGrpc

Service for managing Test Cases and Test Case Results.

TestCasesGrpc.TestCasesBlockingStub

A stub to allow clients to do synchronous rpc calls to service TestCases.

Service for managing Test Cases and Test Case Results.

TestCasesGrpc.TestCasesFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service TestCases.

Service for managing Test Cases and Test Case Results.

TestCasesGrpc.TestCasesImplBase

Base class for the server implementation of the service TestCases.

Service for managing Test Cases and Test Case Results.

TestCasesGrpc.TestCasesStub

A stub to allow clients to do asynchronous rpc calls to service TestCases.

Service for managing Test Cases and Test Case Results.

TestCasesSettings

Settings class to configure an instance of TestCasesClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of batchDeleteTestCases to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TestCasesSettings.Builder testCasesSettingsBuilder = TestCasesSettings.newBuilder();
 testCasesSettingsBuilder
     .batchDeleteTestCasesSettings()
     .setRetrySettings(
         testCasesSettingsBuilder
             .batchDeleteTestCasesSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TestCasesSettings testCasesSettings = testCasesSettingsBuilder.build();

TestCasesSettings.Builder

Builder for TestCasesSettings.

TestConfig

Represents configurations for a test case.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestConfig

TestConfig.Builder

Represents configurations for a test case.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestConfig

TestError

Error info for running a test.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestError

TestError.Builder

Error info for running a test.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestError

TestRunDifference

The description of differences between original and replayed agent output.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestRunDifference

TestRunDifference.Builder

The description of differences between original and replayed agent output.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TestRunDifference

TextInput

Represents the natural language text to be processed.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TextInput

TextInput.Builder

Represents the natural language text to be processed.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TextInput

TextToSpeechSettings

Settings related to speech generating.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TextToSpeechSettings

TextToSpeechSettings.Builder

Settings related to speech generating.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TextToSpeechSettings

TrainFlowRequest

The request message for Flows.TrainFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TrainFlowRequest

TrainFlowRequest.Builder

The request message for Flows.TrainFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TrainFlowRequest

TransitionCoverage

Transition coverage represents the percentage of all possible page transitions (page-level transition routes and event handlers, excluding transition route groups) present within any of a parent's test cases.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionCoverage

TransitionCoverage.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionCoverage

TransitionCoverage.Transition

A transition in a page.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionCoverage.Transition

TransitionCoverage.Transition.Builder

A transition in a page.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionCoverage.Transition

TransitionCoverage.TransitionNode

The source or target of a transition.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionCoverage.TransitionNode

TransitionCoverage.TransitionNode.Builder

The source or target of a transition.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionCoverage.TransitionNode

TransitionRoute

A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order:

If there is a trigger_fulfillment associated with the transition, it will be called.
If there is a target_page associated with the transition, the session will transition into the specified page.
If there is a target_flow associated with the transition, the session will transition into the specified flow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRoute

TransitionRoute.Builder

If there is a trigger_fulfillment associated with the transition, it will be called.
If there is a target_page associated with the transition, the session will transition into the specified page.
If there is a target_flow associated with the transition, the session will transition into the specified flow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRoute

TransitionRouteGroup

An TransitionRouteGroup represents a group of TransitionRoutes to be used by a Page.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup

TransitionRouteGroup.Builder

An TransitionRouteGroup represents a group of TransitionRoutes to be used by a Page.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup

TransitionRouteGroupCoverage

Transition route group coverage represents the percentage of all possible transition routes present within any of a parent's test cases. The results are grouped by the transition route group.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroupCoverage

TransitionRouteGroupCoverage.Builder

Transition route group coverage represents the percentage of all possible transition routes present within any of a parent's test cases. The results are grouped by the transition route group.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroupCoverage

TransitionRouteGroupCoverage.Coverage

Coverage result message for one transition route group.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroupCoverage.Coverage

TransitionRouteGroupCoverage.Coverage.Builder

Coverage result message for one transition route group.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroupCoverage.Coverage

TransitionRouteGroupCoverage.Coverage.Transition

A transition coverage in a transition route group.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroupCoverage.Coverage.Transition

TransitionRouteGroupCoverage.Coverage.Transition.Builder

A transition coverage in a transition route group.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroupCoverage.Coverage.Transition

TransitionRouteGroupName

TransitionRouteGroupName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/transitionRouteGroups/{transition_route_group}.

TransitionRouteGroupProto

TransitionRouteGroupsClient

Service Description: Service for managing TransitionRouteGroups.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create()) {
   TransitionRouteGroupName name =
       TransitionRouteGroupName.of(
           "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]");
   TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name);
 }

Note: close() needs to be called on the TransitionRouteGroupsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of TransitionRouteGroupsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TransitionRouteGroupsSettings transitionRouteGroupsSettings =
     TransitionRouteGroupsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create(transitionRouteGroupsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TransitionRouteGroupsSettings transitionRouteGroupsSettings =
     TransitionRouteGroupsSettings.newBuilder().setEndpoint(myEndpoint).build();
 TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create(transitionRouteGroupsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TransitionRouteGroupsSettings transitionRouteGroupsSettings =
     TransitionRouteGroupsSettings.newHttpJsonBuilder().build();
 TransitionRouteGroupsClient transitionRouteGroupsClient =
     TransitionRouteGroupsClient.create(transitionRouteGroupsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

TransitionRouteGroupsClient.ListLocationsFixedSizeCollection

TransitionRouteGroupsClient.ListLocationsPage

TransitionRouteGroupsClient.ListLocationsPagedResponse

TransitionRouteGroupsClient.ListTransitionRouteGroupsFixedSizeCollection

TransitionRouteGroupsClient.ListTransitionRouteGroupsPage

TransitionRouteGroupsClient.ListTransitionRouteGroupsPagedResponse

TransitionRouteGroupsGrpc

Service for managing TransitionRouteGroups.

TransitionRouteGroupsGrpc.TransitionRouteGroupsBlockingStub

A stub to allow clients to do synchronous rpc calls to service TransitionRouteGroups.

Service for managing TransitionRouteGroups.

TransitionRouteGroupsGrpc.TransitionRouteGroupsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service TransitionRouteGroups.

Service for managing TransitionRouteGroups.

TransitionRouteGroupsGrpc.TransitionRouteGroupsImplBase

Base class for the server implementation of the service TransitionRouteGroups.

Service for managing TransitionRouteGroups.

TransitionRouteGroupsGrpc.TransitionRouteGroupsStub

A stub to allow clients to do asynchronous rpc calls to service TransitionRouteGroups.

Service for managing TransitionRouteGroups.

TransitionRouteGroupsSettings

Settings class to configure an instance of TransitionRouteGroupsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getTransitionRouteGroup to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TransitionRouteGroupsSettings.Builder transitionRouteGroupsSettingsBuilder =
     TransitionRouteGroupsSettings.newBuilder();
 transitionRouteGroupsSettingsBuilder
     .getTransitionRouteGroupSettings()
     .setRetrySettings(
         transitionRouteGroupsSettingsBuilder
             .getTransitionRouteGroupSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TransitionRouteGroupsSettings transitionRouteGroupsSettings =
     transitionRouteGroupsSettingsBuilder.build();

TransitionRouteGroupsSettings.Builder

Builder for TransitionRouteGroupsSettings.

UpdateAgentRequest

The request message for Agents.UpdateAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateAgentRequest

UpdateAgentRequest.Builder

The request message for Agents.UpdateAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateAgentRequest

UpdateEntityTypeRequest

The request message for EntityTypes.UpdateEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateEntityTypeRequest

UpdateEntityTypeRequest.Builder

The request message for EntityTypes.UpdateEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateEntityTypeRequest

UpdateEnvironmentRequest

The request message for Environments.UpdateEnvironment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateEnvironmentRequest

UpdateEnvironmentRequest.Builder

The request message for Environments.UpdateEnvironment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateEnvironmentRequest

UpdateExperimentRequest

The request message for Experiments.UpdateExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateExperimentRequest

UpdateExperimentRequest.Builder

The request message for Experiments.UpdateExperiment.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateExperimentRequest

UpdateFlowRequest

The request message for Flows.UpdateFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateFlowRequest

UpdateFlowRequest.Builder

The request message for Flows.UpdateFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateFlowRequest

UpdateIntentRequest

The request message for Intents.UpdateIntent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateIntentRequest

UpdateIntentRequest.Builder

The request message for Intents.UpdateIntent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateIntentRequest

UpdatePageRequest

The request message for Pages.UpdatePage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdatePageRequest

UpdatePageRequest.Builder

The request message for Pages.UpdatePage.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdatePageRequest

UpdateSecuritySettingsRequest

The request message for SecuritySettingsService.UpdateSecuritySettings.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateSecuritySettingsRequest

UpdateSecuritySettingsRequest.Builder

The request message for SecuritySettingsService.UpdateSecuritySettings.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateSecuritySettingsRequest

UpdateSessionEntityTypeRequest

The request message for SessionEntityTypes.UpdateSessionEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateSessionEntityTypeRequest

UpdateSessionEntityTypeRequest.Builder

The request message for SessionEntityTypes.UpdateSessionEntityType.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateSessionEntityTypeRequest

UpdateTestCaseRequest

The request message for TestCases.UpdateTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateTestCaseRequest

UpdateTestCaseRequest.Builder

The request message for TestCases.UpdateTestCase.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateTestCaseRequest

UpdateTransitionRouteGroupRequest

The request message for TransitionRouteGroups.UpdateTransitionRouteGroup.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateTransitionRouteGroupRequest

UpdateTransitionRouteGroupRequest.Builder

The request message for TransitionRouteGroups.UpdateTransitionRouteGroup.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateTransitionRouteGroupRequest

UpdateVersionRequest

The request message for Versions.UpdateVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateVersionRequest

UpdateVersionRequest.Builder

The request message for Versions.UpdateVersion.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateVersionRequest

UpdateWebhookRequest

The request message for Webhooks.UpdateWebhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateWebhookRequest

UpdateWebhookRequest.Builder

The request message for Webhooks.UpdateWebhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.UpdateWebhookRequest

ValidateAgentRequest

The request message for Agents.ValidateAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ValidateAgentRequest

ValidateAgentRequest.Builder

The request message for Agents.ValidateAgent.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ValidateAgentRequest

ValidateFlowRequest

The request message for Flows.ValidateFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ValidateFlowRequest

ValidateFlowRequest.Builder

The request message for Flows.ValidateFlow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ValidateFlowRequest

ValidationMessage

Agent/flow validation message.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ValidationMessage

ValidationMessage.Builder

Agent/flow validation message.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ValidationMessage

ValidationMessageProto

VariantsHistory

The history of variants update.

Protobuf type google.cloud.dialogflow.cx.v3beta1.VariantsHistory

VariantsHistory.Builder

The history of variants update.

Protobuf type google.cloud.dialogflow.cx.v3beta1.VariantsHistory

Version

Represents a version of a flow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Version

Version.Builder

Represents a version of a flow.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Version

VersionName

VersionName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/versions/{version}.

VersionProto

VersionVariants

A list of flow version variants.

Protobuf type google.cloud.dialogflow.cx.v3beta1.VersionVariants

VersionVariants.Builder

A list of flow version variants.

Protobuf type google.cloud.dialogflow.cx.v3beta1.VersionVariants

VersionVariants.Variant

A single flow version with specified traffic allocation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.VersionVariants.Variant

VersionVariants.Variant.Builder

A single flow version with specified traffic allocation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.VersionVariants.Variant

VersionsClient

Service Description: Service for managing Versions.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VersionsClient versionsClient = VersionsClient.create()) {
   VersionName name =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]");
   Version response = versionsClient.getVersion(name);
 }

Note: close() needs to be called on the VersionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of VersionsSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VersionsSettings versionsSettings =
     VersionsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VersionsClient versionsClient = VersionsClient.create(versionsSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VersionsSettings versionsSettings =
     VersionsSettings.newBuilder().setEndpoint(myEndpoint).build();
 VersionsClient versionsClient = VersionsClient.create(versionsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VersionsSettings versionsSettings = VersionsSettings.newHttpJsonBuilder().build();
 VersionsClient versionsClient = VersionsClient.create(versionsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

VersionsClient.ListLocationsFixedSizeCollection

VersionsClient.ListLocationsPage

VersionsClient.ListLocationsPagedResponse

VersionsClient.ListVersionsFixedSizeCollection

VersionsClient.ListVersionsPage

VersionsClient.ListVersionsPagedResponse

VersionsGrpc

Service for managing Versions.

VersionsGrpc.VersionsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Versions.

Service for managing Versions.

VersionsGrpc.VersionsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Versions.

Service for managing Versions.

VersionsGrpc.VersionsImplBase

Base class for the server implementation of the service Versions.

Service for managing Versions.

VersionsGrpc.VersionsStub

A stub to allow clients to do asynchronous rpc calls to service Versions.

Service for managing Versions.

VersionsSettings

Settings class to configure an instance of VersionsClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getVersion to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VersionsSettings.Builder versionsSettingsBuilder = VersionsSettings.newBuilder();
 versionsSettingsBuilder
     .getVersionSettings()
     .setRetrySettings(
         versionsSettingsBuilder
             .getVersionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VersionsSettings versionsSettings = versionsSettingsBuilder.build();

VersionsSettings.Builder

Builder for VersionsSettings.

VoiceSelectionParams

Description of which voice to use for speech synthesis.

Protobuf type google.cloud.dialogflow.cx.v3beta1.VoiceSelectionParams

VoiceSelectionParams.Builder

Description of which voice to use for speech synthesis.

Protobuf type google.cloud.dialogflow.cx.v3beta1.VoiceSelectionParams

Webhook

Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Webhook

Webhook.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.Webhook

Webhook.GenericWebService

Represents configuration for a generic web service.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService

Webhook.GenericWebService.Builder

Represents configuration for a generic web service.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService

Webhook.ServiceDirectoryConfig

Represents configuration for a Service Directory service.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfig

Webhook.ServiceDirectoryConfig.Builder

Represents configuration for a Service Directory service.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfig

WebhookName

WebhookName.Builder

Builder for projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}.

WebhookProto

WebhookRequest

The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest

WebhookRequest.Builder

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest

WebhookRequest.FulfillmentInfo

Represents fulfillment information communicated to the webhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest.FulfillmentInfo

WebhookRequest.FulfillmentInfo.Builder

Represents fulfillment information communicated to the webhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest.FulfillmentInfo

WebhookRequest.IntentInfo

Represents intent information communicated to the webhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest.IntentInfo

WebhookRequest.IntentInfo.Builder

Represents intent information communicated to the webhook.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest.IntentInfo

WebhookRequest.IntentInfo.IntentParameterValue

Represents a value for an intent parameter.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest.IntentInfo.IntentParameterValue

WebhookRequest.IntentInfo.IntentParameterValue.Builder

Represents a value for an intent parameter.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest.IntentInfo.IntentParameterValue

WebhookRequest.SentimentAnalysisResult

Represents the result of sentiment analysis.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest.SentimentAnalysisResult

WebhookRequest.SentimentAnalysisResult.Builder

Represents the result of sentiment analysis.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookRequest.SentimentAnalysisResult

WebhookResponse

The response message for a webhook call.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookResponse

WebhookResponse.Builder

The response message for a webhook call.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookResponse

WebhookResponse.FulfillmentResponse

Represents a fulfillment response to the user.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookResponse.FulfillmentResponse

WebhookResponse.FulfillmentResponse.Builder

Represents a fulfillment response to the user.

Protobuf type google.cloud.dialogflow.cx.v3beta1.WebhookResponse.FulfillmentResponse

WebhooksClient

Service Description: Service for managing Webhooks.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WebhooksClient webhooksClient = WebhooksClient.create()) {
   WebhookName name = WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
   Webhook response = webhooksClient.getWebhook(name);
 }

Note: close() needs to be called on the WebhooksClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of WebhooksSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebhooksSettings webhooksSettings =
     WebhooksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WebhooksClient webhooksClient = WebhooksClient.create(webhooksSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebhooksSettings webhooksSettings =
     WebhooksSettings.newBuilder().setEndpoint(myEndpoint).build();
 WebhooksClient webhooksClient = WebhooksClient.create(webhooksSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebhooksSettings webhooksSettings = WebhooksSettings.newHttpJsonBuilder().build();
 WebhooksClient webhooksClient = WebhooksClient.create(webhooksSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

WebhooksClient.ListLocationsFixedSizeCollection

WebhooksClient.ListLocationsPage

WebhooksClient.ListLocationsPagedResponse

WebhooksClient.ListWebhooksFixedSizeCollection

WebhooksClient.ListWebhooksPage

WebhooksClient.ListWebhooksPagedResponse

WebhooksGrpc

Service for managing Webhooks.

WebhooksGrpc.WebhooksBlockingStub

A stub to allow clients to do synchronous rpc calls to service Webhooks.

Service for managing Webhooks.

WebhooksGrpc.WebhooksFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Webhooks.

Service for managing Webhooks.

WebhooksGrpc.WebhooksImplBase

Base class for the server implementation of the service Webhooks.

Service for managing Webhooks.

WebhooksGrpc.WebhooksStub

A stub to allow clients to do asynchronous rpc calls to service Webhooks.

Service for managing Webhooks.

WebhooksSettings

Settings class to configure an instance of WebhooksClient.

The default instance has everything set to sensible defaults:

The default service address (dialogflow.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getWebhook to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebhooksSettings.Builder webhooksSettingsBuilder = WebhooksSettings.newBuilder();
 webhooksSettingsBuilder
     .getWebhookSettings()
     .setRetrySettings(
         webhooksSettingsBuilder
             .getWebhookSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 WebhooksSettings webhooksSettings = webhooksSettingsBuilder.build();

WebhooksSettings.Builder

Builder for WebhooksSettings.

Interfaces

AdvancedSettings.LoggingSettingsOrBuilder

AdvancedSettingsOrBuilder

AgentOrBuilder

AgentValidationResultOrBuilder

AgentsGrpc.AsyncService

Service for managing Agents.

AudioInputOrBuilder

BatchDeleteTestCasesRequestOrBuilder

BatchRunTestCasesMetadataOrBuilder

BatchRunTestCasesRequestOrBuilder

BatchRunTestCasesResponseOrBuilder

CalculateCoverageRequestOrBuilder

CalculateCoverageResponseOrBuilder

ChangelogOrBuilder

ChangelogsGrpc.AsyncService

Service for managing Changelogs.

CompareVersionsRequestOrBuilder

CompareVersionsResponseOrBuilder

ContinuousTestResultOrBuilder

ConversationTurn.UserInputOrBuilder

ConversationTurn.VirtualAgentOutputOrBuilder

ConversationTurnOrBuilder

CreateAgentRequestOrBuilder

CreateEntityTypeRequestOrBuilder

CreateEnvironmentRequestOrBuilder

CreateExperimentRequestOrBuilder

CreateFlowRequestOrBuilder

CreateIntentRequestOrBuilder

CreatePageRequestOrBuilder

CreateSecuritySettingsRequestOrBuilder

CreateSessionEntityTypeRequestOrBuilder

CreateTestCaseRequestOrBuilder

CreateTransitionRouteGroupRequestOrBuilder

CreateVersionOperationMetadataOrBuilder

CreateVersionRequestOrBuilder

CreateWebhookRequestOrBuilder

DeleteAgentRequestOrBuilder

DeleteEntityTypeRequestOrBuilder

DeleteEnvironmentRequestOrBuilder

DeleteExperimentRequestOrBuilder

DeleteFlowRequestOrBuilder

DeleteIntentRequestOrBuilder

DeletePageRequestOrBuilder

DeleteSecuritySettingsRequestOrBuilder

DeleteSessionEntityTypeRequestOrBuilder

DeleteTransitionRouteGroupRequestOrBuilder

DeleteVersionRequestOrBuilder

DeleteWebhookRequestOrBuilder

DeployFlowMetadataOrBuilder

DeployFlowRequestOrBuilder

DeployFlowResponseOrBuilder

Deployment.ResultOrBuilder

DeploymentOrBuilder

DeploymentsGrpc.AsyncService

Service for managing Deployments.

DetectIntentRequestOrBuilder

DetectIntentResponseOrBuilder

DtmfInputOrBuilder

EntityType.EntityOrBuilder

EntityType.ExcludedPhraseOrBuilder

EntityTypeOrBuilder

EntityTypesGrpc.AsyncService

Service for managing EntityTypes.

Environment.TestCasesConfigOrBuilder

Environment.VersionConfigOrBuilder

Environment.WebhookConfigOrBuilder

EnvironmentOrBuilder

EnvironmentsGrpc.AsyncService

Service for managing Environments.

EventHandlerOrBuilder

EventInputOrBuilder

Experiment.DefinitionOrBuilder

Experiment.Result.ConfidenceIntervalOrBuilder

Experiment.Result.MetricOrBuilder

Experiment.Result.VersionMetricsOrBuilder

Experiment.ResultOrBuilder

ExperimentOrBuilder

ExperimentsGrpc.AsyncService

Service for managing Experiments.

ExportAgentRequestOrBuilder

ExportAgentResponseOrBuilder

ExportFlowRequestOrBuilder

ExportFlowResponseOrBuilder

ExportTestCasesMetadataOrBuilder

ExportTestCasesRequestOrBuilder

ExportTestCasesResponseOrBuilder

FlowOrBuilder

FlowValidationResultOrBuilder

FlowsGrpc.AsyncService

Service for managing Flows.

Form.Parameter.FillBehaviorOrBuilder

Form.ParameterOrBuilder

FormOrBuilder

FulfillIntentRequestOrBuilder

FulfillIntentResponseOrBuilder

Fulfillment.ConditionalCases.Case.CaseContentOrBuilder

Fulfillment.ConditionalCases.CaseOrBuilder

Fulfillment.ConditionalCasesOrBuilder

Fulfillment.SetParameterActionOrBuilder

FulfillmentOrBuilder

GcsDestinationOrBuilder

GetAgentRequestOrBuilder

GetAgentValidationResultRequestOrBuilder

GetChangelogRequestOrBuilder

GetDeploymentRequestOrBuilder

GetEntityTypeRequestOrBuilder

GetEnvironmentRequestOrBuilder

GetExperimentRequestOrBuilder

GetFlowRequestOrBuilder

GetFlowValidationResultRequestOrBuilder

GetIntentRequestOrBuilder

GetPageRequestOrBuilder

GetSecuritySettingsRequestOrBuilder

GetSessionEntityTypeRequestOrBuilder

GetTestCaseRequestOrBuilder

GetTestCaseResultRequestOrBuilder

GetTransitionRouteGroupRequestOrBuilder

GetVersionRequestOrBuilder

GetWebhookRequestOrBuilder

ImportFlowRequestOrBuilder

ImportFlowResponseOrBuilder

ImportTestCasesMetadataOrBuilder

ImportTestCasesRequestOrBuilder

ImportTestCasesResponseOrBuilder

InputAudioConfigOrBuilder

Intent.ParameterOrBuilder

Intent.TrainingPhrase.PartOrBuilder

Intent.TrainingPhraseOrBuilder

IntentCoverage.IntentOrBuilder

IntentCoverageOrBuilder

IntentInputOrBuilder

IntentOrBuilder

IntentsGrpc.AsyncService

Service for managing Intents.

ListAgentsRequestOrBuilder

ListAgentsResponseOrBuilder

ListChangelogsRequestOrBuilder

ListChangelogsResponseOrBuilder

ListContinuousTestResultsRequestOrBuilder

ListContinuousTestResultsResponseOrBuilder

ListDeploymentsRequestOrBuilder

ListDeploymentsResponseOrBuilder

ListEntityTypesRequestOrBuilder

ListEntityTypesResponseOrBuilder

ListEnvironmentsRequestOrBuilder

ListEnvironmentsResponseOrBuilder

ListExperimentsRequestOrBuilder

ListExperimentsResponseOrBuilder

ListFlowsRequestOrBuilder

ListFlowsResponseOrBuilder

ListIntentsRequestOrBuilder

ListIntentsResponseOrBuilder

ListPagesRequestOrBuilder

ListPagesResponseOrBuilder

ListSecuritySettingsRequestOrBuilder

ListSecuritySettingsResponseOrBuilder

ListSessionEntityTypesRequestOrBuilder

ListSessionEntityTypesResponseOrBuilder

ListTestCaseResultsRequestOrBuilder

ListTestCaseResultsResponseOrBuilder

ListTestCasesRequestOrBuilder

ListTestCasesResponseOrBuilder

ListTransitionRouteGroupsRequestOrBuilder

ListTransitionRouteGroupsResponseOrBuilder

ListVersionsRequestOrBuilder

ListVersionsResponseOrBuilder

ListWebhooksRequestOrBuilder

ListWebhooksResponseOrBuilder

LoadVersionRequestOrBuilder

LookupEnvironmentHistoryRequestOrBuilder

LookupEnvironmentHistoryResponseOrBuilder

MatchIntentRequestOrBuilder

MatchIntentResponseOrBuilder

MatchOrBuilder

NluSettingsOrBuilder

OutputAudioConfigOrBuilder

PageInfo.FormInfo.ParameterInfoOrBuilder

PageInfo.FormInfoOrBuilder

PageInfoOrBuilder

PageOrBuilder

PagesGrpc.AsyncService

Service for managing Pages.

QueryInputOrBuilder

QueryParametersOrBuilder

QueryResultOrBuilder

ResourceNameOrBuilder

ResponseMessage.ConversationSuccessOrBuilder

ResponseMessage.EndInteractionOrBuilder

ResponseMessage.LiveAgentHandoffOrBuilder

ResponseMessage.MixedAudio.SegmentOrBuilder

ResponseMessage.MixedAudioOrBuilder

ResponseMessage.OutputAudioTextOrBuilder

ResponseMessage.PlayAudioOrBuilder

ResponseMessage.TelephonyTransferCallOrBuilder

ResponseMessage.TextOrBuilder

ResponseMessageOrBuilder

RestoreAgentRequestOrBuilder

RolloutConfig.RolloutStepOrBuilder

RolloutConfigOrBuilder

RolloutStateOrBuilder

RunContinuousTestMetadataOrBuilder

RunContinuousTestRequestOrBuilder

RunContinuousTestResponseOrBuilder

RunTestCaseMetadataOrBuilder

RunTestCaseRequestOrBuilder

RunTestCaseResponseOrBuilder

SecuritySettings.AudioExportSettingsOrBuilder

SecuritySettings.InsightsExportSettingsOrBuilder

SecuritySettingsOrBuilder

SecuritySettingsServiceGrpc.AsyncService

Service for managing security settings for Dialogflow.

SentimentAnalysisResultOrBuilder

SessionEntityTypeOrBuilder

SessionEntityTypesGrpc.AsyncService

Service for managing SessionEntityTypes.

SessionInfoOrBuilder

SessionsGrpc.AsyncService

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.

SpeechToTextSettingsOrBuilder

SpeechWordInfoOrBuilder

StartExperimentRequestOrBuilder

StopExperimentRequestOrBuilder

StreamingDetectIntentRequestOrBuilder

StreamingDetectIntentResponseOrBuilder

StreamingRecognitionResultOrBuilder

SynthesizeSpeechConfigOrBuilder

TestCaseErrorOrBuilder

TestCaseOrBuilder

TestCaseResultOrBuilder

TestCasesGrpc.AsyncService

Service for managing Test Cases and Test Case Results.

TestConfigOrBuilder

TestErrorOrBuilder

TestRunDifferenceOrBuilder

TextInputOrBuilder

TextToSpeechSettingsOrBuilder

TrainFlowRequestOrBuilder

TransitionCoverage.TransitionNodeOrBuilder

TransitionCoverage.TransitionOrBuilder

TransitionCoverageOrBuilder

TransitionRouteGroupCoverage.Coverage.TransitionOrBuilder

TransitionRouteGroupCoverage.CoverageOrBuilder

TransitionRouteGroupCoverageOrBuilder

TransitionRouteGroupOrBuilder

TransitionRouteGroupsGrpc.AsyncService

Service for managing TransitionRouteGroups.

TransitionRouteOrBuilder

UpdateAgentRequestOrBuilder

UpdateEntityTypeRequestOrBuilder

UpdateEnvironmentRequestOrBuilder

UpdateExperimentRequestOrBuilder

UpdateFlowRequestOrBuilder

UpdateIntentRequestOrBuilder

UpdatePageRequestOrBuilder

UpdateSecuritySettingsRequestOrBuilder

UpdateSessionEntityTypeRequestOrBuilder

UpdateTestCaseRequestOrBuilder

UpdateTransitionRouteGroupRequestOrBuilder

UpdateVersionRequestOrBuilder

UpdateWebhookRequestOrBuilder

ValidateAgentRequestOrBuilder

ValidateFlowRequestOrBuilder

ValidationMessageOrBuilder

VariantsHistoryOrBuilder

VersionOrBuilder

VersionVariants.VariantOrBuilder

VersionVariantsOrBuilder

VersionsGrpc.AsyncService

Service for managing Versions.

VoiceSelectionParamsOrBuilder

Webhook.GenericWebServiceOrBuilder

Webhook.ServiceDirectoryConfigOrBuilder

WebhookOrBuilder

WebhookRequest.FulfillmentInfoOrBuilder

WebhookRequest.IntentInfo.IntentParameterValueOrBuilder

WebhookRequest.IntentInfoOrBuilder

WebhookRequest.SentimentAnalysisResultOrBuilder

WebhookRequestOrBuilder

WebhookResponse.FulfillmentResponseOrBuilder

WebhookResponseOrBuilder

WebhooksGrpc.AsyncService

Service for managing Webhooks.

Enums

AudioEncoding

Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.AudioEncoding

CalculateCoverageRequest.CoverageType

The type of coverage score requested.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.CalculateCoverageRequest.CoverageType

CalculateCoverageResponse.CoverageTypeCase

ContinuousTestResult.AggregatedTestResult

The overall result for a continuous test run in an agent environment.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.ContinuousTestResult.AggregatedTestResult

Deployment.State

The state of the deployment.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.Deployment.State

DetectIntentResponse.ResponseType

Represents different DetectIntentResponse types.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse.ResponseType

EntityType.AutoExpansionMode

Represents different entity type expansion modes. Automated expansion allows an agent to recognize values that have not been explicitly listed in the entity (for example, new kinds of shopping list items).

Protobuf enum google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode

EntityType.Kind

Represents kinds of entities.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.EntityType.Kind

EventHandler.TargetCase

Experiment.Definition.VariantsCase

Experiment.Result.CountType

types of count-based metric for Dialogflow experiment.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.Experiment.Result.CountType

Experiment.Result.Metric.ValueCase

Experiment.Result.MetricType

Types of ratio-based metric for Dialogflow experiment.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.Experiment.Result.MetricType

Experiment.State

The state of the experiment.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.Experiment.State

ExportAgentRequest.DataFormat

Data format of the exported agent.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.ExportAgentRequest.DataFormat

ExportAgentResponse.AgentCase

ExportFlowResponse.FlowCase

ExportTestCasesRequest.DataFormat

Data format of the exported test cases.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.ExportTestCasesRequest.DataFormat

ExportTestCasesRequest.DestinationCase

ExportTestCasesResponse.DestinationCase

Fulfillment.ConditionalCases.Case.CaseContent.CasesOrMessageCase

ImportFlowRequest.FlowCase

ImportFlowRequest.ImportOption

Import option.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.ImportFlowRequest.ImportOption

ImportTestCasesRequest.SourceCase

IntentView

Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.IntentView

ListTestCasesRequest.TestCaseView

Specifies how much test case information to include in the response.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.ListTestCasesRequest.TestCaseView

Match.MatchType

Type of a Match.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.Match.MatchType

MatchIntentResponse.QueryCase

NluSettings.ModelTrainingMode

NLU model training mode.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.NluSettings.ModelTrainingMode

NluSettings.ModelType

NLU model type.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.NluSettings.ModelType

OutputAudioEncoding

Audio encoding of the output audio format in Text-To-Speech.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.OutputAudioEncoding

PageInfo.FormInfo.ParameterInfo.ParameterState

Represents the state of a parameter.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo.ParameterInfo.ParameterState

QueryInput.InputCase

QueryResult.QueryCase

ResponseMessage.MessageCase

ResponseMessage.MixedAudio.Segment.ContentCase

ResponseMessage.OutputAudioText.SourceCase

ResponseMessage.TelephonyTransferCall.EndpointCase

RestoreAgentRequest.AgentCase

RestoreAgentRequest.RestoreOption

Restore option.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.RestoreAgentRequest.RestoreOption

SecuritySettings.AudioExportSettings.AudioFormat

File format for exported audio file. Currently only in telephony recordings.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings.AudioFormat

SecuritySettings.DataRetentionCase

SecuritySettings.PurgeDataType

Type of data we purge after retention settings triggers purge.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType

SecuritySettings.RedactionScope

Defines what types of data to redact.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionScope

SecuritySettings.RedactionStrategy

Defines how we redact data.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionStrategy

SessionEntityType.EntityOverrideMode

The types of modifications for the session entity type.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.SessionEntityType.EntityOverrideMode

SpeechModelVariant

Variant of the specified Speech model to use. See the Cloud Speech documentation for which models have different variants. For example, the "phone_call" model has both a standard and an enhanced variant. When you use an enhanced model, you will generally receive higher quality results than for a standard model.

Protobuf enum google.cloud.dialogflow.cx.v3beta1.SpeechModelVariant