Index
Agents
(interface)Changelogs
(interface)Deployments
(interface)EntityTypes
(interface)Environments
(interface)Experiments
(interface)Flows
(interface)Generators
(interface)Intents
(interface)Pages
(interface)SecuritySettingsService
(interface)SessionEntityTypes
(interface)Sessions
(interface)TestCases
(interface)TransitionRouteGroups
(interface)Versions
(interface)Webhooks
(interface)AdvancedSettings
(message)AdvancedSettings.DtmfSettings
(message)AdvancedSettings.LoggingSettings
(message)AdvancedSettings.SpeechSettings
(message)Agent
(message)Agent.AnswerFeedbackSettings
(message)Agent.ClientCertificateSettings
(message)Agent.GenAppBuilderSettings
(message)Agent.GitIntegrationSettings
(message)Agent.GitIntegrationSettings.GithubSettings
(message)Agent.PersonalizationSettings
(message)AgentValidationResult
(message)AnswerFeedback
(message)AnswerFeedback.Rating
(enum)AnswerFeedback.RatingReason
(message)AudioEncoding
(enum)AudioInput
(message)BargeInConfig
(message)BatchDeleteTestCasesRequest
(message)BatchRunTestCasesMetadata
(message)BatchRunTestCasesRequest
(message)BatchRunTestCasesResponse
(message)BoostSpec
(message)BoostSpec.ConditionBoostSpec
(message)BoostSpec.ConditionBoostSpec.BoostControlSpec
(message)BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType
(enum)BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint
(message)BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType
(enum)BoostSpecs
(message)CalculateCoverageRequest
(message)CalculateCoverageRequest.CoverageType
(enum)CalculateCoverageResponse
(message)Changelog
(message)CloudConversationDebuggingInfo
(message)CompareVersionsRequest
(message)CompareVersionsResponse
(message)ContinuousTestResult
(message)ContinuousTestResult.AggregatedTestResult
(enum)ConversationSignals
(message)ConversationTurn
(message)ConversationTurn.UserInput
(message)ConversationTurn.VirtualAgentOutput
(message)CreateAgentRequest
(message)CreateEntityTypeRequest
(message)CreateEnvironmentRequest
(message)CreateExperimentRequest
(message)CreateFlowRequest
(message)CreateGeneratorRequest
(message)CreateIntentRequest
(message)CreatePageRequest
(message)CreateSecuritySettingsRequest
(message)CreateSessionEntityTypeRequest
(message)CreateTestCaseRequest
(message)CreateTransitionRouteGroupRequest
(message)CreateVersionOperationMetadata
(message)CreateVersionRequest
(message)CreateWebhookRequest
(message)DataStoreConnection
(message)DataStoreConnectionSignals
(message)DataStoreConnectionSignals.AnswerGenerationModelCallSignals
(message)DataStoreConnectionSignals.AnswerPart
(message)DataStoreConnectionSignals.CitedSnippet
(message)DataStoreConnectionSignals.GroundingSignals
(message)DataStoreConnectionSignals.GroundingSignals.GroundingDecision
(enum)DataStoreConnectionSignals.GroundingSignals.GroundingScoreBucket
(enum)DataStoreConnectionSignals.RewriterModelCallSignals
(message)DataStoreConnectionSignals.SafetySignals
(message)DataStoreConnectionSignals.SafetySignals.BannedPhraseMatch
(enum)DataStoreConnectionSignals.SafetySignals.SafetyDecision
(enum)DataStoreConnectionSignals.SearchSnippet
(message)DataStoreType
(enum)DeleteAgentRequest
(message)DeleteEntityTypeRequest
(message)DeleteEnvironmentRequest
(message)DeleteExperimentRequest
(message)DeleteFlowRequest
(message)DeleteGeneratorRequest
(message)DeleteIntentRequest
(message)DeletePageRequest
(message)DeleteSecuritySettingsRequest
(message)DeleteSessionEntityTypeRequest
(message)DeleteTransitionRouteGroupRequest
(message)DeleteVersionRequest
(message)DeleteWebhookRequest
(message)DeployFlowMetadata
(message)DeployFlowRequest
(message)DeployFlowResponse
(message)Deployment
(message)Deployment.Result
(message)Deployment.State
(enum)DetectIntentRequest
(message)DetectIntentResponse
(message)DetectIntentResponse.ResponseType
(enum)DocumentProcessingMode
(enum)DtmfInput
(message)EntityType
(message)EntityType.AutoExpansionMode
(enum)EntityType.Entity
(message)EntityType.ExcludedPhrase
(message)EntityType.Kind
(enum)Environment
(message)Environment.TestCasesConfig
(message)Environment.VersionConfig
(message)Environment.WebhookConfig
(message)EventHandler
(message)EventInput
(message)Experiment
(message)Experiment.Definition
(message)Experiment.Result
(message)Experiment.Result.ConfidenceInterval
(message)Experiment.Result.CountType
(enum)Experiment.Result.Metric
(message)Experiment.Result.MetricType
(enum)Experiment.Result.VersionMetrics
(message)Experiment.State
(enum)ExportAgentRequest
(message)ExportAgentRequest.DataFormat
(enum)ExportAgentRequest.GitDestination
(message)ExportAgentResponse
(message)ExportEntityTypesMetadata
(message)ExportEntityTypesRequest
(message)ExportEntityTypesRequest.DataFormat
(enum)ExportEntityTypesResponse
(message)ExportFlowRequest
(message)ExportFlowResponse
(message)ExportIntentsMetadata
(message)ExportIntentsRequest
(message)ExportIntentsRequest.DataFormat
(enum)ExportIntentsResponse
(message)ExportTestCasesMetadata
(message)ExportTestCasesRequest
(message)ExportTestCasesRequest.DataFormat
(enum)ExportTestCasesResponse
(message)FilterSpecs
(message)Flow
(message)Flow.MultiLanguageSettings
(message)FlowImportStrategy
(message)FlowValidationResult
(message)Form
(message)Form.Parameter
(message)Form.Parameter.FillBehavior
(message)FulfillIntentRequest
(message)FulfillIntentResponse
(message)Fulfillment
(message)Fulfillment.ConditionalCases
(message)Fulfillment.ConditionalCases.Case
(message)Fulfillment.ConditionalCases.Case.CaseContent
(message)Fulfillment.SetParameterAction
(message)GcsDestination
(message)GenerativeSettings
(message)GenerativeSettings.FallbackSettings
(message)GenerativeSettings.FallbackSettings.PromptTemplate
(message)GenerativeSettings.KnowledgeConnectorSettings
(message)Generator
(message)Generator.ModelParameter
(message)Generator.Placeholder
(message)GetAgentRequest
(message)GetAgentValidationResultRequest
(message)GetChangelogRequest
(message)GetDeploymentRequest
(message)GetEntityTypeRequest
(message)GetEnvironmentRequest
(message)GetExperimentRequest
(message)GetFlowRequest
(message)GetFlowValidationResultRequest
(message)GetGenerativeSettingsRequest
(message)GetGeneratorRequest
(message)GetIntentRequest
(message)GetPageRequest
(message)GetSecuritySettingsRequest
(message)GetSessionEntityTypeRequest
(message)GetTestCaseRequest
(message)GetTestCaseResultRequest
(message)GetTransitionRouteGroupRequest
(message)GetVersionRequest
(message)GetWebhookRequest
(message)ImportEntityTypesMetadata
(message)ImportEntityTypesRequest
(message)ImportEntityTypesRequest.MergeOption
(enum)ImportEntityTypesResponse
(message)ImportEntityTypesResponse.ConflictingResources
(message)ImportFlowRequest
(message)ImportFlowRequest.ImportOption
(enum)ImportFlowResponse
(message)ImportIntentsMetadata
(message)ImportIntentsRequest
(message)ImportIntentsRequest.MergeOption
(enum)ImportIntentsResponse
(message)ImportIntentsResponse.ConflictingResources
(message)ImportStrategy
(enum)ImportTestCasesMetadata
(message)ImportTestCasesRequest
(message)ImportTestCasesResponse
(message)InlineDestination
(message)InlineSource
(message)InputAudioConfig
(message)Intent
(message)Intent.Parameter
(message)Intent.TrainingPhrase
(message)Intent.TrainingPhrase.Part
(message)IntentCoverage
(message)IntentCoverage.Intent
(message)IntentInput
(message)IntentView
(enum)KnowledgeConnectorSettings
(message)LanguageInfo
(message)ListAgentsRequest
(message)ListAgentsResponse
(message)ListChangelogsRequest
(message)ListChangelogsResponse
(message)ListContinuousTestResultsRequest
(message)ListContinuousTestResultsResponse
(message)ListDeploymentsRequest
(message)ListDeploymentsResponse
(message)ListEntityTypesRequest
(message)ListEntityTypesResponse
(message)ListEnvironmentsRequest
(message)ListEnvironmentsResponse
(message)ListExperimentsRequest
(message)ListExperimentsResponse
(message)ListFlowsRequest
(message)ListFlowsResponse
(message)ListGeneratorsRequest
(message)ListGeneratorsResponse
(message)ListIntentsRequest
(message)ListIntentsResponse
(message)ListPagesRequest
(message)ListPagesResponse
(message)ListSecuritySettingsRequest
(message)ListSecuritySettingsResponse
(message)ListSessionEntityTypesRequest
(message)ListSessionEntityTypesResponse
(message)ListTestCaseResultsRequest
(message)ListTestCaseResultsResponse
(message)ListTestCasesRequest
(message)ListTestCasesRequest.TestCaseView
(enum)ListTestCasesResponse
(message)ListTransitionRouteGroupsRequest
(message)ListTransitionRouteGroupsResponse
(message)ListVersionsRequest
(message)ListVersionsResponse
(message)ListWebhooksRequest
(message)ListWebhooksResponse
(message)LoadVersionRequest
(message)LookupEnvironmentHistoryRequest
(message)LookupEnvironmentHistoryResponse
(message)Match
(message)Match.MatchType
(enum)MatchIntentRequest
(message)MatchIntentResponse
(message)NluSettings
(message)NluSettings.ModelTrainingMode
(enum)NluSettings.ModelType
(enum)OutputAudioConfig
(message)OutputAudioEncoding
(enum)Page
(message)PageInfo
(message)PageInfo.FormInfo
(message)PageInfo.FormInfo.ParameterInfo
(message)PageInfo.FormInfo.ParameterInfo.ParameterState
(enum)Phrase
(message)QueryInput
(message)QueryParameters
(message)QueryResult
(message)ResourceName
(message)ResponseMessage
(message)ResponseMessage.ConversationSuccess
(message)ResponseMessage.EndInteraction
(message)ResponseMessage.KnowledgeInfoCard
(message)ResponseMessage.LiveAgentHandoff
(message)ResponseMessage.MixedAudio
(message)ResponseMessage.MixedAudio.Segment
(message)ResponseMessage.OutputAudioText
(message)ResponseMessage.PlayAudio
(message)ResponseMessage.ResponseType
(enum)ResponseMessage.TelephonyTransferCall
(message)ResponseMessage.Text
(message)RestoreAgentRequest
(message)RestoreAgentRequest.GitSource
(message)RestoreAgentRequest.RestoreOption
(enum)RolloutConfig
(message)RolloutConfig.RolloutStep
(message)RolloutState
(message)RunContinuousTestMetadata
(message)RunContinuousTestRequest
(message)RunContinuousTestResponse
(message)RunTestCaseMetadata
(message)RunTestCaseRequest
(message)RunTestCaseResponse
(message)SafetySettings
(message)SafetySettings.Phrase
(message)SearchConfig
(message)SecuritySettings
(message)SecuritySettings.AudioExportSettings
(message)SecuritySettings.AudioExportSettings.AudioFormat
(enum)SecuritySettings.InsightsExportSettings
(message)SecuritySettings.PurgeDataType
(enum)SecuritySettings.RedactionScope
(enum)SecuritySettings.RedactionStrategy
(enum)SecuritySettings.RetentionStrategy
(enum)SentimentAnalysisResult
(message)SessionEntityType
(message)SessionEntityType.EntityOverrideMode
(enum)SessionInfo
(message)SpeechModelVariant
(enum)SpeechToTextSettings
(message)SpeechWordInfo
(message)SsmlVoiceGender
(enum)StartExperimentRequest
(message)StopExperimentRequest
(message)StreamingDetectIntentRequest
(message)StreamingDetectIntentResponse
(message)StreamingRecognitionResult
(message)StreamingRecognitionResult.MessageType
(enum)SubmitAnswerFeedbackRequest
(message)SynthesizeSpeechConfig
(message)TestCase
(message)TestCaseError
(message)TestCaseResult
(message)TestConfig
(message)TestError
(message)TestResult
(enum)TestRunDifference
(message)TestRunDifference.DiffType
(enum)TextInput
(message)TextToSpeechSettings
(message)TrainFlowRequest
(message)TransitionCoverage
(message)TransitionCoverage.Transition
(message)TransitionCoverage.TransitionNode
(message)TransitionRoute
(message)TransitionRouteGroup
(message)TransitionRouteGroupCoverage
(message)TransitionRouteGroupCoverage.Coverage
(message)TransitionRouteGroupCoverage.Coverage.Transition
(message)TurnSignals
(message)TurnSignals.FailureReason
(enum)UpdateAgentRequest
(message)UpdateEntityTypeRequest
(message)UpdateEnvironmentRequest
(message)UpdateExperimentRequest
(message)UpdateFlowRequest
(message)UpdateGenerativeSettingsRequest
(message)UpdateGeneratorRequest
(message)UpdateIntentRequest
(message)UpdatePageRequest
(message)UpdateSecuritySettingsRequest
(message)UpdateSessionEntityTypeRequest
(message)UpdateTestCaseRequest
(message)UpdateTransitionRouteGroupRequest
(message)UpdateVersionRequest
(message)UpdateWebhookRequest
(message)ValidateAgentRequest
(message)ValidateFlowRequest
(message)ValidationMessage
(message)ValidationMessage.ResourceType
(enum)ValidationMessage.Severity
(enum)VariantsHistory
(message)Version
(message)Version.State
(enum)VersionVariants
(message)VersionVariants.Variant
(message)VoiceSelectionParams
(message)Webhook
(message)Webhook.GenericWebService
(message)Webhook.GenericWebService.HttpMethod
(enum)Webhook.GenericWebService.OAuthConfig
(message)Webhook.GenericWebService.ServiceAgentAuth
(enum)Webhook.GenericWebService.WebhookType
(enum)Webhook.ServiceDirectoryConfig
(message)WebhookRequest
(message)WebhookRequest.FulfillmentInfo
(message)WebhookRequest.IntentInfo
(message)WebhookRequest.IntentInfo.IntentParameterValue
(message)WebhookRequest.SentimentAnalysisResult
(message)WebhookResponse
(message)WebhookResponse.FulfillmentResponse
(message)WebhookResponse.FulfillmentResponse.MergeBehavior
(enum)
Agents
Service for managing Agents
.
CreateAgent |
---|
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. |
satisfies_ |
Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent. |
satisfies_ |
Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent. |
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: |
document_ |
The document processing mode for the data store connection. Should only be set for PUBLIC_WEB and UNSTRUCTURED data stores. If not set it is considered as DOCUMENTS, as this is the legacy mode. |
DataStoreConnectionSignals
Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ...
Fields | |
---|---|
rewriter_ |
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. |
DocumentProcessingMode
The document processing mode of the data store.
Enums | |
---|---|
DOCUMENT_PROCESSING_MODE_UNSPECIFIED |
Not specified. This should be set for STRUCTURED type data stores. Due to legacy reasons this is considered as DOCUMENTS for STRUCTURED and PUBLIC_WEB data stores. |
DOCUMENTS |
Documents are processed as documents. |
CHUNKS |
Documents are converted to chunks. |
DtmfInput
Represents the input for dtmf event.
Fields | |
---|---|
digits |
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
EntityType
type.Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauce
entity for red or white pizza sauce, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
type.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the
SessionEntityType
type.
For more information about entity types, see the Dialogflow documentation.
Fields | |
---|---|
name |
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
associated with the event, it will be called.trigger_fulfillment
- If there is a
associated with the event, the session will transition into the specified page.target_page
- If there is a
associated with the event, the session will transition into the specified flow.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. |
|