Namespace Google.Cloud.Dialogflow.Cx.V3 (1.5.0)

Classes

AdvancedSettings

Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level.

Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.

AdvancedSettings.Types

Container for nested types declared in the AdvancedSettings message type.

AdvancedSettings.Types.LoggingSettings

Define behaviors on logging.

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][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..

AgentName

Resource name for the Agent resource.

Agents

Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent].

Agents.AgentsBase

Base class for server-side implementations of Agents

Agents.AgentsClient

Client for Agents

AgentsClient

Agents client wrapper, for convenient use.

AgentsClientBuilder

Builder class for AgentsClient to provide simple configuration of credentials, endpoint etc.

AgentsClientImpl

Agents client wrapper implementation, for convenient use.

AgentsSettings

Settings for AgentsClient instances.

AgentValidationResult

The response message for [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].

AgentValidationResultName

Resource name for the AgentValidationResult resource.

AudioInput

Represents the natural speech audio to be processed.

BatchDeleteTestCasesRequest

The request message for [TestCases.BatchDeleteTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchDeleteTestCases].

BatchRunTestCasesMetadata

Metadata returned for the [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases] long running operation.

BatchRunTestCasesRequest

The request message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases].

BatchRunTestCasesResponse

The response message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases].

CalculateCoverageRequest

The request message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

CalculateCoverageRequest.Types

Container for nested types declared in the CalculateCoverageRequest message type.

CalculateCoverageResponse

The response message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

ContinuousTestResult

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

ContinuousTestResult.Types

Container for nested types declared in the ContinuousTestResult message type.

ContinuousTestResultName

Resource name for the ContinuousTestResult resource.

ConversationTurn

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

ConversationTurn.Types

Container for nested types declared in the ConversationTurn message type.

ConversationTurn.Types.UserInput

The input from the human user.

ConversationTurn.Types.VirtualAgentOutput

The output from the virtual agent.

CreateAgentRequest

The request message for [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].

CreateEntityTypeRequest

The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.CreateEntityType].

CreateEnvironmentRequest

The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.cx.v3.Environments.CreateEnvironment].

CreateExperimentRequest

The request message for [Experiments.CreateExperiment][google.cloud.dialogflow.cx.v3.Experiments.CreateExperiment].

CreateFlowRequest

The request message for [Flows.CreateFlow][google.cloud.dialogflow.cx.v3.Flows.CreateFlow].

CreateIntentRequest

The request message for [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent].

CreatePageRequest

The request message for [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage].

CreateSecuritySettingsRequest

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

CreateSessionEntityTypeRequest

The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.CreateSessionEntityType].

CreateTestCaseRequest

The request message for [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3.TestCases.CreateTestCase].

CreateTransitionRouteGroupRequest

The request message for [TransitionRouteGroups.CreateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.CreateTransitionRouteGroup].

CreateVersionOperationMetadata

Metadata associated with the long running operation for [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].

CreateVersionRequest

The request message for [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].

CreateWebhookRequest

The request message for [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook].

DeidentifyTemplateName

Resource name for the DeidentifyTemplate resource.

DeleteAgentRequest

The request message for [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].

DeleteEntityTypeRequest

The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.DeleteEntityType].

DeleteEnvironmentRequest

The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.cx.v3.Environments.DeleteEnvironment].

DeleteExperimentRequest

The request message for [Experiments.DeleteExperiment][google.cloud.dialogflow.cx.v3.Experiments.DeleteExperiment].

DeleteFlowRequest

The request message for [Flows.DeleteFlow][google.cloud.dialogflow.cx.v3.Flows.DeleteFlow].

DeleteIntentRequest

The request message for [Intents.DeleteIntent][google.cloud.dialogflow.cx.v3.Intents.DeleteIntent].

DeletePageRequest

The request message for [Pages.DeletePage][google.cloud.dialogflow.cx.v3.Pages.DeletePage].

DeleteSecuritySettingsRequest

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

DeleteSessionEntityTypeRequest

The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.DeleteSessionEntityType].

DeleteTransitionRouteGroupRequest

The request message for [TransitionRouteGroups.DeleteTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.DeleteTransitionRouteGroup].

DeleteVersionRequest

The request message for [Versions.DeleteVersion][google.cloud.dialogflow.cx.v3.Versions.DeleteVersion].

DeleteWebhookRequest

The request message for [Webhooks.DeleteWebhook][google.cloud.dialogflow.cx.v3.Webhooks.DeleteWebhook].

DeployFlowMetadata

Metadata returned for the [Environments.DeployFlow][google.cloud.dialogflow.cx.v3.Environments.DeployFlow] long running operation.

DeployFlowRequest

The request message for [Environments.DeployFlow][google.cloud.dialogflow.cx.v3.Environments.DeployFlow].

DeployFlowResponse

The response message for [Environments.DeployFlow][google.cloud.dialogflow.cx.v3.Environments.DeployFlow].

Deployment

Represents an 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.

Deployment.Types

Container for nested types declared in the Deployment message type.

Deployment.Types.Result

Result of the deployment.

DeploymentName

Resource name for the Deployment resource.

Deployments

Service for managing [Deployments][google.cloud.dialogflow.cx.v3.Deployment].

Deployments.DeploymentsBase

Base class for server-side implementations of Deployments

Deployments.DeploymentsClient

Client for Deployments

DeploymentsClient

Deployments client wrapper, for convenient use.

DeploymentsClientBuilder

Builder class for DeploymentsClient to provide simple configuration of credentials, endpoint etc.

DeploymentsClientImpl

Deployments client wrapper implementation, for convenient use.

DeploymentsSettings

Settings for DeploymentsClient instances.

DetectIntentRequest

The request to detect user's intent.

DetectIntentResponse

The message returned from the DetectIntent method.

DetectIntentResponse.Types

Container for nested types declared in the DetectIntentResponse message type.

DtmfInput

Represents the input for dtmf event.

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][google.cloud.dialogflow.cx.v3.SessionEntityType] type.

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

EntityType.Types

Container for nested types declared in the EntityType message type.

EntityType.Types.Entity

An entity entry for an associated entity type.

EntityType.Types.ExcludedPhrase

An excluded entity phrase that should not be matched.

EntityTypeName

Resource name for the EntityType resource.

EntityTypes

Service for managing [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType].

EntityTypes.EntityTypesBase

Base class for server-side implementations of EntityTypes

EntityTypes.EntityTypesClient

Client for EntityTypes

EntityTypesClient

EntityTypes client wrapper, for convenient use.

EntityTypesClientBuilder

Builder class for EntityTypesClient to provide simple configuration of credentials, endpoint etc.

EntityTypesClientImpl

EntityTypes client wrapper implementation, for convenient use.

EntityTypesSettings

Settings for EntityTypesClient instances.

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.

Environment.Types

Container for nested types declared in the Environment message type.

Environment.Types.TestCasesConfig

The configuration for continuous tests.

Environment.Types.VersionConfig

Configuration for the version.

EnvironmentName

Resource name for the Environment resource.

Environments

Service for managing [Environments][google.cloud.dialogflow.cx.v3.Environment].

Environments.EnvironmentsBase

Base class for server-side implementations of Environments

Environments.EnvironmentsClient

Client for Environments

EnvironmentsClient

Environments client wrapper, for convenient use.

EnvironmentsClientBuilder

Builder class for EnvironmentsClient to provide simple configuration of credentials, endpoint etc.

EnvironmentsClientImpl

Environments client wrapper implementation, for convenient use.

EnvironmentsSettings

Settings for EnvironmentsClient instances.

EventHandler

An event handler specifies an [event][google.cloud.dialogflow.cx.v3.EventHandler.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][google.cloud.dialogflow.cx.v3.EventHandler.trigger_fulfillment] associated with the event, it will be called.
If there is a [target_page][google.cloud.dialogflow.cx.v3.EventHandler.target_page] associated with the event, the session will transition into the specified page.
If there is a [target_flow][google.cloud.dialogflow.cx.v3.EventHandler.target_flow] associated with the event, the session will transition into the specified flow.

EventInput

Represents the event to trigger.

Experiment

Represents an experiment in an environment.

Experiment.Types

Container for nested types declared in the Experiment message type.

Experiment.Types.Definition

Definition of the experiment.

Experiment.Types.Result

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

Experiment.Types.Result.Types

Container for nested types declared in the Result message type.

Experiment.Types.Result.Types.ConfidenceInterval

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

Experiment.Types.Result.Types.Metric

Metric and corresponding confidence intervals.

Experiment.Types.Result.Types.VersionMetrics

Version variant and associated metrics.

ExperimentName

Resource name for the Experiment resource.

Experiments

Service for managing [Experiments][google.cloud.dialogflow.cx.v3.Experiment].

Experiments.ExperimentsBase

Base class for server-side implementations of Experiments

Experiments.ExperimentsClient

Client for Experiments

ExperimentsClient

Experiments client wrapper, for convenient use.

ExperimentsClientBuilder

Builder class for ExperimentsClient to provide simple configuration of credentials, endpoint etc.

ExperimentsClientImpl

Experiments client wrapper implementation, for convenient use.

ExperimentsSettings

Settings for ExperimentsClient instances.

ExportAgentRequest

The request message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].

ExportAgentResponse

The response message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].

ExportFlowRequest

The request message for [Flows.ExportFlow][google.cloud.dialogflow.cx.v3.Flows.ExportFlow].

ExportFlowResponse

The response message for [Flows.ExportFlow][google.cloud.dialogflow.cx.v3.Flows.ExportFlow].

ExportTestCasesMetadata

Metadata returned for the [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases] long running operation. This message currently has no fields.

ExportTestCasesRequest

The request message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases].

ExportTestCasesRequest.Types

Container for nested types declared in the ExportTestCasesRequest message type.

ExportTestCasesResponse

The response message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases].

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.

FlowName

Resource name for the Flow resource.

Flows

Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].

Flows.FlowsBase

Base class for server-side implementations of Flows

Flows.FlowsClient

Client for Flows

FlowsClient

Flows client wrapper, for convenient use.

FlowsClientBuilder

Builder class for FlowsClient to provide simple configuration of credentials, endpoint etc.

FlowsClientImpl

Flows client wrapper implementation, for convenient use.

FlowsSettings

Settings for FlowsClient instances.

FlowValidationResult

The response message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

FlowValidationResultName

Resource name for the FlowValidationResult resource.

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][google.cloud.dialogflow.cx.v3.Page]. When form filling is done, the filled parameters will be written to the [session][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

Form.Types

Container for nested types declared in the Form message type.

Form.Types.Parameter

Represents a form parameter.

Form.Types.Parameter.Types

Container for nested types declared in the Parameter message type.

Form.Types.Parameter.Types.FillBehavior

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

FulfillIntentRequest

Request of [FulfillIntent][]

FulfillIntentResponse

Response of [FulfillIntent][]

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][google.cloud.dialogflow.cx.v3.Page] or [Form][google.cloud.dialogflow.cx.v3.Form] lifecycle. For example, when a [DetectIntentRequest][google.cloud.dialogflow.cx.v3.DetectIntentRequest] drives a session to enter a new page, the page's entry fulfillment can add a static response to the [QueryResult][google.cloud.dialogflow.cx.v3.QueryResult] in the returning [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse], call the webhook (for example, to load user data from a database), or both.

Fulfillment.Types

Container for nested types declared in the Fulfillment message type.

Fulfillment.Types.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.

Fulfillment.Types.ConditionalCases.Types

Container for nested types declared in the ConditionalCases message type.

Fulfillment.Types.ConditionalCases.Types.Case

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

Fulfillment.Types.ConditionalCases.Types.Case.Types

Container for nested types declared in the Case message type.

Fulfillment.Types.ConditionalCases.Types.Case.Types.CaseContent

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

Fulfillment.Types.SetParameterAction

Setting a parameter value.

GetAgentRequest

The request message for [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].

GetAgentValidationResultRequest

The request message for [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].

GetDeploymentRequest

The request message for [Deployments.GetDeployment][google.cloud.dialogflow.cx.v3.Deployments.GetDeployment].

GetEntityTypeRequest

The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.GetEntityType].

GetEnvironmentRequest

The request message for [Environments.GetEnvironment][google.cloud.dialogflow.cx.v3.Environments.GetEnvironment].

GetExperimentRequest

The request message for [Experiments.GetExperiment][google.cloud.dialogflow.cx.v3.Experiments.GetExperiment].

GetFlowRequest

The response message for [Flows.GetFlow][google.cloud.dialogflow.cx.v3.Flows.GetFlow].

GetFlowValidationResultRequest

The request message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

GetIntentRequest

The request message for [Intents.GetIntent][google.cloud.dialogflow.cx.v3.Intents.GetIntent].

GetPageRequest

The request message for [Pages.GetPage][google.cloud.dialogflow.cx.v3.Pages.GetPage].

GetSecuritySettingsRequest

The request message for [SecuritySettingsService.GetSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.GetSecuritySettings].

GetSessionEntityTypeRequest

The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.GetSessionEntityType].

GetTestCaseRequest

The request message for [TestCases.GetTestCase][google.cloud.dialogflow.cx.v3.TestCases.GetTestCase].

GetTestCaseResultRequest

The request message for [TestCases.GetTestCaseResult][google.cloud.dialogflow.cx.v3.TestCases.GetTestCaseResult].

GetTransitionRouteGroupRequest

The request message for [TransitionRouteGroups.GetTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.GetTransitionRouteGroup].

GetVersionRequest

The request message for [Versions.GetVersion][google.cloud.dialogflow.cx.v3.Versions.GetVersion].

GetWebhookRequest

The request message for [Webhooks.GetWebhook][google.cloud.dialogflow.cx.v3.Webhooks.GetWebhook].

ImportFlowRequest

The request message for [Flows.ImportFlow][google.cloud.dialogflow.cx.v3.Flows.ImportFlow].

ImportFlowRequest.Types

Container for nested types declared in the ImportFlowRequest message type.

ImportFlowResponse

The response message for [Flows.ImportFlow][google.cloud.dialogflow.cx.v3.Flows.ImportFlow].

ImportTestCasesMetadata

Metadata returned for the [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases] long running operation.

ImportTestCasesRequest

The request message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases].

ImportTestCasesResponse

The response message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases].

InputAudioConfig

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

InspectTemplateName

Resource name for the InspectTemplate resource.

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.

Intent.Types

Container for nested types declared in the Intent message type.

Intent.Types.Parameter

Represents an intent parameter.

Intent.Types.TrainingPhrase

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

Intent.Types.TrainingPhrase.Types

Container for nested types declared in the TrainingPhrase message type.

Intent.Types.TrainingPhrase.Types.Part

Represents a part of a training phrase.

IntentCoverage

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

IntentCoverage.Types

Container for nested types declared in the IntentCoverage message type.

IntentCoverage.Types.Intent

The agent's intent.

IntentInput

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

IntentName

Resource name for the Intent resource.

Intents

Service for managing [Intents][google.cloud.dialogflow.cx.v3.Intent].

Intents.IntentsBase

Base class for server-side implementations of Intents

Intents.IntentsClient

Client for Intents

IntentsClient

Intents client wrapper, for convenient use.

IntentsClientBuilder

Builder class for IntentsClient to provide simple configuration of credentials, endpoint etc.

IntentsClientImpl

Intents client wrapper implementation, for convenient use.

IntentsSettings

Settings for IntentsClient instances.

ListAgentsRequest

The request message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].

ListAgentsResponse

The response message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].

ListContinuousTestResultsRequest

The request message for [Environments.ListContinuousTestResults][google.cloud.dialogflow.cx.v3.Environments.ListContinuousTestResults].

ListContinuousTestResultsResponse

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

ListDeploymentsRequest

The request message for [Deployments.ListDeployments][google.cloud.dialogflow.cx.v3.Deployments.ListDeployments].

ListDeploymentsResponse

The response message for [Deployments.ListDeployments][google.cloud.dialogflow.cx.v3.Deployments.ListDeployments].

ListEntityTypesRequest

The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].

ListEntityTypesResponse

The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].

ListEnvironmentsRequest

The request message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

ListEnvironmentsResponse

The response message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

ListExperimentsRequest

The request message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

ListExperimentsResponse

The response message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

ListFlowsRequest

The request message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].

ListFlowsResponse

The response message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].

ListIntentsRequest

The request message for [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].

ListIntentsResponse

The response message for [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].

ListPagesRequest

The request message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

ListPagesResponse

The response message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

ListSecuritySettingsRequest

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

ListSecuritySettingsResponse

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

ListSessionEntityTypesRequest

The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

ListSessionEntityTypesResponse

The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

ListTestCaseResultsRequest

The request message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults].

ListTestCaseResultsResponse

The response message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults].

ListTestCasesRequest

The request message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases].

ListTestCasesRequest.Types

Container for nested types declared in the ListTestCasesRequest message type.

ListTestCasesResponse

The response message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases].

ListTransitionRouteGroupsRequest

The request message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].

ListTransitionRouteGroupsResponse

The response message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].

ListVersionsRequest

The request message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].

ListVersionsResponse

The response message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].

ListWebhooksRequest

The request message for [Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].

ListWebhooksResponse

The response message for [Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].

LoadVersionRequest

The request message for [Versions.LoadVersion][google.cloud.dialogflow.cx.v3.Versions.LoadVersion].

LookupEnvironmentHistoryRequest

The request message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].

LookupEnvironmentHistoryResponse

The response message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].

Match

Represents one match result of [MatchIntent][].

Match.Types

Container for nested types declared in the Match message type.

MatchIntentRequest

Request of [MatchIntent][].

MatchIntentResponse

Response of [MatchIntent][].

NluSettings

Settings related to NLU.

NluSettings.Types

Container for nested types declared in the NluSettings message type.

OutputAudioConfig

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

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.

PageInfo

Represents page information communicated to and from the webhook.

PageInfo.Types

Container for nested types declared in the PageInfo message type.

PageInfo.Types.FormInfo

Represents form information.

PageInfo.Types.FormInfo.Types

Container for nested types declared in the FormInfo message type.

PageInfo.Types.FormInfo.Types.ParameterInfo

Represents parameter information.

PageInfo.Types.FormInfo.Types.ParameterInfo.Types

Container for nested types declared in the ParameterInfo message type.

PageName

Resource name for the Page resource.

Pages

Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page].

Pages.PagesBase

Base class for server-side implementations of Pages

Pages.PagesClient

Client for Pages

PagesClient

Pages client wrapper, for convenient use.

PagesClientBuilder

Builder class for PagesClient to provide simple configuration of credentials, endpoint etc.

PagesClientImpl

Pages client wrapper implementation, for convenient use.

PagesSettings

Settings for PagesClient instances.

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.

QueryParameters

Represents the parameters of a conversational query.

QueryResult

Represents the result of a conversational query.

ResourceName

Resource name and display name.

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.

ResponseMessage.Types

Container for nested types declared in the ResponseMessage message type.

ResponseMessage.Types.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][google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess].

You may set this, for example:

In the [entry_fulfillment][google.cloud.dialogflow.cx.v3.Page.entry_fulfillment] of a [Page][google.cloud.dialogflow.cx.v3.Page] if entering the page indicates that the conversation succeeded.
In a webhook response when you determine that you handled the customer issue.

ResponseMessage.Types.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.

ResponseMessage.Types.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][google.cloud.dialogflow.cx.v3.Page.entry_fulfillment] of a [Page][google.cloud.dialogflow.cx.v3.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.

ResponseMessage.Types.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][google.cloud.dialogflow.cx.v3.ResponseMessage.play_audio]. This message is generated by Dialogflow only and not supposed to be defined by the user.

ResponseMessage.Types.MixedAudio.Types

Container for nested types declared in the MixedAudio message type.

ResponseMessage.Types.MixedAudio.Types.Segment

Represents one segment of audio.

ResponseMessage.Types.OutputAudioText

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

ResponseMessage.Types.PlayAudio

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

ResponseMessage.Types.Text

The text response message.

RestoreAgentRequest

The request message for [Agents.RestoreAgent][google.cloud.dialogflow.cx.v3.Agents.RestoreAgent].

RestoreAgentRequest.Types

Container for nested types declared in the RestoreAgentRequest message type.

RolloutConfig

The configuration for auto rollout.

RolloutConfig.Types

Container for nested types declared in the RolloutConfig message type.

RolloutConfig.Types.RolloutStep

A single rollout step with specified traffic allocation.

RolloutState

State of the auto-rollout process.

RunContinuousTestMetadata

Metadata returned for the [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest] long running operation.

RunContinuousTestRequest

The request message for [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest].

RunContinuousTestResponse

The response message for [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest].

RunTestCaseMetadata

Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase] long running operation. This message currently has no fields.

RunTestCaseRequest

The request message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase].

RunTestCaseResponse

The response message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase].

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.

SecuritySettings.Types

Container for nested types declared in the SecuritySettings message type.

SecuritySettings.Types.InsightsExportSettings

Settings for exporting conversations to Insights.

SecuritySettingsName

Resource name for the SecuritySettings resource.

SecuritySettingsService

Service for managing security settings for Dialogflow.

SecuritySettingsService.SecuritySettingsServiceBase

Base class for server-side implementations of SecuritySettingsService

SecuritySettingsService.SecuritySettingsServiceClient

Client for SecuritySettingsService

SecuritySettingsServiceClient

SecuritySettingsService client wrapper, for convenient use.

SecuritySettingsServiceClientBuilder

Builder class for SecuritySettingsServiceClient to provide simple configuration of credentials, endpoint etc.

SecuritySettingsServiceClientImpl

SecuritySettingsService client wrapper implementation, for convenient use.

SecuritySettingsServiceSettings

Settings for SecuritySettingsServiceClient instances.

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.

ServiceName

Resource name for the Service resource.

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][google.cloud.dialogflow.cx.v3.EntityType] 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.

SessionEntityType.Types

Container for nested types declared in the SessionEntityType message type.

SessionEntityTypeName

Resource name for the SessionEntityType resource.

SessionEntityTypes

Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].

SessionEntityTypes.SessionEntityTypesBase

Base class for server-side implementations of SessionEntityTypes

SessionEntityTypes.SessionEntityTypesClient

Client for SessionEntityTypes

SessionEntityTypesClient

SessionEntityTypes client wrapper, for convenient use.

SessionEntityTypesClientBuilder

Builder class for SessionEntityTypesClient to provide simple configuration of credentials, endpoint etc.

SessionEntityTypesClientImpl

SessionEntityTypes client wrapper implementation, for convenient use.

SessionEntityTypesSettings

Settings for SessionEntityTypesClient instances.

SessionInfo

Represents session information communicated to and from the webhook.

SessionName

Resource name for the Session resource.

Sessions

A session represents an interaction with a user. You retrieve user input and pass it to the [DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] method to determine user intent and respond.

Sessions.SessionsBase

Base class for server-side implementations of Sessions

Sessions.SessionsClient

Client for Sessions

SessionsClient

Sessions client wrapper, for convenient use.

SessionsClient.StreamingDetectIntentStream

Bidirectional streaming methods for StreamingDetectIntent(CallSettings, BidirectionalStreamingSettings).

SessionsClientBuilder

Builder class for SessionsClient to provide simple configuration of credentials, endpoint etc.

SessionsClientImpl

Sessions client wrapper implementation, for convenient use.

SessionsSettings

Settings for SessionsClient instances.

SpeechToTextSettings

Settings related to speech recognition.

SpeechWordInfo

Information for a word recognized by the speech recognizer.

StartExperimentRequest

The request message for [Experiments.StartExperiment][google.cloud.dialogflow.cx.v3.Experiments.StartExperiment].

StopExperimentRequest

The request message for [Experiments.StopExperiment][google.cloud.dialogflow.cx.v3.Experiments.StopExperiment].

StreamingDetectIntentRequest

The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method.

Multiple request messages should be sent in order:

The first message must contain [session][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.output_audio_config].
If [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] was set to [query_input.audio.config][google.cloud.dialogflow.cx.v3.AudioInput.config], all subsequent messages must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3.AudioInput.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][google.cloud.dialogflow.cx.v3.QueryInput.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.

StreamingDetectIntentResponse

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.
If enable_partial_response is true, the following N messages (currently 1 <= N <= 4) contain detect_intent_response. The first (N-1) detect_intent_responses will have response_type set to PARTIAL. The last detect_intent_response has response_type set to FINAL. If response_type is false, response stream only contains the final detect_intent_response.

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.

Example:

transcript: "tube"
transcript: "to be a"
transcript: "to be"
transcript: "to be or not to be" is_final: true
transcript: " that's"
transcript: " that is"
message_type: END_OF_SINGLE_UTTERANCE
transcript: " that is the question" is_final: true

Only two of the responses contain final results (#4 and #8 indicated by is_final: true). Concatenating these generates the full transcript: "to be or not to be that is the question".

In each response we populate:

for TRANSCRIPT: transcript and possibly is_final.
for END_OF_SINGLE_UTTERANCE: only message_type.

StreamingRecognitionResult.Types

Container for nested types declared in the StreamingRecognitionResult message type.

SynthesizeSpeechConfig

Configuration of how speech should be synthesized.

TestCase

Represents a test case.

TestCaseError

Error info for importing a test.

TestCaseName

Resource name for the TestCase resource.

TestCaseResult

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

TestCaseResultName

Resource name for the TestCaseResult resource.

TestCases

Service for managing [Test Cases][google.cloud.dialogflow.cx.v3.TestCase] and [Test Case Results][google.cloud.dialogflow.cx.v3.TestCaseResult].

TestCases.TestCasesBase

Base class for server-side implementations of TestCases

TestCases.TestCasesClient

Client for TestCases

TestCasesClient

TestCases client wrapper, for convenient use.

TestCasesClientBuilder

Builder class for TestCasesClient to provide simple configuration of credentials, endpoint etc.

TestCasesClientImpl

TestCases client wrapper implementation, for convenient use.

TestCasesSettings

Settings for TestCasesClient instances.

TestConfig

Represents configurations for a test case.

TestError

Error info for running a test.

TestRunDifference

The description of differences between original and replayed agent output.

TestRunDifference.Types

Container for nested types declared in the TestRunDifference message type.

TextInput

Represents the natural language text to be processed.

TrainFlowRequest

The request message for [Flows.TrainFlow][google.cloud.dialogflow.cx.v3.Flows.TrainFlow].

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.

TransitionCoverage.Types

Container for nested types declared in the TransitionCoverage message type.

TransitionCoverage.Types.Transition

A transition in a page.

TransitionCoverage.Types.TransitionNode

The source or target of a transition.

TransitionRoute

A transition route specifies a [intent][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.TransitionRoute.trigger_fulfillment] associated with the transition, it will be called.
If there is a [target_page][google.cloud.dialogflow.cx.v3.TransitionRoute.target_page] associated with the transition, the session will transition into the specified page.
If there is a [target_flow][google.cloud.dialogflow.cx.v3.TransitionRoute.target_flow] associated with the transition, the session will transition into the specified flow.

TransitionRouteGroup

An TransitionRouteGroup represents a group of [TransitionRoutes][google.cloud.dialogflow.cx.v3.TransitionRoute] to be used by a [Page][google.cloud.dialogflow.cx.v3.Page].

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.

TransitionRouteGroupCoverage.Types

Container for nested types declared in the TransitionRouteGroupCoverage message type.

TransitionRouteGroupCoverage.Types.Coverage

Coverage result message for one transition route group.

TransitionRouteGroupCoverage.Types.Coverage.Types

Container for nested types declared in the Coverage message type.

TransitionRouteGroupCoverage.Types.Coverage.Types.Transition

A transition coverage in a transition route group.

TransitionRouteGroupName

Resource name for the TransitionRouteGroup resource.

TransitionRouteGroups

Service for managing [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].

TransitionRouteGroups.TransitionRouteGroupsBase

Base class for server-side implementations of TransitionRouteGroups

TransitionRouteGroups.TransitionRouteGroupsClient

Client for TransitionRouteGroups

TransitionRouteGroupsClient

TransitionRouteGroups client wrapper, for convenient use.

TransitionRouteGroupsClientBuilder

Builder class for TransitionRouteGroupsClient to provide simple configuration of credentials, endpoint etc.

TransitionRouteGroupsClientImpl

TransitionRouteGroups client wrapper implementation, for convenient use.

TransitionRouteGroupsSettings

Settings for TransitionRouteGroupsClient instances.

UpdateAgentRequest

The request message for [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].

UpdateEntityTypeRequest

The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType].

UpdateEnvironmentRequest

The request message for [Environments.UpdateEnvironment][google.cloud.dialogflow.cx.v3.Environments.UpdateEnvironment].

UpdateExperimentRequest

The request message for [Experiments.UpdateExperiment][google.cloud.dialogflow.cx.v3.Experiments.UpdateExperiment].

UpdateFlowRequest

The request message for [Flows.UpdateFlow][google.cloud.dialogflow.cx.v3.Flows.UpdateFlow].

UpdateIntentRequest

The request message for [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent].

UpdatePageRequest

The request message for [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage].

UpdateSecuritySettingsRequest

The request message for [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings].

UpdateSessionEntityTypeRequest

The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.UpdateSessionEntityType].

UpdateTestCaseRequest

The request message for [TestCases.UpdateTestCase][google.cloud.dialogflow.cx.v3.TestCases.UpdateTestCase].

UpdateTransitionRouteGroupRequest

The request message for [TransitionRouteGroups.UpdateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.UpdateTransitionRouteGroup].

UpdateVersionRequest

The request message for [Versions.UpdateVersion][google.cloud.dialogflow.cx.v3.Versions.UpdateVersion].

UpdateWebhookRequest

The request message for [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook].

ValidateAgentRequest

The request message for [Agents.ValidateAgent][google.cloud.dialogflow.cx.v3.Agents.ValidateAgent].

ValidateFlowRequest

The request message for [Flows.ValidateFlow][google.cloud.dialogflow.cx.v3.Flows.ValidateFlow].

ValidationMessage

Agent/flow validation message.

ValidationMessage.Types

Container for nested types declared in the ValidationMessage message type.

VariantsHistory

The history of variants update.

Version

Represents a version of a flow.

Version.Types

Container for nested types declared in the Version message type.

VersionName

Resource name for the Version resource.

Versions

Service for managing [Versions][google.cloud.dialogflow.cx.v3.Version].

Versions.VersionsBase

Base class for server-side implementations of Versions

Versions.VersionsClient

Client for Versions

VersionsClient

Versions client wrapper, for convenient use.

VersionsClientBuilder

Builder class for VersionsClient to provide simple configuration of credentials, endpoint etc.

VersionsClientImpl

Versions client wrapper implementation, for convenient use.

VersionsSettings

Settings for VersionsClient instances.

VersionVariants

A list of flow version variants.

VersionVariants.Types

Container for nested types declared in the VersionVariants message type.

VersionVariants.Types.Variant

A single flow version with specified traffic allocation.

VoiceSelectionParams

Description of which voice to use for speech synthesis.

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.

Webhook.Types

Container for nested types declared in the Webhook message type.

Webhook.Types.GenericWebService

Represents configuration for a generic web service.

Webhook.Types.ServiceDirectoryConfig

Represents configuration for a Service Directory service.

WebhookName

Resource name for the Webhook resource.

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.

WebhookRequest.Types

Container for nested types declared in the WebhookRequest message type.

WebhookRequest.Types.FulfillmentInfo

Represents fulfillment information communicated to the webhook.

WebhookRequest.Types.IntentInfo

Represents intent information communicated to the webhook.

WebhookRequest.Types.IntentInfo.Types

Container for nested types declared in the IntentInfo message type.

WebhookRequest.Types.IntentInfo.Types.IntentParameterValue

Represents a value for an intent parameter.

WebhookRequest.Types.SentimentAnalysisResult

Represents the result of sentiment analysis.

WebhookResponse

The response message for a webhook call.

WebhookResponse.Types

Container for nested types declared in the WebhookResponse message type.

WebhookResponse.Types.FulfillmentResponse

Represents a fulfillment response to the user.

WebhookResponse.Types.FulfillmentResponse.Types

Container for nested types declared in the FulfillmentResponse message type.

Webhooks

Service for managing [Webhooks][google.cloud.dialogflow.cx.v3.Webhook].

Webhooks.WebhooksBase

Base class for server-side implementations of Webhooks

Webhooks.WebhooksClient

Client for Webhooks

WebhooksClient

Webhooks client wrapper, for convenient use.

WebhooksClientBuilder

Builder class for WebhooksClient to provide simple configuration of credentials, endpoint etc.

WebhooksClientImpl

Webhooks client wrapper implementation, for convenient use.

WebhooksSettings

Settings for WebhooksClient instances.

Enums

AgentName.ResourceNameType

The possible contents of AgentName.

AgentValidationResultName.ResourceNameType

The possible contents of AgentValidationResultName.

AudioEncoding

Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.

CalculateCoverageRequest.Types.CoverageType

The type of coverage score requested.

CalculateCoverageResponse.CoverageTypeOneofCase

Enum of possible cases for the "coverage_type" oneof.

ContinuousTestResult.Types.AggregatedTestResult

The overall result for a continuous test run in an agent environment.

ContinuousTestResultName.ResourceNameType

The possible contents of ContinuousTestResultName.

DeidentifyTemplateName.ResourceNameType

The possible contents of DeidentifyTemplateName.

Deployment.Types.State

The state of the deployment.

DeploymentName.ResourceNameType

The possible contents of DeploymentName.

DetectIntentResponse.Types.ResponseType

Represents different DetectIntentResponse types.

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

EntityType.Types.Kind

Represents kinds of entities.

EntityTypeName.ResourceNameType

The possible contents of EntityTypeName.

EnvironmentName.ResourceNameType

The possible contents of EnvironmentName.

EventHandler.TargetOneofCase

Enum of possible cases for the "target" oneof.

Experiment.Types.Definition.VariantsOneofCase

Enum of possible cases for the "variants" oneof.

Experiment.Types.Result.Types.CountType

Types of count-based metric for Dialogflow experiment.

Experiment.Types.Result.Types.Metric.ValueOneofCase

Enum of possible cases for the "value" oneof.

Experiment.Types.Result.Types.MetricType

Types of ratio-based metric for Dialogflow experiment.

Experiment.Types.State

The state of the experiment.

ExperimentName.ResourceNameType

The possible contents of ExperimentName.

ExportAgentResponse.AgentOneofCase

Enum of possible cases for the "agent" oneof.

ExportFlowResponse.FlowOneofCase

Enum of possible cases for the "flow" oneof.

ExportTestCasesRequest.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

ExportTestCasesRequest.Types.DataFormat

Data format of the exported test cases.

ExportTestCasesResponse.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

FlowName.ResourceNameType

The possible contents of FlowName.

FlowValidationResultName.ResourceNameType

The possible contents of FlowValidationResultName.

Fulfillment.Types.ConditionalCases.Types.Case.Types.CaseContent.CasesOrMessageOneofCase

Enum of possible cases for the "cases_or_message" oneof.

ImportFlowRequest.FlowOneofCase

Enum of possible cases for the "flow" oneof.

ImportFlowRequest.Types.ImportOption

Import option.

ImportTestCasesRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

InspectTemplateName.ResourceNameType

The possible contents of InspectTemplateName.

IntentName.ResourceNameType

The possible contents of IntentName.

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.

ListTestCasesRequest.Types.TestCaseView

Specifies how much test case information to include in the response.

Match.Types.MatchType

Type of a Match.

MatchIntentResponse.QueryOneofCase

Enum of possible cases for the "query" oneof.

NluSettings.Types.ModelTrainingMode

NLU model training mode.

NluSettings.Types.ModelType

NLU model type.

OutputAudioEncoding

Audio encoding of the output audio format in Text-To-Speech.

PageInfo.Types.FormInfo.Types.ParameterInfo.Types.ParameterState

Represents the state of a parameter.

PageName.ResourceNameType

The possible contents of PageName.

QueryInput.InputOneofCase

Enum of possible cases for the "input" oneof.

QueryResult.QueryOneofCase

Enum of possible cases for the "query" oneof.

ResponseMessage.MessageOneofCase

Enum of possible cases for the "message" oneof.

ResponseMessage.Types.MixedAudio.Types.Segment.ContentOneofCase

Enum of possible cases for the "content" oneof.

ResponseMessage.Types.OutputAudioText.SourceOneofCase

Enum of possible cases for the "source" oneof.

RestoreAgentRequest.AgentOneofCase

Enum of possible cases for the "agent" oneof.

RestoreAgentRequest.Types.RestoreOption

Restore option.

SecuritySettings.DataRetentionOneofCase

Enum of possible cases for the "data_retention" oneof.

SecuritySettings.Types.PurgeDataType

Type of data we purge after retention settings triggers purge.

SecuritySettings.Types.RedactionScope

Defines what types of data to redact.

SecuritySettings.Types.RedactionStrategy

Defines how we redact data.

SecuritySettingsName.ResourceNameType

The possible contents of SecuritySettingsName.

ServiceName.ResourceNameType

The possible contents of ServiceName.

SessionEntityType.Types.EntityOverrideMode

The types of modifications for the session entity type.

SessionEntityTypeName.ResourceNameType

The possible contents of SessionEntityTypeName.

SessionName.ResourceNameType

The possible contents of SessionName.

SpeechModelVariant

Variant of the specified [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.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.