1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.cloud.dialogflow.cx.v3beta1; 18 19import "google/api/field_behavior.proto"; 20import "google/cloud/dialogflow/cx/v3beta1/gcs.proto"; 21import "google/protobuf/duration.proto"; 22 23option cc_enable_arenas = true; 24option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1"; 25option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb"; 26option java_multiple_files = true; 27option java_outer_classname = "AdvancedSettingsProto"; 28option java_package = "com.google.cloud.dialogflow.cx.v3beta1"; 29option objc_class_prefix = "DF"; 30option ruby_package = "Google::Cloud::Dialogflow::CX::V3beta1"; 31 32// Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. 33// Settings exposed at lower level overrides the settings exposed at higher 34// level. Overriding occurs at the sub-setting level. For example, the 35// playback_interruption_settings at fulfillment level only overrides the 36// playback_interruption_settings at the agent level, leaving other settings 37// at the agent level unchanged. 38// 39// DTMF settings does not override each other. DTMF settings set at different 40// levels define DTMF detections running in parallel. 41// 42// Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. 43message AdvancedSettings { 44 // Define behaviors of speech to text detection. 45 message SpeechSettings { 46 // Sensitivity of the speech model that detects the end of speech. 47 // Scale from 0 to 100. 48 int32 endpointer_sensitivity = 1; 49 50 // Timeout before detecting no speech. 51 google.protobuf.Duration no_speech_timeout = 2; 52 53 // Use timeout based endpointing, interpreting endpointer sensitivy as 54 // seconds of timeout value. 55 bool use_timeout_based_endpointing = 3; 56 57 // Mapping from language to Speech-to-Text model. The mapped Speech-to-Text 58 // model will be selected for requests from its corresponding language. 59 // For more information, see 60 // [Speech 61 // models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). 62 map<string, string> models = 5; 63 } 64 65 // Define behaviors for DTMF (dual tone multi frequency). 66 message DtmfSettings { 67 // If true, incoming audio is processed for DTMF (dual tone multi frequency) 68 // events. For example, if the caller presses a button on their telephone 69 // keypad and DTMF processing is enabled, Dialogflow will detect the 70 // event (e.g. a "3" was pressed) in the incoming audio and pass the event 71 // to the bot to drive business logic (e.g. when 3 is pressed, return the 72 // account balance). 73 bool enabled = 1; 74 75 // Max length of DTMF digits. 76 int32 max_digits = 2; 77 78 // The digit that terminates a DTMF digit sequence. 79 string finish_digit = 3; 80 } 81 82 // Define behaviors on logging. 83 message LoggingSettings { 84 // If true, StackDriver logging is currently enabled. 85 bool enable_stackdriver_logging = 2; 86 87 // If true, DF Interaction logging is currently enabled. 88 bool enable_interaction_logging = 3; 89 } 90 91 // If present, incoming audio is exported by Dialogflow to the configured 92 // Google Cloud Storage destination. 93 // Exposed at the following levels: 94 // - Agent level 95 // - Flow level 96 GcsDestination audio_export_gcs_destination = 2; 97 98 // Settings for speech to text detection. 99 // Exposed at the following levels: 100 // - Agent level 101 // - Flow level 102 // - Page level 103 // - Parameter level 104 SpeechSettings speech_settings = 3; 105 106 // Settings for DTMF. 107 // Exposed at the following levels: 108 // - Agent level 109 // - Flow level 110 // - Page level 111 // - Parameter level. 112 DtmfSettings dtmf_settings = 5; 113 114 // Settings for logging. 115 // Settings for Dialogflow History, Contact Center messages, StackDriver logs, 116 // and speech logging. 117 // Exposed at the following levels: 118 // - Agent level. 119 LoggingSettings logging_settings = 6; 120} 121