Service for managingAgents.

Service for managingAgents.

A pager for iterating throughlist_agents requests.

This class thinly wraps an initialListAgentsResponse object, andprovides an__aiter__ method to iterate through itsagents field.

If there are more pages, the__aiter__ method will make additionalListAgents requests and continue to iteratethrough theagents field on thecorresponding responses.

All the usualListAgentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_agents requests.

This class thinly wraps an initialListAgentsResponse object, andprovides an__iter__ method to iterate through itsagents field.

If there are more pages, the__iter__ method will make additionalListAgents requests and continue to iteratethrough theagents field on thecorresponding responses.

All the usualListAgentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingChangelogs.

Service for managingChangelogs.

A pager for iterating throughlist_changelogs requests.

This class thinly wraps an initialListChangelogsResponse object, andprovides an__aiter__ method to iterate through itschangelogs field.

If there are more pages, the__aiter__ method will make additionalListChangelogs requests and continue to iteratethrough thechangelogs field on thecorresponding responses.

All the usualListChangelogsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_changelogs requests.

This class thinly wraps an initialListChangelogsResponse object, andprovides an__iter__ method to iterate through itschangelogs field.

If there are more pages, the__iter__ method will make additionalListChangelogs requests and continue to iteratethrough thechangelogs field on thecorresponding responses.

All the usualListChangelogsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingDeployments.

Service for managingDeployments.

A pager for iterating throughlist_deployments requests.

This class thinly wraps an initialListDeploymentsResponse object, andprovides an__aiter__ method to iterate through itsdeployments field.

If there are more pages, the__aiter__ method will make additionalListDeployments requests and continue to iteratethrough thedeployments field on thecorresponding responses.

All the usualListDeploymentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_deployments requests.

This class thinly wraps an initialListDeploymentsResponse object, andprovides an__iter__ method to iterate through itsdeployments field.

If there are more pages, the__iter__ method will make additionalListDeployments requests and continue to iteratethrough thedeployments field on thecorresponding responses.

All the usualListDeploymentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingEntityTypes.

Service for managingEntityTypes.

A pager for iterating throughlist_entity_types requests.

This class thinly wraps an initialListEntityTypesResponse object, andprovides an__aiter__ method to iterate through itsentity_types field.

If there are more pages, the__aiter__ method will make additionalListEntityTypes requests and continue to iteratethrough theentity_types field on thecorresponding responses.

All the usualListEntityTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_entity_types requests.

This class thinly wraps an initialListEntityTypesResponse object, andprovides an__iter__ method to iterate through itsentity_types field.

If there are more pages, the__iter__ method will make additionalListEntityTypes requests and continue to iteratethrough theentity_types field on thecorresponding responses.

All the usualListEntityTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingEnvironments.

Service for managingEnvironments.

A pager for iterating throughlist_continuous_test_results requests.

This class thinly wraps an initialListContinuousTestResultsResponse object, andprovides an__aiter__ method to iterate through itscontinuous_test_results field.

If there are more pages, the__aiter__ method will make additionalListContinuousTestResults requests and continue to iteratethrough thecontinuous_test_results field on thecorresponding responses.

All the usualListContinuousTestResultsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_continuous_test_results requests.

This class thinly wraps an initialListContinuousTestResultsResponse object, andprovides an__iter__ method to iterate through itscontinuous_test_results field.

If there are more pages, the__iter__ method will make additionalListContinuousTestResults requests and continue to iteratethrough thecontinuous_test_results field on thecorresponding responses.

All the usualListContinuousTestResultsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_environments requests.

This class thinly wraps an initialListEnvironmentsResponse object, andprovides an__aiter__ method to iterate through itsenvironments field.

If there are more pages, the__aiter__ method will make additionalListEnvironments requests and continue to iteratethrough theenvironments field on thecorresponding responses.

All the usualListEnvironmentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_environments requests.

This class thinly wraps an initialListEnvironmentsResponse object, andprovides an__iter__ method to iterate through itsenvironments field.

If there are more pages, the__iter__ method will make additionalListEnvironments requests and continue to iteratethrough theenvironments field on thecorresponding responses.

All the usualListEnvironmentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlookup_environment_history requests.

This class thinly wraps an initialLookupEnvironmentHistoryResponse object, andprovides an__aiter__ method to iterate through itsenvironments field.

If there are more pages, the__aiter__ method will make additionalLookupEnvironmentHistory requests and continue to iteratethrough theenvironments field on thecorresponding responses.

All the usualLookupEnvironmentHistoryResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlookup_environment_history requests.

This class thinly wraps an initialLookupEnvironmentHistoryResponse object, andprovides an__iter__ method to iterate through itsenvironments field.

If there are more pages, the__iter__ method will make additionalLookupEnvironmentHistory requests and continue to iteratethrough theenvironments field on thecorresponding responses.

All the usualLookupEnvironmentHistoryResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingExperiments.

Service for managingExperiments.

A pager for iterating throughlist_experiments requests.

This class thinly wraps an initialListExperimentsResponse object, andprovides an__aiter__ method to iterate through itsexperiments field.

If there are more pages, the__aiter__ method will make additionalListExperiments requests and continue to iteratethrough theexperiments field on thecorresponding responses.

All the usualListExperimentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_experiments requests.

This class thinly wraps an initialListExperimentsResponse object, andprovides an__iter__ method to iterate through itsexperiments field.

If there are more pages, the__iter__ method will make additionalListExperiments requests and continue to iteratethrough theexperiments field on thecorresponding responses.

All the usualListExperimentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingFlows.

Service for managingFlows.

A pager for iterating throughlist_flows requests.

This class thinly wraps an initialListFlowsResponse object, andprovides an__aiter__ method to iterate through itsflows field.

If there are more pages, the__aiter__ method will make additionalListFlows requests and continue to iteratethrough theflows field on thecorresponding responses.

All the usualListFlowsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_flows requests.

This class thinly wraps an initialListFlowsResponse object, andprovides an__iter__ method to iterate through itsflows field.

If there are more pages, the__iter__ method will make additionalListFlows requests and continue to iteratethrough theflows field on thecorresponding responses.

All the usualListFlowsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingGenerators

Service for managingGenerators

A pager for iterating throughlist_generators requests.

This class thinly wraps an initialListGeneratorsResponse object, andprovides an__aiter__ method to iterate through itsgenerators field.

If there are more pages, the__aiter__ method will make additionalListGenerators requests and continue to iteratethrough thegenerators field on thecorresponding responses.

All the usualListGeneratorsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_generators requests.

This class thinly wraps an initialListGeneratorsResponse object, andprovides an__iter__ method to iterate through itsgenerators field.

If there are more pages, the__iter__ method will make additionalListGenerators requests and continue to iteratethrough thegenerators field on thecorresponding responses.

All the usualListGeneratorsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingIntents.

Service for managingIntents.

A pager for iterating throughlist_intents requests.

This class thinly wraps an initialListIntentsResponse object, andprovides an__aiter__ method to iterate through itsintents field.

If there are more pages, the__aiter__ method will make additionalListIntents requests and continue to iteratethrough theintents field on thecorresponding responses.

All the usualListIntentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_intents requests.

This class thinly wraps an initialListIntentsResponse object, andprovides an__iter__ method to iterate through itsintents field.

If there are more pages, the__iter__ method will make additionalListIntents requests and continue to iteratethrough theintents field on thecorresponding responses.

All the usualListIntentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingPages.

Service for managingPages.

A pager for iterating throughlist_pages requests.

This class thinly wraps an initialListPagesResponse object, andprovides an__aiter__ method to iterate through itspages field.

If there are more pages, the__aiter__ method will make additionalListPages requests and continue to iteratethrough thepages field on thecorresponding responses.

All the usualListPagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_pages requests.

This class thinly wraps an initialListPagesResponse object, andprovides an__iter__ method to iterate through itspages field.

If there are more pages, the__iter__ method will make additionalListPages requests and continue to iteratethrough thepages field on thecorresponding responses.

All the usualListPagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managing security settings for Dialogflow.

Service for managing security settings for Dialogflow.

A pager for iterating throughlist_security_settings requests.

This class thinly wraps an initialListSecuritySettingsResponse object, andprovides an__aiter__ method to iterate through itssecurity_settings field.

If there are more pages, the__aiter__ method will make additionalListSecuritySettings requests and continue to iteratethrough thesecurity_settings field on thecorresponding responses.

All the usualListSecuritySettingsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_security_settings requests.

This class thinly wraps an initialListSecuritySettingsResponse object, andprovides an__iter__ method to iterate through itssecurity_settings field.

If there are more pages, the__iter__ method will make additionalListSecuritySettings requests and continue to iteratethrough thesecurity_settings field on thecorresponding responses.

All the usualListSecuritySettingsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingSessionEntityTypes.

Service for managingSessionEntityTypes.

A pager for iterating throughlist_session_entity_types requests.

This class thinly wraps an initialListSessionEntityTypesResponse object, andprovides an__aiter__ method to iterate through itssession_entity_types field.

If there are more pages, the__aiter__ method will make additionalListSessionEntityTypes requests and continue to iteratethrough thesession_entity_types field on thecorresponding responses.

All the usualListSessionEntityTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_session_entity_types requests.

This class thinly wraps an initialListSessionEntityTypesResponse object, andprovides an__iter__ method to iterate through itssession_entity_types field.

If there are more pages, the__iter__ method will make additionalListSessionEntityTypes requests and continue to iteratethrough thesession_entity_types field on thecorresponding responses.

All the usualListSessionEntityTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A session represents an interaction with a user. You retrieve userinput and pass it to theDetectIntentmethod to determine user intent and respond.

A session represents an interaction with a user. You retrieve userinput and pass it to theDetectIntentmethod to determine user intent and respond.

Service for managing [TestCases][google.cloud.dialogflow.cx.v3.TestCase] and [Test CaseResults][google.cloud.dialogflow.cx.v3.TestCaseResult].

Service for managing [TestCases][google.cloud.dialogflow.cx.v3.TestCase] and [Test CaseResults][google.cloud.dialogflow.cx.v3.TestCaseResult].

A pager for iterating throughlist_test_case_results requests.

This class thinly wraps an initialListTestCaseResultsResponse object, andprovides an__aiter__ method to iterate through itstest_case_results field.

If there are more pages, the__aiter__ method will make additionalListTestCaseResults requests and continue to iteratethrough thetest_case_results field on thecorresponding responses.

All the usualListTestCaseResultsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_test_case_results requests.

This class thinly wraps an initialListTestCaseResultsResponse object, andprovides an__iter__ method to iterate through itstest_case_results field.

If there are more pages, the__iter__ method will make additionalListTestCaseResults requests and continue to iteratethrough thetest_case_results field on thecorresponding responses.

All the usualListTestCaseResultsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_test_cases requests.

This class thinly wraps an initialListTestCasesResponse object, andprovides an__aiter__ method to iterate through itstest_cases field.

If there are more pages, the__aiter__ method will make additionalListTestCases requests and continue to iteratethrough thetest_cases field on thecorresponding responses.

All the usualListTestCasesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_test_cases requests.

This class thinly wraps an initialListTestCasesResponse object, andprovides an__iter__ method to iterate through itstest_cases field.

If there are more pages, the__iter__ method will make additionalListTestCases requests and continue to iteratethrough thetest_cases field on thecorresponding responses.

All the usualListTestCasesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingTransitionRouteGroups.

Service for managingTransitionRouteGroups.

A pager for iterating throughlist_transition_route_groups requests.

This class thinly wraps an initialListTransitionRouteGroupsResponse object, andprovides an__aiter__ method to iterate through itstransition_route_groups field.

If there are more pages, the__aiter__ method will make additionalListTransitionRouteGroups requests and continue to iteratethrough thetransition_route_groups field on thecorresponding responses.

All the usualListTransitionRouteGroupsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_transition_route_groups requests.

This class thinly wraps an initialListTransitionRouteGroupsResponse object, andprovides an__iter__ method to iterate through itstransition_route_groups field.

If there are more pages, the__iter__ method will make additionalListTransitionRouteGroups requests and continue to iteratethrough thetransition_route_groups field on thecorresponding responses.

All the usualListTransitionRouteGroupsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingVersions.

Service for managingVersions.

A pager for iterating throughlist_versions requests.

This class thinly wraps an initialListVersionsResponse object, andprovides an__aiter__ method to iterate through itsversions field.

If there are more pages, the__aiter__ method will make additionalListVersions requests and continue to iteratethrough theversions field on thecorresponding responses.

All the usualListVersionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_versions requests.

This class thinly wraps an initialListVersionsResponse object, andprovides an__iter__ method to iterate through itsversions field.

If there are more pages, the__iter__ method will make additionalListVersions requests and continue to iteratethrough theversions field on thecorresponding responses.

All the usualListVersionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingWebhooks.

Service for managingWebhooks.

A pager for iterating throughlist_webhooks requests.

This class thinly wraps an initialListWebhooksResponse object, andprovides an__aiter__ method to iterate through itswebhooks field.

If there are more pages, the__aiter__ method will make additionalListWebhooks requests and continue to iteratethrough thewebhooks field on thecorresponding responses.

All the usualListWebhooksResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_webhooks requests.

This class thinly wraps an initialListWebhooksResponse object, andprovides an__iter__ method to iterate through itswebhooks field.

If there are more pages, the__iter__ method will make additionalListWebhooks requests and continue to iteratethrough thewebhooks field on thecorresponding responses.

All the usualListWebhooksResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Hierarchical advanced settings foragent/flow/page/fulfillment/parameter. Settings exposed at lowerlevel overrides the settings exposed at higher level. Overridingoccurs at the sub-setting level. For example, theplayback_interruption_settings at fulfillment level only overridesthe playback_interruption_settings at the agent level, leaving othersettings at the agent level unchanged.

DTMF settings does not override each other. DTMF settings set atdifferent levels define DTMF detections running in parallel.

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

Define behaviors for DTMF (dual tone multi frequency).

Define behaviors on logging.

Define behaviors of speech to text detection.

The abstract base class for a message.

Agents are best described as Natural Language Understanding (NLU)modules that transform user requests into actionable data. You caninclude agents in your app, product, or service to determine userintent and respond to the user in a natural way.

After you create an agent, you can addIntents, [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType],Flows,Fulfillments,Webhooks,TransitionRouteGroupsand so on to manage the conversation flows.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Settings for answer feedback collection.

Settings for custom client certificates.

Settings for Gen App Builder.

Settings for connecting to Git repository for an agent.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Settings of integration with GitHub.

Settings for end user personalization.

The response message forAgents.GetAgentValidationResult.

Stores information about feedback provided by users about aresponse.

Represents thumbs up/down rating provided by user about aresponse.

Stores extra information about why users provided thumbs downrating.

Audio encoding of the audio content sent in the conversational queryrequest. Refer to theCloud Speech APIdocumentation <https://cloud.google.com/speech-to-text/docs/basics>__for more details.

Represents the natural speech audio to be processed.

Configuration of the barge-in behavior. Barge-in instructs the APIto return a detected utterance at a proper time while the client isplaying back the response audio from a previous request. When theclient sees the utterance, it should stop the playback andimmediately get ready for receiving the responses for the currentrequest.

The barge-in handling requires the client to start streaming audioinput as soon as it starts playing back the audio from the previousresponse. The playback is modeled into two phases:

• No barge-in phase: which goes first and during which speechdetection should not be carried out.

• Barge-in phase: which follows the no barge-in phase and duringwhich the API starts speech detection and may inform the clientthat an utterance has been detected. Note that no-speech event isnot expected in this phase.

The client provides this configuration in terms of the durations ofthose two phases. The durations are measured in terms of the audiolength from the start of the input audio.

No-speech event is a response with END_OF_UTTERANCE without anytranscript following up.

The request message forTestCases.BatchDeleteTestCases.

Metadata returned for theTestCases.BatchRunTestCaseslong running operation.

The request message forTestCases.BatchRunTestCases.

The response message forTestCases.BatchRunTestCases.

Boost specification to boost certain documents.A copy of google.cloud.discoveryengine.v1main.BoostSpec, fielddocumentation is available athttps://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec

Boost applies to documents which match a condition.

Specification for custom ranking based on customer specifiedattribute value. It provides more controls for customizedranking than the simple (condition, boost) combination above.

The attribute(or function) for which the custom ranking is tobe applied.

The control points used to define the curve. The curvedefined through these control points can only be monotonicallyincreasing or decreasing(constant values are acceptable).

The interpolation type to be applied. Default will be linear(Piecewise Linear).

Boost specifications for data stores.

The request message forTestCases.CalculateCoverage.

The type of coverage score requested.

The response message forTestCases.CalculateCoverage.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Changelogs represents a change made to a given agent.

Cloud conversation info for easier debugging. It will get populatedinStreamingDetectIntentResponse orStreamingAnalyzeContentResponse when the flagenable_debugging_info is set to true in corresponding requests.

The request message forVersions.CompareVersions.

The response message forVersions.CompareVersions.

Represents a result from running a test case in an agentenvironment.

The overall result for a continuous test run in an agentenvironment.

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

The input from the human user.

The output from the virtual agent.

The request message forAgents.CreateAgent.

The request message forEntityTypes.CreateEntityType.

The request message forEnvironments.CreateEnvironment.

The request message forExperiments.CreateExperiment.

The request message forFlows.CreateFlow.

The request message forGenerators.CreateGenerator.

The request message forIntents.CreateIntent.

The request message forPages.CreatePage.

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

The request message forSessionEntityTypes.CreateSessionEntityType.

The request message forTestCases.CreateTestCase.

The request message forTransitionRouteGroups.CreateTransitionRouteGroup.

Metadata associated with the long running operation forVersions.CreateVersion.

The request message forVersions.CreateVersion.

The request message forWebhooks.CreateWebhook.

A data store connection. It represents a data store inDiscovery Engine and the type of the contents it contains.

Data store connection feature output signals.Might be only partially field if processing stop before thefinal answer. Reasons for this can be, but are not limited to:empty UCS search results, positive RAI check outcome, groundingfailure, ...

Diagnostic info related to the answer generation model call.

Answer part with citation.

Snippet cited by the answer generation model.

Grounding signals.

Represents the decision of the grounding check.

Grounding score buckets.

Diagnostic info related to the rewriter model call.

Safety check results.

Specifies banned phrase match subject.

Safety decision.All kinds of check are incorporated into this final decision,including banned phrases check.

Search snippet details.

Type of a data store.Determines how search is performed in the data store.

The request message forAgents.DeleteAgent.

The request message forEntityTypes.DeleteEntityType.

The request message forEnvironments.DeleteEnvironment.

The request message forExperiments.DeleteExperiment.

The request message forFlows.DeleteFlow.

The request message forGenerators.DeleteGenerator.

The request message forIntents.DeleteIntent.

The request message forPages.DeletePage.

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

The request message forSessionEntityTypes.DeleteSessionEntityType.

The request message forTransitionRouteGroups.DeleteTransitionRouteGroup.

The request message forVersions.DeleteVersion.

The request message forWebhooks.DeleteWebhook.

Metadata returned for theEnvironments.DeployFlowlong running operation.

The request message forEnvironments.DeployFlow.

The response message forEnvironments.DeployFlow.

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

Result of the deployment.

The state of the deployment.

The request to detect user's intent.

The message returned from the DetectIntent method.

Represents different DetectIntentResponse types.

The document processing mode of the data store.

Represents the input for dtmf event.

Entities are extracted from user input and represent parameters thatare meaningful to your application. For example, a date range, aproper 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 allmap to that entity. For example, "soft drink", "soda", "pop", and soon.

There are three types of entities:

• System - entities that are defined by the Dialogflow API forcommon data types such as date, time, currency, and so on. Asystem entity is represented by theEntityType type.

• Custom - entities that are defined by you that representactionable data that is meaningful to your application. Forexample, you could define apizza.sauce entity for red orwhite pizza sauce, apizza.cheese entity for the differenttypes of cheese on a pizza, apizza.topping entity fordifferent toppings, and so on. A custom entity is represented bytheEntityType type.

• User - entities that are built for an individual user such asfavorites, preferences, playlists, and so on. A user entity isrepresented by theSessionEntityTypetype.

For more information about entity types, see theDialogflowdocumentation <https://cloud.google.com/dialogflow/docs/entities-overview>__.

Represents different entity type expansion modes. Automatedexpansion allows an agent to recognize values that have not beenexplicitly listed in the entity (for example, new kinds ofshopping list items).

Anentity entry for an associated entity type.

An excluded entity phrase that should not be matched.

Represents kinds of entities.

Represents an environment for an agent. You can createmultiple versions of your agent and publish them to separateenvironments. When you edit an agent, you are editing the draftagent. At any point, you can save the draft agent as an agentversion, which is an immutable snapshot of your agent. When yousave the draft agent, it is published to the defaultenvironment. When you create agent versions, you can publishthem to custom environments. You can create a variety of customenvironments for testing, development, production, etc.

The configuration for continuous tests.

Configuration for the version.

Configuration for webhooks.

An event handler specifies anevent that canbe handled during a session. When the specified event happens, thefollowing 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 thespecified page.
• If there is a[target_flow][google.cloud.dialogflow.cx.v3.EventHandler.target_flow]associated with the event, the session will transition into thespecified flow.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the event to trigger.

Represents an experiment in an environment.

Definition of the experiment.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

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

Types of count-based metric for Dialogflow experiment.

Metric and corresponding confidence intervals.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Types of ratio-based metric for Dialogflow experiment.

Version variant and associated metrics.

The state of the experiment.

The request message forAgents.ExportAgent.

Data format of the exported agent.

Settings for exporting to a git branch.

The response message forAgents.ExportAgent.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata returned for theEntityTypes.ExportEntityTypeslong running operation.

The request message forEntityTypes.ExportEntityTypes.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Data format of the exported entity types.

The response message forEntityTypes.ExportEntityTypes.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The request message forFlows.ExportFlow.

The response message forFlows.ExportFlow.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata returned for theIntents.ExportIntentslong running operation.

The request message forIntents.ExportIntents.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Data format of the exported intents.

The response message forIntents.ExportIntents.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata returned for theTestCases.ExportTestCaseslong running operation. This message currently has no fields.

The request message forTestCases.ExportTestCases.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Data format of the exported test cases.

The response message forTestCases.ExportTestCases.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Filter specifications for data stores.

Flows represents the conversation flows when you build yourchatbot agent.A flow consists of many pages connected by the transitionroutes. Conversations always start with the built-in Start Flow(with an all-0 ID). Transition routes can direct theconversation session from the current flow (parent flow) toanother flow (sub flow). When the sub flow is finished,Dialogflow will bring the session back to the parent flow, wherethe sub flow is started.

Usually, when a transition route is followed by a matchedintent, the intent will be "consumed". This means the intentwon't activate more transition routes. However, when thefollowed transition route moves the conversation session into adifferent flow, the matched intent can be carried over and to beconsumed in the target flow.

Settings for multi-lingual agents.

The flow import strategy used for resource conflict resolutionassociated with anImportFlowRequest.

The response message forFlows.GetFlowValidationResult.

A form is a data model that groups related parameters that can becollected from the user. The process in which the agent prompts theuser and collects parameter values from the user is called formfilling. A form can be added to apage. When form filling isdone, the filled parameters will be written to thesession.

Represents a form parameter.

Configuration for how the filling of a parameter should behandled.

Request of [FulfillIntent][]

Response of [FulfillIntent][]

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

• Generate rich message responses.
• Set parameter values.
• Call the webhook.

Fulfillments can be called at various stages in thePage orForm lifecycle. For example,when aDetectIntentRequestdrives a session to enter a new page, the page's entry fulfillmentcan add a static response to theQueryResult in thereturningDetectIntentResponse,call the webhook (for example, to load user data from a database),or both.

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

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

The list of messages or conditional cases to activate forthis case.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Generator settings used by the LLM to generate a textresponse.

The abstract base class for a message.

Setting a parameter value.

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

Settings for Generative AI.

Settings for Generative Fallback.

Prompt template.

Settings for knowledge connector. These parameters are used for LLMprompt like "You are . You are a helpful and verbose<agent_identity> at , <business_description>. Your task is to helphumans on <agent_scope>".

Generators contain prompt to be sent to the LLM model togenerate text. The prompt can contain parameters which will beresolved before calling the model. It can optionally containbanned phrases to ensure the model responses are safe.

Parameters to be passed to the LLM. If not set, defaultvalues will be used.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents a custom placeholder in the prompt text.

The request message forAgents.GetAgent.

The request message forAgents.GetAgentValidationResult.

The request message forChangelogs.GetChangelog.

The request message forDeployments.GetDeployment.

The request message forEntityTypes.GetEntityType.

The request message forEnvironments.GetEnvironment.

The request message forExperiments.GetExperiment.

The response message forFlows.GetFlow.

The request message forFlows.GetFlowValidationResult.

Request forGetGenerativeSettingsRPC.

The request message forGenerators.GetGenerator.

The request message forIntents.GetIntent.

The request message forPages.GetPage.

The request message forSecuritySettingsService.GetSecuritySettings.

The request message forSessionEntityTypes.GetSessionEntityType.

The request message forTestCases.GetTestCase.

The request message forTestCases.GetTestCaseResult.

The request message forTransitionRouteGroups.GetTransitionRouteGroup.

The request message forVersions.GetVersion.

The request message forWebhooks.GetWebhook.

Metadata returned for theEntityTypes.ImportEntityTypeslong running operation.

The request message forEntityTypes.ImportEntityTypes.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Merge option when display name conflicts exist during import.

The response message forEntityTypes.ImportEntityTypes.

Conflicting resources detected during the import process. Onlyfilled whenREPORT_CONFLICT][ImportEntityTypesResponse.REPORT_CONFLICT] is setin the request and there are conflicts in the display names.

The request message forFlows.ImportFlow.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Import option.

The response message forFlows.ImportFlow.

Metadata returned for theIntents.ImportIntentslong running operation.

The request message forIntents.ImportIntents.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Merge option when display name conflicts exist during import.

The response message forIntents.ImportIntents.

Conflicting resources detected during the import process. Onlyfilled whenREPORT_CONFLICT][ImportIntentsResponse.REPORT_CONFLICT]is set in the request and there are conflicts in the display names.

Import strategies for the conflict resolution of resources(i.e. intents, entities, and webhooks) with identical displaynames during import operations.

Metadata returned for theTestCases.ImportTestCaseslong running operation.

The request message forTestCases.ImportTestCases.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The response message forTestCases.ImportTestCases.

Inline destination for a Dialogflow operation that writes or exportsobjects (e.g.intents)outside of Dialogflow.

Inline source for a Dialogflow operation that reads or importsobjects (e.g.intents) intoDialogflow.

Instructs the speech recognizer on how to process the audiocontent.

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

The abstract base class for a message.

Represents an intent parameter.

Represents an example that the agent is trained on toidentify the intent.

Represents a part of a training phrase.

Intent coverage represents the percentage of all possibleintents in the agent that are triggered in any of a parent'stest cases.

The agent's intent.

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

Represents the options for views of an intent.An intent can be a sizable object. Therefore, we provide aresource view that does not return training phrases in theresponse.

The Knowledge Connector settings for this page or flow.This includes information such as the attached Knowledge Bases,and the way to execute fulfillment.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the language information of the request.

The request message forAgents.ListAgents.

The response message forAgents.ListAgents.

The request message forChangelogs.ListChangelogs.

The response message forChangelogs.ListChangelogs.

The request message forEnvironments.ListContinuousTestResults.

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

The request message forDeployments.ListDeployments.

The response message forDeployments.ListDeployments.

The request message forEntityTypes.ListEntityTypes.

The response message forEntityTypes.ListEntityTypes.

The request message forEnvironments.ListEnvironments.

The response message forEnvironments.ListEnvironments.

The request message forExperiments.ListExperiments.

The response message forExperiments.ListExperiments.

The request message forFlows.ListFlows.

The response message forFlows.ListFlows.

The request message forGenerators.ListGenerators.

The response message forGenerators.ListGenerators.

The request message forIntents.ListIntents.

The response message forIntents.ListIntents.

The request message forPages.ListPages.

The response message forPages.ListPages.

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

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

The request message forSessionEntityTypes.ListSessionEntityTypes.

The response message forSessionEntityTypes.ListSessionEntityTypes.

The request message forTestCases.ListTestCaseResults.

The response message forTestCases.ListTestCaseResults.

The request message forTestCases.ListTestCases.

Specifies how much test case information to include in theresponse.

The response message forTestCases.ListTestCases.

The request message forTransitionRouteGroups.ListTransitionRouteGroups.

The response message forTransitionRouteGroups.ListTransitionRouteGroups.

The request message forVersions.ListVersions.

The response message forVersions.ListVersions.

The request message forWebhooks.ListWebhooks.

The response message forWebhooks.ListWebhooks.

The request message forVersions.LoadVersion.

The request message forEnvironments.LookupEnvironmentHistory.

The response message forEnvironments.LookupEnvironmentHistory.

Represents one match result of [MatchIntent][].

Type of a Match.

Request of [MatchIntent][].

Response of [MatchIntent][].

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Settings related to NLU.

NLU model training mode.

NLU model type.

Instructs the speech synthesizer how to generate the outputaudio content.

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

A Dialogflow CX conversation (session) can be described andvisualized as a state machine. The states of a CX session arerepresented by pages.

For each flow, you define many pages, where your combined pages canhandle a complete conversation on the topics the flow is designedfor. At any given moment, exactly one page is the current page, thecurrent page is considered active, and the flow associated with thatpage is considered active. Every flow has a special start page. Whena flow initially becomes active, the start page page becomes thecurrent page. For each conversational turn, the current page willeither stay the same or transition to another page.

You configure each page to collect information from the end-userthat is relevant for the conversational state represented by thepage.

For more information, see thePageguide <https://cloud.google.com/dialogflow/cx/docs/concept/page>__.

Represents page information communicated to and from thewebhook.

Represents form information.

Represents parameter information.

Represents the state of a parameter.

Text input which can be used for prompt or banned phrases.

Represents the query input. It can contain one of:

1. A conversational query in the form of text.

2. An intent query that specifies which intent to trigger.

3. Natural language speech audio to be processed.

4. An event to be triggered.

5. DTMF digits to invoke an intent and fill in parameter value.

6. The results of a tool executed by the client.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the parameters of a conversational query.

The abstract base class for a message.

Represents the result of a conversational query.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Resource name and display name.

Represents a response message that can be returned by aconversational agent.

Response messages are also used for output audio synthesis. Theapproach is as follows:

• If at least one OutputAudioText response is present, then allOutputAudioText responses are linearly concatenated, and theresult 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, theresult is treated as either text or SSML as appropriate. The agentdesigner should ideally use either text or SSML consistentlythroughout the bot design.
• Otherwise, all Text responses are linearly concatenated, and theresult is used for output audio synthesis.

This approach allows for more sophisticated user experiencescenarios, where the text displayed to the user may differ from whatis heard.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Indicates that the conversation succeeded, i.e., the bot handled theissue that the customer talked to it about.

Dialogflow only uses this to determine which conversations should becounted as successful and doesn't process the metadata in thismessage in any way. Note that Dialogflow also considersconversations that get to the conversation end page as successfuleven if they don't returnConversationSuccess.

You may set this, for example:

• In theentry_fulfillmentof aPage if entering thepage indicates that the conversation succeeded.
• In a webhook response when you determine that you handled thecustomer issue.

Indicates that interaction with the Dialogflow agent hasended. This message is generated by Dialogflow only and notsupposed to be defined by the user.

Represents info card response. If the response containsgenerative knowledge prediction, Dialogflow will return apayload with Infobot Messenger compatible info card.

Otherwise, the info card response is skipped.

Indicates that the conversation should be handed off to a liveagent.

Dialogflow only uses this to determine which conversations werehanded off to a human agent for measurement purposes. What else todo with this signal is up to you and your handoff procedures.

You may set this, for example:

• In theentry_fulfillmentof aPage if entering thepage indicates something went extremely wrong in the conversation.
• In a webhook response when you determine that the customer issuecan only be handled by a human.

Represents an audio message that is composed of both segmentssynthesized from the Dialogflow agent prompts and ones hostedexternally at the specified URIs. The external URIs are specifiedviaplay_audio.This message is generated by Dialogflow only and not supposed to bedefined by the user.

Represents one segment of audio.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

Represents different response types.

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

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The text response message.

The request message forAgents.RestoreAgent.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Settings for restoring from a git branch

Restore option.

The configuration for auto rollout.

A single rollout step with specified traffic allocation.

State of the auto-rollout process.

Metadata returned for theEnvironments.RunContinuousTestlong running operation.

The request message forEnvironments.RunContinuousTest.

The response message forEnvironments.RunContinuousTest.

Metadata returned for theTestCases.RunTestCaselong running operation. This message currently has no fields.

The request message forTestCases.RunTestCase.

The response message forTestCases.RunTestCase.

Settings for Generative Safety.

Text input which can be used for prompt or banned phrases.

Search configuration for UCS search queries.

Represents the settings related to security issues, such asdata redaction and data retention. It may take hours for updateson the settings to propagate to all the related components andtake effect.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Settings for exporting audio.

File format for exported audio file. Currently only intelephony recordings.

Settings for exporting conversations toInsights <https://cloud.google.com/contact-center/insights/docs>__.

Type of data we purge after retention settings triggerspurge.

Defines what types of data to redact.

Defines how we redact data.

Defines how long we retain persisted data that containssensitive info.

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

Session entity types are referred to asUser entity types andare entities that are built for an individual user such asfavorites, preferences, playlists, and so on.

You can redefine a session entity type at the session level toextend or replace a [custom entitytype][google.cloud.dialogflow.cx.v3.EntityType] at the user sessionlevel (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 thelanguage.

For more information about entity types, see theDialogflowdocumentation <https://cloud.google.com/dialogflow/docs/entities-overview>__.

The types of modifications for the session entity type.

    Note: Even in this override mode calls to    `ListSessionEntityTypes`, `GetSessionEntityType`,    `CreateSessionEntityType` and `UpdateSessionEntityType`    only return the additional entities added in this session    entity type. If you want to get the supplemented list,    please call    <xref uid="google.cloud.dialogflow.cx.v3.EntityTypes.GetEntityType">EntityTypes.GetEntityType</xref>    on the custom entity type and merge.

Represents session information communicated to and from thewebhook.

The abstract base class for a message.

Variant of the specified [Speechmodel][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.

See theCloud Speechdocumentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>__for which models have different variants. For example, the"phone_call" model has both a standard and an enhanced variant. Whenyou use an enhanced model, you will generally receive higher qualityresults than for a standard model.

    - If an enhanced variant does not exist for the given      <xref uid="google.cloud.dialogflow.cx.v3.InputAudioConfig.model">model</xref>      and request language, Dialogflow falls back to the      standard variant.      The `Cloud Speech      documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__      describes which models have enhanced variants.

Settings related to speech recognition.

Information for a word recognized by the speech recognizer.

Gender of the voice as described inSSML voiceelement <https://www.w3.org/TR/speech-synthesis11/#edef_voice>__.

The request message forExperiments.StartExperiment.

The request message forExperiments.StopExperiment.

The top-level message sent by the client to theSessions.StreamingDetectIntentmethod.

Multiple request messages should be sent in order:

1. The first message must containsession,query_inputplus optionallyquery_params.If the client wants to receive an audio response, it should alsocontainoutput_audio_config.

2. Ifquery_inputwas set toquery_input.audio.config,all subsequent messages must containquery_input.audio.audioto continue with Speech recognition. If you decide to ratherdetect an intent from text input after you already started Speechrecognition, please send a message withquery_input.text.

   However, note that:

   • Dialogflow will bill you for the audio duration so far.
   • Dialogflow discards all Speech recognition results in favor ofthe input text.
   • Dialogflow will use the language code from the first message.

After you sent all input, you must half-close or abort the requeststream.

The top-level message returned from theStreamingDetectIntentmethod.

Multiple response messages can be returned in order:

• If theStreamingDetectIntentRequest.query_input.audio fieldwas set, the first M messages containrecognition_result. Eachrecognition_result represents a more complete transcript ofwhat the user said. The lastrecognition_result hasis_final set totrue.

• If theStreamingDetectIntentRequest.enable_partial_responsefield was true, thedetect_intent_response field is populatedfor each of the following N responses, where 0 <= N <= 5. Theseresponses set theDetectIntentResponse.response_typefield toPARTIAL.

For the last response message, thedetect_intent_response isfully populated, andDetectIntentResponse.response_typeis set toFINAL.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Contains a speech recognition result corresponding to a portion ofthe audio that is currently being processed or an indication thatthis is the end of the single requested utterance.

While end-user audio is being processed, Dialogflow sends a seriesof results. Each result may contain atranscript value. Atranscript represents a portion of the utterance. While therecognizer is processing audio, transcript values may be interimvalues or finalized values. Once a transcript is finalized, theis_final value is set to true and processing continues for thenext transcript.

IfStreamingDetectIntentRequest.query_input.audio.config.single_utterancewas true, and the recognizer has completed processing audio, themessage_type value is set to `END_OF_SINGLE_UTTERANCE and thefollowing (last) result contains the last finalized transcript.

The complete end-user utterance is determined by concatenating thefinalized transcript values received for the series of results.

In the following example, single utterance is enabled. In the casewhere single utterance is not enabled, result 7 would not occur.

::

Concatenating the finalized transcripts withis_final set totrue, the complete utterance becomes "to be or not to be that is thequestion".

Type of the response message.

The request to set the feedback for a bot answer.

Configuration of how speech should be synthesized.

Represents a test case.

Error info for importing a test.

Represents a result from running a test case in an agentenvironment.

Represents configurations for a test case.

Error info for running a test.

The test result for a test case and an agent environment.

The description of differences between original and replayedagent output.

What part of the message replay differs from the test case.

Represents the natural language text to be processed.

Settings related to speech synthesizing.

The abstract base class for a message.

The request message forFlows.TrainFlow.

Transition coverage represents the percentage of all possiblepage transitions (page-level transition routes and eventhandlers, excluding transition route groups) present within anyof a parent's test cases.

A transition in a page.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The source or target of a transition.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A transition route specifies aintent that can be matchedand/or a data condition that can be evaluated during a session. Whena specified transition is matched, the following actions are takenin 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 intothe specified page.
• If there is a[target_flow][google.cloud.dialogflow.cx.v3.TransitionRoute.target_flow]associated with the transition, the session will transition intothe specified flow.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

Transition route group coverage represents the percentage ofall possible transition routes present within any of a parent'stest cases. The results are grouped by the transition routegroup.

Coverage result message for one transition route group.

A transition coverage in a transition route group.

The request message forAgents.UpdateAgent.

The request message forEntityTypes.UpdateEntityType.

The request message forEnvironments.UpdateEnvironment.

The request message forExperiments.UpdateExperiment.

The request message forFlows.UpdateFlow.

Request forUpdateGenerativeSettingsRPC.

The request message forGenerators.UpdateGenerator.

The request message forIntents.UpdateIntent.

The request message forPages.UpdatePage.

The request message forSecuritySettingsService.UpdateSecuritySettings.

The request message forSessionEntityTypes.UpdateSessionEntityType.

The request message forTestCases.UpdateTestCase.

The request message forTransitionRouteGroups.UpdateTransitionRouteGroup.

The request message forVersions.UpdateVersion.

The request message forWebhooks.UpdateWebhook.

The request message forAgents.ValidateAgent.

The request message forFlows.ValidateFlow.

Agent/flow validation message.

Resource types.

Severity level.

The history of variants update.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents a version of a flow.

The state of the version.

A list of flow version variants.

A single flow version with specified traffic allocation.

Description of which voice to use for speech synthesis.

Webhooks host the developer's business logic. During asession, webhooks allow the developer to use the data extractedby Dialogflow's natural language processing to generate dynamicresponses, validate collected data, or trigger actions on thebackend.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents configuration for a generic web service.

HTTP method to use when calling webhooks.

Represents configuration of OAuth client credential flow for3rd party API authentication.

The abstract base class for a message.

The abstract base class for a message.

Indicate the auth token type generated from theDiglogflow serviceagent <https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent>__.

Represents the type of webhook configuration.

Represents configuration for aServiceDirectory <https://cloud.google.com/service-directory>__ service.

The request message for a webhook call. The request is sentas a JSON object and the field names will be presented in camelcases.

You may see undocumented fields in an actual request. Thesefields are used internally by Dialogflow and should be ignored.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents fulfillment information communicated to thewebhook.

Represents intent information communicated to the webhook.

Represents a value for an intent parameter.

The abstract base class for a message.

Represents the result of sentiment analysis.

The response message for a webhook call.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents a fulfillment response to the user.

Defines merge behavior formessages.

Service for managingAgents.

Service for managingAgents.

A pager for iterating throughlist_agents requests.

This class thinly wraps an initialListAgentsResponse object, andprovides an__aiter__ method to iterate through itsagents field.

If there are more pages, the__aiter__ method will make additionalListAgents requests and continue to iteratethrough theagents field on thecorresponding responses.

All the usualListAgentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_agents requests.

This class thinly wraps an initialListAgentsResponse object, andprovides an__iter__ method to iterate through itsagents field.

If there are more pages, the__iter__ method will make additionalListAgents requests and continue to iteratethrough theagents field on thecorresponding responses.

All the usualListAgentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingChangelogs.

Service for managingChangelogs.

A pager for iterating throughlist_changelogs requests.

This class thinly wraps an initialListChangelogsResponse object, andprovides an__aiter__ method to iterate through itschangelogs field.

If there are more pages, the__aiter__ method will make additionalListChangelogs requests and continue to iteratethrough thechangelogs field on thecorresponding responses.

All the usualListChangelogsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_changelogs requests.

This class thinly wraps an initialListChangelogsResponse object, andprovides an__iter__ method to iterate through itschangelogs field.

If there are more pages, the__iter__ method will make additionalListChangelogs requests and continue to iteratethrough thechangelogs field on thecorresponding responses.

All the usualListChangelogsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managing conversation history.

Service for managing conversation history.

A pager for iterating throughlist_conversations requests.

This class thinly wraps an initialListConversationsResponse object, andprovides an__aiter__ method to iterate through itsconversations field.

If there are more pages, the__aiter__ method will make additionalListConversations requests and continue to iteratethrough theconversations field on thecorresponding responses.

All the usualListConversationsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_conversations requests.

This class thinly wraps an initialListConversationsResponse object, andprovides an__iter__ method to iterate through itsconversations field.

If there are more pages, the__iter__ method will make additionalListConversations requests and continue to iteratethrough theconversations field on thecorresponding responses.

All the usualListConversationsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingDeployments.

Service for managingDeployments.

A pager for iterating throughlist_deployments requests.

This class thinly wraps an initialListDeploymentsResponse object, andprovides an__aiter__ method to iterate through itsdeployments field.

If there are more pages, the__aiter__ method will make additionalListDeployments requests and continue to iteratethrough thedeployments field on thecorresponding responses.

All the usualListDeploymentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_deployments requests.

This class thinly wraps an initialListDeploymentsResponse object, andprovides an__iter__ method to iterate through itsdeployments field.

If there are more pages, the__iter__ method will make additionalListDeployments requests and continue to iteratethrough thedeployments field on thecorresponding responses.

All the usualListDeploymentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingEntityTypes.

Service for managingEntityTypes.

A pager for iterating throughlist_entity_types requests.

This class thinly wraps an initialListEntityTypesResponse object, andprovides an__aiter__ method to iterate through itsentity_types field.

If there are more pages, the__aiter__ method will make additionalListEntityTypes requests and continue to iteratethrough theentity_types field on thecorresponding responses.

All the usualListEntityTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_entity_types requests.

This class thinly wraps an initialListEntityTypesResponse object, andprovides an__iter__ method to iterate through itsentity_types field.

If there are more pages, the__iter__ method will make additionalListEntityTypes requests and continue to iteratethrough theentity_types field on thecorresponding responses.

All the usualListEntityTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingEnvironments.

Service for managingEnvironments.

A pager for iterating throughlist_continuous_test_results requests.

This class thinly wraps an initialListContinuousTestResultsResponse object, andprovides an__aiter__ method to iterate through itscontinuous_test_results field.

If there are more pages, the__aiter__ method will make additionalListContinuousTestResults requests and continue to iteratethrough thecontinuous_test_results field on thecorresponding responses.

All the usualListContinuousTestResultsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_continuous_test_results requests.

This class thinly wraps an initialListContinuousTestResultsResponse object, andprovides an__iter__ method to iterate through itscontinuous_test_results field.

If there are more pages, the__iter__ method will make additionalListContinuousTestResults requests and continue to iteratethrough thecontinuous_test_results field on thecorresponding responses.

All the usualListContinuousTestResultsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_environments requests.

This class thinly wraps an initialListEnvironmentsResponse object, andprovides an__aiter__ method to iterate through itsenvironments field.

If there are more pages, the__aiter__ method will make additionalListEnvironments requests and continue to iteratethrough theenvironments field on thecorresponding responses.

All the usualListEnvironmentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_environments requests.

This class thinly wraps an initialListEnvironmentsResponse object, andprovides an__iter__ method to iterate through itsenvironments field.

If there are more pages, the__iter__ method will make additionalListEnvironments requests and continue to iteratethrough theenvironments field on thecorresponding responses.

All the usualListEnvironmentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlookup_environment_history requests.

This class thinly wraps an initialLookupEnvironmentHistoryResponse object, andprovides an__aiter__ method to iterate through itsenvironments field.

If there are more pages, the__aiter__ method will make additionalLookupEnvironmentHistory requests and continue to iteratethrough theenvironments field on thecorresponding responses.

All the usualLookupEnvironmentHistoryResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlookup_environment_history requests.

This class thinly wraps an initialLookupEnvironmentHistoryResponse object, andprovides an__iter__ method to iterate through itsenvironments field.

If there are more pages, the__iter__ method will make additionalLookupEnvironmentHistory requests and continue to iteratethrough theenvironments field on thecorresponding responses.

All the usualLookupEnvironmentHistoryResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingExamples.

Service for managingExamples.

A pager for iterating throughlist_examples requests.

This class thinly wraps an initialListExamplesResponse object, andprovides an__aiter__ method to iterate through itsexamples field.

If there are more pages, the__aiter__ method will make additionalListExamples requests and continue to iteratethrough theexamples field on thecorresponding responses.

All the usualListExamplesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_examples requests.

This class thinly wraps an initialListExamplesResponse object, andprovides an__iter__ method to iterate through itsexamples field.

If there are more pages, the__iter__ method will make additionalListExamples requests and continue to iteratethrough theexamples field on thecorresponding responses.

All the usualListExamplesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingExperiments.

Service for managingExperiments.

A pager for iterating throughlist_experiments requests.

This class thinly wraps an initialListExperimentsResponse object, andprovides an__aiter__ method to iterate through itsexperiments field.

If there are more pages, the__aiter__ method will make additionalListExperiments requests and continue to iteratethrough theexperiments field on thecorresponding responses.

All the usualListExperimentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_experiments requests.

This class thinly wraps an initialListExperimentsResponse object, andprovides an__iter__ method to iterate through itsexperiments field.

If there are more pages, the__iter__ method will make additionalListExperiments requests and continue to iteratethrough theexperiments field on thecorresponding responses.

All the usualListExperimentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingFlows.

Service for managingFlows.

A pager for iterating throughlist_flows requests.

This class thinly wraps an initialListFlowsResponse object, andprovides an__aiter__ method to iterate through itsflows field.

If there are more pages, the__aiter__ method will make additionalListFlows requests and continue to iteratethrough theflows field on thecorresponding responses.

All the usualListFlowsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_flows requests.

This class thinly wraps an initialListFlowsResponse object, andprovides an__iter__ method to iterate through itsflows field.

If there are more pages, the__iter__ method will make additionalListFlows requests and continue to iteratethrough theflows field on thecorresponding responses.

All the usualListFlowsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingGenerators

Service for managingGenerators

A pager for iterating throughlist_generators requests.

This class thinly wraps an initialListGeneratorsResponse object, andprovides an__aiter__ method to iterate through itsgenerators field.

If there are more pages, the__aiter__ method will make additionalListGenerators requests and continue to iteratethrough thegenerators field on thecorresponding responses.

All the usualListGeneratorsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_generators requests.

This class thinly wraps an initialListGeneratorsResponse object, andprovides an__iter__ method to iterate through itsgenerators field.

If there are more pages, the__iter__ method will make additionalListGenerators requests and continue to iteratethrough thegenerators field on thecorresponding responses.

All the usualListGeneratorsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingIntents.

Service for managingIntents.

A pager for iterating throughlist_intents requests.

This class thinly wraps an initialListIntentsResponse object, andprovides an__aiter__ method to iterate through itsintents field.

If there are more pages, the__aiter__ method will make additionalListIntents requests and continue to iteratethrough theintents field on thecorresponding responses.

All the usualListIntentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_intents requests.

This class thinly wraps an initialListIntentsResponse object, andprovides an__iter__ method to iterate through itsintents field.

If there are more pages, the__iter__ method will make additionalListIntents requests and continue to iteratethrough theintents field on thecorresponding responses.

All the usualListIntentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingPages.

Service for managingPages.

A pager for iterating throughlist_pages requests.

This class thinly wraps an initialListPagesResponse object, andprovides an__aiter__ method to iterate through itspages field.

If there are more pages, the__aiter__ method will make additionalListPages requests and continue to iteratethrough thepages field on thecorresponding responses.

All the usualListPagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_pages requests.

This class thinly wraps an initialListPagesResponse object, andprovides an__iter__ method to iterate through itspages field.

If there are more pages, the__iter__ method will make additionalListPages requests and continue to iteratethrough thepages field on thecorresponding responses.

All the usualListPagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingPlaybooks.

Service for managingPlaybooks.

A pager for iterating throughlist_playbook_versions requests.

This class thinly wraps an initialListPlaybookVersionsResponse object, andprovides an__aiter__ method to iterate through itsplaybook_versions field.

If there are more pages, the__aiter__ method will make additionalListPlaybookVersions requests and continue to iteratethrough theplaybook_versions field on thecorresponding responses.

All the usualListPlaybookVersionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_playbook_versions requests.

This class thinly wraps an initialListPlaybookVersionsResponse object, andprovides an__iter__ method to iterate through itsplaybook_versions field.

If there are more pages, the__iter__ method will make additionalListPlaybookVersions requests and continue to iteratethrough theplaybook_versions field on thecorresponding responses.

All the usualListPlaybookVersionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_playbooks requests.

This class thinly wraps an initialListPlaybooksResponse object, andprovides an__aiter__ method to iterate through itsplaybooks field.

If there are more pages, the__aiter__ method will make additionalListPlaybooks requests and continue to iteratethrough theplaybooks field on thecorresponding responses.

All the usualListPlaybooksResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_playbooks requests.

This class thinly wraps an initialListPlaybooksResponse object, andprovides an__iter__ method to iterate through itsplaybooks field.

If there are more pages, the__iter__ method will make additionalListPlaybooks requests and continue to iteratethrough theplaybooks field on thecorresponding responses.

All the usualListPlaybooksResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managing security settings for Dialogflow.

Service for managing security settings for Dialogflow.

A pager for iterating throughlist_security_settings requests.

This class thinly wraps an initialListSecuritySettingsResponse object, andprovides an__aiter__ method to iterate through itssecurity_settings field.

If there are more pages, the__aiter__ method will make additionalListSecuritySettings requests and continue to iteratethrough thesecurity_settings field on thecorresponding responses.

All the usualListSecuritySettingsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_security_settings requests.

This class thinly wraps an initialListSecuritySettingsResponse object, andprovides an__iter__ method to iterate through itssecurity_settings field.

If there are more pages, the__iter__ method will make additionalListSecuritySettings requests and continue to iteratethrough thesecurity_settings field on thecorresponding responses.

All the usualListSecuritySettingsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingSessionEntityTypes.

Service for managingSessionEntityTypes.

A pager for iterating throughlist_session_entity_types requests.

This class thinly wraps an initialListSessionEntityTypesResponse object, andprovides an__aiter__ method to iterate through itssession_entity_types field.

If there are more pages, the__aiter__ method will make additionalListSessionEntityTypes requests and continue to iteratethrough thesession_entity_types field on thecorresponding responses.

All the usualListSessionEntityTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_session_entity_types requests.

This class thinly wraps an initialListSessionEntityTypesResponse object, andprovides an__iter__ method to iterate through itssession_entity_types field.

If there are more pages, the__iter__ method will make additionalListSessionEntityTypes requests and continue to iteratethrough thesession_entity_types field on thecorresponding responses.

All the usualListSessionEntityTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A session represents an interaction with a user. You retrieve userinput and pass it to theDetectIntentmethod to determine user intent and respond.

A session represents an interaction with a user. You retrieve userinput and pass it to theDetectIntentmethod to determine user intent and respond.

Service for managing [TestCases][google.cloud.dialogflow.cx.v3beta1.TestCase] and [Test CaseResults][google.cloud.dialogflow.cx.v3beta1.TestCaseResult].

Service for managing [TestCases][google.cloud.dialogflow.cx.v3beta1.TestCase] and [Test CaseResults][google.cloud.dialogflow.cx.v3beta1.TestCaseResult].

A pager for iterating throughlist_test_case_results requests.

This class thinly wraps an initialListTestCaseResultsResponse object, andprovides an__aiter__ method to iterate through itstest_case_results field.

If there are more pages, the__aiter__ method will make additionalListTestCaseResults requests and continue to iteratethrough thetest_case_results field on thecorresponding responses.

All the usualListTestCaseResultsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_test_case_results requests.

This class thinly wraps an initialListTestCaseResultsResponse object, andprovides an__iter__ method to iterate through itstest_case_results field.

If there are more pages, the__iter__ method will make additionalListTestCaseResults requests and continue to iteratethrough thetest_case_results field on thecorresponding responses.

All the usualListTestCaseResultsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_test_cases requests.

This class thinly wraps an initialListTestCasesResponse object, andprovides an__aiter__ method to iterate through itstest_cases field.

If there are more pages, the__aiter__ method will make additionalListTestCases requests and continue to iteratethrough thetest_cases field on thecorresponding responses.

All the usualListTestCasesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_test_cases requests.

This class thinly wraps an initialListTestCasesResponse object, andprovides an__iter__ method to iterate through itstest_cases field.

If there are more pages, the__iter__ method will make additionalListTestCases requests and continue to iteratethrough thetest_cases field on thecorresponding responses.

All the usualListTestCasesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingTools.

Service for managingTools.

A pager for iterating throughlist_tool_versions requests.

This class thinly wraps an initialListToolVersionsResponse object, andprovides an__aiter__ method to iterate through itstool_versions field.

If there are more pages, the__aiter__ method will make additionalListToolVersions requests and continue to iteratethrough thetool_versions field on thecorresponding responses.

All the usualListToolVersionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_tool_versions requests.

This class thinly wraps an initialListToolVersionsResponse object, andprovides an__iter__ method to iterate through itstool_versions field.

If there are more pages, the__iter__ method will make additionalListToolVersions requests and continue to iteratethrough thetool_versions field on thecorresponding responses.

All the usualListToolVersionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_tools requests.

This class thinly wraps an initialListToolsResponse object, andprovides an__aiter__ method to iterate through itstools field.

If there are more pages, the__aiter__ method will make additionalListTools requests and continue to iteratethrough thetools field on thecorresponding responses.

All the usualListToolsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_tools requests.

This class thinly wraps an initialListToolsResponse object, andprovides an__iter__ method to iterate through itstools field.

If there are more pages, the__iter__ method will make additionalListTools requests and continue to iteratethrough thetools field on thecorresponding responses.

All the usualListToolsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingTransitionRouteGroups.

Service for managingTransitionRouteGroups.

A pager for iterating throughlist_transition_route_groups requests.

This class thinly wraps an initialListTransitionRouteGroupsResponse object, andprovides an__aiter__ method to iterate through itstransition_route_groups field.

If there are more pages, the__aiter__ method will make additionalListTransitionRouteGroups requests and continue to iteratethrough thetransition_route_groups field on thecorresponding responses.

All the usualListTransitionRouteGroupsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_transition_route_groups requests.

This class thinly wraps an initialListTransitionRouteGroupsResponse object, andprovides an__iter__ method to iterate through itstransition_route_groups field.

If there are more pages, the__iter__ method will make additionalListTransitionRouteGroups requests and continue to iteratethrough thetransition_route_groups field on thecorresponding responses.

All the usualListTransitionRouteGroupsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingVersions.

Service for managingVersions.

A pager for iterating throughlist_versions requests.

This class thinly wraps an initialListVersionsResponse object, andprovides an__aiter__ method to iterate through itsversions field.

If there are more pages, the__aiter__ method will make additionalListVersions requests and continue to iteratethrough theversions field on thecorresponding responses.

All the usualListVersionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_versions requests.

This class thinly wraps an initialListVersionsResponse object, andprovides an__iter__ method to iterate through itsversions field.

If there are more pages, the__iter__ method will make additionalListVersions requests and continue to iteratethrough theversions field on thecorresponding responses.

All the usualListVersionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Service for managingWebhooks.

Service for managingWebhooks.

A pager for iterating throughlist_webhooks requests.

This class thinly wraps an initialListWebhooksResponse object, andprovides an__aiter__ method to iterate through itswebhooks field.

If there are more pages, the__aiter__ method will make additionalListWebhooks requests and continue to iteratethrough thewebhooks field on thecorresponding responses.

All the usualListWebhooksResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_webhooks requests.

This class thinly wraps an initialListWebhooksResponse object, andprovides an__iter__ method to iterate through itswebhooks field.

If there are more pages, the__iter__ method will make additionalListWebhooks requests and continue to iteratethrough thewebhooks field on thecorresponding responses.

All the usualListWebhooksResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

Action performed by end user or Dialogflow agent in theconversation.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Stores metadata of the state update action, such as a statemachine execution in flows.

Stores the metadata of a function call to execute.

Stores the state of a page and its flow.

Stores metadata of the intent match action.

Stores the matched intent, which is the result of the intentmatch action.

Stores metadata of the Speech-to-Text action.

Stores metadata of the Text-to-Speech action.

Hierarchical advanced settings foragent/flow/page/fulfillment/parameter. Settings exposed at lowerlevel overrides the settings exposed at higher level. Overridingoccurs at the sub-setting level. For example, theplayback_interruption_settings at fulfillment level only overridesthe playback_interruption_settings at the agent level, leaving othersettings at the agent level unchanged.

DTMF settings does not override each other. DTMF settings set atdifferent levels define DTMF detections running in parallel.

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

Define behaviors for DTMF (dual tone multi frequency).

Define behaviors on logging.

Define behaviors of speech to text detection.

The abstract base class for a message.

Agents are best described as Natural Language Understanding (NLU)modules that transform user requests into actionable data. You caninclude agents in your app, product, or service to determine userintent and respond to the user in a natural way.

After you create an agent, you can addIntents, [EntityTypes][google.cloud.dialogflow.cx.v3beta1.EntityType],Flows,Fulfillments,Webhooks,TransitionRouteGroupsand so on to manage the conversation flows.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Settings for answer feedback collection.

Settings for custom client certificates.

Settings for Gen App Builder.

Settings for connecting to Git repository for an agent.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Integration settings for a Git service hosted on Cloud Run.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Settings of integration with GitHub.

Settings for end user personalization.

AgentUtterance represents one message sent by the agent.

The response message forAgents.GetAgentValidationResult.

Stores information about feedback provided by users about aresponse.

Represents thumbs up/down rating provided by user about aresponse.

Stores extra information about why users provided thumbs downrating.

Audio encoding of the audio content sent in the conversational queryrequest. Refer to theCloud Speech APIdocumentation <https://cloud.google.com/speech-to-text/docs/basics>__for more details.

Represents the natural speech audio to be processed.

Configuration of the barge-in behavior. Barge-in instructs the APIto return a detected utterance at a proper time while the client isplaying back the response audio from a previous request. When theclient sees the utterance, it should stop the playback andimmediately get ready for receiving the responses for the currentrequest.

The barge-in handling requires the client to start streaming audioinput as soon as it starts playing back the audio from the previousresponse. The playback is modeled into two phases:

• No barge-in phase: which goes first and during which speechdetection should not be carried out.

• Barge-in phase: which follows the no barge-in phase and duringwhich the API starts speech detection and may inform the clientthat an utterance has been detected. Note that no-speech event isnot expected in this phase.

The client provides this configuration in terms of the durations ofthose two phases. The durations are measured in terms of the audiolength from the start of the input audio.

No-speech event is a response with END_OF_UTTERANCE without anytranscript following up.

The request message forTestCases.BatchDeleteTestCases.

Metadata returned for theTestCases.BatchRunTestCaseslong running operation.

The request message forTestCases.BatchRunTestCases.

The response message forTestCases.BatchRunTestCases.

The settings of BigQuery export.

Boost specification to boost certain documents.A copy of google.cloud.discoveryengine.v1main.BoostSpec, fielddocumentation is available athttps://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec

Boost applies to documents which match a condition.

Specification for custom ranking based on customer specifiedattribute value. It provides more controls for customizedranking than the simple (condition, boost) combination above.

The attribute(or function) for which the custom ranking is tobe applied.

The control points used to define the curve. The curvedefined through these control points can only be monotonicallyincreasing or decreasing(constant values are acceptable).

The interpolation type to be applied. Default will be linear(Piecewise Linear).

Boost specifications for data stores.

The request message forTestCases.CalculateCoverage.

The type of coverage score requested.

The response message forTestCases.CalculateCoverage.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Changelogs represents a change made to a given agent.

Cloud conversation info for easier debugging. It will get populatedinStreamingDetectIntentResponse orStreamingAnalyzeContentResponse when the flagenable_debugging_info is set to true in corresponding requests.

The request message forVersions.CompareVersions.

The response message forVersions.CompareVersions.

Represents a result from running a test case in an agentenvironment.

The overall result for a continuous test run in an agentenvironment.

Represents a conversation.

The abstract base class for a message.

Represents an interaction between an end user and aDialogflow CX agent using V3 (Streaming)DetectIntent API, or aninteraction between an end user and a Dialogflow CX agent usingV2 (Streaming)AnalyzeContent API.

Information collected for DF CX agents in case NLU predictedan intent that was filtered out as being inactive which mayindicate a missing transition and/or absent functionality.

Metrics of each processing step.

Represents metrics for the conversation.

Count byMatch.MatchTypeof the matches in the conversation.

Count by types ofQueryInput of therequests in the conversation.

Represents the type of a conversation.

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

The input from the human user.

The output from the virtual agent.

The request message forAgents.CreateAgent.

The request message forEntityTypes.CreateEntityType.

The request message forEnvironments.CreateEnvironment.

The request message forExamples.CreateExample.

The request message forExperiments.CreateExperiment.

The request message forFlows.CreateFlow.

The request message forGenerators.CreateGenerator.

The request message forIntents.CreateIntent.

The request message forPages.CreatePage.

The request message forPlaybooks.CreatePlaybook.

The request message forPlaybooks.CreatePlaybookVersion.

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

The request message forSessionEntityTypes.CreateSessionEntityType.

The request message forTestCases.CreateTestCase.

The request message forTools.CreateTool.

The request message forTools.CreateToolVersion.The request message forTools.CreateToolVersion.

The request message forTransitionRouteGroups.CreateTransitionRouteGroup.

Metadata associated with the long running operation forVersions.CreateVersion.

The request message forVersions.CreateVersion.

The request message forWebhooks.CreateWebhook.

A data store connection. It represents a data store inDiscovery Engine and the type of the contents it contains.

Data store connection feature output signals.Might be only partially field if processing stop before thefinal answer. Reasons for this can be, but are not limited to:empty UCS search results, positive RAI check outcome, groundingfailure, ...

Diagnostic info related to the answer generation model call.

Answer part with citation.

Snippet cited by the answer generation model.

Grounding signals.

Represents the decision of the grounding check.

Grounding score buckets.

Diagnostic info related to the rewriter model call.

Safety check results.

Specifies banned phrase match subject.

Safety decision.All kinds of check are incorporated into this final decision,including banned phrases check.

Search snippet details.

Type of a data store.Determines how search is performed in the data store.

Defines data types that are supported for inlined schemas. Thesetypes are consistent withgoogle.protobuf.Value][google.protobuf.Value].

The request message forAgents.DeleteAgent.

The request message for [Conversations.DeleteConversation][].

The request message forEntityTypes.DeleteEntityType.

The request message forEnvironments.DeleteEnvironment.

The request message forExamples.DeleteExample.

The request message forExperiments.DeleteExperiment.

The request message forFlows.DeleteFlow.

The request message forGenerators.DeleteGenerator.

The request message forIntents.DeleteIntent.

The request message forPages.DeletePage.

The request message forPlaybooks.DeletePlaybook.

The request message forPlaybooks.DeletePlaybookVersion.

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

The request message forSessionEntityTypes.DeleteSessionEntityType.

The request message forTools.DeleteTool.

The request message forTools.DeleteToolVersion.

The request message forTransitionRouteGroups.DeleteTransitionRouteGroup.

The request message forVersions.DeleteVersion.

The request message forWebhooks.DeleteWebhook.

Metadata returned for theEnvironments.DeployFlowlong running operation.

The request message forEnvironments.DeployFlow.

The response message forEnvironments.DeployFlow.

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

Result of the deployment.

The state of the deployment.

The request to detect user's intent.

The message returned from the DetectIntent method.

Represents different DetectIntentResponse types.

The document processing mode of the data store.

Represents the input for dtmf event.

Entities are extracted from user input and represent parameters thatare meaningful to your application. For example, a date range, aproper 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 allmap to that entity. For example, "soft drink", "soda", "pop", and soon.

There are three types of entities:

• System - entities that are defined by the Dialogflow API forcommon data types such as date, time, currency, and so on. Asystem entity is represented by theEntityType type.

• Custom - entities that are defined by you that representactionable data that is meaningful to your application. Forexample, you could define apizza.sauce entity for red orwhite pizza sauce, apizza.cheese entity for the differenttypes of cheese on a pizza, apizza.topping entity fordifferent toppings, and so on. A custom entity is represented bytheEntityType type.

• User - entities that are built for an individual user such asfavorites, preferences, playlists, and so on. A user entity isrepresented by theSessionEntityTypetype.

For more information about entity types, see theDialogflowdocumentation <https://cloud.google.com/dialogflow/docs/entities-overview>__.

Represents different entity type expansion modes. Automatedexpansion allows an agent to recognize values that have not beenexplicitly listed in the entity (for example, new kinds ofshopping list items).

Anentity entry for an associated entity type.

An excluded entity phrase that should not be matched.

Represents kinds of entities.

Represents an environment for an agent. You can createmultiple versions of your agent and publish them to separateenvironments. When you edit an agent, you are editing the draftagent. At any point, you can save the draft agent as an agentversion, which is an immutable snapshot of your agent. When yousave the draft agent, it is published to the defaultenvironment. When you create agent versions, you can publishthem to custom environments. You can create a variety of customenvironments for testing, development, production, etc.

The configuration for continuous tests.

Configuration for the version.

Configuration for webhooks.

Event represents the event sent by the customer.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the event to trigger.

Example represents a sample execution of the playbook in theconversation.An example consists of a list of ordered actions performed byend user or Dialogflow agent according the playbook instructionsto fulfill the task.

Exception thrown during the execution of an action.

Represents an experiment in an environment.

Definition of the experiment.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

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

types of count-based metric for Dialogflow experiment.

Metric and corresponding confidence intervals.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Types of ratio-based metric for Dialogflow experiment.

Version variant and associated metrics.

The state of the experiment.

The request message forAgents.ExportAgent.

Data format of the exported agent.

Settings for exporting to a git branch.

The response message forAgents.ExportAgent.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata returned for theEntityTypes.ExportEntityTypeslong running operation.

The request message forEntityTypes.ExportEntityTypes.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Data format of the exported entity types.

The response message forEntityTypes.ExportEntityTypes.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The request message forFlows.ExportFlow.

The response message forFlows.ExportFlow.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata returned for theIntents.ExportIntentslong running operation.

The request message forIntents.ExportIntents.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Data format of the exported intents.

The response message forIntents.ExportIntents.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The request message forPlaybooks.ExportPlaybook.

Data format of the exported playbook.

The response message forPlaybooks.ExportPlaybook.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata returned for theTestCases.ExportTestCaseslong running operation. This message currently has no fields.

The request message forTestCases.ExportTestCases.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Data format of the exported test cases.

The response message forTestCases.ExportTestCases.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata returned for theTools.ExportToolslong running operation.

The request message forTools.ExportTools.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Data format of the exported tools.

The response message forTools.ExportTools.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Filter specifications for data stores.

Flows represents the conversation flows when you build yourchatbot agent.A flow consists of many pages connected by the transitionroutes. Conversations always start with the built-in Start Flow(with an all-0 ID). Transition routes can direct theconversation session from the current flow (parent flow) toanother flow (sub flow). When the sub flow is finished,Dialogflow will bring the session back to the parent flow, wherethe sub flow is started.

Usually, when a transition route is followed by a matchedintent, the intent will be "consumed". This means the intentwon't activate more transition routes. However, when thefollowed transition route moves the conversation session into adifferent flow, the matched intent can be carried over and to beconsumed in the target flow.

Settings for multi-lingual agents.

The flow import strategy used for resource conflict resolutionassociated with anImportFlowRequest.

Stores metadata of the invocation of a child CX flow. Flowinvocation actions enter the child flow.

Stores metadata of the transition to a target CX flow. Flowtransition actions exit the caller playbook and enter the childflow.

The response message forFlows.GetFlowValidationResult.

A form is a data model that groups related parameters that can becollected from the user. The process in which the agent prompts theuser and collects parameter values from the user is called formfilling. A form can be added to apage. When form fillingis done, the filled parameters will be written to thesession.

Represents a form parameter.

Configuration for how the filling of a parameter should behandled.

Request of [FulfillIntent][]

Response of [FulfillIntent][]

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

• Generate rich message responses.
• Set parameter values.
• Call the webhook.

Fulfillments can be called at various stages in thePage orForm lifecycle. Forexample, when aDetectIntentRequestdrives a session to enter a new page, the page's entry fulfillmentcan add a static response to theQueryResult in thereturningDetectIntentResponse,call the webhook (for example, to load user data from a database),or both.

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

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

The list of messages or conditional cases to activate forthis case.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Generator settings used by the LLM to generate a textresponse.

The abstract base class for a message.

Setting a parameter value.

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

Represents the information of a query if handled bygenerative agent resources.

Settings for Generative AI.

Settings for Generative Fallback.

Prompt template.

Settings for knowledge connector. These parameters are used for LLMprompt like "You are . You are a helpful and verbose<agent_identity> at , <business_description>. Your task is to helphumans on <agent_scope>".

Generators contain prompt to be sent to the LLM model togenerate text. The prompt can contain parameters which will beresolved before calling the model. It can optionally containbanned phrases to ensure the model responses are safe.

Parameters to be passed to the LLM. If not set, defaultvalues will be used.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents a custom placeholder in the prompt text.

The request message forAgents.GetAgent.

The request message forAgents.GetAgentValidationResult.

The request message forChangelogs.GetChangelog.

The request message for [Conversations.GetConversation][].

The request message forDeployments.GetDeployment.

The request message forEntityTypes.GetEntityType.

The request message forEnvironments.GetEnvironment.

The request message forExamples.GetExample.

The request message forExperiments.GetExperiment.

The response message forFlows.GetFlow.

The request message forFlows.GetFlowValidationResult.

Request forGetGenerativeSettingsRPC.

The request message forGenerators.GetGenerator.

The request message forIntents.GetIntent.

The request message forPages.GetPage.

The request message forPlaybooks.GetPlaybook.

The request message forPlaybooks.GetPlaybookVersion.

The request message forSecuritySettingsService.GetSecuritySettings.

The request message forSessionEntityTypes.GetSessionEntityType.

The request message forTestCases.GetTestCase.

The request message forTestCases.GetTestCaseResult.

The request message forTools.GetTool.

The request message forTools.GetToolVersion.

The request message forTransitionRouteGroups.GetTransitionRouteGroup.

The request message forVersions.GetVersion.

The request message forWebhooks.GetWebhook.

Handler can be used to define custom logic to be executedbased on the user-specified triggers.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A handler that is triggered by the specifiedevent.

A handler that is triggered on the specificlifecycle_stageof the playbook execution.

Metadata returned for theEntityTypes.ImportEntityTypeslong running operation.

The request message forEntityTypes.ImportEntityTypes.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Merge option when display name conflicts exist during import.

The response message forEntityTypes.ImportEntityTypes.

Conflicting resources detected during the import process. Onlyfilled whenREPORT_CONFLICT][ImportEntityTypesResponse.REPORT_CONFLICT] is setin the request and there are conflicts in the display names.

The request message forFlows.ImportFlow.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Import option.

The response message forFlows.ImportFlow.

Metadata returned for theIntents.ImportIntentslong running operation.

The request message forIntents.ImportIntents.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Merge option when display name conflicts exist during import.

The response message forIntents.ImportIntents.

Conflicting resources detected during the import process. Onlyfilled whenREPORT_CONFLICT][ImportIntentsResponse.REPORT_CONFLICT]is set in the request and there are conflicts in the display names.

The request message forPlaybooks.ImportPlaybook.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The response message forPlaybooks.ImportPlaybook.

Conflicting resources detected during the import process. Onlyfilled whenREPORT_CONFLICTS][ImportPlaybookResponse.REPORT_CONFLICTS] is setin the request and there are conflicts in the display names.

Import strategies for the conflict resolution of resources(i.e. intents, entities, and webhooks) with identical displaynames during import operations.

Metadata returned for theTestCases.ImportTestCaseslong running operation.

The request message forTestCases.ImportTestCases.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The response message forTestCases.ImportTestCases.

Inline destination for a Dialogflow operation that writes or exportsobjects (e.g.intents)outside of Dialogflow.

A type schema object that's specified inline.

Inline source for a Dialogflow operation that reads or importsobjects (e.g.intents)into Dialogflow.

Instructs the speech recognizer on how to process the audiocontent.

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

The abstract base class for a message.

Represents an intent parameter.

Represents an example that the agent is trained on toidentify the intent.

Represents a part of a training phrase.

Intent coverage represents the percentage of all possibleintents in the agent that are triggered in any of a parent'stest cases.

The agent's intent.

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

Represents the options for views of an intent.An intent can be a sizable object. Therefore, we provide aresource view that does not return training phrases in theresponse.

The Knowledge Connector settings for this page or flow.This includes information such as the attached Knowledge Bases,and the way to execute fulfillment.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the language information of the request.

The request message forAgents.ListAgents.

The response message forAgents.ListAgents.

The request message forChangelogs.ListChangelogs.

The response message forChangelogs.ListChangelogs.

The request message forEnvironments.ListContinuousTestResults.

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

The request message for [Conversations.ListConversations][].

The response message for [Conversations.ListConversations][].

The request message forDeployments.ListDeployments.

The response message forDeployments.ListDeployments.

The request message forEntityTypes.ListEntityTypes.

The response message forEntityTypes.ListEntityTypes.

The request message forEnvironments.ListEnvironments.

The response message forEnvironments.ListEnvironments.

The request message forExamples.ListExamples.

The response message forExamples.ListExamples.

The request message forExperiments.ListExperiments.

The response message forExperiments.ListExperiments.

The request message forFlows.ListFlows.

The response message forFlows.ListFlows.

The request message forGenerators.ListGenerators.

The response message forGenerators.ListGenerators.

The request message forIntents.ListIntents.

The response message forIntents.ListIntents.

The request message forPages.ListPages.

The response message forPages.ListPages.

The request message forPlaybooks.ListPlaybookVersions.

The response message forPlaybooks.ListPlaybookVersions.

The request message forPlaybooks.ListPlaybooks.

The response message forPlaybooks.ListPlaybooks.

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

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

The request message forSessionEntityTypes.ListSessionEntityTypes.

The response message forSessionEntityTypes.ListSessionEntityTypes.

The request message forTestCases.ListTestCaseResults.

The response message forTestCases.ListTestCaseResults.

The request message forTestCases.ListTestCases.

Specifies how much test case information to include in theresponse.

The response message forTestCases.ListTestCases.

The request message forTools.ListToolVersions.

The response message forTools.ListToolVersions.

The request message forTools.ListTools.

The response message forTools.ListTools.

The request message forTransitionRouteGroups.ListTransitionRouteGroups.

The response message forTransitionRouteGroups.ListTransitionRouteGroups.

The request message forVersions.ListVersions.

The response message forVersions.ListVersions.

The request message forWebhooks.ListWebhooks.

The response message forWebhooks.ListWebhooks.

Stores metadata of the call of an LLM.

Relevant example used for the LLM prompt.

Stores token counts of the LLM call.

Settings for LLM models.

Generative model parameters to control the model behavior.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The input token limits for 1 LLM call. For the limit of eachmodel, seehttps://cloud.google.com/vertex-ai/generative-ai/docs/learn/modelsfor more information.

The output token limits for 1 LLM call. The limits aresubject to change. For the limit of each model, seehttps://cloud.google.com/vertex-ai/generative-ai/docs/learn/modelsfor more information.

The request message forVersions.LoadVersion.

The request message forEnvironments.LookupEnvironmentHistory.

The response message forEnvironments.LookupEnvironmentHistory.

Represents one match result of [MatchIntent][].

Type of a Match.

Request of [MatchIntent][].

Response of [MatchIntent][].

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A named metric is a metric with name, value and unit.

Settings related to NLU.

NLU model training mode.

NLU model type.

Instructs the speech synthesizer how to generate the outputaudio content.

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

Output state.

A Dialogflow CX conversation (session) can be described andvisualized as a state machine. The states of a CX session arerepresented by pages.

For each flow, you define many pages, where your combined pages canhandle a complete conversation on the topics the flow is designedfor. At any given moment, exactly one page is the current page, thecurrent page is considered active, and the flow associated with thatpage is considered active. Every flow has a special start page. Whena flow initially becomes active, the start page page becomes thecurrent page. For each conversational turn, the current page willeither stay the same or transition to another page.

You configure each page to collect information from the end-userthat is relevant for the conversational state represented by thepage.

For more information, see thePageguide <https://cloud.google.com/dialogflow/cx/docs/concept/page>__.

Represents page information communicated to and from thewebhook.

Represents form information.

Represents parameter information.

Represents the state of a parameter.

Defines the properties of a parameter.Used to define parameters used in the agent and the input /output parameters for each fulfillment.

Parameter types are used for validation. These types are consistentwithgoogle.protobuf.Value][google.protobuf.Value].

Text input which can be used for prompt or banned phrases.

Playbook is the basic building block to instruct the LLM howto execute a certain task.

A playbook consists of a goal to accomplish, an optional list ofstep by step instructions (the step instruction may refers toname of the custom or default plugin tools to use) to performthe task,a list of contextual input data to be passed in at the beginningof the invoked, and a list of output parameters to store theplaybook result.

Message of the Instruction of the playbook.

Type of the playbook.

Message of single step execution.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The playbook import strategy used for resource conflict resolutionassociated with anImportPlaybookRequest.

Input of the playbook.

Stores metadata of the invocation of a child playbook.Playbook invocation actions enter the child playbook.

Output of the playbook.

Playbook output state.

Stores metadata of the transition to another target playbook.Playbook transition actions exit the caller playbook and enterthe target playbook.

Playbook version is a snapshot of the playbook at certaintimestamp.

Represents the query input. It can contain one of:

1. A conversational query in the form of text.

2. An intent query that specifies which intent to trigger.

3. Natural language speech audio to be processed.

4. An event to be triggered.

5. DTMF digits to invoke an intent and fill in parameter value.

6. The results of a tool executed by the client.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the parameters of a conversational query.

The abstract base class for a message.

Represents the result of a conversational query.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Resource name and display name.

Represents a response message that can be returned by aconversational agent.

Response messages are also used for output audio synthesis. Theapproach is as follows:

• If at least one OutputAudioText response is present, then allOutputAudioText responses are linearly concatenated, and theresult 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, theresult is treated as either text or SSML as appropriate. The agentdesigner should ideally use either text or SSML consistentlythroughout the bot design.
• Otherwise, all Text responses are linearly concatenated, and theresult is used for output audio synthesis.

This approach allows for more sophisticated user experiencescenarios, where the text displayed to the user may differ from whatis heard.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Indicates that the conversation succeeded, i.e., the bot handled theissue that the customer talked to it about.

Dialogflow only uses this to determine which conversations should becounted as successful and doesn't process the metadata in thismessage in any way. Note that Dialogflow also considersconversations that get to the conversation end page as successfuleven if they don't returnConversationSuccess.

You may set this, for example:

• In theentry_fulfillmentof aPage if enteringthe page indicates that the conversation succeeded.
• In a webhook response when you determine that you handled thecustomer issue.

Indicates that interaction with the Dialogflow agent hasended. This message is generated by Dialogflow only and notsupposed to be defined by the user.

Represents info card response. If the response containsgenerative knowledge prediction, Dialogflow will return apayload with Infobot Messenger compatible info card.

Otherwise, the info card response is skipped.

Indicates that the conversation should be handed off to a liveagent.

Dialogflow only uses this to determine which conversations werehanded off to a human agent for measurement purposes. What else todo with this signal is up to you and your handoff procedures.

You may set this, for example:

• In theentry_fulfillmentof aPage if enteringthe page indicates something went extremely wrong in theconversation.
• In a webhook response when you determine that the customer issuecan only be handled by a human.

Represents an audio message that is composed of both segmentssynthesized from the Dialogflow agent prompts and ones hostedexternally at the specified URIs. The external URIs are specifiedviaplay_audio.This message is generated by Dialogflow only and not supposed to bedefined by the user.

Represents one segment of audio.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

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

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The text response message.

The request message forAgents.RestoreAgent.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Settings for restoring from a git branch

Restore option.

The request message forPlaybooks.RestorePlaybookVersion.

The response message forPlaybooks.RestorePlaybookVersion.

The request message forTools.RestoreToolVersion.

The response message forTools.RestoreToolVersion.

Retrieval strategy on how the example is selected to be fedto the prompt.

The configuration for auto rollout.

A single rollout step with specified traffic allocation.

State of the auto-rollout process.

Metadata returned for theEnvironments.RunContinuousTestlong running operation.

The request message forEnvironments.RunContinuousTest.

The response message forEnvironments.RunContinuousTest.

Metadata returned for theTestCases.RunTestCaselong running operation. This message currently has no fields.

The request message forTestCases.RunTestCase.

The response message forTestCases.RunTestCase.

Settings for Generative Safety.

Text input which can be used for prompt or banned phrases.

Strategy for matching phrases.

Settings for prompt security checks.

Search configuration for UCS search queries.

Represents the settings related to security issues, such asdata redaction and data retention. It may take hours for updateson the settings to propagate to all the related components andtake effect.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Settings for exporting audio.

File format for exported audio file. Currently only intelephony recordings.

Settings for exporting conversations toInsights <https://cloud.google.com/contact-center/insights/docs>__.

Type of data we purge after retention settings triggerspurge.

Defines what types of data to redact.

Defines how we redact data.

Defines how long we retain persisted data that containssensitive info.

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

Session entity types are referred to asUser entity types andare entities that are built for an individual user such asfavorites, preferences, playlists, and so on.

You can redefine a session entity type at the session level toextend or replace a [custom entitytype][google.cloud.dialogflow.cx.v3beta1.EntityType] at the usersession level (we refer to the entity types defined at the agentlevel as "custom entity types").

Note: session entity types apply to all queries, regardless of thelanguage.

For more information about entity types, see theDialogflowdocumentation <https://cloud.google.com/dialogflow/docs/entities-overview>__.

The types of modifications for the session entity type.

    Note: Even in this override mode calls to    `ListSessionEntityTypes`, `GetSessionEntityType`,    `CreateSessionEntityType` and `UpdateSessionEntityType`    only return the additional entities added in this session    entity type. If you want to get the supplemented list,    please call    <xref uid="google.cloud.dialogflow.cx.v3beta1.EntityTypes.GetEntityType">EntityTypes.GetEntityType</xref>    on the custom entity type and merge.

Represents session information communicated to and from thewebhook.

The abstract base class for a message.

A span represents a sub execution step of an action.

Variant of the specified [Speechmodel][google.cloud.dialogflow.cx.v3beta1.InputAudioConfig.model] touse.

See theCloud Speechdocumentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>__for which models have different variants. For example, the"phone_call" model has both a standard and an enhanced variant. Whenyou use an enhanced model, you will generally receive higher qualityresults than for a standard model.

    - If an enhanced variant does not exist for the given      <xref uid="google.cloud.dialogflow.cx.v3beta1.InputAudioConfig.model">model</xref>      and request language, Dialogflow falls back to the      standard variant.      The `Cloud Speech      documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__      describes which models have enhanced variants.

Settings related to speech recognition.

Information for a word recognized by the speech recognizer.

Gender of the voice as described inSSML voiceelement <https://www.w3.org/TR/speech-synthesis11/#edef_voice>__.

The request message forExperiments.StartExperiment.

The status of the action.

The request message forExperiments.StopExperiment.

The top-level message sent by the client to theSessions.StreamingDetectIntentmethod.

Multiple request messages should be sent in order:

1. The first message must containsession,query_inputplus optionallyquery_params.If the client wants to receive an audio response, it should alsocontainoutput_audio_config.

2. Ifquery_inputwas set toquery_input.audio.config,all subsequent messages must containquery_input.audio.audioto continue with Speech recognition. If you decide to ratherdetect an intent from text input after you already started Speechrecognition, please send a message withquery_input.text.

   However, note that:

   • Dialogflow will bill you for the audio duration so far.
   • Dialogflow discards all Speech recognition results in favor ofthe input text.
   • Dialogflow will use the language code from the first message.

After you sent all input, you must half-close or abort the requeststream.

The top-level message returned from theStreamingDetectIntentmethod.

Multiple response messages can be returned in order:

• If theStreamingDetectIntentRequest.query_input.audio fieldwas set, the first M messages containrecognition_result. Eachrecognition_result represents a more complete transcript ofwhat the user said. The lastrecognition_result hasis_final set totrue.

• If theStreamingDetectIntentRequest.enable_partial_responsefield was true, thedetect_intent_response field is populatedfor each of the following N responses, where 0 <= N <= 5. Theseresponses set theDetectIntentResponse.response_typefield toPARTIAL.

For the last response message, thedetect_intent_response isfully populated, andDetectIntentResponse.response_typeis set toFINAL.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Contains a speech recognition result corresponding to a portion ofthe audio that is currently being processed or an indication thatthis is the end of the single requested utterance.

While end-user audio is being processed, Dialogflow sends a seriesof results. Each result may contain atranscript value. Atranscript represents a portion of the utterance. While therecognizer is processing audio, transcript values may be interimvalues or finalized values. Once a transcript is finalized, theis_final value is set to true and processing continues for thenext transcript.

IfStreamingDetectIntentRequest.query_input.audio.config.single_utterancewas true, and the recognizer has completed processing audio, themessage_type value is set to `END_OF_SINGLE_UTTERANCE and thefollowing (last) result contains the last finalized transcript.

The complete end-user utterance is determined by concatenating thefinalized transcript values received for the series of results.

In the following example, single utterance is enabled. In the casewhere single utterance is not enabled, result 7 would not occur.

::

Concatenating the finalized transcripts withis_final set totrue, the complete utterance becomes "to be or not to be that is thequestion".

Type of the response message.

The request to set the feedback for a bot answer.

Configuration of how speech should be synthesized.

Represents a test case.

Error info for importing a test.

Represents a result from running a test case in an agentenvironment.

Represents configurations for a test case.

Error info for running a test.

The test result for a test case and an agent environment.

The description of differences between original and replayedagent output.

What part of the message replay differs from the test case.

Represents the natural language text to be processed.

Settings related to speech synthesizing.

The abstract base class for a message.

A tool provides a list of actions which are available to thePlaybook to attainits goal. A Tool consists of a description of the tool's usage and aspecification of the tool which contains the schema andauthentication information.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Authentication information required for API calls

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Config for authentication with API key.

Config for authentication using bearer token.

Config for authentication with OAuth.

OAuth grant types. Onlyclient credentialgrant <https://oauth.net/2/grant-types/client-credentials>__ issupported.

The location of the API key in the request.

Config for auth usingDiglogflow serviceagent <https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent>__.

Indicate the auth token type generated from theDiglogflow serviceagent <https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent>__.

A ConnectorTool enabling using Integration ConnectorsConnections as tools.

Configuration of a Connection operation for the tool to use.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Entity CRUD operation specification.

The operation to perform on the entity.

A DataStoreTool is a way to provide specifications needed tosearch a list of data stores.

A FallbackPrompt is a way to provide specifications for theData Store fallback prompt when generating responses.

End-user authentication configuration used for Connection calls. Thefield values can either be hardcoded authentication values or thenames ofsessionparameters <https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref>orrequestparameters <https://cloud.google.com/dialogflow/cx/docs/concept/parameter#request-scoped>.

If parameter names are provided, then those parameters can be usedto pass the authentication values dynamically, through$session.params.param-id or$request.payload.param-id.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Oauth 2.0 Authorization Code authentication configuration.

JWT Profile Oauth 2.0 Authorization Grant authenticationconfiguration.

An ExtensionTool is a way to use Vertex Extensions as a tool.

A Function tool describes the functions to be invoked on theclient side.

An OpenAPI tool is a way to provide the Tool specificationsin the Open API schema format.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Configuration for tools using Service Directory.

The TLS configuration.

The CA certificate.

Represents the type of the tool.

Represents a call of a specific tool's action with thespecified inputs.

The result of calling a tool's action that has been executedby the client.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

An error produced by the tool call.

Stores metadata of the invocation of an action supported by atool.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The tracing information for the data store tool.

The tracing information for the webhook tool.

Tool version is a snapshot of the tool at certain timestamp.

The request message forFlows.TrainFlow.

Transition coverage represents the percentage of all possiblepage transitions (page-level transition routes and eventhandlers, excluding transition route groups) present within anyof a parent's test cases.

A transition in a page.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The source or target of a transition.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A transition route specifies aintent that can bematched and/or a data condition that can be evaluated during asession. When a specified transition is matched, the followingactions are taken in order:

• If there is a[trigger_fulfillment][google.cloud.dialogflow.cx.v3beta1.TransitionRoute.trigger_fulfillment]associated with the transition, it will be called.
• If there is a[target_page][google.cloud.dialogflow.cx.v3beta1.TransitionRoute.target_page]associated with the transition, the session will transition intothe specified page.
• If there is a[target_flow][google.cloud.dialogflow.cx.v3beta1.TransitionRoute.target_flow]associated with the transition, the session will transition intothe specified flow.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A TransitionRouteGroup represents a group of[TransitionRoutes][google.cloud.dialogflow.cx.v3beta1.TransitionRoute]to be used by aPage.

Transition route group coverage represents the percentage ofall possible transition routes present within any of a parent'stest cases. The results are grouped by the transition routegroup.

Coverage result message for one transition route group.

A transition coverage in a transition route group.

Encapsulates different type schema variations: either areference to an a schema that's already defined by a tool, or aninline definition.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A reference to the schema of an existing tool.

The request message forAgents.UpdateAgent.

The request message forEntityTypes.UpdateEntityType.

The request message forEnvironments.UpdateEnvironment.

The request message forExamples.UpdateExample.

The request message forExperiments.UpdateExperiment.

The request message forFlows.UpdateFlow.

Request forUpdateGenerativeSettingsRPC.

The request message forGenerators.UpdateGenerator.

The request message forIntents.UpdateIntent.

The request message forPages.UpdatePage.

The request message forPlaybooks.UpdatePlaybook.

The request message forSecuritySettingsService.UpdateSecuritySettings.

The request message forSessionEntityTypes.UpdateSessionEntityType.

The request message forTestCases.UpdateTestCase.

The request message forTools.UpdateTool.

The request message forTransitionRouteGroups.UpdateTransitionRouteGroup.

The request message forVersions.UpdateVersion.

The request message forWebhooks.UpdateWebhook.

UserUtterance represents one message sent by the customer.

The request message forAgents.ValidateAgent.

The request message forFlows.ValidateFlow.

Agent/flow validation message.

Resource types.

Severity level.

The history of variants update.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents a version of a flow.

The state of the version.

A list of flow version variants.

A single flow version with specified traffic allocation.

Description of which voice to use for speech synthesis.

Webhooks host the developer's business logic. During asession, webhooks allow the developer to use the data extractedby Dialogflow's natural language processing to generate dynamicresponses, validate collected data, or trigger actions on thebackend.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents configuration for a generic web service.

HTTP method to use when calling webhooks.

Represents configuration of OAuth client credential flow for3rd party API authentication.

The abstract base class for a message.

The abstract base class for a message.

Represents the value of an HTTP header stored in aSecretManager secret version.

The abstract base class for a message.

Indicate the auth token type generated from theDiglogflow serviceagent <https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent>__.

Represents the type of webhook configuration.

Represents configuration for aServiceDirectory <https://cloud.google.com/service-directory>__ service.

The request message for a webhook call. The request is sentas a JSON object and the field names will be presented in camelcases.

You may see undocumented fields in an actual request. Thesefields are used internally by Dialogflow and should be ignored.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents fulfillment information communicated to thewebhook.

Represents intent information communicated to the webhook.

Represents a value for an intent parameter.

The abstract base class for a message.

Represents the result of sentiment analysis.

The response message for a webhook call.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents a fulfillment response to the user.

Defines merge behavior formessages.

API documentation fordialogflowcx_v3.services.agents.pagers module.

API documentation fordialogflowcx_v3.services.changelogs.pagers module.

API documentation fordialogflowcx_v3.services.deployments.pagers module.

API documentation fordialogflowcx_v3.services.entity_types.pagers module.

API documentation fordialogflowcx_v3.services.environments.pagers module.

API documentation fordialogflowcx_v3.services.experiments.pagers module.

API documentation fordialogflowcx_v3.services.flows.pagers module.

API documentation fordialogflowcx_v3.services.generators.pagers module.

API documentation fordialogflowcx_v3.services.intents.pagers module.

API documentation fordialogflowcx_v3.services.pages.pagers module.

API documentation fordialogflowcx_v3.services.security_settings_service.pagers module.

API documentation fordialogflowcx_v3.services.session_entity_types.pagers module.

API documentation fordialogflowcx_v3.services.test_cases.pagers module.

API documentation fordialogflowcx_v3.services.transition_route_groups.pagers module.

API documentation fordialogflowcx_v3.services.versions.pagers module.

API documentation fordialogflowcx_v3.services.webhooks.pagers module.

API documentation fordialogflowcx_v3beta1.services.agents.pagers module.

API documentation fordialogflowcx_v3beta1.services.changelogs.pagers module.

API documentation fordialogflowcx_v3beta1.services.conversation_history.pagers module.

API documentation fordialogflowcx_v3beta1.services.deployments.pagers module.

API documentation fordialogflowcx_v3beta1.services.entity_types.pagers module.

API documentation fordialogflowcx_v3beta1.services.environments.pagers module.

API documentation fordialogflowcx_v3beta1.services.examples.pagers module.

API documentation fordialogflowcx_v3beta1.services.experiments.pagers module.

API documentation fordialogflowcx_v3beta1.services.flows.pagers module.

API documentation fordialogflowcx_v3beta1.services.generators.pagers module.

API documentation fordialogflowcx_v3beta1.services.intents.pagers module.

API documentation fordialogflowcx_v3beta1.services.pages.pagers module.

API documentation fordialogflowcx_v3beta1.services.playbooks.pagers module.

API documentation fordialogflowcx_v3beta1.services.security_settings_service.pagers module.

API documentation fordialogflowcx_v3beta1.services.session_entity_types.pagers module.

API documentation fordialogflowcx_v3beta1.services.test_cases.pagers module.

API documentation fordialogflowcx_v3beta1.services.tools.pagers module.

API documentation fordialogflowcx_v3beta1.services.transition_route_groups.pagers module.

API documentation fordialogflowcx_v3beta1.services.versions.pagers module.

API documentation fordialogflowcx_v3beta1.services.webhooks.pagers module.