Package google.cloud.dialogflow.cx.v3beta1

Index

• Agents (interface)
• Changelogs (interface)
• Deployments (interface)
• EntityTypes (interface)
• Environments (interface)
• Experiments (interface)
• Flows (interface)
• Intents (interface)
• Pages (interface)
• SecuritySettingsService (interface)
• SessionEntityTypes (interface)
• Sessions (interface)
• TestCases (interface)
• TransitionRouteGroups (interface)
• Versions (interface)
• Webhooks (interface)
• AdvancedSettings (message)
• AdvancedSettings.LoggingSettings (message)
• Agent (message)
• AgentValidationResult (message)
• AudioEncoding (enum)
• AudioInput (message)
• BatchDeleteTestCasesRequest (message)
• BatchRunTestCasesMetadata (message)
• BatchRunTestCasesRequest (message)
• BatchRunTestCasesResponse (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)
• CreateDocumentOperationMetadata (message)
• CreateEntityTypeRequest (message)
• CreateEnvironmentRequest (message)
• CreateExperimentRequest (message)
• CreateFlowRequest (message)
• CreateIntentRequest (message)
• CreatePageRequest (message)
• CreateSecuritySettingsRequest (message)
• CreateSessionEntityTypeRequest (message)
• CreateTestCaseRequest (message)
• CreateTransitionRouteGroupRequest (message)
• CreateVersionOperationMetadata (message)
• CreateVersionRequest (message)
• CreateWebhookRequest (message)
• DeleteAgentRequest (message)
• DeleteDocumentOperationMetadata (message)
• DeleteEntityTypeRequest (message)
• DeleteEnvironmentRequest (message)
• DeleteExperimentRequest (message)
• DeleteFlowRequest (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)
• 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)
• ExportAgentResponse (message)
• ExportFlowRequest (message)
• ExportFlowResponse (message)
• ExportTestCasesMetadata (message)
• ExportTestCasesRequest (message)
• ExportTestCasesRequest.DataFormat (enum)
• ExportTestCasesResponse (message)
• Flow (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)
• GenericKnowledgeOperationMetadata (message)
• GenericKnowledgeOperationMetadata.State (enum)
• GetAgentRequest (message)
• GetAgentValidationResultRequest (message)
• GetChangelogRequest (message)
• GetDeploymentRequest (message)
• GetEntityTypeRequest (message)
• GetEnvironmentRequest (message)
• GetExperimentRequest (message)
• GetFlowRequest (message)
• GetFlowValidationResultRequest (message)
• GetIntentRequest (message)
• GetPageRequest (message)
• GetSecuritySettingsRequest (message)
• GetSessionEntityTypeRequest (message)
• GetTestCaseRequest (message)
• GetTestCaseResultRequest (message)
• GetTransitionRouteGroupRequest (message)
• GetVersionRequest (message)
• GetWebhookRequest (message)
• ImportDocumentsOperationMetadata (message)
• ImportDocumentsResponse (message)
• ImportFlowRequest (message)
• ImportFlowRequest.ImportOption (enum)
• ImportFlowResponse (message)
• ImportTestCasesMetadata (message)
• ImportTestCasesRequest (message)
• ImportTestCasesResponse (message)
• InputAudioConfig (message)
• Intent (message)
• Intent.Parameter (message)
• Intent.TrainingPhrase (message)
• Intent.TrainingPhrase.Part (message)
• IntentCoverage (message)
• IntentCoverage.Intent (message)
• IntentInput (message)
• IntentView (enum)
• 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)
• 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)
• QueryInput (message)
• QueryParameters (message)
• QueryResult (message)
• ReloadDocumentOperationMetadata (message)
• ResourceName (message)
• ResponseMessage (message)
• ResponseMessage.ConversationSuccess (message)
• ResponseMessage.EndInteraction (message)
• ResponseMessage.LiveAgentHandoff (message)
• ResponseMessage.MixedAudio (message)
• ResponseMessage.MixedAudio.Segment (message)
• ResponseMessage.OutputAudioText (message)
• ResponseMessage.PlayAudio (message)
• ResponseMessage.TelephonyTransferCall (message)
• ResponseMessage.Text (message)
• RestoreAgentRequest (message)
• RestoreAgentRequest.RestoreOption (enum)
• RolloutConfig (message)
• RolloutConfig.RolloutStep (message)
• RolloutState (message)
• RunContinuousTestMetadata (message)
• RunContinuousTestRequest (message)
• RunContinuousTestResponse (message)
• RunTestCaseMetadata (message)
• RunTestCaseRequest (message)
• RunTestCaseResponse (message)
• SecuritySettings (message)
• SecuritySettings.AudioExportSettings (message)
• SecuritySettings.AudioExportSettings.AudioFormat (enum)
• SecuritySettings.InsightsExportSettings (message)
• SecuritySettings.PurgeDataType (enum)
• SecuritySettings.RedactionScope (enum)
• SecuritySettings.RedactionStrategy (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)
• 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)
• UpdateDocumentOperationMetadata (message)
• UpdateEntityTypeRequest (message)
• UpdateEnvironmentRequest (message)
• UpdateExperimentRequest (message)
• UpdateFlowRequest (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.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 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.

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.

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

UpdateAgent
rpc UpdateAgent(UpdateAgentRequest) returns (Agent) Updates 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.

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

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.

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 Oper