Index
Agents(interface)Changelogs(interface)Deployments(interface)EntityTypes(interface)Environments(interface)Experiments(interface)Flows(interface)Generators(interface)Intents(interface)Pages(interface)SecuritySettingsService(interface)SessionEntityTypes(interface)Sessions(interface)TestCases(interface)TransitionRouteGroups(interface)Versions(interface)Webhooks(interface)AdvancedSettings(message)AdvancedSettings.DtmfSettings(message)AdvancedSettings.LoggingSettings(message)AdvancedSettings.SpeechSettings(message)Agent(message)Agent.AnswerFeedbackSettings(message)Agent.ClientCertificateSettings(message)Agent.GenAppBuilderSettings(message)Agent.GitIntegrationSettings(message)Agent.GitIntegrationSettings.GithubSettings(message)Agent.PersonalizationSettings(message)AgentValidationResult(message)AnswerFeedback(message)AnswerFeedback.Rating(enum)AnswerFeedback.RatingReason(message)AudioEncoding(enum)AudioInput(message)BargeInConfig(message)BatchDeleteTestCasesRequest(message)BatchRunTestCasesMetadata(message)BatchRunTestCasesRequest(message)BatchRunTestCasesResponse(message)BoostSpec(message)BoostSpec.ConditionBoostSpec(message)BoostSpec.ConditionBoostSpec.BoostControlSpec(message)BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType(enum)BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint(message)BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType(enum)BoostSpecs(message)CalculateCoverageRequest(message)CalculateCoverageRequest.CoverageType(enum)CalculateCoverageResponse(message)Changelog(message)CloudConversationDebuggingInfo(message)CompareVersionsRequest(message)CompareVersionsResponse(message)ContinuousTestResult(message)ContinuousTestResult.AggregatedTestResult(enum)ConversationSignals(message)ConversationTurn(message)ConversationTurn.UserInput(message)ConversationTurn.VirtualAgentOutput(message)CreateAgentRequest(message)CreateEntityTypeRequest(message)CreateEnvironmentRequest(message)CreateExperimentRequest(message)CreateFlowRequest(message)CreateGeneratorRequest(message)CreateIntentRequest(message)CreatePageRequest(message)CreateSecuritySettingsRequest(message)CreateSessionEntityTypeRequest(message)CreateTestCaseRequest(message)CreateTransitionRouteGroupRequest(message)CreateVersionOperationMetadata(message)CreateVersionRequest(message)CreateWebhookRequest(message)DataStoreConnection(message)DataStoreConnectionSignals(message)DataStoreConnectionSignals.AnswerGenerationModelCallSignals(message)DataStoreConnectionSignals.AnswerPart(message)DataStoreConnectionSignals.CitedSnippet(message)DataStoreConnectionSignals.GroundingSignals(message)DataStoreConnectionSignals.GroundingSignals.GroundingDecision(enum)DataStoreConnectionSignals.GroundingSignals.GroundingScoreBucket(enum)DataStoreConnectionSignals.RewriterModelCallSignals(message)DataStoreConnectionSignals.SafetySignals(message)DataStoreConnectionSignals.SafetySignals.BannedPhraseMatch(enum)DataStoreConnectionSignals.SafetySignals.SafetyDecision(enum)DataStoreConnectionSignals.SearchSnippet(message)DataStoreType(enum)DeleteAgentRequest(message)DeleteEntityTypeRequest(message)DeleteEnvironmentRequest(message)DeleteExperimentRequest(message)DeleteFlowRequest(message)DeleteGeneratorRequest(message)DeleteIntentRequest(message)DeletePageRequest(message)DeleteSecuritySettingsRequest(message)DeleteSessionEntityTypeRequest(message)DeleteTransitionRouteGroupRequest(message)DeleteVersionRequest(message)DeleteWebhookRequest(message)DeployFlowMetadata(message)DeployFlowRequest(message)DeployFlowResponse(message)Deployment(message)Deployment.Result(message)Deployment.State(enum)DetectIntentRequest(message)DetectIntentResponse(message)DetectIntentResponse.ResponseType(enum)DtmfInput(message)EntityType(message)EntityType.AutoExpansionMode(enum)EntityType.Entity(message)EntityType.ExcludedPhrase(message)EntityType.Kind(enum)Environment(message)Environment.TestCasesConfig(message)Environment.VersionConfig(message)Environment.WebhookConfig(message)EventHandler(message)EventInput(message)Experiment(message)Experiment.Definition(message)Experiment.Result(message)Experiment.Result.ConfidenceInterval(message)Experiment.Result.CountType(enum)Experiment.Result.Metric(message)Experiment.Result.MetricType(enum)Experiment.Result.VersionMetrics(message)Experiment.State(enum)ExportAgentRequest(message)ExportAgentRequest.DataFormat(enum)ExportAgentRequest.GitDestination(message)ExportAgentResponse(message)ExportEntityTypesMetadata(message)ExportEntityTypesRequest(message)ExportEntityTypesRequest.DataFormat(enum)ExportEntityTypesResponse(message)ExportFlowRequest(message)ExportFlowResponse(message)ExportIntentsMetadata(message)ExportIntentsRequest(message)ExportIntentsRequest.DataFormat(enum)ExportIntentsResponse(message)ExportTestCasesMetadata(message)ExportTestCasesRequest(message)ExportTestCasesRequest.DataFormat(enum)ExportTestCasesResponse(message)FilterSpecs(message)Flow(message)Flow.MultiLanguageSettings(message)FlowImportStrategy(message)FlowValidationResult(message)Form(message)Form.Parameter(message)Form.Parameter.FillBehavior(message)FulfillIntentRequest(message)FulfillIntentResponse(message)Fulfillment(message)Fulfillment.ConditionalCases(message)Fulfillment.ConditionalCases.Case(message)Fulfillment.ConditionalCases.Case.CaseContent(message)Fulfillment.SetParameterAction(message)GcsDestination(message)GenerativeSettings(message)GenerativeSettings.FallbackSettings(message)GenerativeSettings.FallbackSettings.PromptTemplate(message)GenerativeSettings.KnowledgeConnectorSettings(message)Generator(message)Generator.ModelParameter(message)Generator.Placeholder(message)GetAgentRequest(message)GetAgentValidationResultRequest(message)GetChangelogRequest(message)GetDeploymentRequest(message)GetEntityTypeRequest(message)GetEnvironmentRequest(message)GetExperimentRequest(message)GetFlowRequest(message)GetFlowValidationResultRequest(message)GetGenerativeSettingsRequest(message)GetGeneratorRequest(message)GetIntentRequest(message)GetPageRequest(message)GetSecuritySettingsRequest(message)GetSessionEntityTypeRequest(message)GetTestCaseRequest(message)GetTestCaseResultRequest(message)GetTransitionRouteGroupRequest(message)GetVersionRequest(message)GetWebhookRequest(message)ImportEntityTypesMetadata(message)ImportEntityTypesRequest(message)ImportEntityTypesRequest.MergeOption(enum)ImportEntityTypesResponse(message)ImportEntityTypesResponse.ConflictingResources(message)ImportFlowRequest(message)ImportFlowRequest.ImportOption(enum)ImportFlowResponse(message)ImportIntentsMetadata(message)ImportIntentsRequest(message)ImportIntentsRequest.MergeOption(enum)ImportIntentsResponse(message)ImportIntentsResponse.ConflictingResources(message)ImportStrategy(enum)ImportTestCasesMetadata(message)ImportTestCasesRequest(message)ImportTestCasesResponse(message)InlineDestination(message)InlineSource(message)InputAudioConfig(message)Intent(message)Intent.Parameter(message)Intent.TrainingPhrase(message)Intent.TrainingPhrase.Part(message)IntentCoverage(message)IntentCoverage.Intent(message)IntentInput(message)IntentView(enum)KnowledgeConnectorSettings(message)LanguageInfo(message)ListAgentsRequest(message)ListAgentsResponse(message)ListChangelogsRequest(message)ListChangelogsResponse(message)ListContinuousTestResultsRequest(message)ListContinuousTestResultsResponse(message)ListDeploymentsRequest(message)ListDeploymentsResponse(message)ListEntityTypesRequest(message)ListEntityTypesResponse(message)ListEnvironmentsRequest(message)ListEnvironmentsResponse(message)ListExperimentsRequest(message)ListExperimentsResponse(message)ListFlowsRequest(message)ListFlowsResponse(message)ListGeneratorsRequest(message)ListGeneratorsResponse(message)ListIntentsRequest(message)ListIntentsResponse(message)ListPagesRequest(message)ListPagesResponse(message)ListSecuritySettingsRequest(message)ListSecuritySettingsResponse(message)ListSessionEntityTypesRequest(message)ListSessionEntityTypesResponse(message)ListTestCaseResultsRequest(message)ListTestCaseResultsResponse(message)ListTestCasesRequest(message)ListTestCasesRequest.TestCaseView(enum)ListTestCasesResponse(message)ListTransitionRouteGroupsRequest(message)ListTransitionRouteGroupsResponse(message)ListVersionsRequest(message)ListVersionsResponse(message)ListWebhooksRequest(message)ListWebhooksResponse(message)LoadVersionRequest(message)LookupEnvironmentHistoryRequest(message)LookupEnvironmentHistoryResponse(message)Match(message)Match.MatchType(enum)MatchIntentRequest(message)MatchIntentResponse(message)NluSettings(message)NluSettings.ModelTrainingMode(enum)NluSettings.ModelType(enum)OutputAudioConfig(message)OutputAudioEncoding(enum)Page(message)PageInfo(message)PageInfo.FormInfo(message)PageInfo.FormInfo.ParameterInfo(message)PageInfo.FormInfo.ParameterInfo.ParameterState(enum)Phrase(message)QueryInput(message)QueryParameters(message)QueryResult(message)ResourceName(message)ResponseMessage(message)ResponseMessage.ConversationSuccess(message)ResponseMessage.EndInteraction(message)ResponseMessage.KnowledgeInfoCard(message)ResponseMessage.LiveAgentHandoff(message)ResponseMessage.MixedAudio(message)ResponseMessage.MixedAudio.Segment(message)ResponseMessage.OutputAudioText(message)ResponseMessage.PlayAudio(message)ResponseMessage.ResponseType(enum)ResponseMessage.TelephonyTransferCall(message)ResponseMessage.Text(message)RestoreAgentRequest(message)RestoreAgentRequest.GitSource(message)RestoreAgentRequest.RestoreOption(enum)RolloutConfig(message)RolloutConfig.RolloutStep(message)RolloutState(message)RunContinuousTestMetadata(message)RunContinuousTestRequest(message)RunContinuousTestResponse(message)RunTestCaseMetadata(message)RunTestCaseRequest(message)RunTestCaseResponse(message)SafetySettings(message)SafetySettings.Phrase(message)SearchConfig(message)SecuritySettings(message)SecuritySettings.AudioExportSettings(message)SecuritySettings.AudioExportSettings.AudioFormat(enum)SecuritySettings.InsightsExportSettings(message)SecuritySettings.PurgeDataType(enum)SecuritySettings.RedactionScope(enum)SecuritySettings.RedactionStrategy(enum)SecuritySettings.RetentionStrategy(enum)SentimentAnalysisResult(message)SessionEntityType(message)SessionEntityType.EntityOverrideMode(enum)SessionInfo(message)SpeechModelVariant(enum)SpeechToTextSettings(message)SpeechWordInfo(message)SsmlVoiceGender(enum)StartExperimentRequest(message)StopExperimentRequest(message)StreamingDetectIntentRequest(message)StreamingDetectIntentResponse(message)StreamingRecognitionResult(message)StreamingRecognitionResult.MessageType(enum)SubmitAnswerFeedbackRequest(message)SynthesizeSpeechConfig(message)TestCase(message)TestCaseError(message)TestCaseResult(message)TestConfig(message)TestError(message)TestResult(enum)TestRunDifference(message)TestRunDifference.DiffType(enum)TextInput(message)TextToSpeechSettings(message)TrainFlowRequest(message)TransitionCoverage(message)TransitionCoverage.Transition(message)TransitionCoverage.TransitionNode(message)TransitionRoute(message)TransitionRouteGroup(message)TransitionRouteGroupCoverage(message)TransitionRouteGroupCoverage.Coverage(message)TransitionRouteGroupCoverage.Coverage.Transition(message)TurnSignals(message)TurnSignals.FailureReason(enum)UpdateAgentRequest(message)UpdateEntityTypeRequest(message)UpdateEnvironmentRequest(message)UpdateExperimentRequest(message)UpdateFlowRequest(message)UpdateGenerativeSettingsRequest(message)UpdateGeneratorRequest(message)UpdateIntentRequest(message)UpdatePageRequest(message)UpdateSecuritySettingsRequest(message)UpdateSessionEntityTypeRequest(message)UpdateTestCaseRequest(message)UpdateTransitionRouteGroupRequest(message)UpdateVersionRequest(message)UpdateWebhookRequest(message)ValidateAgentRequest(message)ValidateFlowRequest(message)ValidationMessage(message)ValidationMessage.ResourceType(enum)ValidationMessage.Severity(enum)VariantsHistory(message)Version(message)Version.State(enum)VersionVariants(message)VersionVariants.Variant(message)VoiceSelectionParams(message)Webhook(message)Webhook.GenericWebService(message)Webhook.GenericWebService.HttpMethod(enum)Webhook.GenericWebService.OAuthConfig(message)Webhook.GenericWebService.ServiceAgentAuth(enum)Webhook.GenericWebService.WebhookType(enum)Webhook.ServiceDirectoryConfig(message)WebhookRequest(message)WebhookRequest.FulfillmentInfo(message)WebhookRequest.IntentInfo(message)WebhookRequest.IntentInfo.IntentParameterValue(message)WebhookRequest.SentimentAnalysisResult(message)WebhookResponse(message)WebhookResponse.FulfillmentResponse(message)WebhookResponse.FulfillmentResponse.MergeBehavior(enum)
Agents
Service for managing Agents.
| CreateAgent |
|---|
|
Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the training documentation.
|
| DeleteAgent |
|---|
|
Deletes the specified agent.
|
| ExportAgent |
|---|
|
Exports the specified agent to a binary file. This method is a long-running operation. The returned
|
| GetAgent |
|---|
|
Retrieves the specified agent.
|
| GetAgentValidationResult |
|---|
|
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
|
| GetGenerativeSettings |
|---|
|
Gets the generative settings for the agent.
|
| ListAgents |
|---|
|
Returns the list of all agents in the specified location.
|
| RestoreAgent |
|---|
|
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
Note: You should always train flows prior to sending them queries. See the training documentation.
|
| UpdateAgent |
|---|
|
Updates the specified agent. Note: You should always train flows prior to sending them queries. See the training documentation.
|
| UpdateGenerativeSettings |
|---|
|
Updates the generative settings for the agent.
|
| ValidateAgent |
|---|
|
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.
|
Changelogs
Service for managing Changelogs.
| GetChangelog |
|---|
|
Retrieves the specified Changelog.
|
| ListChangelogs |
|---|
|
Returns the list of Changelogs.
|
Deployments
Service for managing Deployments.
| GetDeployment |
|---|
|
Retrieves the specified
|
| ListDeployments |
|---|
|
Returns the list of all deployments in the specified
|
EntityTypes
Service for managing EntityTypes.
| CreateEntityType |
|---|
|
Creates an entity type in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| DeleteEntityType |
|---|
|
Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| ExportEntityTypes |
|---|
|
Exports the selected entity types.
|
| GetEntityType |
|---|
|
Retrieves the specified entity type.
|
| ImportEntityTypes |
|---|
|
Imports the specified entitytypes into the agent.
|
| ListEntityTypes |
|---|
|
Returns the list of all entity types in the specified agent.
|
| UpdateEntityType |
|---|
|
Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
Environments
Service for managing Environments.
| CreateEnvironment |
|---|
|
Creates an This method is a long-running operation. The returned
|
| DeleteEnvironment |
|---|
|
Deletes the specified
|
| DeployFlow |
|---|
|
Deploys a flow to the specified This method is a long-running operation. The returned
|
| GetEnvironment |
|---|
|
Retrieves the specified
|
| ListContinuousTestResults |
|---|
|
Fetches a list of continuous test results for a given environment.
|
| ListEnvironments |
|---|
|
Returns the list of all environments in the specified
|
| LookupEnvironmentHistory |
|---|
|
Looks up the history of the specified
|
| RunContinuousTest |
|---|
|
Kicks off a continuous test under the specified This method is a long-running operation. The returned
|
| UpdateEnvironment |
|---|
|
Updates the specified This method is a long-running operation. The returned
|
Experiments
Service for managing Experiments.
| CreateExperiment |
|---|
|
Creates an
|
| DeleteExperiment |
|---|
|
Deletes the specified
|
| GetExperiment |
|---|
|
Retrieves the specified
|
| ListExperiments |
|---|
|
Returns the list of all experiments in the specified
|
| StartExperiment |
|---|
|
Starts the specified
|
| StopExperiment |
|---|
|
Stops the specified
|
| UpdateExperiment |
|---|
|
Updates the specified
|
Flows
Service for managing Flows.
| CreateFlow |
|---|
|
Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| DeleteFlow |
|---|
|
Deletes a specified flow.
|
| ExportFlow |
|---|
|
Exports the specified flow to a binary file. This method is a long-running operation. The returned
Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
|
| GetFlow |
|---|
|
Retrieves the specified flow.
|
| GetFlowValidationResult |
|---|
|
Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
|
| ImportFlow |
|---|
|
Imports the specified flow to the specified agent from a binary file. This method is a long-running operation. The returned
Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| ListFlows |
|---|
|
Returns the list of all flows in the specified agent.
|
| TrainFlow |
|---|
|
Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a long-running operation. The returned
Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| UpdateFlow |
|---|
|
Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| ValidateFlow |
|---|
|
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.
|
Generators
Service for managing Generators
| CreateGenerator |
|---|
|
Creates a generator in the specified agent.
|
| DeleteGenerator |
|---|
|
Deletes the specified generators.
|
| GetGenerator |
|---|
|
Retrieves the specified generator.
|
| ListGenerators |
|---|
|
Returns the list of all generators in the specified agent.
|
| UpdateGenerator |
|---|
|
Update the specified generator.
|
Intents
Service for managing Intents.
| CreateIntent |
|---|
|
Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| DeleteIntent |
|---|
|
Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| ExportIntents |
|---|
|
Exports the selected intents. This method is a long-running operation. The returned
|
| GetIntent |
|---|
|
Retrieves the specified intent.
|
| ImportIntents |
|---|
|
Imports the specified intents into the agent. This method is a long-running operation. The returned
|
| ListIntents |
|---|
|
Returns the list of all intents in the specified agent.
|
| UpdateIntent |
|---|
|
Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
Pages
Service for managing Pages.
| CreatePage |
|---|
|
Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| DeletePage |
|---|
|
Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| GetPage |
|---|
|
Retrieves the specified page.
|
| ListPages |
|---|
|
Returns the list of all pages in the specified flow.
|
| UpdatePage |
|---|
|
Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
SecuritySettingsService
Service for managing security settings for Dialogflow.
| CreateSecuritySettings |
|---|
|
Create security settings in the specified location.
|
| DeleteSecuritySettings |
|---|
|
Deletes the specified
|
| GetSecuritySettings |
|---|
|
Retrieves the specified
|
| ListSecuritySettings |
|---|
|
Returns the list of all security settings in the specified location.
|
| UpdateSecuritySettings |
|---|
|
Updates the specified
|
SessionEntityTypes
Service for managing SessionEntityTypes.
| CreateSessionEntityType |
|---|
|
Creates a session entity type.
|
| DeleteSessionEntityType |
|---|
|
Deletes the specified session entity type.
|
| GetSessionEntityType |
|---|
|
Retrieves the specified session entity type.
|
| ListSessionEntityTypes |
|---|
|
Returns the list of all session entity types in the specified session.
|
| UpdateSessionEntityType |
|---|
|
Updates the specified session entity type.
|
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 |
|---|
|
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.
|
| FulfillIntent |
|---|
|
Fulfills a matched intent returned by
|
| MatchIntent |
|---|
|
Returns preliminary intent match results, doesn't change the session status.
|
| ServerStreamingDetectIntent |
|---|
|
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.
|
| StreamingDetectIntent |
|---|
|
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.
|
| SubmitAnswerFeedback |
|---|
|
Updates the feedback received from the user for a single turn of the bot response.
|
TestCases
Service for managing Test Cases and Test Case Results.
| BatchDeleteTestCases |
|---|
|
Batch deletes test cases.
|
| BatchRunTestCases |
|---|
|
Kicks off a batch run of test cases. This method is a long-running operation. The returned
|
| CalculateCoverage |
|---|
|
Calculates the test coverage for an agent.
|
| CreateTestCase |
|---|
|
Creates a test case for the given agent.
|
| ExportTestCases |
|---|
|
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
|
| GetTestCase |
|---|
|
Gets a test case.
|
| GetTestCaseResult |
|---|
|
Gets a test case result.
|
| ImportTestCases |
|---|
|
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
|
| ListTestCaseResults |
|---|
|
Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.
|
| ListTestCases |
|---|
|
Fetches a list of test cases for a given agent.
|
| RunTestCase |
|---|
|
Kicks off a test case run. This method is a long-running operation. The returned
|
| UpdateTestCase |
|---|
|
Updates the specified test case.
|
TransitionRouteGroups
Service for managing TransitionRouteGroups.
| CreateTransitionRouteGroup |
|---|
|
Creates an Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| DeleteTransitionRouteGroup |
|---|
|
Deletes the specified Note: You should always train a flow prior to sending it queries. See the training documentation.
|
| GetTransitionRouteGroup |
|---|
|
Retrieves the specified
|
| ListTransitionRouteGroups |
|---|
|
Returns the list of all transition route groups in the specified flow.
|
| UpdateTransitionRouteGroup |
|---|
|
Updates the specified Note: You should always train a flow prior to sending it queries. See the training documentation.
|
Versions
Service for managing Versions.
| CompareVersions |
|---|
|
Compares the specified base version with target version.
|
| CreateVersion |
|---|
|
Creates a This method is a long-running operation. The returned
|
| DeleteVersion |
|---|
|
Deletes the specified
|
| GetVersion |
|---|
|
Retrieves the specified
|
| ListVersions |
|---|
|
Returns the list of all versions in the specified
|
| LoadVersion |
|---|
|
Loads resources in the specified version to the draft flow. This method is a long-running operation. The returned
|
| UpdateVersion |
|---|
|
Updates the specified
|
Webhooks
Service for managing Webhooks.
| CreateWebhook |
|---|
|
Creates a webhook in the specified agent.
|
| DeleteWebhook |
|---|
|
Deletes the specified webhook.
|
| GetWebhook |
|---|
|
Retrieves the specified webhook.
|
| ListWebhooks |
|---|
|
Returns the list of all webhooks in the specified agent.
|
| UpdateWebhook |
|---|
|
Updates the specified webhook.
|
AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged.
DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel.
Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
| Fields | |
|---|---|
audio_ |
If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level |
speech_ |
Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level |
dtmf_ |
Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. |
logging_ |
Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. |
DtmfSettings
Define behaviors for DTMF (dual tone multi frequency).
| Fields | |
|---|---|
enabled |
If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). |
max_ |
Max length of DTMF digits. |
finish_ |
The digit that terminates a DTMF digit sequence. |
interdigit_ |
Interdigit timeout setting for matching dtmf input to regex. |
endpointing_ |
Endpoint timeout setting for matching dtmf input to regex. |
LoggingSettings
Define behaviors on logging.
| Fields | |
|---|---|
enable_ |
Enables Google Cloud Logging. |
enable_ |
Enables DF Interaction logging. |
enable_ |
Enables consent-based end-user input redaction, if true, a pre-defined session parameter |
SpeechSettings
Define behaviors of speech to text detection.
| Fields | |
|---|---|
endpointer_ |
Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. |
no_ |
Timeout before detecting no speech. |
use_ |
Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. |
models |
Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see Speech models. |
Agent
Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.
After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
| Fields | |
|---|---|
name |
The unique identifier of the agent. Required for the |
display_ |
Required. The human-readable name of the agent, unique within the location. |
default_ |
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 |
supported_ |
The list of all languages supported by the agent (except for the |
time_ |
Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris. |
description |
The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. |
avatar_ |
The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration. |
speech_ |
Speech recognition related settings. |
start_ |
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: |
security_ |
Name of the |
enable_stackdriver_logging |
Indicates if stackdriver logging is enabled for the agent. Please use |
enable_ |
Indicates if automatic spell correction is enabled in detect intent requests. |
enable_ |
Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent. |
locked |
Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][]. |
advanced_ |
Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. |
git_ |
Git integration settings for this agent. |
text_ |
Settings on instructing the speech synthesizer on how to generate the output audio content. |
answer_ |
Optional. Answer feedback collection settings. |
personalization_ |
Optional. Settings for end user personalization. |
client_ |
Optional. Settings for custom client certificates. |
gen_ |
Gen App Builder-related agent-level settings. |
AnswerFeedbackSettings
Settings for answer feedback collection.
| Fields | |
|---|---|
enable_ |
Optional. If enabled, end users will be able to provide |
ClientCertificateSettings
Settings for custom client certificates.
| Fields | |
|---|---|
ssl_ |
Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. |
private_ |
Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: |
passphrase |
Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: |
GenAppBuilderSettings
Settings for Gen App Builder.
| Fields | |
|---|---|
engine |
Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: |
GitIntegrationSettings
Settings for connecting to Git repository for an agent.
| Fields | |
|---|---|
Union field git_settings. The git settings to specific systems. git_settings can be only one of the following: |
|
github_ |
GitHub settings. |
GithubSettings
Settings of integration with GitHub.
| Fields | |
|---|---|
display_ |
The unique repository display name for the GitHub repository. |
repository_ |
The GitHub repository URI related to the agent. |
tracking_ |
The branch of the GitHub repository tracked for this agent. |
access_ |
The access token used to authenticate the access to the GitHub repository. |
branches[] |
A list of branches configured to be used from Dialogflow. |
PersonalizationSettings
Settings for end user personalization.
| Fields | |
|---|---|
default_ |
Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the |
AgentValidationResult
The response message for Agents.GetAgentValidationResult.
| Fields | |
|---|---|
name |
The unique identifier of the agent validation result. Format: |
flow_ |
Contains all flow validation results. |
AnswerFeedback
Stores information about feedback provided by users about a response.
| Fields | |
|---|---|
rating |
Optional. Rating from user for the specific Dialogflow response. |
rating_ |
Optional. In case of thumbs down rating provided, users can optionally provide context about the rating. |
custom_ |
Optional. Custom rating from the user about the provided answer, with maximum length of 1024 characters. For example, client could use a customized JSON object to indicate the rating. |
Rating
Represents thumbs up/down rating provided by user about a response.
| Enums | |
|---|---|
RATING_UNSPECIFIED |
Rating not specified. |
THUMBS_UP |
Thumbs up feedback from user. |
THUMBS_DOWN |
Thumbs down feedback from user. |
RatingReason
Stores extra information about why users provided thumbs down rating.
| Fields | |
|---|---|
reason_ |
Optional. Custom reason labels for thumbs down rating provided by the user. The maximum number of labels allowed is 10 and the maximum length of a single label is 128 characters. |
feedback |
Optional. Additional feedback about the rating. This field can be populated without choosing a predefined |
AudioEncoding
Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.
| Enums | |
|---|---|
AUDIO_ENCODING_UNSPECIFIED |
Not specified. |
AUDIO_ENCODING_LINEAR_16 |
Uncompressed 16-bit signed little-endian samples (Linear PCM). |
AUDIO_ENCODING_FLAC |
FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported. |
AUDIO_ENCODING_MULAW |
8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
AUDIO_ENCODING_AMR |
Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000. |
AUDIO_ENCODING_AMR_WB |
Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000. |
AUDIO_ENCODING_OGG_OPUS |
Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000. |
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE |
Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000. |
AUDIO_ENCODING_ALAW |
8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law. |
AudioInput
Represents the natural speech audio to be processed.
| Fields | |
|---|---|
config |
Required. Instructs the speech recognizer how to process the speech audio. |
audio |
The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The For non-streaming audio detect intent, both |
BargeInConfig
Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request.
The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases:
No barge-in phase: which goes first and during which speech detection should not be carried out.
Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase.
The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the start of the input audio.
No-speech event is a response with END_OF_UTTERANCE without any transcript following up.
| Fields | |
|---|---|
no_ |
Duration that is not eligible for barge-in at the beginning of the input audio. |
total_ |
Total duration for the playback at the beginning of the input audio. |
BatchDeleteTestCasesRequest
The request message for TestCases.BatchDeleteTestCases.
| Fields | |
|---|---|
parent |
Required. The agent to delete test cases from. Format: Authorization requires the following IAM permission on the specified resource
|
names[] |
Required. Format of test case names: |
BatchRunTestCasesMetadata
Metadata returned for the TestCases.BatchRunTestCases long running operation.
| Fields | |
|---|---|
errors[] |
The test errors. |
BatchRunTestCasesRequest
The request message for TestCases.BatchRunTestCases.
| Fields | |
|---|---|
parent |
Required. Agent name. Format: |
environment |
Optional. If not set, draft environment is assumed. Format: |
test_ |
Required. Format: |
BatchRunTestCasesResponse
The response message for TestCases.BatchRunTestCases.
| Fields | |
|---|---|
results[] |
The test case results. The detailed |
BoostSpec
Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
| Fields | |
|---|---|
condition_ |
Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. |
ConditionBoostSpec
Boost applies to documents which match a condition.
| Fields | |
|---|---|
condition |
Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples:
|
boost |
Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. |
boost_ |
Optional. Complex specification for custom ranking based on customer defined attribute value. |
BoostControlSpec
Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
| Fields | |
|---|---|
field_ |
Optional. The name of the field whose value will be used to determine the boost amount. |
attribute_ |
Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). |
interpolation_ |
Optional. The interpolation type to be applied to connect the control points listed below. |
control_ |
Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. |
AttributeType
The attribute(or function) for which the custom ranking is to be applied.
| Enums | |
|---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
Unspecified AttributeType. |
NUMERICAL |
The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified. |
FRESHNESS |
For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD][T[nH][nM][nS]]. E.g. 5D, 3DT12H30M, T24H. |
ControlPoint
The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
| Fields | |
|---|---|
attribute_ |
Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD |
boost_ |
Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. |
InterpolationType
The interpolation type to be applied. Default will be linear (Piecewise Linear).
| Enums | |
|---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
Interpolation type is unspecified. In this case, it defaults to Linear. |
LINEAR |
Piecewise linear interpolation will be applied. |
BoostSpecs
Boost specifications for data stores.
| Fields | |
|---|---|
data_ |
Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: |
spec[] |
Optional. A list of boosting specifications. |
CalculateCoverageRequest
The request message for TestCases.CalculateCoverage.
| Fields | |
|---|---|
agent |
Required. The agent to calculate coverage for. Format: Authorization requires the following IAM permission on the specified resource
|
type |
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 |
The agent to calculate coverage for. Format: |
Union field coverage_type. The type of coverage requested. coverage_type can be only one of the following: |
|
intent_ |
Intent coverage. |
transition_ |
Transition (excluding transition route groups) coverage. |
route_ |
Transition route group coverage. |
Changelog
Changelogs represents a change made to a given agent.
| Fields | |
|---|---|
name |
The unique identifier of the changelog. Format: |
user_ |
Email address of the authenticated user. |
display_ |
The affected resource display name of the change. |
action |
The action of the change. |
type |
The affected resource type. |
resource |
The affected resource name of the change. |
create_ |
The timestamp of the change. |
language_ |
The affected language code of the change. |
CloudConversationDebuggingInfo
Cloud conversation info for easier debugging. It will get populated in StreamingDetectIntentResponse or StreamingAnalyzeContentResponse when the flag enable_debugging_info is set to true in corresponding requests.
| Fields | |
|---|---|
audio_ |
Number of input audio data chunks in streaming requests. |
result_ |
Time offset of the end of speech utterance relative to the beginning of the first audio chunk. |
first_ |
Duration of first audio chunk. |
single_ |
Whether client used single utterance mode. |
speech_ |
Time offsets of the speech partial results relative to the beginning of the stream. |
speech_ |
Time offsets of the speech final results (is_final=true) relative to the beginning of the stream. |
partial_ |
Total number of partial responses. |
speaker_ |
Time offset of Speaker ID stream close time relative to the Speech stream close time in milliseconds. Only meaningful for conversations involving passive verification. |
bargein_ |
Whether a barge-in event is triggered in this request. |
speech_ |
Whether speech uses single utterance mode. |
dtmf_ |
Time offsets of the DTMF partial results relative to the beginning of the stream. |
dtmf_ |
Time offsets of the DTMF final results relative to the beginning of the stream. |
single_ |
Time offset of the end-of-single-utterance signal relative to the beginning of the stream. |
no_ |
No speech timeout settings for the stream. |
endpointing_ |
Speech endpointing timeout settings for the stream. |
is_ |
Whether the streaming terminates with an injected text query. |
client_ |
Client half close time in terms of input audio duration. |
client_ |
Client half close time in terms of API streaming duration. |
CompareVersionsRequest
The request message for Versions.CompareVersions.
| Fields | |
|---|---|
base_ |
Required. Name of the base flow version to compare with the target version. Use version ID Format: Authorization requires the following IAM permission on the specified resource
|
target_ |
Required. Name of the target flow version to compare with the base version. Use version ID Authorization requires the following IAM permission on the specified resource
|
language_ |
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_ |
JSON representation of the base version content. |
target_ |
JSON representation of the target version content. |
compare_ |
The timestamp when the two version compares. |
ContinuousTestResult
Represents a result from running a test case in an agent environment.
| Fields | |
|---|---|
name |
The resource name for the continuous test result. Format: |
result |
The result of this continuous test run, i.e. whether all the tests in this continuous test run pass or not. |
test_ |
A list of individual test case results names in this continuous test run. |
run_ |
Time when the continuous testing run starts. |
AggregatedTestResult
The overall result for a continuous test run in an agent environment.
| Enums | |
|---|---|
AGGREGATED_TEST_RESULT_UNSPECIFIED |
Not specified. Should never be used. |
PASSED |
All the tests passed. |
FAILED |
At least one test did not pass. |
ConversationSignals
This message is used to hold all the Conversation Signals data, which will be converted to JSON and exported to BigQuery.
| Fields | |
|---|---|
turn_ |
Required. Turn signals for the current turn. |
ConversationTurn
One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.
| Fields | |
|---|---|
user_ |
The user input. |
virtual_ |
The virtual agent output. |
UserInput
The input from the human user.
| Fields | |
|---|---|
input |
Supports |
injected_ |
Parameters that need to be injected into the conversation during intent detection. |
is_ |
If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. |
enable_ |
Whether sentiment analysis is enabled. |
VirtualAgentOutput
The output from the virtual agent.
| Fields | |
|---|---|
session_ |
The session parameters available to the bot at this point. |
differences[] |
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_ |
Required. Input only. The diagnostic [info][Session.DetectIntentResponse.QueryResult.diagnostic_info] output for the turn. Required to calculate the testing coverage. |
triggered_ |
The |
current_ |
The |
text_ |
The |
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 |
Required. The location to create a agent for. Format: Authorization requires the following IAM permission on the specified resource
|
agent |
Required. The agent to create. |
CreateEntityTypeRequest
The request message for EntityTypes.CreateEntityType.
| Fields | |
|---|---|
parent |
Required. The agent to create a entity type for. Format: Authorization requires the following IAM permission on the specified resource
|
entity_ |
Required. The entity type to create. |
language_ |
The language of the following fields in
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 |
Required. The Authorization requires the following IAM permission on the specified resource
|
environment |
Required. The environment to create. |
CreateExperimentRequest
The request message for Experiments.CreateExperiment.
| Fields | |
|---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
experiment |
Required. The experiment to create. |
CreateFlowRequest
The request message for Flows.CreateFlow.
| Fields | |
|---|---|
parent |
Required. The agent to create a flow for. Format: Authorization requires the following IAM permission on the specified resource
|
flow |
Required. The flow to create. |
language_ |
The language of the following fields in
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. |
CreateGeneratorRequest
The request message for Generators.CreateGenerator.
| Fields | |
|---|---|
parent |
Required. The agent to create a generator for. Format: Authorization requires the following IAM permission on the specified resource
|
generator |
Required. The generator to create. |
language_ |
The language to create generators for the following fields: * |
CreateIntentRequest
The request message for Intents.CreateIntent.
| Fields | |
|---|---|
parent |
Required. The agent to create an intent for. Format: Authorization requires the following IAM permission on the specified resource
|
intent |
Required. The intent to create. |
language_ |
The language of the following fields in
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 |
Required. The flow to create a page for. Format: Authorization requires the following IAM permission on the specified resource
|
page |
Required. The page to create. |
language_ |
The language of the following fields in
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 |
Required. The location to create an Authorization requires the following IAM permission on the specified resource
|
security_ |
Required. The security settings to create. |
CreateSessionEntityTypeRequest
The request message for SessionEntityTypes.CreateSessionEntityType.
| Fields | |
|---|---|
parent |
Required. The session to create a session entity type for. Format: Authorization requires the following IAM permission on the specified resource
|
session_ |
Required. The session entity type to create. |
CreateTestCaseRequest
The request message for TestCases.CreateTestCase.
| Fields | |
|---|---|
parent |
Required. The agent to create the test case for. Format: Authorization requires the following IAM permission on the specified resource
|
test_ |
Required. The test case to create. |
CreateTransitionRouteGroupRequest
The request message for TransitionRouteGroups.CreateTransitionRouteGroup.
| Fields | |
|---|---|
parent |
Required. The flow to create an Authorization requires the following IAM permission on the specified resource
|
transition_ |
Required. The transition route group to create. |
language_ |
The language of the following fields in
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 |
Name of the created version. Format: |
CreateVersionRequest
The request message for Versions.CreateVersion.
| Fields | |
|---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
version |
Required. The version to create. |
CreateWebhookRequest
The request message for Webhooks.CreateWebhook.
| Fields | |
|---|---|
parent |
Required. The agent to create a webhook for. Format: Authorization requires the following IAM permission on the specified resource
|
webhook |
Required. The webhook to create. |
DataStoreConnection
A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
| Fields | |
|---|---|
data_ |
The type of the connected data store. |
data_ |
The full name of the referenced data store. Formats: |
DataStoreConnectionSignals
Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ...
| Fields | |
|---|---|
rewriter_ |
Optional. Diagnostic info related to the rewriter model call. |
rewritten_ |
Optional. Rewritten string query used for search. |
search_ |
Optional. Search snippets included in the answer generation prompt. |
answer_ |
Optional. Diagnostic info related to the answer generation model call. |
answer |
Optional. The final compiled answer. |
answer_ |
Optional. Answer parts with relevant citations. Concatenation of texts should add up the |
cited_ |
Optional. Snippets cited by the answer generation model from the most to least relevant. |
grounding_ |
Optional. Grounding signals. |
safety_ |
Optional. Safety check result. |
AnswerGenerationModelCallSignals
Diagnostic info related to the answer generation model call.
| Fields | |
|---|---|
rendered_ |
Prompt as sent to the model. |
model_ |
Output of the generative model. |
model |
Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
AnswerPart
Answer part with citation.
| Fields | |
|---|---|
text |
Substring of the answer. |
supporting_ |
Citations for this answer part. Indices of |
CitedSnippet
Snippet cited by the answer generation model.
| Fields | |
|---|---|
search_ |
Details of the snippet. |
snippet_ |
Index of the snippet in |
GroundingSignals
Grounding signals.
| Fields | |
|---|---|
decision |
Represents the decision of the grounding check. |
score |
Grounding score bucket setting. |
GroundingDecision
Represents the decision of the grounding check.
| Enums | |
|---|---|
GROUNDING_DECISION_UNSPECIFIED |
Decision not specified. |
ACCEPTED_BY_GROUNDING |
Grounding have accepted the answer. |
REJECTED_BY_GROUNDING |
Grounding have rejected the answer. |
GroundingScoreBucket
Grounding score buckets.
| Enums | |
|---|---|
GROUNDING_SCORE_BUCKET_UNSPECIFIED |
Score not specified. |
VERY_LOW |
We have very low confidence that the answer is grounded. |
LOW |
We have low confidence that the answer is grounded. |
MEDIUM |
We have medium confidence that the answer is grounded. |
HIGH |
We have high confidence that the answer is grounded. |
VERY_HIGH |
We have very high confidence that the answer is grounded. |
RewriterModelCallSignals
Diagnostic info related to the rewriter model call.
| Fields | |
|---|---|
rendered_ |
Prompt as sent to the model. |
model_ |
Output of the generative model. |
model |
Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
SafetySignals
Safety check results.
| Fields | |
|---|---|
decision |
Safety decision. |
banned_ |
Specifies banned phrase match subject. |
matched_ |
The matched banned phrase if there was a match. |
BannedPhraseMatch
Specifies banned phrase match subject.
| Enums | |
|---|---|
BANNED_PHRASE_MATCH_UNSPECIFIED |
No banned phrase check was executed. |
BANNED_PHRASE_MATCH_NONE |
All banned phrase checks led to no match. |
BANNED_PHRASE_MATCH_QUERY |
A banned phrase matched the query. |
BANNED_PHRASE_MATCH_RESPONSE |
A banned phrase matched the response. |
SafetyDecision
Safety decision. All kinds of check are incorporated into this final decision, including banned phrases check.
| Enums | |
|---|---|
SAFETY_DECISION_UNSPECIFIED |
Decision not specified. |
ACCEPTED_BY_SAFETY_CHECK |
No manual or automatic safety check fired. |
REJECTED_BY_SAFETY_CHECK |
One ore more safety checks fired. |
SearchSnippet
Search snippet details.
| Fields | |
|---|---|
document_ |
Title of the enclosing document. |
document_ |
Uri for the document. Present if specified for the document. |
text |
Text included in the prompt. |
DataStoreType
Type of a data store. Determines how search is performed in the data store.
| Enums | |
|---|---|
DATA_STORE_TYPE_UNSPECIFIED |
Not specified. This value indicates that the data store type is not specified, so it will not be used during search. |
PUBLIC_WEB |
A data store that contains public web content. |
UNSTRUCTURED |
A data store that contains unstructured private data. |
STRUCTURED |
A data store that contains structured data (for example FAQ). |
DeleteAgentRequest
The request message for Agents.DeleteAgent.
| Fields | |
|---|---|
name |
Required. The name of the agent to delete. Format: Authorization requires the following IAM permission on the specified resource
|
DeleteEntityTypeRequest
The request message for EntityTypes.DeleteEntityType.
| Fields | |
|---|---|
name |
Required. The name of the entity type to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for entity type not being used. For entity types that are used by intents or pages:
|
DeleteEnvironmentRequest
The request message for Environments.DeleteEnvironment.
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
DeleteExperimentRequest
The request message for Experiments.DeleteExperiment.
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
DeleteFlowRequest
The request message for Flows.DeleteFlow.
| Fields | |
|---|---|
name |
Required. The name of the flow to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for flows with no incoming transitions. For flows with incoming transitions:
|
DeleteGeneratorRequest
The request message for Generators.DeleteGenerator.
| Fields | |
|---|---|
name |
Required. The name of the generator to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for generators not being used. For generators that are used by pages/flows/transition route groups:
|
DeleteIntentRequest
The request message for Intents.DeleteIntent.
| Fields | |
|---|---|
name |
Required. The name of the intent to delete. Format: Authorization requires the following IAM permission on the specified resource
|
DeletePageRequest
The request message for Pages.DeletePage.
| Fields | |
|---|---|
name |
Required. The name of the page to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for pages with no incoming transitions. For pages with incoming transitions:
|
DeleteSecuritySettingsRequest
The request message for [SecuritySettings.DeleteSecuritySettings][].
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
DeleteSessionEntityTypeRequest
The request message for SessionEntityTypes.DeleteSessionEntityType.
| Fields | |
|---|---|
name |
Required. The name of the session entity type to delete. Format: Authorization requires the following IAM permission on the specified resource
|
DeleteTransitionRouteGroupRequest
The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page:
|
DeleteVersionRequest
The request message for Versions.DeleteVersion.
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
DeleteWebhookRequest
The request message for Webhooks.DeleteWebhook.
| Fields | |
|---|---|
name |
Required. The name of the webhook to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: |
DeployFlowMetadata
Metadata returned for the Environments.DeployFlow long running operation.
| Fields | |
|---|---|
test_ |
Errors of running deployment tests. |
DeployFlowRequest
The request message for Environments.DeployFlow.
| Fields | |
|---|---|
environment |
Required. The environment to deploy the flow to. Format: Authorization requires the following IAM permission on the specified resource
|
flow_ |
Required. The flow version to deploy. Format: |
DeployFlowResponse
The response message for Environments.DeployFlow.
| Fields | |
|---|---|
environment |
The updated environment where the flow is deployed. |
deployment |
The name of the flow version |
Deployment
Represents a deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc.
| Fields | |
|---|---|
name |
The name of the deployment. Format: projects/ |
flow_ |
The name of the flow version for this deployment. Format: projects/ |
state |
The current state of the deployment. |
result |
Result of the deployment. |
start_ |
Start time of this deployment. |
end_ |
End time of this deployment. |
Result
Result of the deployment.
| Fields | |
|---|---|
deployment_ |
Results of test cases running before the deployment. Format: |
experiment |
The name of the experiment triggered by this deployment. Format: projects/ |
State
The state of the deployment.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
State unspecified. |
RUNNING |
The deployment is running. |
SUCCEEDED |
The deployment succeeded. |
FAILED |
The deployment failed. |
DetectIntentRequest
The request to detect user's intent.
| Fields | |
|---|---|
session |
Required. The name of the session this query is sent to. Format: 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
|
query_ |
The parameters of this query. |
query_ |
Required. The input specification. |
output_ |
Instructs the speech synthesizer how to generate the output audio. |
DetectIntentResponse
The message returned from the DetectIntent method.
| Fields | |
|---|---|
response_ |
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_ |
The result of the conversational query. |
output_ |
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 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_ |
The config used by the speech synthesizer to generate the output audio. |
response_ |
Response type. |
allow_ |
Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled. |
ResponseType
Represents different DetectIntentResponse types.
| Enums | |
|---|---|
RESPONSE_TYPE_UNSPECIFIED |
Not specified. This should never happen. |
PARTIAL |
Partial response. e.g. Aggregated responses in a Fulfillment that enables return_partial_response can be returned as partial response. WARNING: partial response is not eligible for barge-in. |
FINAL |
Final response. |
DtmfInput
Represents the input for dtmf event.
| Fields | |
|---|---|
digits |
The dtmf digits. |
finish_ |
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
EntityTypetype.Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauceentity for red or white pizza sauce, apizza.cheeseentity for the different types of cheese on a pizza, apizza.toppingentity for different toppings, and so on. A custom entity is represented by theEntityTypetype.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the
SessionEntityTypetype.
For more information about entity types, see the Dialogflow documentation.
| Fields | |
|---|---|
name |
The unique identifier of the entity type. Required for |
display_ |
Required. The human-readable name of the entity type, unique within the agent. |
kind |
Required. Indicates the kind of entity type. |
auto_ |
Indicates whether the entity type can be automatically expanded. |
entities[] |
The collection of entity entries associated with the entity type. |
excluded_ |
Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry |
enable_ |
Enables fuzzy entity extraction during classification. |
redact |
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 |
Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For
For
|
synonyms[] |
Required. A collection of value synonyms. For example, if the entity type is vegetable, and For
|
ExcludedPhrase
An excluded entity phrase that should not be matched.
| Fields | |
|---|---|
value |
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 |
The name of the environment. Format: |
display_ |
Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. |
description |
The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. |
version_ |
A list of configurations for flow versions. You should include version configs for all flows that are reachable from [ |
update_ |
Output only. Update time of this environment. |
test_ |
The test cases config for continuous tests of this environment. |
webhook_ |
The webhook configuration for this environment. |
TestCasesConfig
The configuration for continuous tests.
| Fields | |
|---|---|
test_ |
A list of test case names to run. They should be under the same agent. Format of each test case name: |
enable_ |
Whether to run test cases in |
enable_ |
Whether to run test cases in |
VersionConfig
Configuration for the version.
| Fields | |
|---|---|
version |
Required. Both flow and playbook versions are supported. Format for flow version: projects/ |
WebhookConfig
Configuration for webhooks.
| Fields | |
|---|---|
webhook_ |
The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in |
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 - If there is a
target_page - If there is a
target_flow
| Fields | |
|---|---|
name |
Output only. The unique identifier of this event handler. |
event |
Required. The name of the event to handle. |
trigger_ |
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_ |
The target page to transition to. Format: |
target_ |
The target flow to transition to. Format: |
target_ |
The target playbook to transition to. Format: |
EventInput
Represents the event to trigger.
| Fields | |
|---|---|
event |
Name of the event. |
Experiment
Represents an experiment in an environment.
| Fields | |
|---|---|
name |
The name of the experiment. Format: projects/ |
display_ |
Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters. |
description |
The human-readable description of the experiment. |
state |
The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE. |
definition |
The definition of the experiment. |
rollout_ |
The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow. |
rollout_ |
State of the auto rollout process. |
rollout_ |
The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED. |
result |
Inference result of the experiment. |
create_ |
Creation time of this experiment. |
start_ |
Start time of this experiment. |
end_ |
End time of this experiment. |
last_ |
Last update time of this experiment. |
experiment_ |
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_ |
The history of updates to the experiment variants. |
Definition
Definition of the experiment.
| Fields | |
|---|---|
condition |
The condition defines which subset of sessions are selected for this experiment. If not specified, all sessions are eligible. E.g. "query_input.language_code=en" See the conditions reference. |
Union field variants. The variants of the experiment. We currently only support single variant experiment. variants can be only one of the following: |
|
version_ |
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_ |
Version variants and metrics. |
last_ |
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_ |
The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval. |
ratio |
The percent change between an experiment metric's value and the value for its control. |
lower_ |
Lower bound of the interval. |
upper_ |
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 |
Ratio-based metric type. Only one of type or count_type is specified in each Metric. |
count_ |
Count-based metric type. Only one of type or count_type is specified in each Metric. |
confidence_ |
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 |
Ratio value of a metric. |
count |
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 |
The name of the flow |
metrics[] |
The metrics and corresponding confidence intervals in the inference result. |
session_ |
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 |
The experiment is done. |
ROLLOUT_FAILED |
The experiment with auto-rollout enabled has failed. |
ExportAgentRequest
The request message for Agents.ExportAgent.
| Fields | |
|---|---|
name |
Required. The name of the agent to export. Format: Authorization requires the following IAM permission on the specified resource
|
agent_ |
Optional. The Google Cloud Storage URI to export the agent to. The format of this URI must be Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control. |
data_ |
Optional. The data format of the exported agent. If not specified, |
environment |
Optional. Environment name. If not set, draft environment is assumed. Format: |
git_ |
Optional. The Git branch to export the agent to. |
include_ |
Optional. Whether to include BigQuery Export setting. |
DataFormat
Data format of the exported agent.
| Enums | |
|---|---|
DATA_FORMAT_UNSPECIFIED |
Unspecified format. |
BLOB |
Agent content will be exported as raw bytes. |
JSON_PACKAGE |
Agent content will be exported in JSON Package format. |
GitDestination
Settings for exporting to a git branch.
| Fields | |
|---|---|
tracking_ |
Tracking branch for the git push. |
commit_ |
Commit message for the git push. |
ExportAgentResponse
The response message for Agents.ExportAgent.
| Fields | |
|---|---|
Union field agent. The exported agent. agent can be only one of the following: |
|
agent_ |
The URI to a file containing the exported agent. This field is populated if |
agent_ |
Uncompressed raw byte content for agent. This field is populated if none of |
commit_ |
Commit SHA of the git push. This field is populated if |
ExportEntityTypesMetadata
This type has no fields.
Metadata returned for the EntityTypes.ExportEntityTypes long running operation.
ExportEntityTypesRequest
The request message for EntityTypes.ExportEntityTypes.
| Fields | |
|---|---|
parent |
Required. The name of the parent agent to export entity types. Format: Authorization requires the following IAM permission on the specified resource
|
entity_ |
Required. The name of the entity types to export. Format: |
data_ |
Optional. The data format of the exported entity types. If not specified, |
language_ |
Optional. The language to retrieve the entity type for. The following fields are language dependent:
If not specified, all language dependent fields will be retrieved. Many languages are supported. Note: languages must be enabled in the agent before they can be used. |
Union field destination. The destination to export. destination can be only one of the following: |
|
entity_ |
Optional. The Google Cloud Storage URI to export the entity types to. The format of this URI must be Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control. |
entity_ |
Optional. The option to return the serialized entity types inline. |
DataFormat
Data format of the exported entity types.
| Enums | |
|---|---|
DATA_FORMAT_UNSPECIFIED |
Unspecified format. Treated as BLOB. |
BLOB |
EntityTypes will be exported as raw bytes. |
JSON_PACKAGE |
EntityTypes will be exported in JSON Package format. |
ExportEntityTypesResponse
The response message for EntityTypes.ExportEntityTypes.
| Fields | |
|---|---|
Union field exported_entity_types. Exported entity types can be either in cloud storage or local download. exported_entity_types can be only one of the following: |
|
entity_ |
The URI to a file containing the exported entity types. This field is populated only if |
entity_ |
Uncompressed byte content for entity types. This field is populated only if |
ExportFlowRequest
The request message for Flows.ExportFlow.
| Fields | |
|---|---|
name |
Required. The name of the flow to export. Format: Authorization requires the following IAM permission on the specified resource
|
flow_ |
Optional. The Google Cloud Storage URI to export the flow to. The format of this URI must be Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control. |
include_ |
Optional. Whether to export flows referenced by the specified flow. |
ExportFlowResponse
The response message for Flows.ExportFlow.
| Fields | |
|---|---|
Union field flow. The exported flow. flow can be only one of the following: |
|
flow_ |
The URI to a file containing the exported flow. This field is populated only if |
flow_ |
Uncompressed raw byte content for flow. |
ExportIntentsMetadata
This type has no fields.
Metadata returned for the Intents.ExportIntents long running operation.
ExportIntentsRequest
The request message for Intents.ExportIntents.
| Fields | |
|---|---|
parent |
Required. The name of the parent agent to export intents. Format: Authorization requires the following IAM permission on the specified resource
|
intents[] |
Required. The name of the intents to export. Format: |
data_ |
Optional. The data format of the exported intents. If not specified, |
Union field destination. The destination to export. destination can be only one of the following: |
|
intents_ |
Optional. The Google Cloud Storage URI to export the intents to. The format of this URI must be Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control. |
intents_ |
Optional. The option to return the serialized intents inline. |
DataFormat
Data format of the exported intents.
| Enums | |
|---|---|
DATA_FORMAT_UNSPECIFIED |
Unspecified format. Treated as BLOB. |
BLOB |
Intents will be exported as raw bytes. |
JSON |
Intents will be exported in JSON format. |
CSV |
Intents will be exported in CSV format. |
ExportIntentsResponse
The response message for Intents.ExportIntents.
| Fields | |
|---|---|
Union field intents. The exported intents. intents can be only one of the following: |
|
intents_ |
The URI to a file containing the exported intents. This field is populated only if |
intents_ |
Uncompressed byte content for intents. This field is populated only if |
ExportTestCasesMetadata
This type has no fields.
Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.
ExportTestCasesRequest
The request message for TestCases.ExportTestCases.
| Fields | |
|---|---|
parent |
Required. The agent where to export test cases from. Format: Authorization requires the following IAM permission on the specified resource
|
data_ |
The data format of the exported test cases. If not specified, |
filter |
The filter expression used to filter exported test cases, see API Filtering. The expression is case insensitive and supports the following syntax: name = For example:
|
Union field destination. The destination to export. destination can be only one of the following: |
|
gcs_ |
The Google Cloud Storage URI to export the test cases to. The format of this URI must be Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control. |
DataFormat
Data format of the exported test cases.
| Enums | |
|---|---|
DATA_FORMAT_UNSPECIFIED |
Unspecified format. |
BLOB |
Raw bytes. |
JSON |
JSON format. |
ExportTestCasesResponse
The response message for TestCases.ExportTestCases.
| Fields | |
|---|---|
Union field destination. The exported test cases. destination can be only one of the following: |
|
gcs_ |
The URI to a file containing the exported test cases. This field is populated only if |
content |
Uncompressed raw byte content for test cases. |
FilterSpecs
Filter specifications for data stores.
| Fields | |
|---|---|
data_ |
Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: |
filter |
Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax |
Flow
Flows represents the conversation flows when you build your chatbot agent.
A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.
Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
| Fields | |
|---|---|
name |
The unique identifier of the flow. Format: |
display_ |
Required. The human-readable name of the flow. |
description |
The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. |
transition_ |
A flow's transition routes serve two purposes:
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified are inherited by pages in the flow. |
event_ |
A flow's event handlers serve two purposes:
Unlike |
transition_ |
A flow's transition route group serve two purposes:
Format: |
nlu_ |
NLU related settings of the flow. |
advanced_ |
Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level. |
knowledge_ |
Optional. Knowledge connector configuration. |
multi_ |
Optional. Multi-lingual agent settings for this flow. |
locked |
Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected. |
MultiLanguageSettings
Settings for multi-lingual agents.
| Fields | |
|---|---|
enable_ |
Optional. Enable multi-language detection for this flow. This can be set only if [agent level multi language setting][Agent.enable_multi_language_training] is enabled. |
supported_ |
Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the |
FlowImportStrategy
The flow import strategy used for resource conflict resolution associated with an ImportFlowRequest.
| Fields | |
|---|---|
global_ |
Optional. Import strategy for resource conflict resolution, applied globally throughout the flow. It will be applied for all display name conflicts in the imported content. If not specified, 'CREATE_NEW' is assumed. |
FlowValidationResult
The response message for Flows.GetFlowValidationResult.
| Fields | |
|---|---|
name |
The unique identifier of the flow validation result. Format: |
validation_ |
Contains all validation messages. |
update_ |
Last time the flow was validated. |
Form
A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.
| Fields | |
|---|---|
parameters[] |
Parameters to collect from the user. |
Parameter
Represents a form parameter.
| Fields | |
|---|---|
display_ |
Required. The human-readable name of the parameter, unique within the form. |
required |
Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes. |
entity_ |
Required. The entity type of the parameter. Format: |
is_ |
Indicates whether the parameter represents a list of values. |
fill_ |
Required. Defines fill behavior for the parameter. |
default_ |
The default value of an optional parameter. If the parameter is required, the default value will be ignored. |
redact |
Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or |
advanced_ |
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. |
FillBehavior
Configuration for how the filling of a parameter should be handled.
| Fields | |
|---|---|
initial_ |
Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. |
reprompt_ |
The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the A A If the event handler for the corresponding event can't be found on the parameter, |
FulfillIntentRequest
Request of [FulfillIntent][]
| Fields | |
|---|---|
match_ |
Must be same as the corresponding MatchIntent request, otherwise the behavior is undefined. |
match |
The matched intent/event to fulfill. |
output_ |
Instructs the speech synthesizer how to generate output audio. |
FulfillIntentResponse
Response of [FulfillIntent][]
| Fields | |
|---|---|
response_ |
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_ |
The result of the conversational query. |
output_ |
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 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_ |
The config used by the speech synthesizer to generate the output audio. |
Fulfillment
A fulfillment can do one or more of the following actions at the same time:
- Generate rich message responses.
- Set parameter values.
- Call the webhook.
Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.
| Fields | |
|---|---|
messages[] |
The list of rich message responses to present to the user. |
webhook |
The webhook to call. Format: |
return_ |
Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
tag |
The value of this field will be populated in the |
set_ |
Set parameter values before executing the webhook. |
conditional_ |
Conditional cases for this fulfillment. |
advanced_ |
Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. |
enable_ |
If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined |
ConditionalCases
A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
| Fields | |
|---|---|
cases[] |
A list of cascading if-else conditions. |
Case
Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
| Fields | |
|---|---|
condition |
The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against [form parameters][Form.parameters] or [session parameters][SessionInfo.parameters]. See the conditions reference. |
case_ |
A list of case content. |
CaseContent
The list of messages or conditional cases to activate for this case.
| Fields | |
|---|---|
Union field cases_or_message. Either a message is returned or additional cases to be evaluated. cases_or_message can be only one of the following: |
|
message |
Returned message. |
additional_ |
Additional cases to be evaluated. |
SetParameterAction
Setting a parameter value.
| Fields | |
|---|---|
parameter |
Display name of the parameter. |
value |
The new value of the parameter. A null value clears the parameter. |
GcsDestination
Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.
| Fields | |
|---|---|
uri |
Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: |
GenerativeSettings
Settings for Generative AI.
| Fields | |
|---|---|
name |
Format: |
fallback_ |
Settings for Generative Fallback. |
generative_ |
Settings for Generative Safety. |
knowledge_ |
Settings for knowledge connector. |
language_ |
Language for this settings. |
FallbackSettings
Settings for Generative Fallback.
| Fields | |
|---|---|
selected_ |
Display name of the selected prompt. |
prompt_ |
Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones. |
PromptTemplate
Prompt template.
| Fields | |
|---|---|
display_ |
Prompt name. |
prompt_ |
Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: " |
frozen |
If the flag is true, the prompt is frozen and cannot be modified by users. |
KnowledgeConnectorSettings
Settings for knowledge connector. These parameters are used for LLM prompt like "You are
| Fields | |
|---|---|
business |
Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. |
agent |
Name of the virtual agent. Used for LLM prompt. Can be left empty. |
agent_ |
Identity of the agent, e.g. "virtual agent", "AI assistant". |
business_ |
Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans". |
agent_ |
Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner". |
disable_ |
Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled. |
Generator
Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
| Fields | |
|---|---|
name |
The unique identifier of the generator. Must be set for the |
display_ |
Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. |
prompt_ |
Required. Prompt for the LLM model. |
placeholders[] |
Optional. List of custom placeholders in the prompt text. |
model_ |
Parameters passed to the LLM to configure its behavior. |
ModelParameter
Parameters to be passed to the LLM. If not set, default values will be used.
| Fields | |
|---|---|
temperature |
The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random. |
max_ |
The maximum number of tokens to generate. |
top_ |
If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random. |
top_ |
If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random. |
Placeholder
Represents a custom placeholder in the prompt text.
| Fields | |
|---|---|
id |
Unique ID used to map custom placeholder to parameters in fulfillment. |
name |
Custom placeholder value in the prompt text. |
GetAgentRequest
The request message for Agents.GetAgent.
| Fields | |
|---|---|
name |
Required. The name of the agent. Format: Authorization requires the following IAM permission on the specified resource
|
GetAgentValidationResultRequest
The request message for Agents.GetAgentValidationResult.
| Fields | |
|---|---|
name |
Required. The agent name. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
If not specified, the agent's default language is used. |
GetChangelogRequest
The request message for Changelogs.GetChangelog.
| Fields | |
|---|---|
name |
Required. The name of the changelog to get. Format: |
GetDeploymentRequest
The request message for Deployments.GetDeployment.
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
GetEntityTypeRequest
The request message for EntityTypes.GetEntityType.
| Fields | |
|---|---|
name |
Required. The name of the entity type. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to retrieve the entity type for. The following fields are language dependent:
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. |
GetEnvironmentRequest
The request message for Environments.GetEnvironment.
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
GetExperimentRequest
The request message for Experiments.GetExperiment.
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
GetFlowRequest
The response message for Flows.GetFlow.
| Fields | |
|---|---|
name |
Required. The name of the flow to get. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to retrieve the flow for. The following fields are language dependent:
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. |
GetFlowValidationResultRequest
The request message for Flows.GetFlowValidationResult.
| Fields | |
|---|---|
name |
Required. The flow name. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
If not specified, the agent's default language is used. |
GetGenerativeSettingsRequest
Request for GetGenerativeSettings RPC.
| Fields | |
|---|---|
name |
Required. Format: |
language_ |
Required. Language code of the generative settings. |
GetGeneratorRequest
The request message for Generators.GetGenerator.
| Fields | |
|---|---|
name |
Required. The name of the generator. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to list generators for. |
GetIntentRequest
The request message for Intents.GetIntent.
| Fields | |
|---|---|
name |
Required. The name of the intent. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to retrieve the intent for. The following fields are language dependent:
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. |
GetPageRequest
The request message for Pages.GetPage.
| Fields | |
|---|---|
name |
Required. The name of the page. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to retrieve the page for. The following fields are language dependent:
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. |
GetSecuritySettingsRequest
The request message for SecuritySettingsService.GetSecuritySettings.
| Fields | |
|---|---|
name |
Required. Resource name of the settings. Format: Authorization requires the following IAM permission on the specified resource
|
GetSessionEntityTypeRequest
The request message for SessionEntityTypes.GetSessionEntityType.
| Fields | |
|---|---|
name |
Required. The name of the session entity type. Format: Authorization requires the following IAM permission on the specified resource
|
GetTestCaseRequest
The request message for TestCases.GetTestCase.
| Fields | |
|---|---|
name |
Required. The name of the testcase. Format: Authorization requires the following IAM permission on the specified resource
|
GetTestCaseResultRequest
The request message for TestCases.GetTestCaseResult.
| Fields | |
|---|---|
name |
Required. The name of the testcase. Format: Authorization requires the following IAM permission on the specified resource
|
GetTransitionRouteGroupRequest
The request message for TransitionRouteGroups.GetTransitionRouteGroup.
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to retrieve the transition route group for. The following fields are language dependent:
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. |
GetVersionRequest
The request message for Versions.GetVersion.
| Fields | |
|---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
GetWebhookRequest
The request message for Webhooks.GetWebhook.
| Fields | |
|---|---|
name |
Required. The name of the webhook. Format: Authorization requires the following IAM permission on the specified resource
|
ImportEntityTypesMetadata
This type has no fields.
Metadata returned for the EntityTypes.ImportEntityTypes long running operation.
ImportEntityTypesRequest
The request message for EntityTypes.ImportEntityTypes.
| Fields | |
|---|---|
parent |
Required. The agent to import the entity types into. Format: Authorization requires the following IAM permission on the specified resource
|
merge_ |
Required. Merge option for importing entity types. |
target_ |
Optional. The target entity type to import into. Format: |
Union field entity_types. Required. The entity types to import. entity_types can be only one of the following: |
|
entity_ |
The Google Cloud Storage URI to import entity types from. The format of this URI must be Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control. |
entity_ |
Uncompressed byte content of entity types. |
MergeOption
Merge option when display name conflicts exist during import.
| Enums | |
|---|---|
MERGE_OPTION_UNSPECIFIED |
Unspecified. If used, system uses REPORT_CONFLICT as default. |
REPLACE |
Replace the original entity type in the agent with the new entity type when display name conflicts exist. |
MERGE |
Merge the original entity type with the new entity type when display name conflicts exist. |
RENAME |
Create new entity types with new display names to differentiate them from the existing entity types when display name conflicts exist. |
REPORT_CONFLICT |
Report conflict information if display names conflict is detected. Otherwise, import entity types. |
KEEP |
Keep the original entity type and discard the conflicting new entity type when display name conflicts exist. |
ImportEntityTypesResponse
The response message for EntityTypes.ImportEntityTypes.
| Fields | |
|---|---|
entity_ |
The unique identifier of the imported entity types. Format: |
conflicting_ |
Info which resources have conflicts when [REPORT_CONFLICT][ImportEntityTypesResponse.REPORT_CONFLICT] merge_option is set in ImportEntityTypesRequest. |
ConflictingResources
Conflicting resources detected during the import process. Only filled when [REPORT_CONFLICT][ImportEntityTypesResponse.REPORT_CONFLICT] is set in the request and there are conflicts in the display names.
| Fields | |
|---|---|
entity_ |
Display names of conflicting entity types. |
entity_ |
Display names of conflicting entities. |
ImportFlowRequest
The request message for Flows.ImportFlow.
| Fields | |
|---|---|
parent |
Required. The agent to import the flow into. Format: Authorization requires the following IAM permission on the specified resource
|
import_ |
Flow import mode. If not specified, |
flow_ |
Optional. Specifies the import strategy used when resolving resource conflicts. |
Union field flow. Required. The flow to import. flow can be only one of the following: |
|
flow_ |
The Google Cloud Storage URI to import flow from. The format of this URI must be Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control. |
flow_ |
Uncompressed raw byte content for flow. |
ImportOption
Import option.
| Enums | |
|---|---|
IMPORT_OPTION_UNSPECIFIED |
Unspecified. Treated as KEEP. |
KEEP |
Always respect settings in exported flow content. It may cause a import failure if some settings (e.g. custom NLU) are not supported in the agent to import into. |
FALLBACK |
Fallback to default settings if some settings are not supported in the agent to import into. E.g. Standard NLU will be used if custom NLU is not available. |
ImportFlowResponse
The response message for Flows.ImportFlow.
| Fields | |
|---|---|
flow |
The unique identifier of the new flow. Format: |
ImportIntentsMetadata
This type has no fields.
Metadata returned for the Intents.ImportIntents long running operation.
ImportIntentsRequest
The request message for Intents.ImportIntents.
| Fields | |
|---|---|
parent |
Required. The agent to import the intents into. Format: Authorization requires the following IAM permission on the specified resource
|
merge_ |
Merge option for importing intents. If not specified, |
Union field intents. Required. The intents to import. intents can be only one of the following: |
|
intents_ |
The Google Cloud Storage URI to import intents from. The format of this URI must be Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control. |
intents_ |
Uncompressed byte content of intents. |
MergeOption
Merge option when display name conflicts exist during import.
| Enums | |
|---|---|
MERGE_OPTION_UNSPECIFIED |
Unspecified. Should not be used. |
REJECT |
DEPRECATED: Please use [REPORT_CONFLICT][ImportIntentsRequest.REPORT_CONFLICT] instead. Fail the request if there are intents whose display names conflict with the display names of intents in the agent. |
REPLACE |
Replace the original intent in the agent with the new intent when display name conflicts exist. |
MERGE |
Merge the original intent with the new intent when display name conflicts exist. |
RENAME |
Create new intents with new display names to differentiate them from the existing intents when display name conflicts exist. |
REPORT_CONFLICT |
Report conflict information if display names conflict is detected. Otherwise, import intents. |
KEEP |
Keep the original intent and discard the conflicting new intent when display name conflicts exist. |
ImportIntentsResponse
The response message for Intents.ImportIntents.
| Fields | |
|---|---|
intents[] |
The unique identifier of the imported intents. Format: |
conflicting_ |
Info which resources have conflicts when [REPORT_CONFLICT][ImportIntentsResponse.REPORT_CONFLICT] merge_option is set in ImportIntentsRequest. |
ConflictingResources
Conflicting resources detected during the import process. Only filled when [REPORT_CONFLICT][ImportIntentsResponse.REPORT_CONFLICT] is set in the request and there are conflicts in the display names.
| Fields | |
|---|---|
intent_ |
Display names of conflicting intents. |
entity_ |
Display names of conflicting entities. |
ImportStrategy
Import strategies for the conflict resolution of resources (i.e. intents, entities, and webhooks) with identical display names during import operations.
| Enums | |
|---|---|
IMPORT_STRATEGY_UNSPECIFIED |
Unspecified. Treated as 'CREATE_NEW'. |
IMPORT_STRATEGY_CREATE_NEW |
Create a new resource with a numeric suffix appended to the end of the existing display name. |
IMPORT_STRATEGY_REPLACE |
Replace existing resource with incoming resource in the content to be imported. |
IMPORT_STRATEGY_KEEP |
Keep existing resource and discard incoming resource in the content to be imported. |
IMPORT_STRATEGY_MERGE |
Combine existing and incoming resources when a conflict is encountered. |
IMPORT_STRATEGY_THROW_ERROR |
Throw error if a conflict is encountered. |
ImportTestCasesMetadata
Metadata returned for the TestCases.ImportTestCases long running operation.
| Fields | |
|---|---|
errors[] |
Errors for failed test cases. |
ImportTestCasesRequest
The request message for TestCases.ImportTestCases.
| Fields | |
|---|---|
parent |
Required. The agent to import test cases to. Format: Authorization requires the following IAM permission on the specified resource
|
Union field source. Required. The source to import. source can be only one of the following: |
|
gcs_ |
The Google Cloud Storage URI to import test cases from. The format of this URI must be Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control. |
content |
Uncompressed raw byte content for test cases. |
ImportTestCasesResponse
The response message for TestCases.ImportTestCases.
| Fields | |
|---|---|
names[] |
The unique identifiers of the new test cases. Format: |
InlineDestination
Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.
| Fields | |
|---|---|
content |
Output only. The uncompressed byte content for the objects. Only populated in responses. |
InlineSource
Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow.
| Fields | |
|---|---|
content |
The uncompressed byte content for the objects. |
InputAudioConfig
Instructs the speech recognizer on how to process the audio content.
| Fields | |
|---|---|
audio_ |
Required. Audio encoding of the audio content to process. |
sample_ |
Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details. |
enable_ |
Optional. If |
phrase_ |
Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details. |
model |
Optional. Which Speech model to select for the given request. For more information, see Speech models. |
model_ |
Optional. Which variant of the |
single_ |
Optional. If |
barge_ |
Configuration of barge-in behavior during the streaming of input audio. |
opt_ |
If |
Intent
An intent represents a user's intent to interact with a conversational agent.
You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
| Fields | |
|---|---|
name |
The unique identifier of the intent. Required for the |
display_ |
Required. The human-readable name of the intent, unique within the agent. |
training_ |
The collection of training phrases the agent is trained on to identify the intent. |
parameters[] |
The collection of parameters associated with the intent. |
priority |
The priority of this intent. Higher numbers represent higher priorities.
|
is_ |
Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. |
labels |
The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. |
description |
Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
Parameter
Represents an intent parameter.
| Fields | |
|---|---|
id |
Required. The unique identifier of the parameter. This field is used by |
entity_ |
Required. The entity type of the parameter. Format: |
is_ |
Indicates whether the parameter represents a list of values. |
redact |
Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or |
TrainingPhrase
Represents an example that the agent is trained on to identify the intent.
| Fields | |
|---|---|
id |
Output only. The unique identifier of the training phrase. |
parts[] |
Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:
|
repeat_ |
Indicates how many times this example was added to the intent. |
Part
Represents a part of a training phrase.
| Fields | |
|---|---|
text |
Required. The text for this part. |
parameter_ |
The |
IntentCoverage
Intent coverage represents the percentage of all possible intents in the agent that are triggered in any of a parent's test cases.
| Fields | |
|---|---|
intents[] |
The list of Intents present in the agent |
coverage_ |
The percent of intents in the agent that are covered. |
Intent
The agent's intent.
| Fields | |
|---|---|
intent |
The intent full resource name |
covered |
Whether the intent is covered by at least one of the agent's test cases. |
IntentInput
Represents the intent to trigger programmatically rather than as a result of natural language processing.
| Fields | |
|---|---|
intent |
Required. The unique identifier of the intent. Format: |
IntentView
Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response.
| Enums | |
|---|---|
INTENT_VIEW_UNSPECIFIED |
Not specified. Treated as INTENT_VIEW_FULL. |
INTENT_VIEW_PARTIAL |
Training phrases field is not populated in the response. |
INTENT_VIEW_FULL |
All fields are populated. |
KnowledgeConnectorSettings
The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.
| Fields | |
|---|---|
enabled |
Whether Knowledge Connector is enabled or not. |
trigger_ |
The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter |
data_ |
Optional. List of related data store connections. |
Union field target. The target to transition to, either a page in the same host flow (the flow that owns this KnowledgeConnectorSettings), or another flow in the same agent. target can be only one of the following: |
|
target_ |
The target page to transition to. Format: |
target_ |
The target flow to transition to. Format: |
LanguageInfo
Represents the language information of the request.
| Fields | |
|---|---|
input_ |
The language code specified in the original |
resolved_ |
The language code detected for this request based on the user conversation. |
confidence_ |
The confidence score of the detected language between 0 and 1. |
ListAgentsRequest
The request message for Agents.ListAgents.
| Fields | |
|---|---|
parent |
Required. The location to list all agents for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListAgentsResponse
The response message for Agents.ListAgents.
| Fields | |
|---|---|
agents[] |
The list of agents. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListChangelogsRequest
The request message for Changelogs.ListChangelogs.
| Fields | |
|---|---|
parent |
Required. The agent containing the changelogs. Format: |
filter |
The filter string. Supports filter by user_email, resource, type and create_time. Some examples: 1. By user email: user_email = "someone@google.com" 2. By resource name: resource = "projects/123/locations/global/agents/456/flows/789" 3. By resource display name: display_name = "my agent" 4. By action: action = "Create" 5. By type: type = "flows" 6. By create time. Currently predicates on |
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListChangelogsResponse
The response message for Changelogs.ListChangelogs.
| Fields | |
|---|---|
changelogs[] |
The list of changelogs. There will be a maximum number of items returned based on the page_size field in the request. The changelogs will be ordered by timestamp. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListContinuousTestResultsRequest
The request message for Environments.ListContinuousTestResults.
| Fields | |
|---|---|
parent |
Required. The environment to list results for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListContinuousTestResultsResponse
The response message for [Environments.ListTestCaseResults][].
| Fields | |
|---|---|
continuous_ |
The list of continuous test results. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListDeploymentsRequest
The request message for Deployments.ListDeployments.
| Fields | |
|---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 20 and at most 100. |
page_ |
The next_page_token value returned from a previous list request. |
ListDeploymentsResponse
The response message for Deployments.ListDeployments.
| Fields | |
|---|---|
deployments[] |
The list of deployments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListEntityTypesRequest
The request message for EntityTypes.ListEntityTypes.
| Fields | |
|---|---|
parent |
Required. The agent to list all entity types for. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to list entity types for. The following fields are language dependent:
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. |
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListEntityTypesResponse
The response message for EntityTypes.ListEntityTypes.
| Fields | |
|---|---|
entity_ |
The list of entity types. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListEnvironmentsRequest
The request message for Environments.ListEnvironments.
| Fields | |
|---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 20 and at most 100. |
page_ |
The next_page_token value returned from a previous list request. |
ListEnvironmentsResponse
The response message for Environments.ListEnvironments.
| Fields | |
|---|---|
environments[] |
The list of environments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListExperimentsRequest
The request message for Experiments.ListExperiments.
| Fields | |
|---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 20 and at most 100. |
page_ |
The next_page_token value returned from a previous list request. |
ListExperimentsResponse
The response message for Experiments.ListExperiments.
| Fields | |
|---|---|
experiments[] |
The list of experiments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListFlowsRequest
The request message for Flows.ListFlows.
| Fields | |
|---|---|
parent |
Required. The agent containing the flows. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
language_ |
The language to list flows for. The following fields are language dependent:
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. |
ListFlowsResponse
The response message for Flows.ListFlows.
| Fields | |
|---|---|
flows[] |
The list of flows. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListGeneratorsRequest
The request message for Generators.ListGenerators.
| Fields | |
|---|---|
parent |
Required. The agent to list all generators for. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to list generators for. |
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListGeneratorsResponse
The response message for Generators.ListGenerators.
| Fields | |
|---|---|
generators[] |
The list of generators. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListIntentsRequest
The request message for Intents.ListIntents.
| Fields | |
|---|---|
parent |
Required. The agent to list all intents for. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to list intents for. The following fields are language dependent:
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. |
intent_ |
The resource view to apply to the returned intent. |
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListIntentsResponse
The response message for Intents.ListIntents.
| Fields | |
|---|---|
intents[] |
The list of intents. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListPagesRequest
The request message for Pages.ListPages.
| Fields | |
|---|---|
parent |
Required. The flow to list all pages for. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to list pages for. The following fields are language dependent:
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. |
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListPagesResponse
The response message for Pages.ListPages.
| Fields | |
|---|---|
pages[] |
The list of pages. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListSecuritySettingsRequest
The request message for [SecuritySettings.ListSecuritySettings][].
| Fields | |
|---|---|
parent |
Required. The location to list all security settings for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 20 and at most 100. |
page_ |
The next_page_token value returned from a previous list request. |
ListSecuritySettingsResponse
The response message for [SecuritySettings.ListSecuritySettings][].
| Fields | |
|---|---|
security_ |
The list of security settings. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListSessionEntityTypesRequest
The request message for SessionEntityTypes.ListSessionEntityTypes.
| Fields | |
|---|---|
parent |
Required. The session to list all session entity types from. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListSessionEntityTypesResponse
The response message for SessionEntityTypes.ListSessionEntityTypes.
| Fields | |
|---|---|
session_ |
The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListTestCaseResultsRequest
The request message for TestCases.ListTestCaseResults.
| Fields | |
|---|---|
parent |
Required. The test case to list results for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
filter |
The filter expression used to filter test case results. See API Filtering. The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: The supported fields and operators are: field operator
Examples: * "environment=draft AND latest" matches the latest test result for each test case in the draft environment. * "environment IN (e1,e2)" matches any test case results with an environment resource name of either "e1" or "e2". * "test_time > 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713. |
ListTestCaseResultsResponse
The response message for TestCases.ListTestCaseResults.
| Fields | |
|---|---|
test_ |
The list of test case results. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListTestCasesRequest
The request message for TestCases.ListTestCases.
| Fields | |
|---|---|
parent |
Required. The agent to list all pages for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500. |
page_ |
The next_page_token value returned from a previous list request. |
view |
Specifies whether response should include all fields or just the metadata. |
TestCaseView
Specifies how much test case information to include in the response.
| Enums | |
|---|---|
TEST_CASE_VIEW_UNSPECIFIED |
The default / unset value. The API will default to the BASIC view. |
BASIC |
Include basic metadata about the test case, but not the conversation turns. This is the default value. |
FULL |
Include everything. |
ListTestCasesResponse
The response message for TestCases.ListTestCases.
| Fields | |
|---|---|
test_ |
The list of test cases. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListTransitionRouteGroupsRequest
The request message for TransitionRouteGroups.ListTransitionRouteGroups.
| Fields | |
|---|---|
parent |
Required. The flow to list all transition route groups for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
language_ |
The language to list transition route groups for. The following fields are language dependent:
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. |
ListTransitionRouteGroupsResponse
The response message for TransitionRouteGroups.ListTransitionRouteGroups.
| Fields | |
|---|---|
transition_ |
The list of transition route groups. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListVersionsRequest
The request message for Versions.ListVersions.
| Fields | |
|---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 20 and at most 100. |
page_ |
The next_page_token value returned from a previous list request. |
ListVersionsResponse
The response message for Versions.ListVersions.
| Fields | |
|---|---|
versions[] |
A list of versions. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListWebhooksRequest
The request message for Webhooks.ListWebhooks.
| Fields | |
|---|---|
parent |
Required. The agent to list all webhooks for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListWebhooksResponse
The response message for Webhooks.ListWebhooks.
| Fields | |
|---|---|
webhooks[] |
The list of webhooks. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
LoadVersionRequest
The request message for Versions.LoadVersion.
| Fields | |
|---|---|
name |
Required. The Authorization requires the following IAM permission on the specified resource
|
allow_ |
This field is used to prevent accidental overwrite of other agent resources, which can potentially impact other flow's behavior. If |
LookupEnvironmentHistoryRequest
The request message for Environments.LookupEnvironmentHistory.
| Fields | |
|---|---|
name |
Required. Resource name of the environment to look up the history for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
LookupEnvironmentHistoryResponse
The response message for Environments.LookupEnvironmentHistory.
| Fields | |
|---|---|
environments[] |
Represents a list of snapshots for an environment. Time of the snapshots is stored in |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
Match
Represents one match result of [MatchIntent][].
| Fields | |
|---|---|
intent |
The |
event |
The event that matched the query. Filled for |
parameters |
The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
|
resolved_ |
Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. |
match_ |
Type of this |
confidence |
The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. |
MatchType
Type of a Match.
| Enums | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
Not specified. Should never be used. |
INTENT |
The query was matched to an intent. |
DIRECT_INTENT |
The query directly triggered an intent. |
PARAMETER_FILLING |
The query was used for parameter filling. |
NO_MATCH |
No match was found for the query. |
NO_INPUT |
Indicates an empty query. |
EVENT |
The query directly triggered an event. |
KNOWLEDGE_CONNECTOR |
The query was matched to a Knowledge Connector answer. |
PLAYBOOK |
The query was handled by a [Playbook][Playbook]. |
MatchIntentRequest
Request of [MatchIntent][].
| Fields | |
|---|---|
session |
Required. The name of the session this query is sent to. Format: For more information, see the sessions guide. Authorization requires the following IAM permission on the specified resource
|
query_ |
The parameters of this query. |
query_ |
Required. The input specification. |
persist_ |
Persist session parameter changes from |
MatchIntentResponse
Response of [MatchIntent][].
| Fields | |
|---|---|
matches[] |
Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query. |
current_ |
The current |
Union field query. The original conversational query. query can be only one of the following: |
|
text |
If |
trigger_ |
If an |
transcript |
If |
trigger_ |
If an |
NluSettings
Settings related to NLU.
| Fields | |
|---|---|
model_ |
Indicates the type of NLU model. |
classification_ |
To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. |
model_ |
Indicates NLU model training mode. |
ModelTrainingMode
NLU model training mode.
| Enums | |
|---|---|
MODEL_TRAINING_MODE_UNSPECIFIED |
Not specified. MODEL_TRAINING_MODE_AUTOMATIC will be used. |
MODEL_TRAINING_MODE_AUTOMATIC |
NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode. |
MODEL_TRAINING_MODE_MANUAL |
User needs to manually trigger NLU model training. Best for large flows whose models take long time to train. |
ModelType
NLU model type.
| Enums | |
|---|---|
MODEL_TYPE_UNSPECIFIED |
Not specified. MODEL_TYPE_STANDARD will be used. |
MODEL_TYPE_STANDARD |
Use standard NLU model. |
MODEL_TYPE_ADVANCED |
Use advanced NLU model. |
OutputAudioConfig
Instructs the speech synthesizer how to generate the output audio content.
| Fields | |
|---|---|
audio_ |
Required. Audio encoding of the synthesized audio content. |
sample_ |
Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
synthesize_ |
Optional. Configuration of how speech should be synthesized. If not specified, |
OutputAudioEncoding
Audio encoding of the output audio format in Text-To-Speech.
| Enums | |
|---|---|
OUTPUT_AUDIO_ENCODING_UNSPECIFIED |
Not specified. |
OUTPUT_AUDIO_ENCODING_LINEAR_16 |
Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header. |
OUTPUT_AUDIO_ENCODING_MP3 |
MP3 audio at 32kbps. |
OUTPUT_AUDIO_ENCODING_MP3_64_KBPS |
MP3 audio at 64kbps. |
OUTPUT_AUDIO_ENCODING_OGG_OPUS |
Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate. |
OUTPUT_AUDIO_ENCODING_MULAW |
8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
OUTPUT_AUDIO_ENCODING_ALAW |
8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law. |
Page
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.
For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.
You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.
For more information, see the Page guide.
| Fields | |
|---|---|
name |
The unique identifier of the page. Required for the |
display_ |
Required. The human-readable name of the page, unique within the flow. |
description |
The description of the page. The maximum length is 500 characters. |
entry_ |
The fulfillment to call when the session is entering the page. |
form |
The form associated with the page, used for collecting parameters relevant to the page. |
transition_ |
Ordered list of
Format: |
transition_ |
A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order:
|
event_ |
Handlers associated with the page to handle events such as webhook errors, no match or no input. |
advanced_ |
Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. |
knowledge_ |
Optional. Knowledge connector configuration. |
PageInfo
Represents page information communicated to and from the webhook.
| Fields | |
|---|---|
current_ |
Always present for |
display_ |
Always present for |
form_ |
Optional for both |
FormInfo
Represents form information.
| Fields | |
|---|---|
parameter_ |
Optional for both |
ParameterInfo
Represents parameter information.
| Fields | |
|---|---|
display_ |
Always present for |
required |
Optional for both |
state |
Always present for |
value |
Optional for both |
just_ |
Optional for |
ParameterState
Represents the state of a parameter.
| Enums | |
|---|---|
PARAMETER_STATE_UNSPECIFIED |
Not specified. This value should be never used. |
EMPTY |
Indicates that the parameter does not have a value. |
INVALID |
Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again. |
FILLED |
Indicates that the parameter has a value. |
Phrase
Text input which can be used for prompt or banned phrases.
| Fields | |
|---|---|
text |
Required. Text input which can be used for prompt or banned phrases. |
QueryInput
Represents the query input. It can contain one of:
A conversational query in the form of text.
An intent query that specifies which intent to trigger.
Natural language speech audio to be processed.
An event to be triggered.
DTMF digits to invoke an intent and fill in parameter value.
The results of a tool executed by the client.
| Fields | |
|---|---|
language_ |
Required. The language of the input. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
Union field input. Required. The input specification. input can be only one of the following: |
|
text |
The natural language text to be processed. |
intent |
The intent to be triggered. |
audio |
The natural language speech audio to be processed. |
event |
The event to be triggered. |
dtmf |
The DTMF event to be handled. |
QueryParameters
Represents the parameters of a conversational query.
| Fields | |
|---|---|
time_ |
The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used. |
geo_ |
The geo location of this conversational query. |
session_ |
Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. |
payload |
This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: |
parameters |
Additional parameters to be put into [session parameters][SessionInfo.parameters]. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
|
current_ |
The unique identifier of the If |
disable_ |
Whether to disable webhook calls for this request. |
analyze_ |
Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. |
webhook_ |
This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc. |
flow_ |
A list of flow versions to override for the request. Format: If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list. |
channel |
The channel which this query is for. If specified, only the If unspecified, the |
session_ |
Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day. |
end_ |
Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: |
search_ |
Optional. Search configuration for UCS search queries. |
populate_ |
Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations. |
QueryResult
Represents the result of a conversational query.
| Fields | |
|---|---|
language_ |
The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes. |
parameters |
The collected Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
|
response_ |
The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. |
webhook_ |
The list of webhook call status in the order of call sequence. |
webhook_ |
The list of webhook payload in |
current_ |
The current |
intent |
The |
intent_detection_confidence |
The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use |
match |
Intent match result, could be an intent or an event. |
diagnostic_ |
The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results:
|
sentiment_ |
The sentiment analyss result, which depends on |
advanced_ |
Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding. |
allow_ |
Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget. |
data_ |
Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate_data_store_connection_signals is set to true in the request. |
Union field query. The original conversational query. query can be only one of the following: |
|
text |
If |
trigger_ |
If an |
transcript |
If |
trigger_ |
If an |
dtmf |
If a |
ResourceName
Resource name and display name.
| Fields | |
|---|---|
name |
Name. |
display_ |
Display name. |
ResponseMessage
Represents a response message that can be returned by a conversational agent.
Response messages are also used for output audio synthesis. The approach is as follows:
- If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis.
- If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design.
- Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis.
This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
| Fields | |
|---|---|
response_ |
Response type. |
channel |
The channel which the response is associated with. Clients can specify the channel via |
Union field message. Required. The rich response message. message can be only one of the following: |
|
text |
Returns a text response. |
payload |
Returns a response containing a custom, platform-specific payload. |
conversation_ |
Indicates that the conversation succeeded. |
output_ |
A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
live_ |
Hands off conversation to a human agent. |
end_ |
Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches It's guaranteed that there is at most one such message in each response. |
play_ |
Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct |
mixed_ |
Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via |
telephony_ |
A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
knowledge_ |
Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. |
ConversationSuccess
Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.
Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.
You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.
| Fields | |
|---|---|
metadata |
Custom metadata. Dialogflow doesn't impose any structure on this. |
EndInteraction
This type has no fields.
Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.
KnowledgeInfoCard
This type has no fields.
Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card.
Otherwise, the info card response is skipped.
LiveAgentHandoff
Indicates that the conversation should be handed off to a live agent.
Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.
You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.
| Fields | |
|---|---|
metadata |
Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
MixedAudio
Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
| Fields | |
|---|---|
segments[] |
Segments this audio response is composed of. |
Segment
Represents one segment of audio.
| Fields | |
|---|---|
allow_ |
Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
Union field content. Content of the segment. content can be only one of the following: |
|
audio |
Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
uri |
Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
OutputAudioText
A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
| Fields | |
|---|---|
allow_ |
Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
Union field source. The source, which is either plain text or SSML. source can be only one of the following: |
|
text |
The raw text to be synthesized. |
ssml |
The SSML text to be synthesized. For more information, see SSML. |
PlayAudio
Specifies an audio clip to be played by the client as part of the response.
| Fields | |
|---|---|
audio_ |
Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
allow_ |
Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
ResponseType
Represents different response types.
| Enums | |
|---|---|
RESPONSE_TYPE_UNSPECIFIED |
Not specified. |
ENTRY_PROMPT |
The response is from an entry prompt in the page. |
PARAMETER_PROMPT |
The response is from form-filling prompt in the page. |
HANDLER_PROMPT |
The response is from a transition route or an [event handler][EventHandler] in the page or flow or transition route group. |
TelephonyTransferCall
Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.
| Fields | |
|---|---|
Union field endpoint. Endpoint to transfer the call to. endpoint can be only one of the following: |
|
phone_ |
Transfer the call to a phone number in E.164 format. |
Text
The text response message.
| Fields | |
|---|---|
text[] |
Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. |
allow_ |
Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
RestoreAgentRequest
The request message for Agents.RestoreAgent.
| Fields | |
|---|---|
name |
Required. The name of the agent to restore into. Format: Authorization requires the following IAM permission on the specified resource
|
restore_ |
Agent restore mode. If not specified, |
Union field agent. Required. The agent to restore. agent can be only one of the following: |
|
agent_ |
The Google Cloud Storage URI to restore agent from. The format of this URI must be Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control. |
agent_ |
Uncompressed raw byte content for agent. |
git_ |
Setting for restoring from a git branch |
GitSource
Settings for restoring from a git branch
| Fields | |
|---|---|
tracking_ |
tracking branch for the git pull |
RestoreOption
Restore option.
| Enums | |
|---|---|
RESTORE_OPTION_UNSPECIFIED |
Unspecified. Treated as KEEP. |
KEEP |
Always respect the settings from the exported agent file. It may cause a restoration failure if some settings (e.g. model type) are not supported in the target agent. |
FALLBACK |
Fallback to default settings if some settings are not supported in the target agent. |
RolloutConfig
The configuration for auto rollout.
| Fields | |
|---|---|
rollout_ |
Steps to roll out a flow version. Steps should be sorted by percentage in ascending order. |
rollout_ |
The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the conditions reference. |
failure_ |
The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the conditions reference. |
RolloutStep
A single rollout step with specified traffic allocation.
| Fields | |
|---|---|
display_ |
The name of the rollout step; |
traffic_ |
The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%]. |
min_ |
The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour. |
RolloutState
State of the auto-rollout process.
| Fields | |
|---|---|
step |
Display name of the current auto rollout step. |
step_ |
Index of the current step in the auto rollout steps list. |
start_ |
Start time of the current step. |
RunContinuousTestMetadata
Metadata returned for the Environments.RunContinuousTest long running operation.
| Fields | |
|---|---|
errors[] |
The test errors. |
RunContinuousTestRequest
The request message for Environments.RunContinuousTest.
| Fields | |
|---|---|
environment |
Required. Format: Authorization requires the following IAM permission on the specified resource
|
RunContinuousTestResponse
The response message for Environments.RunContinuousTest.
| Fields | |
|---|---|
continuous_ |
The result for a continuous test run. |
RunTestCaseMetadata
This type has no fields.
Metadata returned for the TestCases.RunTestCase long running operation. This message currently has no fields.
RunTestCaseRequest
The request message for TestCases.RunTestCase.
| Fields | |
|---|---|
name |
Required. Format of test case name to run: Authorization requires the following IAM permission on the specified resource
|
environment |
Optional. Environment name. If not set, draft environment is assumed. Format: |
RunTestCaseResponse
The response message for TestCases.RunTestCase.
| Fields | |
|---|---|
result |
The result. |
SafetySettings
Settings for Generative Safety.
| Fields | |
|---|---|
banned_ |
Banned phrases for generated text. |
Phrase
Text input which can be used for prompt or banned phrases.
| Fields | |
|---|---|
text |
Required. Text input which can be used for prompt or banned phrases. |
language_ |
Required. Language code of the phrase. |
SearchConfig
Search configuration for UCS search queries.
| Fields | |
|---|---|
boost_ |
Optional. Boosting configuration for the datastores. |
filter_ |
Optional. Filter configuration for the datastores. |
SecuritySettings
Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
| Fields | |
|---|---|
name |
Resource name of the settings. Required for the |
display_ |
Required. The human-readable name of the security settings, unique within the location. |
redaction_ |
Strategy that defines how we do redaction. |
redaction_ |
Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging. |
inspect_ |
DLP inspect template name. Use this template to define inspect base settings. The If empty, we use the default DLP inspect config. The template name will have one of the following formats: Note: |
deidentify_ |
DLP deidentify template name. Use this template to define de-identification configuration for the content. The If empty, Dialogflow replaces sensitive info with The template name will have one of the following formats: Note: |
purge_ |
List of types of data to remove when retention settings triggers purge. |
audio_ |
Controls audio export settings for post-conversation analytics when ingesting audio to conversations via [Participants.AnalyzeContent][] or [Participants.StreamingAnalyzeContent][]. If If audio export is enabled, audio is recorded and saved to [audio_export_settings.gcs_bucket][], subject to retention policy of [audio_export_settings.gcs_bucket][]. This setting won't effect audio input for implicit sessions via |
insights_ |
Controls conversation exporting settings to Insights after conversation is completed. If |
Union field data_retention. Specifies how data is retained. Note that even if the data is purged due to retention policy, we may still hold it in backup storage for a few days without allowing direct readings. data_retention can be only one of the following: |
|
retention_ |
Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact. |
retention_ |
Specifies the retention behavior defined by |
AudioExportSettings
Settings for exporting audio.
| Fields | |
|---|---|
gcs_ |
Cloud Storage bucket to export audio record to. Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy. |
audio_ |
Filename pattern for exported audio. |
enable_ |
Enable audio redaction if it is true. Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted. |
audio_ |
File format for exported audio file. Currently only in telephony recordings. |
store_ |
Whether to store TTS audio. By default, TTS audio from the virtual agent is not exported. |
AudioFormat
File format for exported audio file. Currently only in telephony recordings.
| Enums | |
|---|---|
AUDIO_FORMAT_UNSPECIFIED |
Unspecified. Do not use. |
MULAW |
G.711 mu-law PCM with 8kHz sample rate. |
MP3 |
MP3 file format. |
OGG |
OGG Vorbis. |
InsightsExportSettings
Settings for exporting conversations to Insights.
| Fields | |
|---|---|
enable_ |
If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers. |
PurgeDataType
Type of data we purge after retention settings triggers purge.
| Enums | |
|---|---|
PURGE_DATA_TYPE_UNSPECIFIED |
Unspecified. Do not use. |
DIALOGFLOW_HISTORY |
Dialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow. |
RedactionScope
Defines what types of data to redact.
| Enums | |
|---|---|
REDACTION_SCOPE_UNSPECIFIED |
Don't redact any kind of data. |
REDACT_DISK_STORAGE |
On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk. |
RedactionStrategy
Defines how we redact data.
| Enums | |
|---|---|
REDACTION_STRATEGY_UNSPECIFIED |
Do not redact. |
REDACT_WITH_SERVICE |
Call redaction service to clean up the data to be persisted. |
RetentionStrategy
Defines how long we retain persisted data that contains sensitive info.
| Enums | |
|---|---|
RETENTION_STRATEGY_UNSPECIFIED |
Retains the persisted data with Dialogflow's internal default 365d TTLs. |
REMOVE_AFTER_CONVERSATION |
Removes data when the conversation ends. If there is no [Conversation][] explicitly established, a default conversation ends when the corresponding Dialogflow session ends. |
SentimentAnalysisResult
The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral.
| Fields | |
|---|---|
score |
Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). |
magnitude |
A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). |
SessionEntityType
Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.
You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types").
Note: session entity types apply to all queries, regardless of the language.
For more information about entity types, see the Dialogflow documentation.
| Fields | |
|---|---|
name |
Required. The unique identifier of the session entity type. Format: |
entity_ |
Required. Indicates whether the additional data should override or supplement the custom entity type definition. |
entities[] |
Required. The collection of entities to override or supplement the custom entity type. |
EntityOverrideMode
The types of modifications for the session entity type.
| Enums | |
|---|---|
ENTITY_OVERRIDE_MODE_UNSPECIFIED |
Not specified. This value should be never used. |
ENTITY_OVERRIDE_MODE_OVERRIDE |
The collection of session entities overrides the collection of entities in the corresponding custom entity type. |
ENTITY_OVERRIDE_MODE_SUPPLEMENT |
The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to |
SessionInfo
Represents session information communicated to and from the webhook.
| Fields | |
|---|---|
session |
Always present for |
parameters |
Optional for |
SpeechModelVariant
Variant of the specified Speech model to use.
See the Cloud Speech documentation for which models have different variants. For example, the "phone_call" model has both a standard and an enhanced variant. When you use an enhanced model, you will generally receive higher quality results than for a standard model.
| Enums | |
|---|---|
SPEECH_MODEL_VARIANT_UNSPECIFIED |
No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE. |
USE_BEST_AVAILABLE |
Use the best available variant of the [Speech model][InputAudioConfig.model] that the caller is eligible for. |
USE_STANDARD |
Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models. |
USE_ENHANCED |
Use an enhanced model variant:
The Cloud Speech documentation describes which models have enhanced variants. |
SpeechToTextSettings
Settings related to speech recognition.
| Fields | |
|---|---|
enable_ |
Whether to use speech adaptation for speech recognition. |
SpeechWordInfo
Information for a word recognized by the speech recognizer.
| Fields | |
|---|---|
word |
The word this info is for. |
start_ |
Time offset relative to the beginning of the audio that corresponds to the start of the spoken word. This is an experimental feature and the accuracy of the time offset can vary. |
end_ |
Time offset relative to the beginning of the audio that corresponds to the end of the spoken word. This is an experimental feature and the accuracy of the time offset can vary. |
confidence |
The Speech confidence between 0.0 and 1.0 for this word. A higher number indicates an estimated greater likelihood that the recognized word is correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be fully stable over time for the same audio input. Users should also not rely on it to always be provided. |
SsmlVoiceGender
Gender of the voice as described in SSML voice element.
| Enums | |
|---|---|
SSML_VOICE_GENDER_UNSPECIFIED |
An unspecified gender, which means that the client doesn't care which gender the selected voice will have. |
SSML_VOICE_GENDER_MALE |
A male voice. |
SSML_VOICE_GENDER_FEMALE |
A female voice. |
SSML_VOICE_GENDER_NEUTRAL |
A gender-neutral voice. |
StartExperimentRequest
The request message for Experiments.StartExperiment.
| Fields | |
|---|---|
name |
Required. Resource name of the experiment to start. Format: Authorization requires the following IAM permission on the specified resource
|
StopExperimentRequest
The request message for Experiments.StopExperiment.
| Fields | |
|---|---|
name |
Required. Resource name of the experiment to stop. Format: Authorization requires the following IAM permission on the specified resource
|
StreamingDetectIntentRequest
The top-level message sent by the client to the Sessions.StreamingDetectIntent method.
Multiple request messages should be sent in order:
The first message must contain
session,query_inputplus optionallyquery_params. If the client wants to receive an audio response, it should also containoutput_audio_config.If
query_inputwas set toquery_input.audio.config, all subsequent messages must containquery_input.audio.audioto continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message withquery_input.text.
However, note that:
* Dialogflow will bill you for the audio duration so far.
* Dialogflow discards all Speech recognition results in favor of the
input text.
* Dialogflow will use the language code from the first message.
After you sent all input, you must half-close or abort the request stream.
| Fields | |
|---|---|
session |
The name of the session this query is sent to. Format: 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
|
query_ |
The parameters of this query. |
query_ |
Required. The input specification. |
output_ |
Instructs the speech synthesizer how to generate the output audio. |
enable_ |
Enable partial detect intent response. If this flag is not enabled, response stream still contains only one final |
enable_ |
If true, |
StreamingDetectIntentResponse
The top-level message returned from the StreamingDetectIntent method.
Multiple response messages (N) can be returned in order.
The first (N-1) responses set either the recognition_result or detect_intent_response field, depending on the request:
If the
StreamingDetectIntentRequest.query_input.audiofield was set, and theStreamingDetectIntentRequest.enable_partial_responsefield was false, therecognition_resultfield is populated for each of the (N-1) responses. See theStreamingRecognitionResultmessage for details about the result message sequence.If the
StreamingDetectIntentRequest.enable_partial_responsefield was true, thedetect_intent_responsefield is populated for each of the (N-1) responses, where 1 <= N <= 4. These responses set theDetectIntentResponse.response_typefield toPARTIAL.
For the final Nth response message, the detect_intent_response is fully populated, and DetectIntentResponse.response_type is set to FINAL.
| Fields | |
|---|---|
debugging_ |
Debugging info that would get populated when |
Union field response. The output response. response can be only one of the following: |
|
recognition_ |
The result of speech recognition. |
detect_ |
The response from detect intent. |
StreamingRecognitionResult
Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.
While end-user audio is being processed, Dialogflow sends a series of results. Each result may contain a transcript value. A transcript represents a portion of the utterance. While the recognizer is processing audio, transcript values may be interim values or finalized values. Once a transcript is finalized, the is_final value is set to true and processing continues for the next transcript.
If StreamingDetectIntentRequest.query_input.audio.config.single_utterance was true, and the recognizer has completed processing audio, the message_type value is set to `END_OF_SINGLE_UTTERANCE and the following (last) result contains the last finalized transcript.
The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results.
In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.
Num | transcript | message_type | is_final
--- | ----------------------- | ----------------------- | --------
1 | "tube" | TRANSCRIPT | false
2 | "to be a" | TRANSCRIPT | false
3 | "to be" | TRANSCRIPT | false
4 | "to be or not to be" | TRANSCRIPT | true
5 | "that's" | TRANSCRIPT | false
6 | "that is | TRANSCRIPT | false
7 | unset | END_OF_SINGLE_UTTERANCE | unset
8 | " that is the question" | TRANSCRIPT | true
Concatenating the finalized transcripts with is_final set to true, the complete utterance becomes "to be or not to be that is the question".
| Fields | |
|---|---|
message_ |
Type of the result message. |
transcript |
Transcript text representing the words that the user spoke. Populated if and only if |
is_ |
If |
confidence |
The Speech confidence between 0.0 and 1.0 for the current portion of audio. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is typically only provided if |
stability |
An estimate of the likelihood that the speech recognizer will not change its guess about this interim recognition result: * If the value is unspecified or 0.0, Dialogflow didn't compute the stability. In particular, Dialogflow will only provide stability for |
speech_ |
Word-specific information for the words recognized by Speech in |
speech_ |
Time offset of the end of this Speech recognition result relative to the beginning of the audio. Only populated for |
language_ |
Detected language code for the transcript. |
MessageType
Type of the response message.
| Enums | |
|---|---|
MESSAGE_TYPE_UNSPECIFIED |
Not specified. Should never be used. |
TRANSCRIPT |
Message contains a (possibly partial) transcript. |
END_OF_SINGLE_UTTERANCE |
This event indicates that the server has detected the end of the user's speech utterance and expects no additional speech. Therefore, the server will not process additional audio (although it may subsequently return additional results). The client should stop sending additional audio data, half-close the gRPC connection, and wait for any additional results until the server closes the gRPC connection. This message is only sent if true, and is not used otherwise. |
SubmitAnswerFeedbackRequest
The request to set the feedback for a bot answer.
| Fields | |
|---|---|
session |
Required. The name of the session the feedback was sent to. Authorization requires the following IAM permission on the specified resource
|
response_ |
Required. ID of the response to update its feedback. This is the same as DetectIntentResponse.response_id. |
answer_ |
Required. Feedback provided for a bot answer. |
update_ |
Optional. The mask to control which fields to update. If the mask is not present, all fields will be updated. |
SynthesizeSpeechConfig
Configuration of how speech should be synthesized.
| Fields | |
|---|---|
speaking_ |
Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. |
pitch |
Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. |
volume_ |
Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
effects_ |
Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. |
voice |
Optional. The desired voice of the synthesized audio. |
TestCase
Represents a test case.
| Fields | |
|---|---|
name |
The unique identifier of the test case. |
tags[] |
Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters. |
display_ |
Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters. |
notes |
Additional freeform notes about the test case. Limit of 400 characters. |
test_ |
Config for the test case. |
test_ |
The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly. |
creation_ |
Output only. When the test was created. |
last_ |
The latest test result. |
TestCaseError
Error info for importing a test.
| Fields | |
|---|---|
test_ |
The test case. |
status |
The status associated with the test case. |
TestCaseResult
Represents a result from running a test case in an agent environment.
| Fields | |
|---|---|
name |
The resource name for the test case result. Format: |
environment |
Environment where the test was run. If not set, it indicates the draft environment. |
conversation_ |
The conversation turns uttered during the test case replay in chronological order. |
test_ |
Whether the test case passed in the agent environment. |
test_ |
The time that the test was run. |
TestConfig
Represents configurations for a test case.
| Fields | |
|---|---|
tracking_ |
Session parameters to be compared when calculating differences. |
flow |
Flow name to start the test case with. Format: Only one of |
page |
The Only one of |
TestError
Error info for running a test.
| Fields | |
|---|---|
test_ |
The test case resource name. |
status |
The status associated with the test. |
test_ |
The timestamp when the test was completed. |
TestResult
The test result for a test case and an agent environment.
| Enums | |
|---|---|
TEST_RESULT_UNSPECIFIED |
Not specified. Should never be used. |
PASSED |
The test passed. |
FAILED |
The test did not pass. |
TestRunDifference
The description of differences between original and replayed agent output.
| Fields | |
|---|---|
type |
The type of diff. |
description |
A human readable description of the diff, showing the actual output vs expected output. |
DiffType
What part of the message replay differs from the test case.
| Enums | |
|---|---|
DIFF_TYPE_UNSPECIFIED |
Should never be used. |
INTENT |
The intent. |
PAGE |
The page. |
PARAMETERS |
The parameters. |
UTTERANCE |
The message utterance. |
FLOW |
The flow. |
TextInput
Represents the natural language text to be processed.
| Fields | |
|---|---|
text |
Required. The UTF-8 encoded natural language text to be processed. |
TextToSpeechSettings
Settings related to speech synthesizing.
| Fields | |
|---|---|
synthesize_ |
Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect:
|
TrainFlowRequest
The request message for Flows.TrainFlow.
| Fields | |
|---|---|
name |
Required. The flow to train. Format: Authorization requires the following IAM permission on the specified resource
|
TransitionCoverage
Transition coverage represents the percentage of all possible page transitions (page-level transition routes and event handlers, excluding transition route groups) present within any of a parent's test cases.
| Fields | |
|---|---|
transitions[] |
The list of Transitions present in the agent. |
coverage_ |
The percent of transitions in the agent that are covered. |
Transition
A transition in a page.
| Fields | |
|---|---|
source |
The start node of a transition. |
index |
The index of a transition in the transition list. Starting from 0. |
target |
The end node of a transition. |
covered |
Whether the transition is covered by at least one of the agent's test cases. |
Union field detail. The detailed transition. detail can be only one of the following: |
|
transition_ |
Intent route or condition route. |
event_ |
Event handler. |
TransitionNode
The source or target of a transition.
| Fields | |
|---|---|
Union field kind. A TransitionNode can be either a page or a flow. kind can be only one of the following: |
|
page |
Indicates a transition to a |
flow |
Indicates a transition to a |
TransitionRoute
A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order:
- If there is a
trigger_fulfillment - If there is a
target_page - If there is a
target_flow
| Fields | |
|---|---|
name |
Output only. The unique identifier of this transition route. |
description |
Optional. The description of the transition route. The maximum length is 500 characters. |
intent |
The unique identifier of an |
condition |
The condition to evaluate against See the conditions reference. At least one of |
trigger_ |
The fulfillment to call when the condition is satisfied. At least one of |
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_ |
The target page to transition to. Format: |
target_ |
The target flow to transition to. Format: |
TransitionRouteGroup
A TransitionRouteGroup represents a group of TransitionRoutesPage.
| Fields | |
|---|---|
name |
The unique identifier of the transition route group. |
display_ |
Required. The human-readable name of the transition route group, unique within the flow. The display name can be no longer than 30 characters. |
transition_ |
Transition routes associated with the |
TransitionRouteGroupCoverage
Transition route group coverage represents the percentage of all possible transition routes present within any of a parent's test cases. The results are grouped by the transition route group.
| Fields | |
|---|---|
coverages[] |
Transition route group coverages. |
coverage_ |
The percent of transition routes in all the transition route groups that are covered. |
Coverage
Coverage result message for one transition route group.
| Fields | |
|---|---|
route_ |
Transition route group metadata. Only name and displayName will be set. |
transitions[] |
The list of transition routes and coverage in the transition route group. |
coverage_ |
The percent of transition routes in the transition route group that are covered. |
Transition
A transition coverage in a transition route group.
| Fields | |
|---|---|
transition_ |
Intent route or condition route. |
covered |
Whether the transition route is covered by at least one of the agent's test cases. |
TurnSignals
Collection of all signals that were extracted for a single turn of the conversation.
| Fields | |
|---|---|
no_ |
Whether NLU predicted NO_MATCH. |
no_ |
Whether user provided no input. |
dtmf_ |
Whether user was using DTMF input. |
user_ |
Whether user was specifically asking for a live agent. |
agent_ |
Whether agent responded with LiveAgentHandoff fulfillment. |
reached_ |
Whether turn resulted in End Session page. |
webhook_ |
Human-readable statuses of the webhooks triggered during this turn. |
failure_ |
Failure reasons of the turn. |
sentiment_ |
Sentiment score of the user utterance if sentiment was enabled. |
sentiment_ |
Sentiment magnitude of the user utterance if sentiment was enabled. |
FailureReason
Reason why the conversation turn has failed.
| Enums | |
|---|---|
FAILURE_REASON_UNSPECIFIED |
Failure reason is not assigned. |
FAILED_INTENT |
Whether NLU failed to recognize user intent. |
FAILED_WEBHOOK |
Whether webhook failed during the turn. |
UpdateAgentRequest
The request message for Agents.UpdateAgent.
| Fields | |
|---|---|
agent |
Required. The agent to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
UpdateEntityTypeRequest
The request message for EntityTypes.UpdateEntityType.
| Fields | |
|---|---|
entity_ |
Required. The entity type to update. Authorization requires the following IAM permission on the specified resource
|
language_ |
The language of the following fields in
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. |
update_ |
The mask to control which fields get updated. |
UpdateEnvironmentRequest
The request message for Environments.UpdateEnvironment.
| Fields | |
|---|---|
environment |
Required. The environment to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to control which fields get updated. |
UpdateExperimentRequest
The request message for Experiments.UpdateExperiment.
| Fields | |
|---|---|
experiment |
Required. The experiment to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to control which fields get updated. |
UpdateFlowRequest
The request message for Flows.UpdateFlow.
| Fields | |
|---|---|
flow |
Required. The flow to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
language_ |
The language of the following fields in
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. |
UpdateGenerativeSettingsRequest
Request for UpdateGenerativeSettings RPC.
| Fields | |
|---|---|
generative_ |
Required. Generative settings to update. |
update_ |
Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
UpdateGeneratorRequest
The request message for Generators.UpdateGenerator.
| Fields | |
|---|---|
generator |
Required. The generator to update. Authorization requires the following IAM permission on the specified resource
|
language_ |
The language to list generators for. |
update_ |
The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
UpdateIntentRequest
The request message for Intents.UpdateIntent.
| Fields | |
|---|---|
intent |
Required. The intent to update. Authorization requires the following IAM permission on the specified resource
|
language_ |
The language of the following fields in
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. |
update_ |
The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
UpdatePageRequest
The request message for Pages.UpdatePage.
| Fields | |
|---|---|
page |
Required. The page to update. Authorization requires the following IAM permission on the specified resource
|
language_ |
The language of the following fields in
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. |
update_ |
The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
UpdateSecuritySettingsRequest
The request message for SecuritySettingsService.UpdateSecuritySettings.
| Fields | |
|---|---|
security_ |
Required. [SecuritySettings] object that contains values for each of the fields to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
UpdateSessionEntityTypeRequest
The request message for SessionEntityTypes.UpdateSessionEntityType.
| Fields | |
|---|---|
session_ |
Required. The session entity type to update. Format: Authorization requires the following IAM permission on the specified resource
|
update_ |
The mask to control which fields get updated. |
UpdateTestCaseRequest
The request message for TestCases.UpdateTestCase.
| Fields | |
|---|---|
test_ |
Required. The test case to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to specify which fields should be updated. The |
UpdateTransitionRouteGroupRequest
The request message for TransitionRouteGroups.UpdateTransitionRouteGroup.
| Fields | |
|---|---|
transition_ |
Required. The transition route group to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
The mask to control which fields get updated. |
language_ |
The language of the following fields in
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. |
UpdateVersionRequest
The request message for Versions.UpdateVersion.
| Fields | |
|---|---|
version |
Required. The version to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to control which fields get updated. Currently only |
UpdateWebhookRequest
The request message for Webhooks.UpdateWebhook.
| Fields | |
|---|---|
webhook |
Required. The webhook to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
ValidateAgentRequest
The request message for Agents.ValidateAgent.
| Fields | |
|---|---|
name |
Required. The agent to validate. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
If not specified, the agent's default language is used. |
ValidateFlowRequest
The request message for Flows.ValidateFlow.
| Fields | |
|---|---|
name |
Required. The flow to validate. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
If not specified, the agent's default language is used. |
ValidationMessage
Agent/flow validation message.
| Fields | |
|---|---|
resource_ |
The type of the resources where the message is found. |
resources[] |
The names of the resources where the message is found. |
resource_ |
The resource names of the resources where the message is found. |
severity |
Indicates the severity of the message. |
detail |
The message detail. |
ResourceType
Resource types.
| Enums | |
|---|---|
RESOURCE_TYPE_UNSPECIFIED |
Unspecified. |
AGENT |
Agent. |
INTENT |
Intent. |
INTENT_TRAINING_PHRASE |
Intent training phrase. |
INTENT_PARAMETER |
Intent parameter. |
INTENTS |
Multiple intents. |
INTENT_TRAINING_PHRASES |
Multiple training phrases. |
ENTITY_TYPE |
Entity type. |
ENTITY_TYPES |
Multiple entity types. |
WEBHOOK |
Webhook. |
FLOW |
Flow. |
PAGE |
Page. |
PAGES |
Multiple pages. |
TRANSITION_ROUTE_GROUP |
Transition route group. |
AGENT_TRANSITION_ROUTE_GROUP |
Agent transition route group. |
Severity
Severity level.
| Enums | |
|---|---|
SEVERITY_UNSPECIFIED |
Unspecified. |
INFO |
The agent doesn't follow Dialogflow best practices. |
WARNING |
The agent may not behave as expected. |
ERROR |
The agent may experience failures. |
VariantsHistory
The history of variants update.
| Fields | |
|---|---|
update_ |
Update time of the variants. |
Union field variants. The variants updated. We currently only support single variant experiment. variants can be only one of the following: |
|
version_ |
The flow versions as the variants. |
Version
Represents a version of a flow.
| Fields | |
|---|---|
name |
Format: projects/ |
display_ |
Required. The human-readable name of the version. Limit of 64 characters. |
description |
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected. |
nlu_ |
Output only. The NLU settings of the flow at version creation. |
create_ |
Output only. Create time of the version. |
state |
Output only. The state of this version. This field is read-only and cannot be set by create and update methods. |
State
The state of the version.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Not specified. This value is not used. |
RUNNING |
Version is not ready to serve (e.g. training is running). |
SUCCEEDED |
Training has succeeded and this version is ready to serve. |
FAILED |
Version training failed. |
VersionVariants
A list of flow version variants.
| Fields | |
|---|---|
variants[] |
A list of flow version variants. |
Variant
A single flow version with specified traffic allocation.
| Fields | |
|---|---|
version |
The name of the flow version. Format: |
traffic_ |
Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0. |
is_ |
Whether the variant is for the control group. |
VoiceSelectionParams
Description of which voice to use for speech synthesis.
| Fields | |
|---|---|
name |
Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and For the list of available voices, please refer to Supported voices and languages. |
ssml_ |
Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and |
Webhook
Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
| Fields | |
|---|---|
name |
The unique identifier of the webhook. Required for the |
display_ |
Required. The human-readable name of the webhook, unique within the agent. |
timeout |
Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds. |
disabled |
Indicates whether the webhook is disabled. |
Union field webhook. Required. The webhook configuration. webhook can be only one of the following: |
|
generic_ |
Configuration for a generic web service. |
service_ |
Configuration for a Service Directory service. |
GenericWebService
Represents configuration for a generic web service.
| Fields | |
|---|---|
uri |
Required. The webhook URI for receiving POST requests. It must use https protocol. |
username |
The user name for HTTP Basic authentication. |
password |
The password for HTTP Basic authentication. |
request_ |
The HTTP request headers to send together with webhook requests. |
allowed_ |
Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, |
oauth_ |
Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. |
service_ |
Optional. Indicate the auth token type generated from the Diglogflow service agent. The generated token is sent in the Authorization header. |
webhook_ |
Optional. Type of the webhook. |
http_ |
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. |
request_ |
Optional. Defines a custom JSON object as request body to send to flexible webhook. |
parameter_ |
Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response |
HttpMethod
HTTP method to use when calling webhooks.
| Enums | |
|---|---|
HTTP_METHOD_UNSPECIFIED |
HTTP method not specified. |
POST |
HTTP POST Method. |
GET |
HTTP GET Method. |
HEAD |
HTTP HEAD Method. |
PUT |
HTTP PUT Method. |
DELETE |
HTTP DELETE Method. |
PATCH |
HTTP PATCH Method. |
OPTIONS |
HTTP OPTIONS Method. |
OAuthConfig
Represents configuration of OAuth client credential flow for 3rd party API authentication.
| Fields | |
|---|---|
client_ |
Required. The client ID provided by the 3rd party platform. |
client_ |
Required. The client secret provided by the 3rd party platform. |
token_ |
Required. The token endpoint provided by the 3rd party platform to exchange an access token. |
scopes[] |
Optional. The OAuth scopes to grant. |
ServiceAgentAuth
Indicate the auth token type generated from the Diglogflow service agent.
| Enums | |
|---|---|
SERVICE_AGENT_AUTH_UNSPECIFIED |
Service agent auth type unspecified. Default to ID_TOKEN. |
NONE |
No token used. |
ID_TOKEN |
Use ID token generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com. |
ACCESS_TOKEN |
Use access token generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com. |
WebhookType
Represents the type of webhook configuration.
| Enums | |
|---|---|
WEBHOOK_TYPE_UNSPECIFIED |
Default value. This value is unused. |
STANDARD |
Represents a standard webhook. |
FLEXIBLE |
Represents a flexible webhook. |
ServiceDirectoryConfig
Represents configuration for a Service Directory service.
| Fields | |
|---|---|
service |
Required. The name of Service Directory service. Format: |
generic_ |
Generic Service configuration of this webhook. |
WebhookRequest
The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.
You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.
| Fields | |
|---|---|
detect_ |
Always present. The unique identifier of the |
language_ |
The language code specified in the [original request][QueryInput.language_code]. |
fulfillment_ |
Always present. Information about the fulfillment that triggered this webhook call. |
intent_ |
Information about the last matched intent. |
page_ |
Information about page status. |
session_ |
Information about session status. |
messages[] |
The list of rich message responses to present to the user. Webhook can choose to append or replace this list in |
payload |
Custom data set in |
sentiment_ |
The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request. |
language_ |
Information about the language of the request. |
Union field query. The original conversational query. query can be only one of the following: |
|
text |
If |
trigger_ |
If an |
transcript |
If |
trigger_ |
If an |
dtmf_ |
If |
FulfillmentInfo
Represents fulfillment information communicated to the webhook.
| Fields | |
|---|---|
tag |
Always present. The value of the |
IntentInfo
Represents intent information communicated to the webhook.
| Fields | |
|---|---|
last_ |
Always present. The unique identifier of the last matched |
display_ |
Always present. The display name of the last matched |
parameters |
Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user's utterance. All parameters defined in the matched intent that are identified will be surfaced here. |
confidence |
The confidence of the matched intent. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). |
IntentParameterValue
Represents a value for an intent parameter.
| Fields | |
|---|---|
original_ |
Always present. Original text value extracted from user utterance. |
resolved_ |
Always present. Structured value for the parameter extracted from user utterance. |
SentimentAnalysisResult
Represents the result of sentiment analysis.
| Fields | |
|---|---|
score |
Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). |
magnitude |
A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). |
WebhookResponse
The response message for a webhook call.
| Fields | |
|---|---|
fulfillment_ |
The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user. |
page_ |
Information about page status. This field can be omitted by the webhook if it does not intend to modify page status. |
session_ |
Information about session status. This field can be omitted by the webhook if it does not intend to modify session status. |
payload |
Value to append directly to |
Union field transition. The target to transition to. This can be set optionally to indicate an immediate transition to a different page in the same host flow, or a different flow in the same agent. transition can be only one of the following: |
|
target_ |
The target page to transition to. Format: |
target_ |
The target flow to transition to. Format: |
FulfillmentResponse
Represents a fulfillment response to the user.
| Fields | |
|---|---|
messages[] |
The list of rich message responses to present to the user. |
merge_ |
Merge behavior for |
MergeBehavior
Defines merge behavior for messages.
| Enums | |
|---|---|
MERGE_BEHAVIOR_UNSPECIFIED |
Not specified. APPEND will be used. |
APPEND |
messages will be appended to the list of messages waiting to be sent to the user. |
REPLACE |
messages will replace the list of messages waiting to be sent to the user. |