Package Classes (1.37.0)

Summary of entries of Classes for dialogflow-cx.

Classes

ListAgentsAsyncPager

A pager for iterating through list_agents requests.

This class thinly wraps an initial ListAgentsResponse object, and provides an __aiter__ method to iterate through its agents field.

If there are more pages, the __aiter__ method will make additional ListAgents requests and continue to iterate through the agents field on the corresponding responses.

All the usual ListAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAgentsPager

A pager for iterating through list_agents requests.

This class thinly wraps an initial ListAgentsResponse object, and provides an __iter__ method to iterate through its agents field.

If there are more pages, the __iter__ method will make additional ListAgents requests and continue to iterate through the agents field on the corresponding responses.

All the usual ListAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChangelogsAsyncPager

A pager for iterating through list_changelogs requests.

This class thinly wraps an initial ListChangelogsResponse object, and provides an __aiter__ method to iterate through its changelogs field.

If there are more pages, the __aiter__ method will make additional ListChangelogs requests and continue to iterate through the changelogs field on the corresponding responses.

All the usual ListChangelogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChangelogsPager

A pager for iterating through list_changelogs requests.

This class thinly wraps an initial ListChangelogsResponse object, and provides an __iter__ method to iterate through its changelogs field.

If there are more pages, the __iter__ method will make additional ListChangelogs requests and continue to iterate through the changelogs field on the corresponding responses.

All the usual ListChangelogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDeploymentsAsyncPager

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __aiter__ method to iterate through its deployments field.

If there are more pages, the __aiter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDeploymentsPager

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __iter__ method to iterate through its deployments field.

If there are more pages, the __iter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntityTypesAsyncPager

A pager for iterating through list_entity_types requests.

This class thinly wraps an initial ListEntityTypesResponse object, and provides an __aiter__ method to iterate through its entity_types field.

If there are more pages, the __aiter__ method will make additional ListEntityTypes requests and continue to iterate through the entity_types field on the corresponding responses.

All the usual ListEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntityTypesPager

A pager for iterating through list_entity_types requests.

This class thinly wraps an initial ListEntityTypesResponse object, and provides an __iter__ method to iterate through its entity_types field.

If there are more pages, the __iter__ method will make additional ListEntityTypes requests and continue to iterate through the entity_types field on the corresponding responses.

All the usual ListEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListContinuousTestResultsAsyncPager

A pager for iterating through list_continuous_test_results requests.

This class thinly wraps an initial ListContinuousTestResultsResponse object, and provides an __aiter__ method to iterate through its continuous_test_results field.

If there are more pages, the __aiter__ method will make additional ListContinuousTestResults requests and continue to iterate through the continuous_test_results field on the corresponding responses.

All the usual ListContinuousTestResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListContinuousTestResultsPager

A pager for iterating through list_continuous_test_results requests.

This class thinly wraps an initial ListContinuousTestResultsResponse object, and provides an __iter__ method to iterate through its continuous_test_results field.

If there are more pages, the __iter__ method will make additional ListContinuousTestResults requests and continue to iterate through the continuous_test_results field on the corresponding responses.

All the usual ListContinuousTestResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnvironmentsAsyncPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __aiter__ method to iterate through its environments field.

If there are more pages, the __aiter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnvironmentsPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __iter__ method to iterate through its environments field.

If there are more pages, the __iter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

LookupEnvironmentHistoryAsyncPager

A pager for iterating through lookup_environment_history requests.

This class thinly wraps an initial LookupEnvironmentHistoryResponse object, and provides an __aiter__ method to iterate through its environments field.

If there are more pages, the __aiter__ method will make additional LookupEnvironmentHistory requests and continue to iterate through the environments field on the corresponding responses.

All the usual LookupEnvironmentHistoryResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

LookupEnvironmentHistoryPager

A pager for iterating through lookup_environment_history requests.

This class thinly wraps an initial LookupEnvironmentHistoryResponse object, and provides an __iter__ method to iterate through its environments field.

If there are more pages, the __iter__ method will make additional LookupEnvironmentHistory requests and continue to iterate through the environments field on the corresponding responses.

All the usual LookupEnvironmentHistoryResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ExperimentsAsyncClient

Service for managing Experiments.

ExperimentsClient

Service for managing Experiments.

ListExperimentsAsyncPager

A pager for iterating through list_experiments requests.

This class thinly wraps an initial ListExperimentsResponse object, and provides an __aiter__ method to iterate through its experiments field.

If there are more pages, the __aiter__ method will make additional ListExperiments requests and continue to iterate through the experiments field on the corresponding responses.

All the usual ListExperimentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExperimentsPager

A pager for iterating through list_experiments requests.

This class thinly wraps an initial ListExperimentsResponse object, and provides an __iter__ method to iterate through its experiments field.

If there are more pages, the __iter__ method will make additional ListExperiments requests and continue to iterate through the experiments field on the corresponding responses.

All the usual ListExperimentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

FlowsAsyncClient

Service for managing Flows.

FlowsClient

Service for managing Flows.

ListFlowsAsyncPager

A pager for iterating through list_flows requests.

This class thinly wraps an initial ListFlowsResponse object, and provides an __aiter__ method to iterate through its flows field.

If there are more pages, the __aiter__ method will make additional ListFlows requests and continue to iterate through the flows field on the corresponding responses.

All the usual ListFlowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFlowsPager

A pager for iterating through list_flows requests.

This class thinly wraps an initial ListFlowsResponse object, and provides an __iter__ method to iterate through its flows field.

If there are more pages, the __iter__ method will make additional ListFlows requests and continue to iterate through the flows field on the corresponding responses.

All the usual ListFlowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

GeneratorsAsyncClient

Service for managing Generators

GeneratorsClient

Service for managing Generators

ListGeneratorsAsyncPager

A pager for iterating through list_generators requests.

This class thinly wraps an initial ListGeneratorsResponse object, and provides an __aiter__ method to iterate through its generators field.

If there are more pages, the __aiter__ method will make additional ListGenerators requests and continue to iterate through the generators field on the corresponding responses.

All the usual ListGeneratorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGeneratorsPager

A pager for iterating through list_generators requests.

This class thinly wraps an initial ListGeneratorsResponse object, and provides an __iter__ method to iterate through its generators field.

If there are more pages, the __iter__ method will make additional ListGenerators requests and continue to iterate through the generators field on the corresponding responses.

All the usual ListGeneratorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

IntentsAsyncClient

Service for managing Intents.

IntentsClient

Service for managing Intents.

ListIntentsAsyncPager

A pager for iterating through list_intents requests.

This class thinly wraps an initial ListIntentsResponse object, and provides an __aiter__ method to iterate through its intents field.

If there are more pages, the __aiter__ method will make additional ListIntents requests and continue to iterate through the intents field on the corresponding responses.

All the usual ListIntentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIntentsPager

A pager for iterating through list_intents requests.

This class thinly wraps an initial ListIntentsResponse object, and provides an __iter__ method to iterate through its intents field.

If there are more pages, the __iter__ method will make additional ListIntents requests and continue to iterate through the intents field on the corresponding responses.

All the usual ListIntentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

PagesAsyncClient

Service for managing Pages.

PagesClient

Service for managing Pages.

ListPagesAsyncPager

A pager for iterating through list_pages requests.

This class thinly wraps an initial ListPagesResponse object, and provides an __aiter__ method to iterate through its pages field.

If there are more pages, the __aiter__ method will make additional ListPages requests and continue to iterate through the pages field on the corresponding responses.

All the usual ListPagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPagesPager

A pager for iterating through list_pages requests.

This class thinly wraps an initial ListPagesResponse object, and provides an __iter__ method to iterate through its pages field.

If there are more pages, the __iter__ method will make additional ListPages requests and continue to iterate through the pages field on the corresponding responses.

All the usual ListPagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SecuritySettingsServiceAsyncClient

Service for managing security settings for Dialogflow.

SecuritySettingsServiceClient

Service for managing security settings for Dialogflow.

ListSecuritySettingsAsyncPager

A pager for iterating through list_security_settings requests.

This class thinly wraps an initial ListSecuritySettingsResponse object, and provides an __aiter__ method to iterate through its security_settings field.

If there are more pages, the __aiter__ method will make additional ListSecuritySettings requests and continue to iterate through the security_settings field on the corresponding responses.

All the usual ListSecuritySettingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSecuritySettingsPager

A pager for iterating through list_security_settings requests.

This class thinly wraps an initial ListSecuritySettingsResponse object, and provides an __iter__ method to iterate through its security_settings field.

If there are more pages, the __iter__ method will make additional ListSecuritySettings requests and continue to iterate through the security_settings field on the corresponding responses.

All the usual ListSecuritySettingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SessionEntityTypesAsyncClient

Service for managing SessionEntityTypes.

SessionEntityTypesClient

Service for managing SessionEntityTypes.

ListSessionEntityTypesAsyncPager

A pager for iterating through list_session_entity_types requests.

This class thinly wraps an initial ListSessionEntityTypesResponse object, and provides an __aiter__ method to iterate through its session_entity_types field.

If there are more pages, the __aiter__ method will make additional ListSessionEntityTypes requests and continue to iterate through the session_entity_types field on the corresponding responses.

All the usual ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSessionEntityTypesPager

A pager for iterating through list_session_entity_types requests.

This class thinly wraps an initial ListSessionEntityTypesResponse object, and provides an __iter__ method to iterate through its session_entity_types field.

If there are more pages, the __iter__ method will make additional ListSessionEntityTypes requests and continue to iterate through the session_entity_types field on the corresponding responses.

All the usual ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SessionsAsyncClient

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

SessionsClient

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

TestCasesAsyncClient

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

TestCasesClient

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

ListTestCaseResultsAsyncPager

A pager for iterating through list_test_case_results requests.

This class thinly wraps an initial ListTestCaseResultsResponse object, and provides an __aiter__ method to iterate through its test_case_results field.

If there are more pages, the __aiter__ method will make additional ListTestCaseResults requests and continue to iterate through the test_case_results field on the corresponding responses.

All the usual ListTestCaseResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTestCaseResultsPager

A pager for iterating through list_test_case_results requests.

This class thinly wraps an initial ListTestCaseResultsResponse object, and provides an __iter__ method to iterate through its test_case_results field.

If there are more pages, the __iter__ method will make additional ListTestCaseResults requests and continue to iterate through the test_case_results field on the corresponding responses.

All the usual ListTestCaseResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTestCasesAsyncPager

A pager for iterating through list_test_cases requests.

This class thinly wraps an initial ListTestCasesResponse object, and provides an __aiter__ method to iterate through its test_cases field.

If there are more pages, the __aiter__ method will make additional ListTestCases requests and continue to iterate through the test_cases field on the corresponding responses.

All the usual ListTestCasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTestCasesPager

A pager for iterating through list_test_cases requests.

This class thinly wraps an initial ListTestCasesResponse object, and provides an __iter__ method to iterate through its test_cases field.

If there are more pages, the __iter__ method will make additional ListTestCases requests and continue to iterate through the test_cases field on the corresponding responses.

All the usual ListTestCasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

TransitionRouteGroupsAsyncClient

Service for managing TransitionRouteGroups.

TransitionRouteGroupsClient

Service for managing TransitionRouteGroups.

ListTransitionRouteGroupsAsyncPager

A pager for iterating through list_transition_route_groups requests.

This class thinly wraps an initial ListTransitionRouteGroupsResponse object, and provides an __aiter__ method to iterate through its transition_route_groups field.

If there are more pages, the __aiter__ method will make additional ListTransitionRouteGroups requests and continue to iterate through the transition_route_groups field on the corresponding responses.

All the usual ListTransitionRouteGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTransitionRouteGroupsPager

A pager for iterating through list_transition_route_groups requests.

This class thinly wraps an initial ListTransitionRouteGroupsResponse object, and provides an __iter__ method to iterate through its transition_route_groups field.

If there are more pages, the __iter__ method will make additional ListTransitionRouteGroups requests and continue to iterate through the transition_route_groups field on the corresponding responses.

All the usual ListTransitionRouteGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

VersionsAsyncClient

Service for managing Versions.

VersionsClient

Service for managing Versions.

ListVersionsAsyncPager

A pager for iterating through list_versions requests.

This class thinly wraps an initial ListVersionsResponse object, and provides an __aiter__ method to iterate through its versions field.

If there are more pages, the __aiter__ method will make additional ListVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListVersionsPager

A pager for iterating through list_versions requests.

This class thinly wraps an initial ListVersionsResponse object, and provides an __iter__ method to iterate through its versions field.

If there are more pages, the __iter__ method will make additional ListVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

WebhooksAsyncClient

Service for managing Webhooks.

WebhooksClient

Service for managing Webhooks.

ListWebhooksAsyncPager

A pager for iterating through list_webhooks requests.

This class thinly wraps an initial ListWebhooksResponse object, and provides an __aiter__ method to iterate through its webhooks field.

If there are more pages, the __aiter__ method will make additional ListWebhooks requests and continue to iterate through the webhooks field on the corresponding responses.

All the usual ListWebhooksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWebhooksPager

A pager for iterating through list_webhooks requests.

This class thinly wraps an initial ListWebhooksResponse object, and provides an __iter__ method to iterate through its webhooks field.

If there are more pages, the __iter__ method will make additional ListWebhooks requests and continue to iterate through the webhooks field on the corresponding responses.

All the usual ListWebhooksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AdvancedSettings

Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged.

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

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

DtmfSettings

Define behaviors for DTMF (dual tone multi frequency).

LoggingSettings

Define behaviors on logging.

SpeechSettings

Define behaviors of speech to text detection.

ModelsEntry

The abstract base class for a message.

Agent

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

After you create an agent, you can add Intents, [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.

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

AnswerFeedbackSettings

Settings for answer feedback collection.

ClientCertificateSettings

Settings for custom client certificates.

GenAppBuilderSettings

Settings for Gen App Builder.

GitIntegrationSettings

Settings for connecting to Git repository for an agent.

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

GithubSettings

Settings of integration with GitHub.

PersonalizationSettings

Settings for end user personalization.

AgentValidationResult

The response message for Agents.GetAgentValidationResult.

AnswerFeedback

Stores information about feedback provided by users about a response.

Rating

Represents thumbs up/down rating provided by user about a response.

RatingReason

Stores extra information about why users provided thumbs down rating.

AudioEncoding

Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation <https://cloud.google.com/speech-to-text/docs/basics>__ for more details.

AudioInput

Represents the natural speech audio to be processed.

BargeInConfig

Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request.

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

No barge-in phase: which goes first and during which speech detection should not be carried out.
Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase.

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

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

BatchDeleteTestCasesRequest

The request message for TestCases.BatchDeleteTestCases.

BatchRunTestCasesMetadata

Metadata returned for the TestCases.BatchRunTestCases long running operation.

BatchRunTestCasesRequest

The request message for TestCases.BatchRunTestCases.

BatchRunTestCasesResponse

The response message for TestCases.BatchRunTestCases.

BoostSpec

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

ConditionBoostSpec

Boost applies to documents which match a condition.

BoostControlSpec

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

AttributeType

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

ControlPoint

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

InterpolationType

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

BoostSpecs

Boost specifications for data stores.

CalculateCoverageRequest

The request message for TestCases.CalculateCoverage.

CoverageType

The type of coverage score requested.

CalculateCoverageResponse

The response message for TestCases.CalculateCoverage.

This message has oneof_ 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 other members.

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

Changelog

Changelogs represents a change made to a given agent.

CloudConversationDebuggingInfo

Cloud conversation info for easier debugging. It will get populated in StreamingDetectIntentResponse or StreamingAnalyzeContentResponse when the flag enable_debugging_info is set to true in corresponding requests.

CompareVersionsRequest

The request message for Versions.CompareVersions.

CompareVersionsResponse

The response message for Versions.CompareVersions.

ContinuousTestResult

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

AggregatedTestResult

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

ConversationTurn

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

UserInput

The input from the human user.

VirtualAgentOutput

The output from the virtual agent.

CreateAgentRequest

The request message for Agents.CreateAgent.

CreateEntityTypeRequest

The request message for EntityTypes.CreateEntityType.

CreateEnvironmentRequest

The request message for Environments.CreateEnvironment.

CreateExperimentRequest

The request message for Experiments.CreateExperiment.

CreateFlowRequest

The request message for Flows.CreateFlow.

CreateGeneratorRequest

The request message for Generators.CreateGenerator.

CreateIntentRequest

The request message for Intents.CreateIntent.

CreatePageRequest

The request message for Pages.CreatePage.

CreateSecuritySettingsRequest

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

CreateSessionEntityTypeRequest

The request message for SessionEntityTypes.CreateSessionEntityType.

CreateTestCaseRequest

The request message for TestCases.CreateTestCase.

CreateTransitionRouteGroupRequest

The request message for TransitionRouteGroups.CreateTransitionRouteGroup.

CreateVersionOperationMetadata

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

CreateVersionRequest

The request message for Versions.CreateVersion.

CreateWebhookRequest

The request message for Webhooks.CreateWebhook.

DataStoreConnection

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

DataStoreConnectionSignals

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

AnswerGenerationModelCallSignals

Diagnostic info related to the answer generation model call.

AnswerPart

Answer part with citation.

CitedSnippet

Snippet cited by the answer generation model.

GroundingSignals

Grounding signals.

GroundingDecision

Represents the decision of the grounding check.

GroundingScoreBucket

Grounding score buckets.

RewriterModelCallSignals

Diagnostic info related to the rewriter model call.

SafetySignals

Safety check results.

BannedPhraseMatch

Specifies banned phrase match subject.

SafetyDecision

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

SearchSnippet

Search snippet details.

DataStoreType

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

DeleteAgentRequest

The request message for Agents.DeleteAgent.

DeleteEntityTypeRequest

The request message for EntityTypes.DeleteEntityType.

DeleteEnvironmentRequest

The request message for Environments.DeleteEnvironment.

DeleteExperimentRequest

The request message for Experiments.DeleteExperiment.

DeleteFlowRequest

The request message for Flows.DeleteFlow.

DeleteGeneratorRequest

The request message for Generators.DeleteGenerator.

DeleteIntentRequest

The request message for Intents.DeleteIntent.

DeletePageRequest

The request message for Pages.DeletePage.

DeleteSecuritySettingsRequest

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

DeleteSessionEntityTypeRequest

The request message for SessionEntityTypes.DeleteSessionEntityType.

DeleteTransitionRouteGroupRequest

The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.

DeleteVersionRequest

The request message for Versions.DeleteVersion.

DeleteWebhookRequest

The request message for Webhooks.DeleteWebhook.

DeployFlowMetadata

Metadata returned for the Environments.DeployFlow long running operation.

DeployFlowRequest

The request message for Environments.DeployFlow.

DeployFlowResponse

The response message for Environments.DeployFlow.

Deployment

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

Result

Result of the deployment.

State

The state of the deployment.

DetectIntentRequest

The request to detect user's intent.

DetectIntentResponse

The message returned from the DetectIntent method.

ResponseType

Represents different DetectIntentResponse types.

DtmfInput

Represents the input for dtmf event.

EntityType

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on.

There are three types of entities:

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

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

AutoExpansionMode

Represents different entity type expansion modes. Automated expansion allows an agent to recognize values that have not been explicitly listed in the entity (for example, new kinds of shopping list items).

Entity

An entity entry for an associated entity type.

ExcludedPhrase

An excluded entity phrase that should not be matched.

Kind

Represents kinds of entities.

Environment

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

TestCasesConfig

The configuration for continuous tests.

VersionConfig

Configuration for the version.

WebhookConfig

Configuration for webhooks.

EventHandler

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

If there is a [trigger_fulfillment][google.cloud.dialogflow.cx.v3.EventHandler.trigger_fulfillment] associated with the event, it will be called.
If there is a [target_page][google.cloud.dialogflow.cx.v3.EventHandler.target_page] associated with the event, the session will transition into the specified page.
If there is a [target_flow][google.cloud.dialogflow.cx.v3.EventHandler.target_flow] associated with the event, the session will transition into the specified flow.

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

EventInput

Represents the event to trigger.

Experiment

Represents an experiment in an environment.

Definition

Definition of the experiment.

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

Result

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

ConfidenceInterval

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

CountType

Types of count-based metric for Dialogflow experiment.

Metric

Metric and corresponding confidence intervals.

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

MetricType

Types of ratio-based metric for Dialogflow experiment.

VersionMetrics

Version variant and associated metrics.

State

The state of the experiment.

ExportAgentRequest

The request message for Agents.ExportAgent.

DataFormat

Data format of the exported agent.

GitDestination

Settings for exporting to a git branch.

ExportAgentResponse

The response message for Agents.ExportAgent.

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

ExportEntityTypesMetadata

Metadata returned for the EntityTypes.ExportEntityTypes long running operation.

ExportEntityTypesRequest

The request message for EntityTypes.ExportEntityTypes.

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

DataFormat

Data format of the exported entity types.

ExportEntityTypesResponse

The response message for EntityTypes.ExportEntityTypes.

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

ExportFlowRequest

The request message for Flows.ExportFlow.

ExportFlowResponse

The response message for Flows.ExportFlow.

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

ExportIntentsMetadata

Metadata returned for the Intents.ExportIntents long running operation.

ExportIntentsRequest

The request message for Intents.ExportIntents.

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

DataFormat

Data format of the exported intents.

ExportIntentsResponse

The response message for Intents.ExportIntents.

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

ExportTestCasesMetadata

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

ExportTestCasesRequest

The request message for TestCases.ExportTestCases.

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

DataFormat

Data format of the exported test cases.

ExportTestCasesResponse

The response message for TestCases.ExportTestCases.

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

FilterSpecs

Filter specifications for data stores.

Flow

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

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

MultiLanguageSettings

Settings for multi-lingual agents.

FlowImportStrategy

The flow import strategy used for resource conflict resolution associated with an ImportFlowRequest.

FlowValidationResult

The response message for Flows.GetFlowValidationResult.

Form

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

Parameter

Represents a form parameter.

FillBehavior

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

FulfillIntentRequest

Request of [FulfillIntent][]

FulfillIntentResponse

Response of [FulfillIntent][]

Fulfillment

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

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

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

ConditionalCases

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

Case

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

CaseContent

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

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

SetParameterAction

Setting a parameter value.

GcsDestination

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

GenerativeSettings

Settings for Generative AI.

FallbackSettings

Settings for Generative Fallback.

PromptTemplate

Prompt template.

KnowledgeConnectorSettings

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

Generator

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

ModelParameter

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

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

Placeholder

Represents a custom placeholder in the prompt text.

GetAgentRequest

The request message for Agents.GetAgent.

GetAgentValidationResultRequest

The request message for Agents.GetAgentValidationResult.

GetChangelogRequest

The request message for Changelogs.GetChangelog.

GetDeploymentRequest

The request message for Deployments.GetDeployment.

GetEntityTypeRequest

The request message for EntityTypes.GetEntityType.

GetEnvironmentRequest

The request message for Environments.GetEnvironment.

GetExperimentRequest

The request message for Experiments.GetExperiment.

GetFlowRequest

The response message for Flows.GetFlow.

GetFlowValidationResultRequest

The request message for Flows.GetFlowValidationResult.

GetGenerativeSettingsRequest

Request for GetGenerativeSettings RPC.

GetGeneratorRequest

The request message for Generators.GetGenerator.

GetIntentRequest

The request message for Intents.GetIntent.

GetPageRequest

The request message for Pages.GetPage.

GetSecuritySettingsRequest

The request message for SecuritySettingsService.GetSecuritySettings.

GetSessionEntityTypeRequest

The request message for SessionEntityTypes.GetSessionEntityType.

GetTestCaseRequest

The request message for TestCases.GetTestCase.

GetTestCaseResultRequest

The request message for TestCases.GetTestCaseResult.

GetTransitionRouteGroupRequest

The request message for TransitionRouteGroups.GetTransitionRouteGroup.

GetVersionRequest

The request message for Versions.GetVersion.

GetWebhookRequest

The request message for Webhooks.GetWebhook.

ImportEntityTypesMetadata

Metadata returned for the EntityTypes.ImportEntityTypes long running operation.

ImportEntityTypesRequest

The request message for EntityTypes.ImportEntityTypes.

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

MergeOption

Merge option when display name conflicts exist during import.

ImportEntityTypesResponse

The response message for EntityTypes.ImportEntityTypes.

ConflictingResources

Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT][ImportEntityTypesResponse.REPORT_CONFLICT] is set in the request and there are conflicts in the display names.

ImportFlowRequest

The request message for Flows.ImportFlow.

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

ImportOption

Import option.

ImportFlowResponse

The response message for Flows.ImportFlow.

ImportIntentsMetadata

Metadata returned for the Intents.ImportIntents long running operation.

ImportIntentsRequest

The request message for Intents.ImportIntents.

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

MergeOption

Merge option when display name conflicts exist during import.

ImportIntentsResponse

The response message for Intents.ImportIntents.

ConflictingResources

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

ImportStrategy

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

ImportTestCasesMetadata

Metadata returned for the TestCases.ImportTestCases long running operation.

ImportTestCasesRequest

The request message for TestCases.ImportTestCases.

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

ImportTestCasesResponse

The response message for TestCases.ImportTestCases.

InlineDestination

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

InlineSource

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

InputAudioConfig

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

Intent

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

LabelsEntry

The abstract base class for a message.

Parameter

Represents an intent parameter.

TrainingPhrase

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

Part

Represents a part of a training phrase.

IntentCoverage

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

Intent

The agent's intent.

IntentInput

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

IntentView

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

KnowledgeConnectorSettings

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

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

LanguageInfo

Represents the language information of the request.

ListAgentsRequest

The request message for Agents.ListAgents.

ListAgentsResponse

The response message for Agents.ListAgents.

ListChangelogsRequest

The request message for Changelogs.ListChangelogs.

ListChangelogsResponse

The response message for Changelogs.ListChangelogs.

ListContinuousTestResultsRequest

The request message for Environments.ListContinuousTestResults.

ListContinuousTestResultsResponse

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

ListDeploymentsRequest

The request message for Deployments.ListDeployments.

ListDeploymentsResponse

The response message for Deployments.ListDeployments.

ListEntityTypesRequest

The request message for EntityTypes.ListEntityTypes.

ListEntityTypesResponse

The response message for EntityTypes.ListEntityTypes.

ListEnvironmentsRequest

The request message for Environments.ListEnvironments.

ListEnvironmentsResponse

The response message for Environments.ListEnvironments.

ListExperimentsRequest

The request message for Experiments.ListExperiments.

ListExperimentsResponse

The response message for Experiments.ListExperiments.

ListFlowsRequest

The request message for Flows.ListFlows.

ListFlowsResponse

The response message for Flows.ListFlows.

ListGeneratorsRequest

The request message for Generators.ListGenerators.

ListGeneratorsResponse

The response message for Generators.ListGenerators.

ListIntentsRequest

The request message for Intents.ListIntents.

ListIntentsResponse

The response message for Intents.ListIntents.

ListPagesRequest

The request message for Pages.ListPages.

ListPagesResponse

The response message for Pages.ListPages.

ListSecuritySettingsRequest

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

ListSecuritySettingsResponse

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

ListSessionEntityTypesRequest

The request message for SessionEntityTypes.ListSessionEntityTypes.

ListSessionEntityTypesResponse

The response message for SessionEntityTypes.ListSessionEntityTypes.

ListTestCaseResultsRequest

The request message for TestCases.ListTestCaseResults.

ListTestCaseResultsResponse

The response message for TestCases.ListTestCaseResults.

ListTestCasesRequest

The request message for TestCases.ListTestCases.

TestCaseView

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

ListTestCasesResponse

The response message for TestCases.ListTestCases.

ListTransitionRouteGroupsRequest

The request message for TransitionRouteGroups.ListTransitionRouteGroups.

ListTransitionRouteGroupsResponse

The response message for TransitionRouteGroups.ListTransitionRouteGroups.

ListVersionsRequest

The request message for Versions.ListVersions.

ListVersionsResponse

The response message for Versions.ListVersions.

ListWebhooksRequest

The request message for Webhooks.ListWebhooks.

ListWebhooksResponse

The response message for Webhooks.ListWebhooks.

LoadVersionRequest

The request message for Versions.LoadVersion.

LookupEnvironmentHistoryRequest

The request message for Environments.LookupEnvironmentHistory.

LookupEnvironmentHistoryResponse

The response message for Environments.LookupEnvironmentHistory.

Match

Represents one match result of [MatchIntent][].

MatchType

Type of a Match.

MatchIntentRequest

Request of [MatchIntent][].

MatchIntentResponse

Response of [MatchIntent][].

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

NluSettings

Settings related to NLU.

ModelTrainingMode

NLU model training mode.

ModelType

NLU model type.

OutputAudioConfig

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

OutputAudioEncoding

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

Page

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.

For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.

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

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

PageInfo

Represents page information communicated to and from the webhook.

FormInfo

Represents form information.

ParameterInfo

Represents parameter information.

ParameterState

Represents the state of a parameter.

Phrase

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

QueryInput

Represents the query input. It can contain one of:

A conversational query in the form of text.
An intent query that specifies which intent to trigger.
Natural language speech audio to be processed.
An event to be triggered.
DTMF digits to invoke an intent and fill in parameter value.
The results of a tool executed by the client.

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

QueryParameters

Represents the parameters of a conversational query.

WebhookHeadersEntry

The abstract base class for a message.

QueryResult

Represents the result of a conversational query.

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

ResourceName

Resource name and display name.

ResponseMessage

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

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

If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis.
If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design.
Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis.

This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

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

ConversationSuccess

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

Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.

You may set this, for example:

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

EndInteraction

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

KnowledgeInfoCard

Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card.

Otherwise, the info card response is skipped.

LiveAgentHandoff

Indicates that the conversation should be handed off to a live agent.

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

You may set this, for example:

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

MixedAudio

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

Segment

Represents one segment of audio.

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

OutputAudioText

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

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

PlayAudio

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

ResponseType

Represents different response types.

TelephonyTransferCall

Represents the signal that telles the client to transfer the phone 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

Text

The text response message.

RestoreAgentRequest

The request message for Agents.RestoreAgent.

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

GitSource

Settings for restoring from a git branch

RestoreOption

Restore option.

RolloutConfig

The configuration for auto rollout.

RolloutStep

A single rollout step with specified traffic allocation.

RolloutState

State of the auto-rollout process.

RunContinuousTestMetadata

Metadata returned for the Environments.RunContinuousTest long running operation.

RunContinuousTestRequest

The request message for Environments.RunContinuousTest.

RunContinuousTestResponse

The response message for Environments.RunContinuousTest.

RunTestCaseMetadata

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

RunTestCaseRequest

The request message for TestCases.RunTestCase.

RunTestCaseResponse

The response message for TestCases.RunTestCase.

SafetySettings

Settings for Generative Safety.

Phrase

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

SearchConfig

Search configuration for UCS search queries.

SecuritySettings

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

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

AudioExportSettings

Settings for exporting audio.

AudioFormat

File format for exported audio file. Currently only in telephony recordings.

InsightsExportSettings

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

PurgeDataType

Type of data we purge after retention settings triggers purge.

RedactionScope

Defines what types of data to redact.

RedactionStrategy

Defines how we redact data.

RetentionStrategy

Defines how long we retain persisted data that contains sensitive info.

SentimentAnalysisResult

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

SessionEntityType

Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.

You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as "custom entity types").

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

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

EntityOverrideMode

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.

SessionInfo

Represents session information communicated to and from the webhook.

ParametersEntry

The abstract base class for a message.

SpeechModelVariant

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

See the Cloud Speech documentation <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. When you use an enhanced model, you will generally receive higher quality results 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.

SpeechToTextSettings

Settings related to speech recognition.

SpeechWordInfo

Information for a word recognized by the speech recognizer.

SsmlVoiceGender

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

StartExperimentRequest

The request message for Experiments.StartExperiment.

StopExperimentRequest

The request message for Experiments.StopExperiment.

StreamingDetectIntentRequest

The top-level message sent by the client to the Sessions.StreamingDetectIntent method.

Multiple request messages should be sent in order:

The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config.
If query_input was set to query_input.audio.config, all subsequent messages must contain query_input.audio.audio to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with query_input.text.

However, note that:
- Dialogflow will bill you for the audio duration so far.
- Dialogflow discards all Speech recognition results in favor of the input text.
- Dialogflow will use the language code from the first message.

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

StreamingDetectIntentResponse

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages (N) can be returned in order.

The first (N-1) responses set either the recognition_result or detect_intent_response field, depending on the request:

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

For the final Nth response message, the detect_intent_response is fully populated, and DetectIntentResponse.response_type is set to FINAL.

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

StreamingRecognitionResult

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

While end-user audio is being processed, Dialogflow sends a series of results. Each result may contain a transcript value. A transcript represents a portion of the utterance. While the recognizer is processing audio, transcript values may be interim values or finalized values. Once a transcript is finalized, the is_final value is set to true and processing continues for the next transcript.

If StreamingDetectIntentRequest.query_input.audio.config.single_utterance was true, and the recognizer has completed processing audio, the message_type value is set to `END_OF_SINGLE_UTTERANCE and the following (last) result contains the last finalized transcript.

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

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

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

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

MessageType

Type of the response message.

SubmitAnswerFeedbackRequest

The request to set the feedback for a bot answer.

SynthesizeSpeechConfig

Configuration of how speech should be synthesized.

TestCase

Represents a test case.

TestCaseError

Error info for importing a test.

TestCaseResult

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

TestConfig

Represents configurations for a test case.

TestError

Error info for running a test.

TestResult

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

TestRunDifference

The description of differences between original and replayed agent output.

DiffType

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

TextInput

Represents the natural language text to be processed.

TextToSpeechSettings

Settings related to speech synthesizing.

SynthesizeSpeechConfigsEntry

The abstract base class for a message.

TrainFlowRequest

The request message for Flows.TrainFlow.

TransitionCoverage

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

Transition

A transition in a page.

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

TransitionNode

The source or target of a transition.

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

TransitionRoute

A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order:

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

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

TransitionRouteGroup

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

TransitionRouteGroupCoverage

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

Coverage

Coverage result message for one transition route group.

Transition

A transition coverage in a transition route group.

UpdateAgentRequest

The request message for Agents.UpdateAgent.

UpdateEntityTypeRequest

The request message for EntityTypes.UpdateEntityType.

UpdateEnvironmentRequest

The request message for Environments.UpdateEnvironment.

UpdateExperimentRequest

The request message for Experiments.UpdateExperiment.

UpdateFlowRequest

The request message for Flows.UpdateFlow.

UpdateGenerativeSettingsRequest

Request for UpdateGenerativeSettings RPC.

UpdateGeneratorRequest

The request message for Generators.UpdateGenerator.

UpdateIntentRequest

The request message for Intents.UpdateIntent.

UpdatePageRequest

The request message for Pages.UpdatePage.

UpdateSecuritySettingsRequest

The request message for SecuritySettingsService.UpdateSecuritySettings.

UpdateSessionEntityTypeRequest

The request message for SessionEntityTypes.UpdateSessionEntityType.

UpdateTestCaseRequest

The request message for TestCases.UpdateTestCase.

UpdateTransitionRouteGroupRequest

The request message for TransitionRouteGroups.UpdateTransitionRouteGroup.

UpdateVersionRequest

The request message for Versions.UpdateVersion.

UpdateWebhookRequest

The request message for Webhooks.UpdateWebhook.

ValidateAgentRequest

The request message for Agents.ValidateAgent.

ValidateFlowRequest

The request message for Flows.ValidateFlow.

ValidationMessage

Agent/flow validation message.

ResourceType

Resource types.

Severity

Severity level.

VariantsHistory

The history of variants update.

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

Version

Represents a version of a flow.

State

The state of the version.

VersionVariants

A list of flow version variants.

Variant

A single flow version with specified traffic allocation.

VoiceSelectionParams

Description of which voice to use for speech synthesis.

Webhook

Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

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

GenericWebService

Represents configuration for a generic web service.

HttpMethod

HTTP method to use when calling webhooks.

OAuthConfig

Represents configuration of OAuth client credential flow for 3rd party API authentication.

ParameterMappingEntry

The abstract base class for a message.

RequestHeadersEntry

The abstract base class for a message.

ServiceAgentAuth

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

WebhookType

Represents the type of webhook configuration.

ServiceDirectoryConfig

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

WebhookRequest

The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.

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

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

FulfillmentInfo

Represents fulfillment information communicated to the webhook.

IntentInfo

Represents intent information communicated to the webhook.

IntentParameterValue

Represents a value for an intent parameter.

ParametersEntry

The abstract base class for a message.

SentimentAnalysisResult

Represents the result of sentiment analysis.

WebhookResponse

The response message for a webhook call.

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

FulfillmentResponse

Represents a fulfillment response to the user.

MergeBehavior

Defines merge behavior for messages.

AgentsAsyncClient

Service for managing Agents.

AgentsClient

Service for managing Agents.

ListAgentsAsyncPager

A pager for iterating through list_agents requests.

This class thinly wraps an initial ListAgentsResponse object, and provides an __aiter__ method to iterate through its agents field.

If there are more pages, the __aiter__ method will make additional ListAgents requests and continue to iterate through the agents field on the corresponding responses.

All the usual ListAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAgentsPager

A pager for iterating through list_agents requests.

This class thinly wraps an initial ListAgentsResponse object, and provides an __iter__ method to iterate through its agents field.

If there are more pages, the __iter__ method will make additional ListAgents requests and continue to iterate through the agents field on the corresponding responses.

All the usual ListAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ChangelogsAsyncClient

Service for managing Changelogs.

ChangelogsClient

Service for managing Changelogs.

ListChangelogsAsyncPager

A pager for iterating through list_changelogs requests.

This class thinly wraps an initial ListChangelogsResponse object, and provides an __aiter__ method to iterate through its changelogs field.

If there are more pages, the __aiter__ method will make additional ListChangelogs requests and continue to iterate through the changelogs field on the corresponding responses.

All the usual ListChangelogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChangelogsPager

A pager for iterating through list_changelogs requests.

This class thinly wraps an initial ListChangelogsResponse object, and provides an __iter__ method to iterate through its changelogs field.

If there are more pages, the __iter__ method will make additional ListChangelogs requests and continue to iterate through the changelogs field on the corresponding responses.

All the usual ListChangelogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ConversationHistoryAsyncClient

Service for managing conversation history.

ConversationHistoryClient

Service for managing conversation history.

ListConversationsAsyncPager

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __aiter__ method to iterate through its conversations field.

If there are more pages, the __aiter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConversationsPager

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __iter__ method to iterate through its conversations field.

If there are more pages, the __iter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

DeploymentsAsyncClient

Service for managing Deployments.

DeploymentsClient

Service for managing Deployments.

ListDeploymentsAsyncPager

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __aiter__ method to iterate through its deployments field.

If there are more pages, the __aiter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDeploymentsPager

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __iter__ method to iterate through its deployments field.

If there are more pages, the __iter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

EntityTypesAsyncClient

Service for managing EntityTypes.

EntityTypesClient

Service for managing EntityTypes.

ListEntityTypesAsyncPager

A pager for iterating through list_entity_types requests.

This class thinly wraps an initial ListEntityTypesResponse object, and provides an __aiter__ method to iterate through its entity_types field.

If there are more pages, the __aiter__ method will make additional ListEntityTypes requests and continue to iterate through the entity_types field on the corresponding responses.

All the usual ListEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntityTypesPager

A pager for iterating through list_entity_types requests.

This class thinly wraps an initial ListEntityTypesResponse object, and provides an __iter__ method to iterate through its entity_types field.

If there are more pages, the __iter__ method will make additional ListEntityTypes requests and continue to iterate through the entity_types field on the corresponding responses.

All the usual ListEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

EnvironmentsAsyncClient

Service for managing Environments.

EnvironmentsClient

Service for managing Environments.

ListContinuousTestResultsAsyncPager

A pager for iterating through list_continuous_test_results requests.

This class thinly wraps an initial ListContinuousTestResultsResponse object, and provides an __aiter__ method to iterate through its continuous_test_results field.

All the usual ListContinuousTestResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListContinuousTestResultsPager

A pager for iterating through list_continuous_test_results requests.

This class thinly wraps an initial ListContinuousTestResultsResponse object, and provides an __iter__ method to iterate through its continuous_test_results field.

All the usual ListContinuousTestResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnvironmentsAsyncPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __aiter__ method to iterate through its environments field.

If there are more pages, the __aiter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnvironmentsPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __iter__ method to iterate through its environments field.

If there are more pages, the __iter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

LookupEnvironmentHistoryAsyncPager

A pager for iterating through lookup_environment_history requests.

This class thinly wraps an initial LookupEnvironmentHistoryResponse object, and provides an __aiter__ method to iterate through its environments field.

If there are more pages, the __aiter__ method will make additional LookupEnvironmentHistory requests and continue to iterate through the environments field on the corresponding responses.

All the usual LookupEnvironmentHistoryResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

LookupEnvironmentHistoryPager

A pager for iterating through lookup_environment_history requests.

This class thinly wraps an initial LookupEnvironmentHistoryResponse object, and provides an __iter__ method to iterate through its environments field.

If there are more pages, the __iter__ method will make additional LookupEnvironmentHistory requests and continue to iterate through the environments field on the corresponding responses.

All the usual LookupEnvironmentHistoryResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ExamplesAsyncClient

Service for managing Examples.

ExamplesClient

Service for managing Examples.

ListExamplesAsyncPager

A pager for iterating through list_examples requests.

This class thinly wraps an initial ListExamplesResponse object, and provides an __aiter__ method to iterate through its examples field.

If there are more pages, the __aiter__ method will make additional ListExamples requests and continue to iterate through the examples field on the corresponding responses.

All the usual ListExamplesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExamplesPager

A pager for iterating through list_examples requests.

This class thinly wraps an initial ListExamplesResponse object, and provides an __iter__ method to iterate through its examples field.

If there are more pages, the __iter__ method will make additional ListExamples requests and continue to iterate through the examples field on the corresponding responses.

All the usual ListExamplesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ExperimentsAsyncClient

Service for managing Experiments.

ExperimentsClient

Service for managing Experiments.

ListExperimentsAsyncPager

A pager for iterating through list_experiments requests.

This class thinly wraps an initial ListExperimentsResponse object, and provides an __aiter__ method to iterate through its experiments field.

If there are more pages, the __aiter__ method will make additional ListExperiments requests and continue to iterate through the experiments field on the corresponding responses.

All the usual ListExperimentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExperimentsPager

A pager for iterating through list_experiments requests.

This class thinly wraps an initial ListExperimentsResponse object, and provides an __iter__ method to iterate through its experiments field.

If there are more pages, the __iter__ method will make additional ListExperiments requests and continue to iterate through the experiments field on the corresponding responses.

All the usual ListExperimentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

FlowsAsyncClient

Service for managing Flows.

FlowsClient

Service for managing Flows.

ListFlowsAsyncPager

A pager for iterating through list_flows requests.

This class thinly wraps an initial ListFlowsResponse object, and provides an __aiter__ method to iterate through its flows field.

If there are more pages, the __aiter__ method will make additional ListFlows requests and continue to iterate through the flows field on the corresponding responses.

All the usual ListFlowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFlowsPager

A pager for iterating through list_flows requests.

This class thinly wraps an initial ListFlowsResponse object, and provides an __iter__ method to iterate through its flows field.

If there are more pages, the __iter__ method will make additional ListFlows requests and continue to iterate through the flows field on the corresponding responses.

All the usual ListFlowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

GeneratorsAsyncClient

Service for managing Generators

GeneratorsClient

Service for managing Generators

ListGeneratorsAsyncPager

A pager for iterating through list_generators requests.

This class thinly wraps an initial ListGeneratorsResponse object, and provides an __aiter__ method to iterate through its generators field.

If there are more pages, the __aiter__ method will make additional ListGenerators requests and continue to iterate through the generators field on the corresponding responses.

All the usual ListGeneratorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGeneratorsPager

A pager for iterating through list_generators requests.

This class thinly wraps an initial ListGeneratorsResponse object, and provides an __iter__ method to iterate through its generators field.

If there are more pages, the __iter__ method will make additional ListGenerators requests and continue to iterate through the generators field on the corresponding responses.

All the usual ListGeneratorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

IntentsAsyncClient

Service for managing Intents.

IntentsClient

Service for managing Intents.

ListIntentsAsyncPager

A pager for iterating through list_intents requests.

This class thinly wraps an initial ListIntentsResponse object, and provides an __aiter__ method to iterate through its intents field.

If there are more pages, the __aiter__ method will make additional ListIntents requests and continue to iterate through the intents field on the corresponding responses.

All the usual ListIntentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIntentsPager

A pager for iterating through list_intents requests.

This class thinly wraps an initial ListIntentsResponse object, and provides an __iter__ method to iterate through its intents field.

If there are more pages, the __iter__ method will make additional ListIntents requests and continue to iterate through the intents field on the corresponding responses.

All the usual ListIntentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

PagesAsyncClient

Service for managing Pages.

PagesClient

Service for managing Pages.

ListPagesAsyncPager

A pager for iterating through list_pages requests.

This class thinly wraps an initial ListPagesResponse object, and provides an __aiter__ method to iterate through its pages field.

If there are more pages, the __aiter__ method will make additional ListPages requests and continue to iterate through the pages field on the corresponding responses.

All the usual ListPagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPagesPager

A pager for iterating through list_pages requests.

This class thinly wraps an initial ListPagesResponse object, and provides an __iter__ method to iterate through its pages field.

If there are more pages, the __iter__ method will make additional ListPages requests and continue to iterate through the pages field on the corresponding responses.

All the usual ListPagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

PlaybooksAsyncClient

Service for managing Playbooks.

PlaybooksClient

Service for managing Playbooks.

ListPlaybookVersionsAsyncPager

A pager for iterating through list_playbook_versions requests.

This class thinly wraps an initial ListPlaybookVersionsResponse object, and provides an __aiter__ method to iterate through its playbook_versions field.

If there are more pages, the __aiter__ method will make additional ListPlaybookVersions requests and continue to iterate through the playbook_versions field on the corresponding responses.

All the usual ListPlaybookVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPlaybookVersionsPager

A pager for iterating through list_playbook_versions requests.

This class thinly wraps an initial ListPlaybookVersionsResponse object, and provides an __iter__ method to iterate through its playbook_versions field.

If there are more pages, the __iter__ method will make additional ListPlaybookVersions requests and continue to iterate through the playbook_versions field on the corresponding responses.

All the usual ListPlaybookVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPlaybooksAsyncPager

A pager for iterating through list_playbooks requests.

This class thinly wraps an initial ListPlaybooksResponse object, and provides an __aiter__ method to iterate through its playbooks field.

If there are more pages, the __aiter__ method will make additional ListPlaybooks requests and continue to iterate through the playbooks field on the corresponding responses.

All the usual ListPlaybooksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPlaybooksPager

A pager for iterating through list_playbooks requests.

This class thinly wraps an initial ListPlaybooksResponse object, and provides an __iter__ method to iterate through its playbooks field.

If there are more pages, the __iter__ method will make additional ListPlaybooks requests and continue to iterate through the playbooks field on the corresponding responses.

All the usual ListPlaybooksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SecuritySettingsServiceAsyncClient

Service for managing security settings for Dialogflow.

SecuritySettingsServiceClient

Service for managing security settings for Dialogflow.

ListSecuritySettingsAsyncPager

A pager for iterating through list_security_settings requests.

This class thinly wraps an initial ListSecuritySettingsResponse object, and provides an __aiter__ method to iterate through its security_settings field.

If there are more pages, the __aiter__ method will make additional ListSecuritySettings requests and continue to iterate through the security_settings field on the corresponding responses.

All the usual ListSecuritySettingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSecuritySettingsPager

A pager for iterating through list_security_settings requests.

This class thinly wraps an initial ListSecuritySettingsResponse object, and provides an __iter__ method to iterate through its security_settings field.

If there are more pages, the __iter__ method will make additional ListSecuritySettings requests and continue to iterate through the security_settings field on the corresponding responses.

All the usual ListSecuritySettingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SessionEntityTypesAsyncClient

Service for managing SessionEntityTypes.

SessionEntityTypesClient

Service for managing SessionEntityTypes.

ListSessionEntityTypesAsyncPager

A pager for iterating through list_session_entity_types requests.

This class thinly wraps an initial ListSessionEntityTypesResponse object, and provides an __aiter__ method to iterate through its session_entity_types field.

If there are more pages, the __aiter__ method will make additional ListSessionEntityTypes requests and continue to iterate through the session_entity_types field on the corresponding responses.

All the usual ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSessionEntityTypesPager

A pager for iterating through list_session_entity_types requests.

This class thinly wraps an initial ListSessionEntityTypesResponse object, and provides an __iter__ method to iterate through its session_entity_types field.

If there are more pages, the __iter__ method will make additional ListSessionEntityTypes requests and continue to iterate through the session_entity_types field on the corresponding responses.

All the usual ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SessionsAsyncClient

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

SessionsClient

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

TestCasesAsyncClient

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

TestCasesClient

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

ListTestCaseResultsAsyncPager

A pager for iterating through list_test_case_results requests.

This class thinly wraps an initial ListTestCaseResultsResponse object, and provides an __aiter__ method to iterate through its test_case_results field.

If there are more pages, the __aiter__ method will make additional ListTestCaseResults requests and continue to iterate through the test_case_results field on the corresponding responses.

All the usual ListTestCaseResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTestCaseResultsPager

A pager for iterating through list_test_case_results requests.

This class thinly wraps an initial ListTestCaseResultsResponse object, and provides an __iter__ method to iterate through its test_case_results field.

If there are more pages, the __iter__ method will make additional ListTestCaseResults requests and continue to iterate through the test_case_results field on the corresponding responses.

All the usual ListTestCaseResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTestCasesAsyncPager

A pager for iterating through list_test_cases requests.

This class thinly wraps an initial ListTestCasesResponse object, and provides an __aiter__ method to iterate through its test_cases field.

If there are more pages, the __aiter__ method will make additional ListTestCases requests and continue to iterate through the test_cases field on the corresponding responses.

All the usual ListTestCasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTestCasesPager

A pager for iterating through list_test_cases requests.

This class thinly wraps an initial ListTestCasesResponse object, and provides an __iter__ method to iterate through its test_cases field.

If there are more pages, the __iter__ method will make additional ListTestCases requests and continue to iterate through the test_cases field on the corresponding responses.

All the usual ListTestCasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ToolsAsyncClient

Service for managing Tools.

ToolsClient

Service for managing Tools.

ListToolsAsyncPager

A pager for iterating through list_tools requests.

This class thinly wraps an initial ListToolsResponse object, and provides an __aiter__ method to iterate through its tools field.

If there are more pages, the __aiter__ method will make additional ListTools requests and continue to iterate through the tools field on the corresponding responses.

All the usual ListToolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListToolsPager

A pager for iterating through list_tools requests.

This class thinly wraps an initial ListToolsResponse object, and provides an __iter__ method to iterate through its tools field.

If there are more pages, the __iter__ method will make additional ListTools requests and continue to iterate through the tools field on the corresponding responses.

All the usual ListToolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

TransitionRouteGroupsAsyncClient

Service for managing TransitionRouteGroups.

TransitionRouteGroupsClient

Service for managing TransitionRouteGroups.

ListTransitionRouteGroupsAsyncPager

A pager for iterating through list_transition_route_groups requests.

This class thinly wraps an initial ListTransitionRouteGroupsResponse object, and provides an __aiter__ method to iterate through its transition_route_groups field.

All the usual ListTransitionRouteGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTransitionRouteGroupsPager

A pager for iterating through list_transition_route_groups requests.

This class thinly wraps an initial ListTransitionRouteGroupsResponse object, and provides an __iter__ method to iterate through its transition_route_groups field.

All the usual ListTransitionRouteGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

VersionsAsyncClient

Service for managing Versions.

VersionsClient

Service for managing Versions.

ListVersionsAsyncPager

A pager for iterating through list_versions requests.

This class thinly wraps an initial ListVersionsResponse object, and provides an __aiter__ method to iterate through its versions field.

If there are more pages, the __aiter__ method will make additional ListVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListVersionsPager

A pager for iterating through list_versions requests.

This class thinly wraps an initial ListVersionsResponse object, and provides an __iter__ method to iterate through its versions field.

If there are more pages, the __iter__ method will make additional ListVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

WebhooksAsyncClient

Service for managing Webhooks.

WebhooksClient

Service for managing Webhooks.

ListWebhooksAsyncPager

A pager for iterating through list_webhooks requests.

This class thinly wraps an initial ListWebhooksResponse object, and provides an __aiter__ method to iterate through its webhooks field.

If there are more pages, the __aiter__ method will make additional ListWebhooks requests and continue to iterate through the webhooks field on the corresponding responses.

All the usual ListWebhooksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWebhooksPager

A pager for iterating through list_webhooks requests.

This class thinly wraps an initial ListWebhooksResponse object, and provides an __iter__ method to iterate through its webhooks field.

If there are more pages, the __iter__ method will make additional ListWebhooks requests and continue to iterate through the webhooks field on the corresponding responses.

All the usual ListWebhooksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Action

Action performed by end user or Dialogflow agent in the conversation.

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

AdvancedSettings

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

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

DtmfSettings

Define behaviors for DTMF (dual tone multi frequency).

LoggingSettings

Define behaviors on logging.

SpeechSettings

Define behaviors of speech to text detection.

ModelsEntry

The abstract base class for a message.

Agent

After you create an agent, you can add Intents, [Entity Types][google.cloud.dialogflow.cx.v3beta1.EntityType], Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.

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

AnswerFeedbackSettings

Settings for answer feedback collection.

ClientCertificateSettings

Settings for custom client certificates.

GenAppBuilderSettings

Settings for Gen App Builder.

GitIntegrationSettings

Settings for connecting to Git repository for an agent.

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

GithubSettings

Settings of integration with GitHub.

PersonalizationSettings

Settings for end user personalization.

AgentUtterance

AgentUtterance represents one message sent by the agent.

AgentValidationResult

The response message for Agents.GetAgentValidationResult.

AnswerFeedback

Stores information about feedback provided by users about a response.

Rating

Represents thumbs up/down rating provided by user about a response.

RatingReason

Stores extra information about why users provided thumbs down rating.

AudioEncoding

Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation <https://cloud.google.com/speech-to-text/docs/basics>__ for more details.

AudioInput

Represents the natural speech audio to be processed.

BargeInConfig

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

No barge-in phase: which goes first and during which speech detection should not be carried out.
Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase.

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

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

BatchDeleteTestCasesRequest

The request message for TestCases.BatchDeleteTestCases.

BatchRunTestCasesMetadata

Metadata returned for the TestCases.BatchRunTestCases long running operation.

BatchRunTestCasesRequest

The request message for TestCases.BatchRunTestCases.

BatchRunTestCasesResponse

The response message for TestCases.BatchRunTestCases.

BigQueryExportSettings

The settings of BigQuery export.

BoostSpec

ConditionBoostSpec

Boost applies to documents which match a condition.

BoostControlSpec

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

AttributeType

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

ControlPoint

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

InterpolationType

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

BoostSpecs

Boost specifications for data stores.

CalculateCoverageRequest

The request message for TestCases.CalculateCoverage.

CoverageType

The type of coverage score requested.

CalculateCoverageResponse

The response message for TestCases.CalculateCoverage.

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

Changelog

Changelogs represents a change made to a given agent.

CloudConversationDebuggingInfo

CompareVersionsRequest

The request message for Versions.CompareVersions.

CompareVersionsResponse

The response message for Versions.CompareVersions.

ContinuousTestResult

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

AggregatedTestResult

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

Conversation

Represents a conversation.

FlowVersionsEntry

The abstract base class for a message.

Interaction

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

MissingTransition

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

Metrics

Represents metrics for the conversation.

MatchTypeCount

Count by Match.MatchType of the matches in the conversation.

QueryInputCount

Count by types of QueryInput of the requests in the conversation.

Type

Represents the type of a conversation.

ConversationTurn

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

UserInput

The input from the human user.

VirtualAgentOutput

The output from the virtual agent.

CreateAgentRequest

The request message for Agents.CreateAgent.

CreateEntityTypeRequest

The request message for EntityTypes.CreateEntityType.

CreateEnvironmentRequest

The request message for Environments.CreateEnvironment.

CreateExampleRequest

The request message for Examples.CreateExample.

CreateExperimentRequest

The request message for Experiments.CreateExperiment.

CreateFlowRequest

The request message for Flows.CreateFlow.

CreateGeneratorRequest

The request message for Generators.CreateGenerator.

CreateIntentRequest

The request message for Intents.CreateIntent.

CreatePageRequest

The request message for Pages.CreatePage.

CreatePlaybookRequest

The request message for Playbooks.CreatePlaybook.

CreatePlaybookVersionRequest

The request message for Playbooks.CreatePlaybookVersion.

CreateSecuritySettingsRequest

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

CreateSessionEntityTypeRequest

The request message for SessionEntityTypes.CreateSessionEntityType.

CreateTestCaseRequest

The request message for TestCases.CreateTestCase.

CreateToolRequest

The request message for Tools.CreateTool.

CreateTransitionRouteGroupRequest

The request message for TransitionRouteGroups.CreateTransitionRouteGroup.

CreateVersionOperationMetadata

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

CreateVersionRequest

The request message for Versions.CreateVersion.

CreateWebhookRequest

The request message for Webhooks.CreateWebhook.

DataStoreConnection

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

DataStoreConnectionSignals

AnswerGenerationModelCallSignals

Diagnostic info related to the answer generation model call.

AnswerPart

Answer part with citation.

CitedSnippet

Snippet cited by the answer generation model.

GroundingSignals

Grounding signals.

GroundingDecision

Represents the decision of the grounding check.

GroundingScoreBucket

Grounding score buckets.

RewriterModelCallSignals

Diagnostic info related to the rewriter model call.

SafetySignals

Safety check results.

BannedPhraseMatch

Specifies banned phrase match subject.

SafetyDecision

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

SearchSnippet

Search snippet details.

DataStoreType

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

DeleteAgentRequest

The request message for Agents.DeleteAgent.

DeleteConversationRequest

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

DeleteEntityTypeRequest

The request message for EntityTypes.DeleteEntityType.

DeleteEnvironmentRequest

The request message for Environments.DeleteEnvironment.

DeleteExampleRequest

The request message for Examples.DeleteExample.

DeleteExperimentRequest

The request message for Experiments.DeleteExperiment.

DeleteFlowRequest

The request message for Flows.DeleteFlow.

DeleteGeneratorRequest

The request message for Generators.DeleteGenerator.

DeleteIntentRequest

The request message for Intents.DeleteIntent.

DeletePageRequest

The request message for Pages.DeletePage.

DeletePlaybookRequest

The request message for Playbooks.DeletePlaybook.

DeletePlaybookVersionRequest

The request message for Playbooks.DeletePlaybookVersion.

DeleteSecuritySettingsRequest

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

DeleteSessionEntityTypeRequest

The request message for SessionEntityTypes.DeleteSessionEntityType.

DeleteToolRequest

The request message for Tools.DeleteTool.

DeleteTransitionRouteGroupRequest

The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.

DeleteVersionRequest

The request message for Versions.DeleteVersion.

DeleteWebhookRequest

The request message for Webhooks.DeleteWebhook.

DeployFlowMetadata

Metadata returned for the Environments.DeployFlow long running operation.

DeployFlowRequest

The request message for Environments.DeployFlow.

DeployFlowResponse

The response message for Environments.DeployFlow.

Deployment

Result

Result of the deployment.

State

The state of the deployment.

DetectIntentRequest

The request to detect user's intent.

DetectIntentResponse

The message returned from the DetectIntent method.

ResponseType

Represents different DetectIntentResponse types.

DtmfInput

Represents the input for dtmf event.

EntityType

When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on.

There are three types of entities:

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

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

AutoExpansionMode

Entity

An entity entry for an associated entity type.

ExcludedPhrase

An excluded entity phrase that should not be matched.

Kind

Represents kinds of entities.

Environment

TestCasesConfig

The configuration for continuous tests.

VersionConfig

Configuration for the version.

WebhookConfig

Configuration for webhooks.

EventHandler

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

If there is a [trigger_fulfillment][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 the specified page.
If there is a [target_flow][google.cloud.dialogflow.cx.v3beta1.EventHandler.target_flow] associated with the event, the session will transition into the specified flow.

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

EventInput

Represents the event to trigger.

Example

Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.

Experiment

Represents an experiment in an environment.

Definition

Definition of the experiment.

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

Result

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

ConfidenceInterval

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

CountType

types of count-based metric for Dialogflow experiment.

Metric

Metric and corresponding confidence intervals.

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

MetricType

Types of ratio-based metric for Dialogflow experiment.

VersionMetrics

Version variant and associated metrics.

State

The state of the experiment.

ExportAgentRequest

The request message for Agents.ExportAgent.

DataFormat

Data format of the exported agent.

GitDestination

Settings for exporting to a git branch.

ExportAgentResponse

The response message for Agents.ExportAgent.

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

ExportEntityTypesMetadata

Metadata returned for the EntityTypes.ExportEntityTypes long running operation.

ExportEntityTypesRequest

The request message for EntityTypes.ExportEntityTypes.

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

DataFormat

Data format of the exported entity types.

ExportEntityTypesResponse

The response message for EntityTypes.ExportEntityTypes.

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

ExportFlowRequest

The request message for Flows.ExportFlow.

ExportFlowResponse

The response message for Flows.ExportFlow.

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

ExportIntentsMetadata

Metadata returned for the Intents.ExportIntents long running operation.

ExportIntentsRequest

The request message for Intents.ExportIntents.

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

DataFormat

Data format of the exported intents.

ExportIntentsResponse

The response message for Intents.ExportIntents.

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

ExportTestCasesMetadata

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

ExportTestCasesRequest

The request message for TestCases.ExportTestCases.

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

DataFormat

Data format of the exported test cases.

ExportTestCasesResponse

The response message for TestCases.ExportTestCases.

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

ExportToolsMetadata

Metadata returned for the Tools.ExportTools long running operation.

ExportToolsRequest

The request message for Tools.ExportTools.

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

DataFormat

Data format of the exported tools.

ExportToolsResponse

The response message for Tools.ExportTools.

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

FilterSpecs

Filter specifications for data stores.

Flow

MultiLanguageSettings

Settings for multi-lingual agents.

FlowImportStrategy

The flow import strategy used for resource conflict resolution associated with an ImportFlowRequest.

FlowInvocation

Stores metadata of the invocation of a CX flow.

FlowValidationResult

The response message for Flows.GetFlowValidationResult.

Form

Parameter

Represents a form parameter.

FillBehavior

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

FulfillIntentRequest

Request of [FulfillIntent][]

FulfillIntentResponse

Response of [FulfillIntent][]

Fulfillment

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

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

ConditionalCases

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

Case

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

CaseContent

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

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

SetParameterAction

Setting a parameter value.

GcsDestination

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

GenerativeInfo

Represents the information of a query if handled by generative agent resources.

GenerativeSettings

Settings for Generative AI.

FallbackSettings

Settings for Generative Fallback.

PromptTemplate

Prompt template.

KnowledgeConnectorSettings

Generator

ModelParameter

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

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

Placeholder

Represents a custom placeholder in the prompt text.

GetAgentRequest

The request message for Agents.GetAgent.

GetAgentValidationResultRequest

The request message for Agents.GetAgentValidationResult.

GetChangelogRequest

The request message for Changelogs.GetChangelog.

GetConversationRequest

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

GetDeploymentRequest

The request message for Deployments.GetDeployment.

GetEntityTypeRequest

The request message for EntityTypes.GetEntityType.

GetEnvironmentRequest

The request message for Environments.GetEnvironment.

GetExampleRequest

The request message for Examples.GetExample.

GetExperimentRequest

The request message for Experiments.GetExperiment.

GetFlowRequest

The response message for Flows.GetFlow.

GetFlowValidationResultRequest

The request message for Flows.GetFlowValidationResult.

GetGenerativeSettingsRequest

Request for GetGenerativeSettings RPC.

GetGeneratorRequest

The request message for Generators.GetGenerator.

GetIntentRequest

The request message for Intents.GetIntent.

GetPageRequest

The request message for Pages.GetPage.

GetPlaybookRequest

The request message for Playbooks.GetPlaybook.

GetPlaybookVersionRequest

The request message for Playbooks.GetPlaybookVersion.

GetSecuritySettingsRequest

The request message for SecuritySettingsService.GetSecuritySettings.

GetSessionEntityTypeRequest

The request message for SessionEntityTypes.GetSessionEntityType.

GetTestCaseRequest

The request message for TestCases.GetTestCase.

GetTestCaseResultRequest

The request message for TestCases.GetTestCaseResult.

GetToolRequest

The request message for Tools.GetTool.

GetTransitionRouteGroupRequest

The request message for TransitionRouteGroups.GetTransitionRouteGroup.

GetVersionRequest

The request message for Versions.GetVersion.

GetWebhookRequest

The request message for Webhooks.GetWebhook.

ImportEntityTypesMetadata

Metadata returned for the EntityTypes.ImportEntityTypes long running operation.

ImportEntityTypesRequest

The request message for EntityTypes.ImportEntityTypes.

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

MergeOption

Merge option when display name conflicts exist during import.

ImportEntityTypesResponse

The response message for EntityTypes.ImportEntityTypes.

ConflictingResources

ImportFlowRequest

The request message for Flows.ImportFlow.

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

ImportOption

Import option.

ImportFlowResponse

The response message for Flows.ImportFlow.

ImportIntentsMetadata

Metadata returned for the Intents.ImportIntents long running operation.

ImportIntentsRequest

The request message for Intents.ImportIntents.

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

MergeOption

Merge option when display name conflicts exist during import.

ImportIntentsResponse

The response message for Intents.ImportIntents.

ConflictingResources

ImportStrategy

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

ImportTestCasesMetadata

Metadata returned for the TestCases.ImportTestCases long running operation.

ImportTestCasesRequest

The request message for TestCases.ImportTestCases.

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

ImportTestCasesResponse

The response message for TestCases.ImportTestCases.

InlineDestination

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

InlineSource

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

InputAudioConfig

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

Intent

LabelsEntry

The abstract base class for a message.

Parameter

Represents an intent parameter.

TrainingPhrase

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

Part

Represents a part of a training phrase.

IntentCoverage

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

Intent

The agent's intent.

IntentInput

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

IntentView

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

KnowledgeConnectorSettings

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

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

LanguageInfo

Represents the language information of the request.

ListAgentsRequest

The request message for Agents.ListAgents.

ListAgentsResponse

The response message for Agents.ListAgents.

ListChangelogsRequest

The request message for Changelogs.ListChangelogs.

ListChangelogsResponse

The response message for Changelogs.ListChangelogs.

ListContinuousTestResultsRequest

The request message for Environments.ListContinuousTestResults.

ListContinuousTestResultsResponse

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

ListConversationsRequest

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

ListConversationsResponse

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

ListDeploymentsRequest

The request message for Deployments.ListDeployments.

ListDeploymentsResponse

The response message for Deployments.ListDeployments.

ListEntityTypesRequest

The request message for EntityTypes.ListEntityTypes.

ListEntityTypesResponse

The response message for EntityTypes.ListEntityTypes.

ListEnvironmentsRequest

The request message for Environments.ListEnvironments.

ListEnvironmentsResponse

The response message for Environments.ListEnvironments.

ListExamplesRequest

The request message for Examples.ListExamples.

ListExamplesResponse

The response message for Examples.ListExamples.

ListExperimentsRequest

The request message for Experiments.ListExperiments.

ListExperimentsResponse

The response message for Experiments.ListExperiments.

ListFlowsRequest

The request message for Flows.ListFlows.

ListFlowsResponse

The response message for Flows.ListFlows.

ListGeneratorsRequest

The request message for Generators.ListGenerators.

ListGeneratorsResponse

The response message for Generators.ListGenerators.

ListIntentsRequest

The request message for Intents.ListIntents.

ListIntentsResponse

The response message for Intents.ListIntents.

ListPagesRequest

The request message for Pages.ListPages.

ListPagesResponse

The response message for Pages.ListPages.

ListPlaybookVersionsRequest

The request message for Playbooks.ListPlaybookVersions.

ListPlaybookVersionsResponse

The response message for Playbooks.ListPlaybookVersions.

ListPlaybooksRequest

The request message for Playbooks.ListPlaybooks.

ListPlaybooksResponse

The response message for Playbooks.ListPlaybooks.

ListSecuritySettingsRequest

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

ListSecuritySettingsResponse

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

ListSessionEntityTypesRequest

The request message for SessionEntityTypes.ListSessionEntityTypes.

ListSessionEntityTypesResponse

The response message for SessionEntityTypes.ListSessionEntityTypes.

ListTestCaseResultsRequest

The request message for TestCases.ListTestCaseResults.

ListTestCaseResultsResponse

The response message for TestCases.ListTestCaseResults.

ListTestCasesRequest

The request message for TestCases.ListTestCases.

TestCaseView

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

ListTestCasesResponse

The response message for TestCases.ListTestCases.

ListToolsRequest

The request message for Tools.ListTools.

ListToolsResponse

The response message for Tools.ListTools.

ListTransitionRouteGroupsRequest

The request message for TransitionRouteGroups.ListTransitionRouteGroups.

ListTransitionRouteGroupsResponse

The response message for TransitionRouteGroups.ListTransitionRouteGroups.

ListVersionsRequest

The request message for Versions.ListVersions.

ListVersionsResponse

The response message for Versions.ListVersions.

ListWebhooksRequest

The request message for Webhooks.ListWebhooks.

ListWebhooksResponse

The response message for Webhooks.ListWebhooks.

LlmModelSettings

Settings for LLM models.

LoadVersionRequest

The request message for Versions.LoadVersion.

LookupEnvironmentHistoryRequest

The request message for Environments.LookupEnvironmentHistory.

LookupEnvironmentHistoryResponse

The response message for Environments.LookupEnvironmentHistory.

Match

Represents one match result of [MatchIntent][].

MatchType

Type of a Match.

MatchIntentRequest

Request of [MatchIntent][].

MatchIntentResponse

Response of [MatchIntent][].

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

NluSettings

Settings related to NLU.

ModelTrainingMode

NLU model training mode.

ModelType

NLU model type.

OutputAudioConfig

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

OutputAudioEncoding

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

OutputState

Output state.

Page

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.

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

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

PageInfo

Represents page information communicated to and from the webhook.

FormInfo

Represents form information.

ParameterInfo

Represents parameter information.

ParameterState

Represents the state of a parameter.

ParameterDefinition

Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. (-- Next Id: 4 --) (-- api-linter: core::0123::resource-annotation=disabled aip.dev/not-precedent: ParameterDefinition is not an exposed resource. --)

ParameterType

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

Phrase

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

Playbook

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

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

Instruction

Message of the Instruction of the playbook.

Step

Message of single step execution.

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

PlaybookInput

Input of the playbook.

PlaybookInvocation

Stores metadata of the invocation of a child playbook.

PlaybookOutput

Output of the playbook.

PlaybookVersion

Playbook version is a snapshot of the playbook at certain timestamp.

QueryInput

Represents the query input. It can contain one of:

A conversational query in the form of text.
An intent query that specifies which intent to trigger.
Natural language speech audio to be processed.
An event to be triggered.
DTMF digits to invoke an intent and fill in parameter value.
The results of a tool executed by the client.

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

QueryParameters

Represents the parameters of a conversational query.

WebhookHeadersEntry

The abstract base class for a message.

QueryResult

Represents the result of a conversational query.

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

ResourceName

Resource name and display name.

ResponseMessage

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

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

If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis.
If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design.
Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis.

This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

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

ConversationSuccess

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

You may set this, for example:

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

EndInteraction

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

KnowledgeInfoCard

Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card.

Otherwise, the info card response is skipped.

LiveAgentHandoff

Indicates that the conversation should be handed off to a live agent.

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

You may set this, for example:

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

MixedAudio

Segment

Represents one segment of audio.

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

OutputAudioText

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

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

PlayAudio

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

TelephonyTransferCall

Represents the signal that telles the client to transfer the phone 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

Text

The text response message.

RestoreAgentRequest

The request message for Agents.RestoreAgent.

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

GitSource

Settings for restoring from a git branch

RestoreOption

Restore option.

RolloutConfig

The configuration for auto rollout.

RolloutStep

A single rollout step with specified traffic allocation.

RolloutState

State of the auto-rollout process.

RunContinuousTestMetadata

Metadata returned for the Environments.RunContinuousTest long running operation.

RunContinuousTestRequest

The request message for Environments.RunContinuousTest.

RunContinuousTestResponse

The response message for Environments.RunContinuousTest.

RunTestCaseMetadata

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

RunTestCaseRequest

The request message for TestCases.RunTestCase.

RunTestCaseResponse

The response message for TestCases.RunTestCase.

SafetySettings

Settings for Generative Safety.

Phrase

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

PhraseMatchStrategy

Strategy for matching phrases.

SearchConfig

Search configuration for UCS search queries.

SecuritySettings

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

AudioExportSettings

Settings for exporting audio.

AudioFormat

File format for exported audio file. Currently only in telephony recordings.

InsightsExportSettings

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

PurgeDataType

Type of data we purge after retention settings triggers purge.

RedactionScope

Defines what types of data to redact.

RedactionStrategy

Defines how we redact data.

RetentionStrategy

Defines how long we retain persisted data that contains sensitive info.

SentimentAnalysisResult

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

SessionEntityType

Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.

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

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

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

EntityOverrideMode

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.

SessionInfo

Represents session information communicated to and from the webhook.

ParametersEntry

The abstract base class for a message.

SpeechModelVariant

Variant of the specified [Speech model][google.cloud.dialogflow.cx.v3beta1.InputAudioConfig.model] to use.

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

SpeechToTextSettings

Settings related to speech recognition.

SpeechWordInfo

Information for a word recognized by the speech recognizer.

SsmlVoiceGender

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

StartExperimentRequest

The request message for Experiments.StartExperiment.

StopExperimentRequest

The request message for Experiments.StopExperiment.

StreamingDetectIntentRequest

The top-level message sent by the client to the Sessions.StreamingDetectIntent method.

Multiple request messages should be sent in order:

The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config.
If query_input was set to query_input.audio.config, all subsequent messages must contain query_input.audio.audio to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with query_input.text.

However, note that:
- Dialogflow will bill you for the audio duration so far.
- Dialogflow discards all Speech recognition results in favor of the input text.
- Dialogflow will use the language code from the first message.

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

StreamingDetectIntentResponse

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages (N) can be returned in order.

The first (N-1) responses set either the recognition_result or detect_intent_response field, depending on the request:

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

For the final Nth response message, the detect_intent_response is fully populated, and DetectIntentResponse.response_type is set to FINAL.

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

StreamingRecognitionResult

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

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

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

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

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

MessageType

Type of the response message.

SubmitAnswerFeedbackRequest

The request to set the feedback for a bot answer.

SynthesizeSpeechConfig

Configuration of how speech should be synthesized.

TestCase

Represents a test case.

TestCaseError

Error info for importing a test.

TestCaseResult

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

TestConfig

Represents configurations for a test case.

TestError

Error info for running a test.

TestResult

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

TestRunDifference

The description of differences between original and replayed agent output.

DiffType

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

TextInput

Represents the natural language text to be processed.

TextToSpeechSettings

Settings related to speech synthesizing.

SynthesizeSpeechConfigsEntry

The abstract base class for a message.

Tool

A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.

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

Authentication

Authentication information required for API calls

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

ApiKeyConfig

Config for authentication with API key.

BearerTokenConfig

Config for authentication using bearer token.

OAuthConfig

Config for authentication with OAuth.

OauthGrantType

OAuth grant types. Only client credential grant <https://oauth.net/2/grant-types/client-credentials>__ is supported.

RequestLocation

The location of the API key in the request.

ServiceAgentAuthConfig

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

ServiceAgentAuth

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

DataStoreTool

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

FallbackPrompt

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

ExtensionTool

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

FunctionTool

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

OpenApiTool

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

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

ServiceDirectoryConfig

Configuration for tools using Service Directory.

TLSConfig

The TLS configuration.

CACert

The CA certificate.

ToolType

Represents the type of the tool.

ToolCall

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

ToolCallResult

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

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

Error

An error produced by the tool call.

ToolUse

Stores metadata of the invocation of an action supported by a tool.

TrainFlowRequest

The request message for Flows.TrainFlow.

TransitionCoverage

Transition

A transition in a page.

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

TransitionNode

The source or target of a transition.

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

TransitionRoute

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 into the specified page.
If there is a [target_flow][google.cloud.dialogflow.cx.v3beta1.TransitionRoute.target_flow] associated with the transition, the session will transition into the specified flow.

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