Package google.cloud.dialogflow.cx.v3

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)
• CompareVersionsRequest (message)
• CompareVersionsResponse (message)
• ContinuousTestResult (message)
• ContinuousTestResult.AggregatedTestResult (enum)
• 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)
• 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)
• TrainFlowRequest (message)
• TransitionCoverage (message)
• TransitionCoverage.Transition (message)
• TransitionCoverage.TransitionNode (message)
• TransitionRoute (message)
• TransitionRouteGroup (message)
• TransitionRouteGroupCoverage (message)
• TransitionRouteGroupCoverage.Coverage (message)
• TransitionRouteGroupCoverage.Coverage.Transition (message)
• 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 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.

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.

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.

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

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.

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.

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.

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.

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 a list of results for a given 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
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.

LoggingSettings

Define behaviors on logging.

Fields
enable_stackdriver_logging	bool If true, StackDriver logging is currently enabled.
enable_interaction_logging	bool If true, DF Interaction logging is currently enabled.

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, 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
security_settings	string Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.
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.
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.

AgentValidationResult

The response message for Agents.GetAgentValidationResult.

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

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.

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

BatchDeleteTestCasesRequest

The request message for TestCases.BatchDeleteTestCases.

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

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/<Project ID>/locations/<Location ID>/agents/ <AgentID>.
environment	string Optional. If not set, draft environment is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
test_cases[]	string Required. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>.

BatchRunTestCasesResponse

The response message for TestCases.BatchRunTestCases.

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

CalculateCoverageRequest

The request message for TestCases.CalculateCoverage.

Fields
agent	string Required. The agent to calculate coverage for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>.
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.

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/<Project ID>/locations/<Location ID>/agents/ <Agent ID>/flows/<Flow ID>/versions/<Version ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/continuousTestResults/<ContinuousTestResult ID>.
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.

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