- 1.38.0 (latest)
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.1
- 1.33.0
- 1.32.1
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.1
- 1.22.0
- 1.21.0
- 1.20.1
- 1.19.0
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.0
- 1.14.1
- 1.13.5
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.1
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.2
- 1.2.0
- 1.1.1
- 1.0.0
- 0.8.2
- 0.7.1
- 0.6.0
- 0.5.0
- 0.4.1
- 0.3.0
- 0.2.0
- 0.1.1
API documentation for dialogflowcx_v3beta1.types
package.
Classes
Action
Action performed by end user or Dialogflow agent in the conversation.
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
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.v3beta1.EntityType], Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
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
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.
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.
BigQueryExportSettings
The settings of BigQuery export.
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.
Conversation
Represents a conversation.
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.
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