Package types (1.35.0)

API documentation for dialogflowcx_v3.types package.

Classes

AdvancedSettings

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

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

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

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

AgentValidationResult

The response message for Agents.GetAgentValidationResult.

AnswerFeedback

Stores information about feedback provided by users about a response.

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

BoostSpecs

Boost specifications for data stores.

CalculateCoverageRequest

The request message for TestCases.CalculateCoverage.

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.

ConversationTurn

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

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

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.

DetectIntentRequest

The request to detect user's intent.

DetectIntentResponse

The message returned from the DetectIntent method.

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

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.

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