Package google.cloud.dialogflow.cx.v3

Index

• Agents (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)
• Agent (message)
• AgentValidationResult (message)
• AudioEncoding (enum)
• AudioInput (message)
• BatchDeleteTestCasesRequest (message)
• BatchRunTestCasesMetadata (message)
• BatchRunTestCasesRequest (message)
• BatchRunTestCasesResponse (message)
• CalculateCoverageRequest (message)
• CalculateCoverageRequest.CoverageType (enum)
• CalculateCoverageResponse (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)
• DetectIntentRequest (message)
• DetectIntentResponse (message)
• DtmfInput (message)
• EntityType (message)
• EntityType.AutoExpansionMode (enum)
• EntityType.Entity (message)
• EntityType.ExcludedPhrase (message)
• EntityType.Kind (enum)
• Environment (message)
• Environment.VersionConfig (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)
• 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)
• 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)
• 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.Text (message)
• RestoreAgentRequest (message)
• RestoreAgentRequest.RestoreOption (enum)
• RunTestCaseMetadata (message)
• RunTestCaseRequest (message)
• RunTestCaseResponse (message)
• SecuritySettings (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. 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. 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. 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. 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.

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

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.

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.

UpdateEnvironment
rpc UpdateEnvironment(UpdateEnvironmentRequest) returns (Operation) Updates 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.

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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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 overwite any existing ones. The provided ID in the imported test case is neglected. 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. 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. 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. 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. 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.

CreateVersion
rpc CreateVersion(CreateVersionRequest) returns (Operation) Creates a Version 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.

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

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 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	bool Indicates if stackdriver logging is enabled for the agent.
enable_spell_correction	bool Indicates if automatic spell correction is enabled in detect intent requests.

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.

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.

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.
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/<Project ID>/locations/<Location ID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.agents.create
agent	Agent Required. The agent to create.

CreateDocumentOperationMetadata

Metadata for CreateDocument operation.

Fields
generic_metadata	GenericKnowledgeOperationMetadata The generic information of the operation.

CreateEntityTypeRequest

The request message for EntityTypes.CreateEntityType.

Fields
parent	string Required. The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>. 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.

CreateIntentRequest

The request message for Intents.CreateIntent.

Fields
parent	string Required. The agent to create an intent for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. 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/<Project ID>/locations/<Location ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

CreateVersionRequest

The request message for Versions.CreateVersion.

Fields
parent	string Required. The Flow to create an Version for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>. Authorization requires the following IAM permission on the specified resource parent: dialogflow.webhooks.create
webhook	Webhook Required. The webhook to create.

DeleteAgentRequest

The request message for Agents.DeleteAgent.

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

DeleteDocumentOperationMetadata

Metadata for DeleteDocument operation.

Fields
generic_metadata	GenericKnowledgeOperationMetadata The generic information of the operation.

DeleteEntityTypeRequest

The request message for EntityTypes.DeleteEntityType.

Fields
name	string Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. 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).

DeleteIntentRequest

The request message for Intents.DeleteIntent.

Fields
name	string Required. The name of the intent to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>. 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/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. 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).

DetectIntentRequest

The request to detect user's intent.

Fields
session	string Required. The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. 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.

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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
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 Required. 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.

VersionConfig

Configuration for the version.

Fields
version	string Required. Format: projects//locations//agents//flows//versions/.

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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.
target_flow	string The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

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 Expriments.StartExperiment: PENDING->RUNNING. Transition triggered by Expriments.CancelExperiment: PENDING->CANCELLED or RUNNING->CANCELLED.
definition	Definition The definition of the experiment.
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.
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.
AVERAGE_TURN_COUNT	Average turn count in a session.

Metric

Metric and corresponding confidence intervals.

Fields
type	MetricType Ratio-based metric type. Only one of type or count_type is specified in each Metric.
count_type	CountType Count-based metric type. Only one of type or count_type is specified in each Metric.
confidence_interval	ConfidenceInterval The probability that the treatment is better than all other treatments in the experiment
Union field value. The actual value of the metric. value can be only one of the following:
ratio	double Ratio value of a metric.
count	double Count value of a metric.

MetricType

Types of ratio-based metric for Dialogflow experiment.

Enums
METRIC_UNSPECIFIED	Metric unspecified.
CONTAINED_SESSION_NO_CALLBACK_RATE	Percentage of contained sessions without user calling back in 24 hours.
LIVE_AGENT_HANDOFF_RATE	Percentage of sessions that were handed to a human agent.
CALLBACK_SESSION_RATE	Percentage of sessions with the same user calling back.
ABANDONED_SESSION_RATE	Percentage of sessions where user hung up.
SESSION_END_RATE	Percentage of sessions reached Dialogflow 'END_PAGE' or 'END_SESSION'.

VersionMetrics

Version variant and associated metrics.

Fields
version	string The name of the flow Version. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.
metrics[]	Metric The metrics and corresponding confidence intervals in the inference result.
session_count	int32 Number of sessions that were allocated to this version.

State

The state of the experiment.

Enums
STATE_UNSPECIFIED	State unspecified.
DRAFT	The experiment is created but not started yet.
RUNNING	The experiment is running.
DONE