Package google.cloud.dialogflow.cx.v3

Index

• Agents (interface)
• Changelogs (interface)
• Deployments (interface)
• EntityTypes (interface)
• Environments (interface)
• Experiments (interface)
• Flows (interface)
• Generators (interface)
• Intents (interface)
• Pages (interface)
• SecuritySettingsService (interface)
• SessionEntityTypes (interface)
• Sessions (interface)
• TestCases (interface)
• TransitionRouteGroups (interface)
• Versions (interface)
• Webhooks (interface)
• AdvancedSettings (message)
• AdvancedSettings.DtmfSettings (message)
• AdvancedSettings.LoggingSettings (message)
• AdvancedSettings.SpeechSettings (message)
• Agent (message)
• Agent.AnswerFeedbackSettings (message)
• Agent.ClientCertificateSettings (message)
• Agent.GenAppBuilderSettings (message)
• Agent.GitIntegrationSettings (message)
• Agent.GitIntegrationSettings.GithubSettings (message)
• Agent.PersonalizationSettings (message)
• AgentValidationResult (message)
• AnswerFeedback (message)
• AnswerFeedback.Rating (enum)
• AnswerFeedback.RatingReason (message)
• AudioEncoding (enum)
• AudioInput (message)
• BargeInConfig (message)
• BatchDeleteTestCasesRequest (message)
• BatchRunTestCasesMetadata (message)
• BatchRunTestCasesRequest (message)
• BatchRunTestCasesResponse (message)
• BoostSpec (message)
• BoostSpec.ConditionBoostSpec (message)
• BoostSpec.ConditionBoostSpec.BoostControlSpec (message)
• BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType (enum)
• BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint (message)
• BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType (enum)
• BoostSpecs (message)
• CalculateCoverageRequest (message)
• CalculateCoverageRequest.CoverageType (enum)
• CalculateCoverageResponse (message)
• Changelog (message)
• CloudConversationDebuggingInfo (message)
• CompareVersionsRequest (message)
• CompareVersionsResponse (message)
• ContinuousTestResult (message)
• ContinuousTestResult.AggregatedTestResult (enum)
• ConversationSignals (message)
• ConversationTurn (message)
• ConversationTurn.UserInput (message)
• ConversationTurn.VirtualAgentOutput (message)
• CreateAgentRequest (message)
• CreateEntityTypeRequest (message)
• CreateEnvironmentRequest (message)
• CreateExperimentRequest (message)
• CreateFlowRequest (message)
• CreateGeneratorRequest (message)
• CreateIntentRequest (message)
• CreatePageRequest (message)
• CreateSecuritySettingsRequest (message)
• CreateSessionEntityTypeRequest (message)
• CreateTestCaseRequest (message)
• CreateTransitionRouteGroupRequest (message)
• CreateVersionOperationMetadata (message)
• CreateVersionRequest (message)
• CreateWebhookRequest (message)
• DataStoreConnection (message)
• DataStoreConnectionSignals (message)
• DataStoreConnectionSignals.AnswerGenerationModelCallSignals (message)
• DataStoreConnectionSignals.AnswerPart (message)
• DataStoreConnectionSignals.CitedSnippet (message)
• DataStoreConnectionSignals.GroundingSignals (message)
• DataStoreConnectionSignals.GroundingSignals.GroundingDecision (enum)
• DataStoreConnectionSignals.GroundingSignals.GroundingScoreBucket (enum)
• DataStoreConnectionSignals.RewriterModelCallSignals (message)
• DataStoreConnectionSignals.SafetySignals (message)
• DataStoreConnectionSignals.SafetySignals.BannedPhraseMatch (enum)
• DataStoreConnectionSignals.SafetySignals.SafetyDecision (enum)
• DataStoreConnectionSignals.SearchSnippet (message)
• DataStoreType (enum)
• DeleteAgentRequest (message)
• DeleteEntityTypeRequest (message)
• DeleteEnvironmentRequest (message)
• DeleteExperimentRequest (message)
• DeleteFlowRequest (message)
• DeleteGeneratorRequest (message)
• DeleteIntentRequest (message)
• DeletePageRequest (message)
• DeleteSecuritySettingsRequest (message)
• DeleteSessionEntityTypeRequest (message)
• DeleteTransitionRouteGroupRequest (message)
• DeleteVersionRequest (message)
• DeleteWebhookRequest (message)
• DeployFlowMetadata (message)
• DeployFlowRequest (message)
• DeployFlowResponse (message)
• Deployment (message)
• Deployment.Result (message)
• Deployment.State (enum)
• DetectIntentRequest (message)
• DetectIntentResponse (message)
• DetectIntentResponse.ResponseType (enum)
• DocumentProcessingMode (enum)
• DtmfInput (message)
• EntityType (message)
• EntityType.AutoExpansionMode (enum)
• EntityType.Entity (message)
• EntityType.ExcludedPhrase (message)
• EntityType.Kind (enum)
• Environment (message)
• Environment.TestCasesConfig (message)
• Environment.VersionConfig (message)
• Environment.WebhookConfig (message)
• EventHandler (message)
• EventInput (message)
• Experiment (message)
• Experiment.Definition (message)
• Experiment.Result (message)
• Experiment.Result.ConfidenceInterval (message)
• Experiment.Result.CountType (enum)
• Experiment.Result.Metric (message)
• Experiment.Result.MetricType (enum)
• Experiment.Result.VersionMetrics (message)
• Experiment.State (enum)
• ExportAgentRequest (message)
• ExportAgentRequest.DataFormat (enum)
• ExportAgentRequest.GitDestination (message)
• ExportAgentResponse (message)
• ExportEntityTypesMetadata (message)
• ExportEntityTypesRequest (message)
• ExportEntityTypesRequest.DataFormat (enum)
• ExportEntityTypesResponse (message)
• ExportFlowRequest (message)
• ExportFlowResponse (message)
• ExportIntentsMetadata (message)
• ExportIntentsRequest (message)
• ExportIntentsRequest.DataFormat (enum)
• ExportIntentsResponse (message)
• ExportTestCasesMetadata (message)
• ExportTestCasesRequest (message)
• ExportTestCasesRequest.DataFormat (enum)
• ExportTestCasesResponse (message)
• FilterSpecs (message)
• Flow (message)
• Flow.MultiLanguageSettings (message)
• FlowImportStrategy (message)
• FlowValidationResult (message)
• Form (message)
• Form.Parameter (message)
• Form.Parameter.FillBehavior (message)
• FulfillIntentRequest (message)
• FulfillIntentResponse (message)
• Fulfillment (message)
• Fulfillment.ConditionalCases (message)
• Fulfillment.ConditionalCases.Case (message)
• Fulfillment.ConditionalCases.Case.CaseContent (message)
• Fulfillment.SetParameterAction (message)
• GcsDestination (message)
• GenerativeSettings (message)
• GenerativeSettings.FallbackSettings (message)
• GenerativeSettings.FallbackSettings.PromptTemplate (message)
• GenerativeSettings.KnowledgeConnectorSettings (message)
• Generator (message)
• Generator.ModelParameter (message)
• Generator.Placeholder (message)
• GetAgentRequest (message)
• GetAgentValidationResultRequest (message)
• GetChangelogRequest (message)
• GetDeploymentRequest (message)
• GetEntityTypeRequest (message)
• GetEnvironmentRequest (message)
• GetExperimentRequest (message)
• GetFlowRequest (message)
• GetFlowValidationResultRequest (message)
• GetGenerativeSettingsRequest (message)
• GetGeneratorRequest (message)
• GetIntentRequest (message)
• GetPageRequest (message)
• GetSecuritySettingsRequest (message)
• GetSessionEntityTypeRequest (message)
• GetTestCaseRequest (message)
• GetTestCaseResultRequest (message)
• GetTransitionRouteGroupRequest (message)
• GetVersionRequest (message)
• GetWebhookRequest (message)
• ImportEntityTypesMetadata (message)
• ImportEntityTypesRequest (message)
• ImportEntityTypesRequest.MergeOption (enum)
• ImportEntityTypesResponse (message)
• ImportEntityTypesResponse.ConflictingResources (message)
• ImportFlowRequest (message)
• ImportFlowRequest.ImportOption (enum)
• ImportFlowResponse (message)
• ImportIntentsMetadata (message)
• ImportIntentsRequest (message)
• ImportIntentsRequest.MergeOption (enum)
• ImportIntentsResponse (message)
• ImportIntentsResponse.ConflictingResources (message)
• ImportStrategy (enum)
• ImportTestCasesMetadata (message)
• ImportTestCasesRequest (message)
• ImportTestCasesResponse (message)
• InlineDestination (message)
• InlineSource (message)
• InputAudioConfig (message)
• Intent (message)
• Intent.Parameter (message)
• Intent.TrainingPhrase (message)
• Intent.TrainingPhrase.Part (message)
• IntentCoverage (message)
• IntentCoverage.Intent (message)
• IntentInput (message)
• IntentView (enum)
• KnowledgeConnectorSettings (message)
• LanguageInfo (message)
• ListAgentsRequest (message)
• ListAgentsResponse (message)
• ListChangelogsRequest (message)
• ListChangelogsResponse (message)
• ListContinuousTestResultsRequest (message)
• ListContinuousTestResultsResponse (message)
• ListDeploymentsRequest (message)
• ListDeploymentsResponse (message)
• ListEntityTypesRequest (message)
• ListEntityTypesResponse (message)
• ListEnvironmentsRequest (message)
• ListEnvironmentsResponse (message)
• ListExperimentsRequest (message)
• ListExperimentsResponse (message)
• ListFlowsRequest (message)
• ListFlowsResponse (message)
• ListGeneratorsRequest (message)
• ListGeneratorsResponse (message)
• ListIntentsRequest (message)
• ListIntentsResponse (message)
• ListPagesRequest (message)
• ListPagesResponse (message)
• ListSecuritySettingsRequest (message)
• ListSecuritySettingsResponse (message)
• ListSessionEntityTypesRequest (message)
• ListSessionEntityTypesResponse (message)
• ListTestCaseResultsRequest (message)
• ListTestCaseResultsResponse (message)
• ListTestCasesRequest (message)
• ListTestCasesRequest.TestCaseView (enum)
• ListTestCasesResponse (message)
• ListTransitionRouteGroupsRequest (message)
• ListTransitionRouteGroupsResponse (message)
• ListVersionsRequest (message)
• ListVersionsResponse (message)
• ListWebhooksRequest (message)
• ListWebhooksResponse (message)
• LoadVersionRequest (message)
• LookupEnvironmentHistoryRequest (message)
• LookupEnvironmentHistoryResponse (message)
• Match (message)
• Match.MatchType (enum)
• MatchIntentRequest (message)
• MatchIntentResponse (message)
• NluSettings (message)
• NluSettings.ModelTrainingMode (enum)
• NluSettings.ModelType (enum)
• OutputAudioConfig (message)
• OutputAudioEncoding (enum)
• Page (message)
• PageInfo (message)
• PageInfo.FormInfo (message)
• PageInfo.FormInfo.ParameterInfo (message)
• PageInfo.FormInfo.ParameterInfo.ParameterState (enum)
• Phrase (message)
• QueryInput (message)
• QueryParameters (message)
• QueryResult (message)
• ResourceName (message)
• ResponseMessage (message)
• ResponseMessage.ConversationSuccess (message)
• ResponseMessage.EndInteraction (message)
• ResponseMessage.KnowledgeInfoCard (message)
• ResponseMessage.LiveAgentHandoff (message)
• ResponseMessage.MixedAudio (message)
• ResponseMessage.MixedAudio.Segment (message)
• ResponseMessage.OutputAudioText (message)
• ResponseMessage.PlayAudio (message)
• ResponseMessage.ResponseType (enum)
• ResponseMessage.TelephonyTransferCall (message)
• ResponseMessage.Text (message)
• RestoreAgentRequest (message)
• RestoreAgentRequest.GitSource (message)
• RestoreAgentRequest.RestoreOption (enum)
• RolloutConfig (message)
• RolloutConfig.RolloutStep (message)
• RolloutState (message)
• RunContinuousTestMetadata (message)
• RunContinuousTestRequest (message)
• RunContinuousTestResponse (message)
• RunTestCaseMetadata (message)
• RunTestCaseRequest (message)
• RunTestCaseResponse (message)
• SafetySettings (message)
• SafetySettings.Phrase (message)
• SearchConfig (message)
• SecuritySettings (message)
• SecuritySettings.AudioExportSettings (message)
• SecuritySettings.AudioExportSettings.AudioFormat (enum)
• SecuritySettings.InsightsExportSettings (message)
• SecuritySettings.PurgeDataType (enum)
• SecuritySettings.RedactionScope (enum)
• SecuritySettings.RedactionStrategy (enum)
• SecuritySettings.RetentionStrategy (enum)
• SentimentAnalysisResult (message)
• SessionEntityType (message)
• SessionEntityType.EntityOverrideMode (enum)
• SessionInfo (message)
• SpeechModelVariant (enum)
• SpeechToTextSettings (message)
• SpeechWordInfo (message)
• SsmlVoiceGender (enum)
• StartExperimentRequest (message)
• StopExperimentRequest (message)
• StreamingDetectIntentRequest (message)
• StreamingDetectIntentResponse (message)
• StreamingRecognitionResult (message)
• StreamingRecognitionResult.MessageType (enum)
• SubmitAnswerFeedbackRequest (message)
• SynthesizeSpeechConfig (message)
• TestCase (message)
• TestCaseError (message)
• TestCaseResult (message)
• TestConfig (message)
• TestError (message)
• TestResult (enum)
• TestRunDifference (message)
• TestRunDifference.DiffType (enum)
• TextInput (message)
• TextToSpeechSettings (message)
• TrainFlowRequest (message)
• TransitionCoverage (message)
• TransitionCoverage.Transition (message)
• TransitionCoverage.TransitionNode (message)
• TransitionRoute (message)
• TransitionRouteGroup (message)
• TransitionRouteGroupCoverage (message)
• TransitionRouteGroupCoverage.Coverage (message)
• TransitionRouteGroupCoverage.Coverage.Transition (message)
• TurnSignals (message)
• TurnSignals.FailureReason (enum)
• UpdateAgentRequest (message)
• UpdateEntityTypeRequest (message)
• UpdateEnvironmentRequest (message)
• UpdateExperimentRequest (message)
• UpdateFlowRequest (message)
• UpdateGenerativeSettingsRequest (message)
• UpdateGeneratorRequest (message)
• UpdateIntentRequest (message)
• UpdatePageRequest (message)
• UpdateSecuritySettingsRequest (message)
• UpdateSessionEntityTypeRequest (message)
• UpdateTestCaseRequest (message)
• UpdateTransitionRouteGroupRequest (message)
• UpdateVersionRequest (message)
• UpdateWebhookRequest (message)
• ValidateAgentRequest (message)
• ValidateFlowRequest (message)
• ValidationMessage (message)
• ValidationMessage.ResourceType (enum)
• ValidationMessage.Severity (enum)
• VariantsHistory (message)
• Version (message)
• Version.State (enum)
• VersionVariants (message)
• VersionVariants.Variant (message)
• VoiceSelectionParams (message)
• Webhook (message)
• Webhook.GenericWebService (message)
• Webhook.GenericWebService.HttpMethod (enum)
• Webhook.GenericWebService.OAuthConfig (message)
• Webhook.GenericWebService.ServiceAgentAuth (enum)
• Webhook.GenericWebService.WebhookType (enum)
• Webhook.ServiceDirectoryConfig (message)
• WebhookRequest (message)
• WebhookRequest.FulfillmentInfo (message)
• WebhookRequest.IntentInfo (message)
• WebhookRequest.IntentInfo.IntentParameterValue (message)
• WebhookRequest.SentimentAnalysisResult (message)
• WebhookResponse (message)
• WebhookResponse.FulfillmentResponse (message)
• WebhookResponse.FulfillmentResponse.MergeBehavior (enum)

Agents

Service for managing Agents.

CreateAgent

rpc CreateAgent(CreateAgentRequest) returns (Agent) Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteAgent
rpc DeleteAgent(DeleteAgentRequest) returns (Empty) Deletes the specified agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ExportAgent

rpc ExportAgent(ExportAgentRequest) returns (Operation) Exports the specified agent to a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: ExportAgentResponse Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetAgent
rpc GetAgent(GetAgentRequest) returns (Agent) Retrieves the specified agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetAgentValidationResult

rpc GetAgentValidationResult(GetAgentValidationResultRequest) returns (AgentValidationResult) Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetGenerativeSettings
rpc GetGenerativeSettings(GetGenerativeSettingsRequest) returns (GenerativeSettings) Gets the generative settings for the agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListAgents
rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse) Returns the list of all agents in the specified location. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

RestoreAgent

rpc RestoreAgent(RestoreAgentRequest) returns (Operation) Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message Note: You should always train flows prior to sending them queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateAgent
rpc UpdateAgent(UpdateAgentRequest) returns (Agent) Updates the specified agent. Note: You should always train flows prior to sending them queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateGenerativeSettings
rpc UpdateGenerativeSettings(UpdateGenerativeSettingsRequest) returns (GenerativeSettings) Updates the generative settings for the agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ValidateAgent

rpc ValidateAgent(ValidateAgentRequest) returns (AgentValidationResult) Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Changelogs

Service for managing Changelogs.

GetChangelog
rpc GetChangelog(GetChangelogRequest) returns (Changelog) Retrieves the specified Changelog. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListChangelogs
rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse) Returns the list of Changelogs. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Deployments

Service for managing Deployments.

GetDeployment
rpc GetDeployment(GetDeploymentRequest) returns (Deployment) Retrieves the specified Deployment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListDeployments
rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) Returns the list of all deployments in the specified Environment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

EntityTypes

Service for managing EntityTypes.

CreateEntityType

rpc CreateEntityType(CreateEntityTypeRequest) returns (EntityType) Creates an entity type in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteEntityType

rpc DeleteEntityType(DeleteEntityTypeRequest) returns (Empty) Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ExportEntityTypes
rpc ExportEntityTypes(ExportEntityTypesRequest) returns (Operation) Exports the selected entity types. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetEntityType
rpc GetEntityType(GetEntityTypeRequest) returns (EntityType) Retrieves the specified entity type. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ImportEntityTypes
rpc ImportEntityTypes(ImportEntityTypesRequest) returns (Operation) Imports the specified entitytypes into the agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListEntityTypes
rpc ListEntityTypes(ListEntityTypesRequest) returns (ListEntityTypesResponse) Returns the list of all entity types in the specified agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateEntityType

rpc UpdateEntityType(UpdateEntityTypeRequest) returns (EntityType) Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Environments

Service for managing Environments.

CreateEnvironment

rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation) Creates an Environment in the specified Agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: Environment Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteEnvironment
rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Empty) Deletes the specified Environment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeployFlow

rpc DeployFlow(DeployFlowRequest) returns (Operation) Deploys a flow to the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: DeployFlowMetadata response: DeployFlowResponse Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetEnvironment
rpc GetEnvironment(GetEnvironmentRequest) returns (Environment) Retrieves the specified Environment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListContinuousTestResults
rpc ListContinuousTestResults(ListContinuousTestResultsRequest) returns (ListContinuousTestResultsResponse) Fetches a list of continuous test results for a given environment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListEnvironments
rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) Returns the list of all environments in the specified Agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

LookupEnvironmentHistory
rpc LookupEnvironmentHistory(LookupEnvironmentHistoryRequest) returns (LookupEnvironmentHistoryResponse) Looks up the history of the specified Environment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

RunContinuousTest

rpc RunContinuousTest(RunContinuousTestRequest) returns (Operation) Kicks off a continuous test under the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: RunContinuousTestMetadata response: RunContinuousTestResponse Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateEnvironment

rpc UpdateEnvironment(UpdateEnvironmentRequest) returns (Operation) Updates the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: Environment Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Experiments

Service for managing Experiments.

CreateExperiment
rpc CreateExperiment(CreateExperimentRequest) returns (Experiment) Creates an Experiment in the specified Environment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteExperiment
rpc DeleteExperiment(DeleteExperimentRequest) returns (Empty) Deletes the specified Experiment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetExperiment
rpc GetExperiment(GetExperimentRequest) returns (Experiment) Retrieves the specified Experiment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListExperiments
rpc ListExperiments(ListExperimentsRequest) returns (ListExperimentsResponse) Returns the list of all experiments in the specified Environment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

StartExperiment
rpc StartExperiment(StartExperimentRequest) returns (Experiment) Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

StopExperiment
rpc StopExperiment(StopExperimentRequest) returns (Experiment) Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateExperiment
rpc UpdateExperiment(UpdateExperimentRequest) returns (Experiment) Updates the specified Experiment. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Flows

Service for managing Flows.

CreateFlow
rpc CreateFlow(CreateFlowRequest) returns (Flow) Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteFlow
rpc DeleteFlow(DeleteFlowRequest) returns (Empty) Deletes a specified flow. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ExportFlow

rpc ExportFlow(ExportFlowRequest) returns (Operation) Exports the specified flow to a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetFlow
rpc GetFlow(GetFlowRequest) returns (Flow) Retrieves the specified flow. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetFlowValidationResult
rpc GetFlowValidationResult(GetFlowValidationResultRequest) returns (FlowValidationResult) Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ImportFlow

rpc ImportFlow(ImportFlowRequest) returns (Operation) Imports the specified flow to the specified agent from a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: ImportFlowResponse Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListFlows
rpc ListFlows(ListFlowsRequest) returns (ListFlowsResponse) Returns the list of all flows in the specified agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

TrainFlow

rpc TrainFlow(TrainFlowRequest) returns (Operation) Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateFlow
rpc UpdateFlow(UpdateFlowRequest) returns (Flow) Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ValidateFlow

rpc ValidateFlow(ValidateFlowRequest) returns (FlowValidationResult) Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Generators

Service for managing Generators

CreateGenerator
rpc CreateGenerator(CreateGeneratorRequest) returns (Generator) Creates a generator in the specified agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteGenerator
rpc DeleteGenerator(DeleteGeneratorRequest) returns (Empty) Deletes the specified generators. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetGenerator
rpc GetGenerator(GetGeneratorRequest) returns (Generator) Retrieves the specified generator. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListGenerators
rpc ListGenerators(ListGeneratorsRequest) returns (ListGeneratorsResponse) Returns the list of all generators in the specified agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateGenerator
rpc UpdateGenerator(UpdateGeneratorRequest) returns (Generator) Update the specified generator. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Intents

Service for managing Intents.

CreateIntent

rpc CreateIntent(CreateIntentRequest) returns (Intent) Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteIntent
rpc DeleteIntent(DeleteIntentRequest) returns (Empty) Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ExportIntents

rpc ExportIntents(ExportIntentsRequest) returns (Operation) Exports the selected intents. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: ExportIntentsMetadata response: ExportIntentsResponse Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetIntent
rpc GetIntent(GetIntentRequest) returns (Intent) Retrieves the specified intent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ImportIntents

rpc ImportIntents(ImportIntentsRequest) returns (Operation) Imports the specified intents into the agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: ImportIntentsMetadata response: ImportIntentsResponse Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListIntents
rpc ListIntents(ListIntentsRequest) returns (ListIntentsResponse) Returns the list of all intents in the specified agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateIntent
rpc UpdateIntent(UpdateIntentRequest) returns (Intent) Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Pages

Service for managing Pages.

CreatePage
rpc CreatePage(CreatePageRequest) returns (Page) Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeletePage
rpc DeletePage(DeletePageRequest) returns (Empty) Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetPage
rpc GetPage(GetPageRequest) returns (Page) Retrieves the specified page. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListPages
rpc ListPages(ListPagesRequest) returns (ListPagesResponse) Returns the list of all pages in the specified flow. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdatePage
rpc UpdatePage(UpdatePageRequest) returns (Page) Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

SecuritySettingsService

Service for managing security settings for Dialogflow.

CreateSecuritySettings
rpc CreateSecuritySettings(CreateSecuritySettingsRequest) returns (SecuritySettings) Create security settings in the specified location. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteSecuritySettings
rpc DeleteSecuritySettings(DeleteSecuritySettingsRequest) returns (Empty) Deletes the specified SecuritySettings. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetSecuritySettings
rpc GetSecuritySettings(GetSecuritySettingsRequest) returns (SecuritySettings) Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListSecuritySettings
rpc ListSecuritySettings(ListSecuritySettingsRequest) returns (ListSecuritySettingsResponse) Returns the list of all security settings in the specified location. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateSecuritySettings
rpc UpdateSecuritySettings(UpdateSecuritySettingsRequest) returns (SecuritySettings) Updates the specified SecuritySettings. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

SessionEntityTypes

Service for managing SessionEntityTypes.

CreateSessionEntityType
rpc CreateSessionEntityType(CreateSessionEntityTypeRequest) returns (SessionEntityType) Creates a session entity type. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteSessionEntityType
rpc DeleteSessionEntityType(DeleteSessionEntityTypeRequest) returns (Empty) Deletes the specified session entity type. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetSessionEntityType
rpc GetSessionEntityType(GetSessionEntityTypeRequest) returns (SessionEntityType) Retrieves the specified session entity type. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListSessionEntityTypes
rpc ListSessionEntityTypes(ListSessionEntityTypesRequest) returns (ListSessionEntityTypesResponse) Returns the list of all session entity types in the specified session. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateSessionEntityType
rpc UpdateSessionEntityType(UpdateSessionEntityTypeRequest) returns (SessionEntityType) Updates the specified session entity type. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Sessions

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.

DetectIntent

rpc DetectIntent(DetectIntentRequest) returns (DetectIntentResponse) Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

FulfillIntent

rpc FulfillIntent(FulfillIntentRequest) returns (FulfillIntentResponse) Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

MatchIntent
rpc MatchIntent(MatchIntentRequest) returns (MatchIntentResponse) Returns preliminary intent match results, doesn't change the session status. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ServerStreamingDetectIntent

rpc ServerStreamingDetectIntent(DetectIntentRequest) returns (DetectIntentResponse) Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

StreamingDetectIntent

rpc StreamingDetectIntent(StreamingDetectIntentRequest) returns (StreamingDetectIntentResponse) Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST). Note: Always use agent versions for production traffic. See Versions and environments. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

SubmitAnswerFeedback
rpc SubmitAnswerFeedback(SubmitAnswerFeedbackRequest) returns (AnswerFeedback) Updates the feedback received from the user for a single turn of the bot response. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

TestCases

Service for managing Test Cases and Test Case Results.

BatchDeleteTestCases
rpc BatchDeleteTestCases(BatchDeleteTestCasesRequest) returns (Empty) Batch deletes test cases. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

BatchRunTestCases

rpc BatchRunTestCases(BatchRunTestCasesRequest) returns (Operation) Kicks off a batch run of test cases. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: BatchRunTestCasesMetadata response: BatchRunTestCasesResponse Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

CalculateCoverage
rpc CalculateCoverage(CalculateCoverageRequest) returns (CalculateCoverageResponse) Calculates the test coverage for an agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

CreateTestCase
rpc CreateTestCase(CreateTestCaseRequest) returns (TestCase) Creates a test case for the given agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ExportTestCases

rpc ExportTestCases(ExportTestCasesRequest) returns (Operation) Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: ExportTestCasesMetadata response: ExportTestCasesResponse Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetTestCase
rpc GetTestCase(GetTestCaseRequest) returns (TestCase) Gets a test case. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetTestCaseResult
rpc GetTestCaseResult(GetTestCaseResultRequest) returns (TestCaseResult) Gets a test case result. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ImportTestCases

rpc ImportTestCases(ImportTestCasesRequest) returns (Operation) Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: ImportTestCasesMetadata response: ImportTestCasesResponse Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListTestCaseResults

rpc ListTestCaseResults(ListTestCaseResultsRequest) returns (ListTestCaseResultsResponse) Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListTestCases
rpc ListTestCases(ListTestCasesRequest) returns (ListTestCasesResponse) Fetches a list of test cases for a given agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

RunTestCase

rpc RunTestCase(RunTestCaseRequest) returns (Operation) Kicks off a test case run. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: RunTestCaseMetadata response: RunTestCaseResponse Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateTestCase
rpc UpdateTestCase(UpdateTestCaseRequest) returns (TestCase) Updates the specified test case. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

TransitionRouteGroups

Service for managing TransitionRouteGroups.

CreateTransitionRouteGroup

rpc CreateTransitionRouteGroup(CreateTransitionRouteGroupRequest) returns (TransitionRouteGroup) Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteTransitionRouteGroup

rpc DeleteTransitionRouteGroup(DeleteTransitionRouteGroupRequest) returns (Empty) Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetTransitionRouteGroup
rpc GetTransitionRouteGroup(GetTransitionRouteGroupRequest) returns (TransitionRouteGroup) Retrieves the specified TransitionRouteGroup. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListTransitionRouteGroups
rpc ListTransitionRouteGroups(ListTransitionRouteGroupsRequest) returns (ListTransitionRouteGroupsResponse) Returns the list of all transition route groups in the specified flow. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateTransitionRouteGroup

rpc UpdateTransitionRouteGroup(UpdateTransitionRouteGroupRequest) returns (TransitionRouteGroup) Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Versions

Service for managing Versions.

CompareVersions
rpc CompareVersions(CompareVersionsRequest) returns (CompareVersionsResponse) Compares the specified base version with target version. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

CreateVersion

rpc CreateVersion(CreateVersionRequest) returns (Operation) Creates a Version in the specified Flow. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: CreateVersionOperationMetadata response: Version Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteVersion
rpc DeleteVersion(DeleteVersionRequest) returns (Empty) Deletes the specified Version. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetVersion
rpc GetVersion(GetVersionRequest) returns (Version) Retrieves the specified Version. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListVersions
rpc ListVersions(ListVersionsRequest) returns (ListVersionsResponse) Returns the list of all versions in the specified Flow. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

LoadVersion

rpc LoadVersion(LoadVersionRequest) returns (Operation) Loads resources in the specified version to the draft flow. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateVersion
rpc UpdateVersion(UpdateVersionRequest) returns (Version) Updates the specified Version. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Webhooks

Service for managing Webhooks.

CreateWebhook
rpc CreateWebhook(CreateWebhookRequest) returns (Webhook) Creates a webhook in the specified agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteWebhook
rpc DeleteWebhook(DeleteWebhookRequest) returns (Empty) Deletes the specified webhook. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetWebhook
rpc GetWebhook(GetWebhookRequest) returns (Webhook) Retrieves the specified webhook. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListWebhooks
rpc ListWebhooks(ListWebhooksRequest) returns (ListWebhooksResponse) Returns the list of all webhooks in the specified agent. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateWebhook
rpc UpdateWebhook(UpdateWebhookRequest) returns (Webhook) Updates the specified webhook. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

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.

Fields
audio_export_gcs_destination	GcsDestination If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
speech_settings	SpeechSettings Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
dtmf_settings	DtmfSettings Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
logging_settings	LoggingSettings Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

DtmfSettings

Define behaviors for DTMF (dual tone multi frequency).

Fields
enabled	bool If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
max_digits	int32 Max length of DTMF digits.
finish_digit	string The digit that terminates a DTMF digit sequence.
interdigit_timeout_duration	Duration Interdigit timeout setting for matching dtmf input to regex.
endpointing_timeout_duration	Duration Endpoint timeout setting for matching dtmf input to regex.

LoggingSettings

Define behaviors on logging.

Fields
enable_stackdriver_logging	bool Enables Google Cloud Logging.
enable_interaction_logging	bool Enables DF Interaction logging.
enable_consent_based_redaction	bool Enables consent-based end-user input redaction, if true, a pre-defined session parameter $session.params.conversation-redaction will be used to determine if the utterance should be redacted.

SpeechSettings

Define behaviors of speech to text detection.

Fields
endpointer_sensitivity	int32 Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
no_speech_timeout	Duration Timeout before detecting no speech.
use_timeout_based_endpointing	bool Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
models	map<string, string> Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see Speech models.

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, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.

Fields
name	string The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
display_name	string Required. The human-readable name of the agent, unique within the location.
default_language_code	string Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
supported_language_codes[]	string The list of all languages supported by the agent (except for the default_language_code).
time_zone	string Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
description	string The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
avatar_uri	string The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
speech_to_text_settings	SpeechToTextSettings Speech recognition related settings.
start_flow	string Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.
security_settings	string Name of the SecuritySettings reference for the agent. Format: projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>.
enable_stackdriver_logging (deprecated)	bool This item is deprecated! Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
enable_spell_correction	bool Indicates if automatic spell correction is enabled in detect intent requests.
enable_multi_language_training	bool Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
locked	bool Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].
advanced_settings	AdvancedSettings Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
git_integration_settings	GitIntegrationSettings Git integration settings for this agent.
text_to_speech_settings	TextToSpeechSettings Settings on instructing the speech synthesizer on how to generate the output audio content.
answer_feedback_settings	AnswerFeedbackSettings Optional. Answer feedback collection settings.
personalization_settings	PersonalizationSettings Optional. Settings for end user personalization.
client_certificate_settings	ClientCertificateSettings Optional. Settings for custom client certificates.
satisfies_pzs	bool Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
satisfies_pzi	bool Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
gen_app_builder_settings	GenAppBuilderSettings Gen App Builder-related agent-level settings.

AnswerFeedbackSettings

Settings for answer feedback collection.

Fields
enable_answer_feedback	bool Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.

ClientCertificateSettings

Settings for custom client certificates.

Fields
ssl_certificate	string Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
private_key	string Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase	string Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: projects/{project}/secrets/{secret}/versions/{version}

GenAppBuilderSettings

Settings for Gen App Builder.

Fields
engine	string Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}

GitIntegrationSettings

Settings for connecting to Git repository for an agent.

Fields
Union field git_settings. The git settings to specific systems. git_settings can be only one of the following:
github_settings	GithubSettings GitHub settings.

GithubSettings

Settings of integration with GitHub.

Fields
display_name	string The unique repository display name for the GitHub repository.
repository_uri	string The GitHub repository URI related to the agent.
tracking_branch	string The branch of the GitHub repository tracked for this agent.
access_token	string The access token used to authenticate the access to the GitHub repository.
branches[]	string A list of branches configured to be used from Dialogflow.

PersonalizationSettings

Settings for end user personalization.

Fields
default_end_user_metadata	Struct Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.

AgentValidationResult

The response message for Agents.GetAgentValidationResult.

Fields
name	string The unique identifier of the agent validation result. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/validationResult.
flow_validation_results[]	FlowValidationResult Contains all flow validation results.

AnswerFeedback

Stores information about feedback provided by users about a response.

Fields
rating	Rating Optional. Rating from user for the specific Dialogflow response.
rating_reason	RatingReason Optional. In case of thumbs down rating provided, users can optionally provide context about the rating.
custom_rating	string Optional. Custom rating from the user about the provided answer, with maximum length of 1024 characters. For example, client could use a customized JSON object to indicate the rating.

Rating

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

Enums
RATING_UNSPECIFIED	Rating not specified.
THUMBS_UP	Thumbs up feedback from user.
THUMBS_DOWN	Thumbs down feedback from user.

RatingReason

Stores extra information about why users provided thumbs down rating.

Fields
reason_labels[]	string Optional. Custom reason labels for thumbs down rating provided by the user. The maximum number of labels allowed is 10 and the maximum length of a single label is 128 characters.
feedback	string Optional. Additional feedback about the rating. This field can be populated without choosing a predefined reason.

AudioEncoding

Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.

Enums
AUDIO_ENCODING_UNSPECIFIED	Not specified.
AUDIO_ENCODING_LINEAR_16	Uncompressed 16-bit signed little-endian samples (Linear PCM).
AUDIO_ENCODING_FLAC	FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported.
AUDIO_ENCODING_MULAW	8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
AUDIO_ENCODING_AMR	Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000.
AUDIO_ENCODING_AMR_WB	Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000.
AUDIO_ENCODING_OGG_OPUS	Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000.
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE	Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000.
AUDIO_ENCODING_ALAW	8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law.

AudioInput

Represents the natural speech audio to be processed.

Fields
config	InputAudioConfig Required. Instructs the speech recognizer how to process the speech audio.
audio	bytes The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests.

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 start of the input audio.

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

Fields
no_barge_in_duration	Duration Duration that is not eligible for barge-in at the beginning of the input audio.
total_duration	Duration Total duration for the playback at the beginning of the input audio.

BatchDeleteTestCasesRequest

The request message for TestCases.BatchDeleteTestCases.

Fields
parent	string Required. The agent to delete test cases from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.testcases.delete
names[]	string Required. Format of test case names: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>.

BatchRunTestCasesMetadata

Metadata returned for the TestCases.BatchRunTestCases long running operation.

Fields
errors[]	TestError The test errors.

BatchRunTestCasesRequest

The request message for TestCases.BatchRunTestCases.

Fields
parent	string Required. Agent name. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
environment	string Optional. If not set, draft environment is assumed. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>.
test_cases[]	string Required. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>.

BatchRunTestCasesResponse

The response message for TestCases.BatchRunTestCases.

Fields
results[]	TestCaseResult The test case results. The detailed conversation turns are empty in this response.

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

Fields
condition_boost_specs[]	ConditionBoostSpec Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

ConditionBoostSpec

Boost applies to documents which match a condition.

Fields
condition	string Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
boost	float Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
boost_control_spec	BoostControlSpec Optional. Complex specification for custom ranking based on customer defined attribute value.

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.

Fields
field_name	string Optional. The name of the field whose value will be used to determine the boost amount.
attribute_type	AttributeType Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
interpolation_type	InterpolationType Optional. The interpolation type to be applied to connect the control points listed below.
control_points[]	ControlPoint Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.

AttributeType

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

Enums
ATTRIBUTE_TYPE_UNSPECIFIED	Unspecified AttributeType.
NUMERICAL	The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.
FRESHNESS	For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD][T[nH][nM][nS]]. E.g. 5D, 3DT12H30M, T24H.

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

Fields
attribute_value	string Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD][T[nH][nM][nS]].
boost_amount	float Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.

InterpolationType

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

Enums
INTERPOLATION_TYPE_UNSPECIFIED	Interpolation type is unspecified. In this case, it defaults to Linear.
LINEAR	Piecewise linear interpolation will be applied.

BoostSpecs

Boost specifications for data stores.

Fields
data_stores[]	string Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store}
spec[]	BoostSpec Optional. A list of boosting specifications.

CalculateCoverageRequest

The request message for TestCases.CalculateCoverage.

Fields
agent	string Required. The agent to calculate coverage for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource agent: dialogflow.testcases.calculateCoverage
type	CoverageType Required. The type of coverage requested.

CoverageType

The type of coverage score requested.

Enums
COVERAGE_TYPE_UNSPECIFIED	Should never be used.
INTENT	Intent coverage.
PAGE_TRANSITION	Page transition coverage.
TRANSITION_ROUTE_GROUP	Transition route group coverage.

CalculateCoverageResponse

The response message for TestCases.CalculateCoverage.

Fields
agent	string The agent to calculate coverage for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
Union field coverage_type. The type of coverage requested. coverage_type can be only one of the following:
intent_coverage	IntentCoverage Intent coverage.
transition_coverage	TransitionCoverage Transition (excluding transition route groups) coverage.
route_group_coverage	TransitionRouteGroupCoverage Transition route group coverage.

Changelog

Changelogs represents a change made to a given agent.

Fields
name	string The unique identifier of the changelog. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/changelogs/<ChangelogID>.
user_email	string Email address of the authenticated user.
display_name	string The affected resource display name of the change.
action	string The action of the change.
type	string The affected resource type.
resource	string The affected resource name of the change.
create_time	Timestamp The timestamp of the change.
language_code	string The affected language code of the change.

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.

Fields
audio_data_chunks	int32 Number of input audio data chunks in streaming requests.
result_end_time_offset	Duration Time offset of the end of speech utterance relative to the beginning of the first audio chunk.
first_audio_duration	Duration Duration of first audio chunk.
single_utterance	bool Whether client used single utterance mode.
speech_partial_results_end_times[]	Duration Time offsets of the speech partial results relative to the beginning of the stream.
speech_final_results_end_times[]	Duration Time offsets of the speech final results (is_final=true) relative to the beginning of the stream.
partial_responses	int32 Total number of partial responses.
speaker_id_passive_latency_ms_offset	int32 Time offset of Speaker ID stream close time relative to the Speech stream close time in milliseconds. Only meaningful for conversations involving passive verification.
bargein_event_triggered	bool Whether a barge-in event is triggered in this request.
speech_single_utterance	bool Whether speech uses single utterance mode.
dtmf_partial_results_times[]	Duration Time offsets of the DTMF partial results relative to the beginning of the stream.
dtmf_final_results_times[]	Duration Time offsets of the DTMF final results relative to the beginning of the stream.
single_utterance_end_time_offset	Duration Time offset of the end-of-single-utterance signal relative to the beginning of the stream.
no_speech_timeout	Duration No speech timeout settings for the stream.
endpointing_timeout	Duration Speech endpointing timeout settings for the stream.
is_input_text	bool Whether the streaming terminates with an injected text query.
client_half_close_time_offset	Duration Client half close time in terms of input audio duration.
client_half_close_streaming_time_offset	Duration Client half close time in terms of API streaming duration.

CompareVersionsRequest

The request message for Versions.CompareVersions.

Fields
base_version	string Required. Name of the base flow version to compare with the target version. Use version ID 0 to indicate the draft version of the specified flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>. Authorization requires the following IAM permission on the specified resource baseVersion: dialogflow.versions.get
target_version	string Required. Name of the target flow version to compare with the base version. Use version ID 0 to indicate the draft version of the specified flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>. Authorization requires the following IAM permission on the specified resource targetVersion: dialogflow.versions.get
language_code	string The language to compare the flow versions for. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

CompareVersionsResponse

The response message for Versions.CompareVersions.

Fields
base_version_content_json	string JSON representation of the base version content.
target_version_content_json	string JSON representation of the target version content.
compare_time	Timestamp The timestamp when the two version compares.

ContinuousTestResult

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

Fields
name	string The resource name for the continuous test result. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/continuousTestResults/<ContinuousTestResultID>.
result	AggregatedTestResult The result of this continuous test run, i.e. whether all the tests in this continuous test run pass or not.
test_case_results[]	string A list of individual test case results names in this continuous test run.
run_time	Timestamp Time when the continuous testing run starts.

AggregatedTestResult

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

Enums
AGGREGATED_TEST_RESULT_UNSPECIFIED	Not specified. Should never be used.
PASSED	All the tests passed.
FAILED	At least one test did not pass.

ConversationSignals

This message is used to hold all the Conversation Signals data, which will be converted to JSON and exported to BigQuery.

Fields
turn_signals	TurnSignals Required. Turn signals for the current turn.

ConversationTurn

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

Fields
user_input	UserInput The user input.
virtual_agent_output	VirtualAgentOutput The virtual agent output.

UserInput

The input from the human user.

Fields
input	QueryInput Supports text input, event input, dtmf input in the test case.
injected_parameters	Struct Parameters that need to be injected into the conversation during intent detection.
is_webhook_enabled	bool If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.
enable_sentiment_analysis	bool Whether sentiment analysis is enabled.

VirtualAgentOutput

The output from the virtual agent.

Fields
session_parameters	Struct The session parameters available to the bot at this point.
differences[]	TestRunDifference Output only. If this is part of a [result conversation turn][TestCaseResult.conversation_turns], the list of differences between the original run and the replay for this output, if any.
diagnostic_info	Struct Required. Input only. The diagnostic [info][Session.DetectIntentResponse.QueryResult.diagnostic_info] output for the turn. Required to calculate the testing coverage.
triggered_intent	Intent The Intent that triggered the response. Only name and displayName will be set.
current_page	Page The Page on which the utterance was spoken. Only name and displayName will be set.
text_responses[]	Text The text responses from the agent for the turn.
status	Status Response error from the agent in the test result. If set, other output is empty.

CreateAgentRequest

The request message for Agents.CreateAgent.

Fields
parent	string Required. The location to create a agent for. Format: projects/<ProjectID>/locations/<LocationID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.agents.create
agent	Agent Required. The agent to create.

CreateEntityTypeRequest

The request message for EntityTypes.CreateEntityType.

Fields
parent	string Required. The agent to create a entity type for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.entityTypes.create
entity_type	EntityType Required. The entity type to create.
language_code	string The language of the following fields in entity_type: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

CreateEnvironmentRequest

The request message for Environments.CreateEnvironment.

Fields
parent	string Required. The Agent to create an Environment for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.environments.create
environment	Environment Required. The environment to create.

CreateExperimentRequest

The request message for Experiments.CreateExperiment.

Fields
parent	string Required. The Agent to create an Environment for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.experiments.create
experiment	Experiment Required. The experiment to create.

CreateFlowRequest

The request message for Flows.CreateFlow.

Fields
parent	string Required. The agent to create a flow for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.flows.create
flow	Flow Required. The flow to create.
language_code	string The language of the following fields in flow: Flow.event_handlers.trigger_fulfillment.messages Flow.event_handlers.trigger_fulfillment.conditional_cases Flow.transition_routes.trigger_fulfillment.messages Flow.transition_routes.trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

CreateGeneratorRequest

The request message for Generators.CreateGenerator.

Fields
parent	string Required. The agent to create a generator for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.generators.create
generator	Generator Required. The generator to create.
language_code	string The language to create generators for the following fields: * Generator.prompt_text.text If not specified, the agent's default language is used.

CreateIntentRequest

The request message for Intents.CreateIntent.

Fields
parent	string Required. The agent to create an intent for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.intents.create
intent	Intent Required. The intent to create.
language_code	string The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

CreatePageRequest

The request message for Pages.CreatePage.

Fields
parent	string Required. The flow to create a page for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.pages.create
page	Page Required. The page to create.
language_code	string The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages * Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.transition_routes.trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

CreateSecuritySettingsRequest

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

Fields
parent	string Required. The location to create an SecuritySettings for. Format: projects/<ProjectID>/locations/<LocationID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.securitySettings.create
security_settings	SecuritySettings Required. The security settings to create.

CreateSessionEntityTypeRequest

The request message for SessionEntityTypes.CreateSessionEntityType.

Fields
parent	string Required. The session to create a session entity type for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>. If Environment ID is not specified, we assume default 'draft' environment. Authorization requires the following IAM permission on the specified resource parent: dialogflow.sessionEntityTypes.create
session_entity_type	SessionEntityType Required. The session entity type to create.

CreateTestCaseRequest

The request message for TestCases.CreateTestCase.

Fields
parent	string Required. The agent to create the test case for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.testcases.create
test_case	TestCase Required. The test case to create.

CreateTransitionRouteGroupRequest

The request message for TransitionRouteGroups.CreateTransitionRouteGroup.

Fields
parent	string Required. The flow to create an TransitionRouteGroup for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID> for agent-level groups. Authorization requires the following IAM permission on the specified resource parent: dialogflow.transitionRouteGroups.create
transition_route_group	TransitionRouteGroup Required. The transition route group to create.
language_code	string The language of the following fields in TransitionRouteGroup: TransitionRouteGroup.transition_routes.trigger_fulfillment.messages * TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

CreateVersionOperationMetadata

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

Fields
version	string Name of the created version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.

CreateVersionRequest

The request message for Versions.CreateVersion.

Fields
parent	string Required. The Flow to create an Version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.versions.create
version	Version Required. The version to create.

CreateWebhookRequest

The request message for Webhooks.CreateWebhook.

Fields
parent	string Required. The agent to create a webhook for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.webhooks.create
webhook	Webhook Required. The webhook to create.

DataStoreConnection

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

Fields
data_store_type	DataStoreType The type of the connected data store.
data_store	string The full name of the referenced data store. Formats: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store}
document_processing_mode	DocumentProcessingMode The document processing mode for the data store connection. Should only be set for PUBLIC_WEB and UNSTRUCTURED data stores. If not set it is considered as DOCUMENTS, as this is the legacy mode.

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

Fields
rewriter_model_call_signals	RewriterModelCallSignals Optional. Diagnostic info related to the rewriter model call.
rewritten_query	string Optional. Rewritten string query used for search.
search_snippets[]	SearchSnippet Optional. Search snippets included in the answer generation prompt.
answer_generation_model_call_signals	AnswerGenerationModelCallSignals Optional. Diagnostic info related to the answer generation model call.
answer	string Optional. The final compiled answer.
answer_parts[]	AnswerPart Optional. Answer parts with relevant citations. Concatenation of texts should add up the answer (not counting whitespaces).
cited_snippets[]	CitedSnippet Optional. Snippets cited by the answer generation model from the most to least relevant.
grounding_signals	GroundingSignals Optional. Grounding signals.
safety_signals	SafetySignals Optional. Safety check result.

AnswerGenerationModelCallSignals

Diagnostic info related to the answer generation model call.

Fields
rendered_prompt	string Prompt as sent to the model.
model_output	string Output of the generative model.
model	string Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.

AnswerPart

Answer part with citation.

Fields
text	string Substring of the answer.
supporting_indices[]	int32 Citations for this answer part. Indices of search_snippets.

CitedSnippet

Snippet cited by the answer generation model.

Fields
search_snippet	SearchSnippet Details of the snippet.
snippet_index	int32 Index of the snippet in search_snippets field.

GroundingSignals

Grounding signals.

Fields
decision	GroundingDecision Represents the decision of the grounding check.
score	GroundingScoreBucket Grounding score bucket setting.

GroundingDecision

Represents the decision of the grounding check.

Enums
GROUNDING_DECISION_UNSPECIFIED	Decision not specified.
ACCEPTED_BY_GROUNDING	Grounding have accepted the answer.
REJECTED_BY_GROUNDING	Grounding have rejected the answer.

GroundingScoreBucket

Grounding score buckets.

Enums
GROUNDING_SCORE_BUCKET_UNSPECIFIED	Score not specified.
VERY_LOW	We have very low confidence that the answer is grounded.
LOW	We have low confidence that the answer is grounded.
MEDIUM	We have medium confidence that the answer is grounded.
HIGH	We have high confidence that the answer is grounded.
VERY_HIGH	We have very high confidence that the answer is grounded.

RewriterModelCallSignals

Diagnostic info related to the rewriter model call.

Fields
rendered_prompt	string Prompt as sent to the model.
model_output	string Output of the generative model.
model	string Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.

SafetySignals

Safety check results.

Fields
decision	SafetyDecision Safety decision.
banned_phrase_match	BannedPhraseMatch Specifies banned phrase match subject.
matched_banned_phrase	string The matched banned phrase if there was a match.

BannedPhraseMatch

Specifies banned phrase match subject.

Enums
BANNED_PHRASE_MATCH_UNSPECIFIED	No banned phrase check was executed.
BANNED_PHRASE_MATCH_NONE	All banned phrase checks led to no match.
BANNED_PHRASE_MATCH_QUERY	A banned phrase matched the query.
BANNED_PHRASE_MATCH_RESPONSE	A banned phrase matched the response.

SafetyDecision

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

Enums
SAFETY_DECISION_UNSPECIFIED	Decision not specified.
ACCEPTED_BY_SAFETY_CHECK	No manual or automatic safety check fired.
REJECTED_BY_SAFETY_CHECK	One ore more safety checks fired.

SearchSnippet

Search snippet details.

Fields
document_title	string Title of the enclosing document.
document_uri	string Uri for the document. Present if specified for the document.
text	string Text included in the prompt.

DataStoreType

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

Enums
DATA_STORE_TYPE_UNSPECIFIED	Not specified. This value indicates that the data store type is not specified, so it will not be used during search.
PUBLIC_WEB	A data store that contains public web content.
UNSTRUCTURED	A data store that contains unstructured private data.
STRUCTURED	A data store that contains structured data (for example FAQ).

DeleteAgentRequest

The request message for Agents.DeleteAgent.

Fields
name	string Required. The name of the agent to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.agents.delete

DeleteEntityTypeRequest

The request message for EntityTypes.DeleteEntityType.

Fields
name	string Required. The name of the entity type to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.entityTypes.delete
force	bool This field has no effect for entity type not being used. For entity types that are used by intents or pages: If force is set to false, an error will be returned with message indicating the referencing resources. If force is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).

DeleteEnvironmentRequest

The request message for Environments.DeleteEnvironment.

Fields
name	string Required. The name of the Environment to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.environments.delete

DeleteExperimentRequest

The request message for Experiments.DeleteExperiment.

Fields
name	string Required. The name of the Environment to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.experiments.delete

DeleteFlowRequest

The request message for Flows.DeleteFlow.

Fields
name	string Required. The name of the flow to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.flows.delete
force	bool This field has no effect for flows with no incoming transitions. For flows with incoming transitions: If force is set to false, an error will be returned with message indicating the incoming transitions. If force is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. [Target flow][EventHandler.target_flow] in event handlers or [Target flow][TransitionRoute.target_flow] in transition routes that point to this flow will be cleared).

DeleteGeneratorRequest

The request message for Generators.DeleteGenerator.

Fields
name	string Required. The name of the generator to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.generators.delete
force	bool This field has no effect for generators not being used. For generators that are used by pages/flows/transition route groups: If force is set to false, an error will be returned with message indicating the referenced resources. If force is set to true, Dialogflow will remove the generator, as well as any references to the generator (i.e. [Generator][Fulfillment.generator]) in fulfillments.

DeleteIntentRequest

The request message for Intents.DeleteIntent.

Fields
name	string Required. The name of the intent to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.intents.delete

DeletePageRequest

The request message for Pages.DeletePage.

Fields
name	string Required. The name of the page to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/Flows/<flowID>/pages/<PageID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.pages.delete
force	bool This field has no effect for pages with no incoming transitions. For pages with incoming transitions: If force is set to false, an error will be returned with message indicating the incoming transitions. If force is set to true, Dialogflow will remove the page, as well as any transitions to the page (i.e. [Target page][EventHandler.target_page] in event handlers or [Target page][TransitionRoute.target_page] in transition routes that point to this page will be cleared).

DeleteSecuritySettingsRequest

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

Fields
name	string Required. The name of the SecuritySettings to delete. Format: projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.securitySettings.delete

DeleteSessionEntityTypeRequest

The request message for SessionEntityTypes.DeleteSessionEntityType.

Fields

name

string Required. The name of the session entity type to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>. If Environment ID is not specified, we assume default 'draft' environment. Authorization requires the following IAM permission on the specified resource name: dialogflow.sessionEntityTypes.delete

DeleteTransitionRouteGroupRequest

The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.

Fields
name	string Required. The name of the TransitionRouteGroup to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.transitionRouteGroups.delete
force	bool This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: If force is set to false, an error will be returned with message indicating pages that reference the transition route group. If force is set to true, Dialogflow will remove the transition route group, as well as any reference to it.

DeleteVersionRequest

The request message for Versions.DeleteVersion.

Fields
name	string Required. The name of the Version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.versions.delete

DeleteWebhookRequest

The request message for Webhooks.DeleteWebhook.

Fields
name	string Required. The name of the webhook to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>. Authorization requires the following IAM permission on the specified resource name: dialogflow.webhooks.delete
force	bool This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: If force is set to false, an error will be returned with message indicating the referenced resources. If force is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).

DeployFlowMetadata

Metadata returned for the Environments.DeployFlow long running operation.

Fields
test_errors[]	TestError Errors of running deployment tests.

DeployFlowRequest

The request message for Environments.DeployFlow.

Fields
environment	string Required. The environment to deploy the flow to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>. Authorization requires the following IAM permission on the specified resource environment: dialogflow.environments.update
flow_version	string Required. The flow version to deploy. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.

DeployFlowResponse

The response message for Environments.DeployFlow.

Fields
environment	Environment The updated environment where the flow is deployed.
deployment	string The name of the flow version Deployment. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/deployments/<DeploymentID>.

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.

Fields
name	string The name of the deployment. Format: projects//locations//agents//environments//deployments/.
flow_version	string The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.
state	State The current state of the deployment.
result	Result Result of the deployment.
start_time	Timestamp Start time of this deployment.
end_time	Timestamp End time of this deployment.

Result

Result of the deployment.

Fields
deployment_test_results[]	string Results of test cases running before the deployment. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>.
experiment	string The name of the experiment triggered by this deployment. Format: projects//locations//agents//environments//experiments/.

State

The state of the deployment.

Enums
STATE_UNSPECIFIED	State unspecified.
RUNNING	The deployment is running.
SUCCEEDED	The deployment succeeded.
FAILED	The deployment failed.

DetectIntentRequest

The request to detect user's intent.

Fields
session	string Required. The name of the session this query is sent to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<Session ID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments. Authorization requires the following IAM permission on the specified resource session: dialogflow.sessions.detectIntent
query_params	QueryParameters The parameters of this query.
query_input	QueryInput Required. The input specification.
output_audio_config	OutputAudioConfig Instructs the speech synthesizer how to generate the output audio.

DetectIntentResponse

The message returned from the DetectIntent method.

Fields
response_id	string Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
query_result	QueryResult The result of the conversational query.
output_audio	bytes The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.response_messages field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.
output_audio_config	OutputAudioConfig The config used by the speech synthesizer to generate the output audio.
response_type	ResponseType Response type.
allow_cancellation	bool Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.

ResponseType

Represents different DetectIntentResponse types.

Enums
RESPONSE_TYPE_UNSPECIFIED	Not specified. This should never happen.
PARTIAL	Partial response. e.g. Aggregated responses in a Fulfillment that enables return_partial_response can be returned as partial response. WARNING: partial response is not eligible for barge-in.
FINAL	Final response.

DocumentProcessingMode

The document processing mode of the data store.

Enums
DOCUMENT_PROCESSING_MODE_UNSPECIFIED	Not specified. This should be set for STRUCTURED type data stores. Due to legacy reasons this is considered as DOCUMENTS for STRUCTURED and PUBLIC_WEB data stores.
DOCUMENTS	Documents are processed as documents.
CHUNKS	Documents are converted to chunks.

DtmfInput

Represents the input for dtmf event.

Fields
digits	string The dtmf digits.
finish_digit	string The finish digit (if any).

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.

Fields
name	string The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.
display_name	string Required. The human-readable name of the entity type, unique within the agent.
kind	Kind Required. Indicates the kind of entity type.
auto_expansion_mode	AutoExpansionMode Indicates whether the entity type can be automatically expanded.
entities[]	Entity The collection of entity entries associated with the entity type.
excluded_phrases[]	ExcludedPhrase Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.
enable_fuzzy_extraction	bool Enables fuzzy entity extraction during classification.
redact	bool Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

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

Enums
AUTO_EXPANSION_MODE_UNSPECIFIED	Auto expansion disabled for the entity.
AUTO_EXPANSION_MODE_DEFAULT	Allows an agent to recognize values that have not been explicitly listed in the entity.

Entity

An entity entry for an associated entity type.

Fields
value	string Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: A canonical value to be used in place of synonyms. For KIND_LIST entity types: A string that can contain references to other entity types (with or without aliases).
synonyms[]	string Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: This collection must contain exactly one synonym equal to value.

ExcludedPhrase

An excluded entity phrase that should not be matched.

Fields
value	string Required. The word or phrase to be excluded.

Kind

Represents kinds of entities.

Enums
KIND_UNSPECIFIED	Not specified. This value should be never used.
KIND_MAP	Map entity types allow mapping of a group of synonyms to a canonical value.
KIND_LIST	List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
KIND_REGEXP	Regexp entity types allow to specify regular expressions in entries values.

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.

Fields
name	string The name of the environment. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>.
display_name	string Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
description	string The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
version_configs[]	VersionConfig A list of configurations for flow versions. You should include version configs for all flows that are reachable from [Start Flow][Agent.start_flow] in the agent. Otherwise, an error will be returned.
update_time	Timestamp Output only. Update time of this environment.
test_cases_config	TestCasesConfig The test cases config for continuous tests of this environment.
webhook_config	WebhookConfig The webhook configuration for this environment.

TestCasesConfig

The configuration for continuous tests.

Fields
test_cases[]	string A list of test case names to run. They should be under the same agent. Format of each test case name: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>
enable_continuous_run	bool Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.
enable_predeployment_run	bool Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.

VersionConfig

Configuration for the version.

Fields
version	string Required. Both flow and playbook versions are supported. Format for flow version: projects//locations//agents//flows//versions/. Format for playbook version: projects//locations//agents//playbooks//versions/.

WebhookConfig

Configuration for webhooks.

Fields
webhook_overrides[]	Webhook The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in generic_web_service and service_directory.

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 associated with the event, it will be called.
• If there is a target_page associated with the event, the session will transition into the specified page.
• If there is a target_flow associated with the event, the session will transition into the specified flow.

Fields
name	string Output only. The unique identifier of this event handler.
event	string Required. The name of the event to handle.
trigger_fulfillment	Fulfillment The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
Union field target. The target to transition to, either a page in the same host flow (the flow that owns this TransitionRoute), or another flow in the same agent. target can be only one of the following:
target_page	string The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
target_flow	string The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.
target_playbook	string The target playbook to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

EventInput

Represents the event to trigger.

Fields
event	string Name of the event.

Experiment

Represents an experiment in an environment.

Fields
name	string The name of the experiment. Format: projects//locations//agents//environments//experiments/.
display_name	string Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
description	string The human-readable description of the experiment.
state	State The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
definition	Definition The definition of the experiment.
rollout_config	RolloutConfig The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow.
rollout_state	RolloutState State of the auto rollout process.
rollout_failure_reason	string The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
result	Result Inference result of the experiment.
create_time	Timestamp Creation time of this experiment.
start_time	Timestamp Start time of this experiment.
end_time	Timestamp End time of this experiment.
last_update_time	Timestamp Last update time of this experiment.
experiment_length	Duration Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.
variants_history[]	VariantsHistory The history of updates to the experiment variants.

Definition

Definition of the experiment.

Fields
condition	string The condition defines which subset of sessions are selected for this experiment. If not specified, all sessions are eligible. E.g. "query_input.language_code=en" See the conditions reference.
Union field variants. The variants of the experiment. We currently only support single variant experiment. variants can be only one of the following:
version_variants	VersionVariants The flow versions as the variants of this experiment.

Result

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

Fields
version_metrics[]	VersionMetrics Version variants and metrics.
last_update_time	Timestamp The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

ConfidenceInterval

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

Fields
confidence_level	double The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.
ratio	double The percent change between an experiment metric's value and the value for its control.
lower_bound	double Lower bound of the interval.
upper_bound	double Upper bound of the interval.

CountType

Types of count-based metric for Dialogflow experiment.

Enums
COUNT_TYPE_UNSPECIFIED	Count type unspecified.
TOTAL_NO_MATCH_COUNT	Total number of occurrences of a 'NO_MATCH'.
TOTAL_TURN_COUNT	Total number of turn counts.