dialogflow/v3 library

Dialogflow API - v3

Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).

For more information, see cloud.google.com/dialogflow/

Create an instance of DialogflowApi to access these resources:

Classes

DialogflowApi
Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).
GoogleCloudDialogflowCxV3AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings
Define behaviors for DTMF (dual tone multi frequency).
GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings
Define behaviors on logging.
GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings
Define behaviors of speech to text detection.
GoogleCloudDialogflowCxV3Agent
Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data.
GoogleCloudDialogflowCxV3AgentAnswerFeedbackSettings
Settings for answer feedback collection.
GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings
Settings for Gen App Builder.
GoogleCloudDialogflowCxV3AgentGitIntegrationSettings
Settings for connecting to Git repository for an agent.
GoogleCloudDialogflowCxV3AgentGitIntegrationSettingsGithubSettings
Settings of integration with GitHub.
GoogleCloudDialogflowCxV3AgentPersonalizationSettings
Settings for end user personalization.
GoogleCloudDialogflowCxV3AgentValidationResult
The response message for Agents.GetAgentValidationResult.
GoogleCloudDialogflowCxV3AnswerFeedback
Stores information about feedback provided by users about a response.
GoogleCloudDialogflowCxV3AnswerFeedbackRatingReason
Stores extra information about why users provided thumbs down rating.
GoogleCloudDialogflowCxV3AudioInput
Represents the natural speech audio to be processed.
GoogleCloudDialogflowCxV3BargeInConfig
Configuration of the barge-in behavior.
GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest
The request message for TestCases.BatchDeleteTestCases.
GoogleCloudDialogflowCxV3BatchRunTestCasesRequest
The request message for TestCases.BatchRunTestCases.
GoogleCloudDialogflowCxV3BoostSpec
Boost specification to boost certain documents.
GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec
Boost applies to documents which match a condition.
GoogleCloudDialogflowCxV3BoostSpecs
Boost specifications for data stores.
GoogleCloudDialogflowCxV3CalculateCoverageResponse
The response message for TestCases.CalculateCoverage.
GoogleCloudDialogflowCxV3Changelog
Changelogs represents a change made to a given agent.
GoogleCloudDialogflowCxV3CompareVersionsRequest
The request message for Versions.CompareVersions.
GoogleCloudDialogflowCxV3CompareVersionsResponse
The response message for Versions.CompareVersions.
GoogleCloudDialogflowCxV3ContinuousTestResult
Represents a result from running a test case in an agent environment.
GoogleCloudDialogflowCxV3ConversationTurn
One interaction between a human and virtual agent.
GoogleCloudDialogflowCxV3ConversationTurnUserInput
The input from the human user.
GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput
The output from the virtual agent.
GoogleCloudDialogflowCxV3DataStoreConnection
A data store connection.
GoogleCloudDialogflowCxV3DataStoreConnectionSignals
Data store connection feature output signals.
GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart
Answer part with citation.
GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet
Snippet cited by the answer generation model.
GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals
Grounding signals.
GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals
Safety check results.
GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet
Search snippet details.
GoogleCloudDialogflowCxV3DeployFlowRequest
The request message for Environments.DeployFlow.
GoogleCloudDialogflowCxV3Deployment
Represents a deployment in an environment.
GoogleCloudDialogflowCxV3DeploymentResult
Result of the deployment.
GoogleCloudDialogflowCxV3DetectIntentRequest
The request to detect user's intent.
GoogleCloudDialogflowCxV3DetectIntentResponse
The message returned from the DetectIntent method.
GoogleCloudDialogflowCxV3DtmfInput
Represents the input for dtmf event.
GoogleCloudDialogflowCxV3EntityType
Entities are extracted from user input and represent parameters that are meaningful to your application.
GoogleCloudDialogflowCxV3EntityTypeEntity
An entity entry for an associated entity type.
GoogleCloudDialogflowCxV3EntityTypeExcludedPhrase
An excluded entity phrase that should not be matched.
GoogleCloudDialogflowCxV3Environment
Represents an environment for an agent.
GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig
The configuration for continuous tests.
GoogleCloudDialogflowCxV3EnvironmentVersionConfig
Configuration for the version.
GoogleCloudDialogflowCxV3EnvironmentWebhookConfig
Configuration for webhooks.
GoogleCloudDialogflowCxV3EventHandler
An event handler specifies an event that can be handled during a session.
GoogleCloudDialogflowCxV3EventInput
Represents the event to trigger.
GoogleCloudDialogflowCxV3Experiment
Represents an experiment in an environment.
GoogleCloudDialogflowCxV3ExperimentDefinition
Definition of the experiment.
GoogleCloudDialogflowCxV3ExperimentResult
The inference result which includes an objective metric to optimize and the confidence interval.
GoogleCloudDialogflowCxV3ExperimentResultConfidenceInterval
A confidence interval is a range of possible values for the experiment objective you are trying to measure.
GoogleCloudDialogflowCxV3ExperimentResultMetric
Metric and corresponding confidence intervals.
GoogleCloudDialogflowCxV3ExperimentResultVersionMetrics
Version variant and associated metrics.
GoogleCloudDialogflowCxV3ExportAgentRequest
The request message for Agents.ExportAgent.
GoogleCloudDialogflowCxV3ExportAgentRequestGitDestination
Settings for exporting to a git branch.
GoogleCloudDialogflowCxV3ExportEntityTypesRequest
The request message for EntityTypes.ExportEntityTypes.
GoogleCloudDialogflowCxV3ExportFlowRequest
The request message for Flows.ExportFlow.
GoogleCloudDialogflowCxV3ExportIntentsRequest
The request message for Intents.ExportIntents.
GoogleCloudDialogflowCxV3ExportTestCasesRequest
The request message for TestCases.ExportTestCases.
GoogleCloudDialogflowCxV3FilterSpecs
Filter specifications for data stores.
GoogleCloudDialogflowCxV3Flow
Flows represents the conversation flows when you build your chatbot agent.
GoogleCloudDialogflowCxV3FlowImportStrategy
The flow import strategy used for resource conflict resolution associated with an ImportFlowRequest.
GoogleCloudDialogflowCxV3FlowMultiLanguageSettings
Settings for multi-lingual agents.
GoogleCloudDialogflowCxV3FlowValidationResult
The response message for Flows.GetFlowValidationResult.
GoogleCloudDialogflowCxV3Form
A form is a data model that groups related parameters that can be collected from the user.
GoogleCloudDialogflowCxV3FormParameter
Represents a form parameter.
GoogleCloudDialogflowCxV3FormParameterFillBehavior
Configuration for how the filling of a parameter should be handled.
GoogleCloudDialogflowCxV3FulfillIntentRequest
Request of FulfillIntent
GoogleCloudDialogflowCxV3FulfillIntentResponse
Response of FulfillIntent
GoogleCloudDialogflowCxV3Fulfillment
A fulfillment can do one or more of the following actions at the same time:
GoogleCloudDialogflowCxV3FulfillmentConditionalCases
A list of cascading if-else conditions.
GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase
Each case has a Boolean condition.
GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent
The list of messages or conditional cases to activate for this case.
GoogleCloudDialogflowCxV3FulfillmentSetParameterAction
Setting a parameter value.
GoogleCloudDialogflowCxV3GcsDestination
Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.
GoogleCloudDialogflowCxV3GenerativeSettings
Settings for Generative AI.
GoogleCloudDialogflowCxV3GenerativeSettingsFallbackSettings
Settings for Generative Fallback.
GoogleCloudDialogflowCxV3GenerativeSettingsFallbackSettingsPromptTemplate
Prompt template.
GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings
Settings for knowledge connector.
GoogleCloudDialogflowCxV3Generator
Generators contain prompt to be sent to the LLM model to generate text.
GoogleCloudDialogflowCxV3GeneratorPlaceholder
Represents a custom placeholder in the prompt text.
GoogleCloudDialogflowCxV3ImportEntityTypesRequest
The request message for EntityTypes.ImportEntityTypes.
GoogleCloudDialogflowCxV3ImportFlowRequest
The request message for Flows.ImportFlow.
GoogleCloudDialogflowCxV3ImportIntentsRequest
The request message for Intents.ImportIntents.
GoogleCloudDialogflowCxV3ImportTestCasesRequest
The request message for TestCases.ImportTestCases.
GoogleCloudDialogflowCxV3InlineSource
Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow.
GoogleCloudDialogflowCxV3InputAudioConfig
Instructs the speech recognizer on how to process the audio content.
GoogleCloudDialogflowCxV3Intent
An intent represents a user's intent to interact with a conversational agent.
GoogleCloudDialogflowCxV3IntentCoverage
Intent coverage represents the percentage of all possible intents in the agent that are triggered in any of a parent's test cases.
GoogleCloudDialogflowCxV3IntentCoverageIntent
The agent's intent.
GoogleCloudDialogflowCxV3IntentInput
Represents the intent to trigger programmatically rather than as a result of natural language processing.
GoogleCloudDialogflowCxV3IntentParameter
Represents an intent parameter.
GoogleCloudDialogflowCxV3IntentTrainingPhrase
Represents an example that the agent is trained on to identify the intent.
GoogleCloudDialogflowCxV3IntentTrainingPhrasePart
Represents a part of a training phrase.
GoogleCloudDialogflowCxV3KnowledgeConnectorSettings
The Knowledge Connector settings for this page or flow.
GoogleCloudDialogflowCxV3ListAgentsResponse
The response message for Agents.ListAgents.
GoogleCloudDialogflowCxV3ListChangelogsResponse
The response message for Changelogs.ListChangelogs.
GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse
The response message for Environments.ListTestCaseResults.
GoogleCloudDialogflowCxV3ListDeploymentsResponse
The response message for Deployments.ListDeployments.
GoogleCloudDialogflowCxV3ListEntityTypesResponse
The response message for EntityTypes.ListEntityTypes.
GoogleCloudDialogflowCxV3ListEnvironmentsResponse
The response message for Environments.ListEnvironments.
GoogleCloudDialogflowCxV3ListExperimentsResponse
The response message for Experiments.ListExperiments.
GoogleCloudDialogflowCxV3ListFlowsResponse
The response message for Flows.ListFlows.
GoogleCloudDialogflowCxV3ListGeneratorsResponse
The response message for Generators.ListGenerators.
GoogleCloudDialogflowCxV3ListIntentsResponse
The response message for Intents.ListIntents.
GoogleCloudDialogflowCxV3ListPagesResponse
The response message for Pages.ListPages.
GoogleCloudDialogflowCxV3ListSecuritySettingsResponse
The response message for SecuritySettings.ListSecuritySettings.
GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse
The response message for SessionEntityTypes.ListSessionEntityTypes.
GoogleCloudDialogflowCxV3ListTestCaseResultsResponse
The response message for TestCases.ListTestCaseResults.
GoogleCloudDialogflowCxV3ListTestCasesResponse
The response message for TestCases.ListTestCases.
GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse
The response message for TransitionRouteGroups.ListTransitionRouteGroups.
GoogleCloudDialogflowCxV3ListVersionsResponse
The response message for Versions.ListVersions.
GoogleCloudDialogflowCxV3ListWebhooksResponse
The response message for Webhooks.ListWebhooks.
GoogleCloudDialogflowCxV3LoadVersionRequest
The request message for Versions.LoadVersion.
GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse
The response message for Environments.LookupEnvironmentHistory.
GoogleCloudDialogflowCxV3Match
Represents one match result of MatchIntent.
GoogleCloudDialogflowCxV3MatchIntentRequest
Request of MatchIntent.
GoogleCloudDialogflowCxV3MatchIntentResponse
Response of MatchIntent.
GoogleCloudDialogflowCxV3NluSettings
Settings related to NLU.
GoogleCloudDialogflowCxV3OutputAudioConfig
Instructs the speech synthesizer how to generate the output audio content.
GoogleCloudDialogflowCxV3Page
A Dialogflow CX conversation (session) can be described and visualized as a state machine.
GoogleCloudDialogflowCxV3Phrase
Text input which can be used for prompt or banned phrases.
GoogleCloudDialogflowCxV3QueryInput
Represents the query input.
GoogleCloudDialogflowCxV3QueryParameters
Represents the parameters of a conversational query.
GoogleCloudDialogflowCxV3QueryResult
Represents the result of a conversational query.
GoogleCloudDialogflowCxV3ResourceName
Resource name and display name.
GoogleCloudDialogflowCxV3ResponseMessage
Represents a response message that can be returned by a conversational agent.
GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess
Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.
GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff
Indicates that the conversation should be handed off to a live agent.
GoogleCloudDialogflowCxV3ResponseMessageMixedAudio
Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.
GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment
Represents one segment of audio.
GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText
A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
GoogleCloudDialogflowCxV3ResponseMessagePlayAudio
Specifies an audio clip to be played by the client as part of the response.
GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall
Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.
GoogleCloudDialogflowCxV3ResponseMessageText
The text response message.
GoogleCloudDialogflowCxV3RestoreAgentRequest
The request message for Agents.RestoreAgent.
GoogleCloudDialogflowCxV3RestoreAgentRequestGitSource
Settings for restoring from a git branch
GoogleCloudDialogflowCxV3RolloutConfig
The configuration for auto rollout.
GoogleCloudDialogflowCxV3RolloutConfigRolloutStep
A single rollout step with specified traffic allocation.
GoogleCloudDialogflowCxV3RolloutState
State of the auto-rollout process.
GoogleCloudDialogflowCxV3RunTestCaseRequest
The request message for TestCases.RunTestCase.
GoogleCloudDialogflowCxV3SafetySettings
Settings for Generative Safety.
GoogleCloudDialogflowCxV3SafetySettingsPhrase
Text input which can be used for prompt or banned phrases.
GoogleCloudDialogflowCxV3SearchConfig
Search configuration for UCS search queries.
GoogleCloudDialogflowCxV3SecuritySettings
Represents the settings related to security issues, such as data redaction and data retention.
GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings
Settings for exporting audio.
GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings
Settings for exporting conversations to Insights.
GoogleCloudDialogflowCxV3SessionEntityType
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.
GoogleCloudDialogflowCxV3SpeechToTextSettings
Settings related to speech recognition.
GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest
The request to set the feedback for a bot answer.
GoogleCloudDialogflowCxV3SynthesizeSpeechConfig
Configuration of how speech should be synthesized.
GoogleCloudDialogflowCxV3TestCase
Represents a test case.
GoogleCloudDialogflowCxV3TestCaseResult
Represents a result from running a test case in an agent environment.
GoogleCloudDialogflowCxV3TestConfig
Represents configurations for a test case.
GoogleCloudDialogflowCxV3TestRunDifference
The description of differences between original and replayed agent output.
GoogleCloudDialogflowCxV3TextInput
Represents the natural language text to be processed.
GoogleCloudDialogflowCxV3TextToSpeechSettings
Settings related to speech synthesizing.
GoogleCloudDialogflowCxV3TransitionCoverage
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.
GoogleCloudDialogflowCxV3TransitionCoverageTransition
A transition in a page.
GoogleCloudDialogflowCxV3TransitionCoverageTransitionNode
The source or target of a transition.
GoogleCloudDialogflowCxV3TransitionRoute
A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session.
GoogleCloudDialogflowCxV3TransitionRouteGroup
A TransitionRouteGroup represents a group of TransitionRoutes to be used by a Page.
GoogleCloudDialogflowCxV3TransitionRouteGroupCoverage
Transition route group coverage represents the percentage of all possible transition routes present within any of a parent's test cases.
GoogleCloudDialogflowCxV3TransitionRouteGroupCoverageCoverage
Coverage result message for one transition route group.
GoogleCloudDialogflowCxV3TransitionRouteGroupCoverageCoverageTransition
A transition coverage in a transition route group.
GoogleCloudDialogflowCxV3ValidationMessage
Agent/flow validation message.
GoogleCloudDialogflowCxV3VariantsHistory
The history of variants update.
GoogleCloudDialogflowCxV3Version
Represents a version of a flow.
GoogleCloudDialogflowCxV3VersionVariants
A list of flow version variants.
GoogleCloudDialogflowCxV3VersionVariantsVariant
A single flow version with specified traffic allocation.
GoogleCloudDialogflowCxV3VoiceSelectionParams
Description of which voice to use for speech synthesis.
GoogleCloudDialogflowCxV3Webhook
Webhooks host the developer's business logic.
GoogleCloudDialogflowCxV3WebhookGenericWebService
Represents configuration for a generic web service.
GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig
Represents configuration of OAuth client credential flow for 3rd party API authentication.
GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig
Represents configuration for a Service Directory service.
GoogleCloudLocationListLocationsResponse
The response message for Locations.ListLocations.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
ProjectsLocationsAgentsChangelogsResource
ProjectsLocationsAgentsEntityTypesResource
ProjectsLocationsAgentsEnvironmentsContinuousTestResultsResource
ProjectsLocationsAgentsEnvironmentsDeploymentsResource
ProjectsLocationsAgentsEnvironmentsExperimentsResource
ProjectsLocationsAgentsEnvironmentsResource
ProjectsLocationsAgentsEnvironmentsSessionsEntityTypesResource
ProjectsLocationsAgentsEnvironmentsSessionsResource
ProjectsLocationsAgentsFlowsPagesResource
ProjectsLocationsAgentsFlowsResource
ProjectsLocationsAgentsFlowsTransitionRouteGroupsResource
ProjectsLocationsAgentsFlowsVersionsResource
ProjectsLocationsAgentsGeneratorsResource
ProjectsLocationsAgentsIntentsResource
ProjectsLocationsAgentsResource
ProjectsLocationsAgentsSessionsEntityTypesResource
ProjectsLocationsAgentsSessionsResource
ProjectsLocationsAgentsTestCasesResource
ProjectsLocationsAgentsTestCasesResultsResource
ProjectsLocationsAgentsTransitionRouteGroupsResource
ProjectsLocationsAgentsWebhooksResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsLocationsSecuritySettingsResource
ProjectsOperationsResource
ProjectsResource

Typedefs

GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals = $ModelCallSignals
Diagnostic info related to the answer generation model call.
GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals = $ModelCallSignals
Diagnostic info related to the rewriter model call.
GoogleCloudDialogflowCxV3ResponseMessageEndInteraction = $Empty
Indicates that interaction with the Dialogflow agent has ended.
GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard = $Empty
Represents info card response.
GoogleCloudDialogflowCxV3RunContinuousTestRequest = $Empty
The request message for Environments.RunContinuousTest.
GoogleCloudDialogflowCxV3SentimentAnalysisResult = $Shared10
The result of sentiment analysis.
GoogleCloudDialogflowCxV3StartExperimentRequest = $Empty
The request message for Experiments.StartExperiment.
GoogleCloudDialogflowCxV3StopExperimentRequest = $Empty
The request message for Experiments.StopExperiment.
GoogleCloudDialogflowCxV3TrainFlowRequest = $Empty
The request message for Flows.TrainFlow.
GoogleCloudDialogflowCxV3ValidateAgentRequest = $Request08
The request message for Agents.ValidateAgent.
GoogleCloudDialogflowCxV3ValidateFlowRequest = $Request08
The request message for Flows.ValidateFlow.
GoogleCloudLocationLocation = $Location00
A resource that represents a Google Cloud location.
GoogleProtobufEmpty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
GoogleRpcStatus = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
GoogleTypeLatLng = $LatLng
An object that represents a latitude/longitude pair.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.