Class: Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb

Overview

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.

Defined Under Namespace

Classes: DtmfSettings, LoggingSettings, SpeechSettings

Instance Attribute Summary collapse

Instance Attribute Details

#audio_export_gcs_destination ⇒ ::Google::Cloud::Dialogflow::CX::V3::GcsDestination

Returns If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels:

  • Agent level
  • Flow level.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb', line 66

class AdvancedSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Define behaviors of speech to text detection.
  # @!attribute [rw] endpointer_sensitivity
  #   @return [::Integer]
  #     Sensitivity of the speech model that detects the end of speech.
  #     Scale from 0 to 100.
  # @!attribute [rw] no_speech_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Timeout before detecting no speech.
  # @!attribute [rw] use_timeout_based_endpointing
  #   @return [::Boolean]
  #     Use timeout based endpointing, interpreting endpointer sensitivy as
  #     seconds of timeout value.
  # @!attribute [rw] models
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
  class SpeechSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ModelsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Define behaviors for DTMF (dual tone multi frequency).
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     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).
  # @!attribute [rw] max_digits
  #   @return [::Integer]
  #     Max length of DTMF digits.
  # @!attribute [rw] finish_digit
  #   @return [::String]
  #     The digit that terminates a DTMF digit sequence.
  # @!attribute [rw] interdigit_timeout_duration
  #   @return [::Google::Protobuf::Duration]
  #     Interdigit timeout setting for matching dtmf input to regex.
  # @!attribute [rw] endpointing_timeout_duration
  #   @return [::Google::Protobuf::Duration]
  #     Endpoint timeout setting for matching dtmf input to regex.
  class DtmfSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Define behaviors on logging.
  # @!attribute [rw] enable_stackdriver_logging
  #   @return [::Boolean]
  #     Enables Google Cloud Logging.
  # @!attribute [rw] enable_interaction_logging
  #   @return [::Boolean]
  #     Enables DF Interaction logging.
  # @!attribute [rw] enable_consent_based_redaction
  #   @return [::Boolean]
  #     Enables consent-based end-user input redaction, if true, a pre-defined
  #     session parameter `$session.params.conversation-redaction` will be
  #     used to determine if the utterance should be redacted.
  class LoggingSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#dtmf_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings::DtmfSettings

Returns Settings for DTMF. Exposed at the following levels:

  • Agent level
  • Flow level
  • Page level
  • Parameter level.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb', line 66

class AdvancedSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Define behaviors of speech to text detection.
  # @!attribute [rw] endpointer_sensitivity
  #   @return [::Integer]
  #     Sensitivity of the speech model that detects the end of speech.
  #     Scale from 0 to 100.
  # @!attribute [rw] no_speech_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Timeout before detecting no speech.
  # @!attribute [rw] use_timeout_based_endpointing
  #   @return [::Boolean]
  #     Use timeout based endpointing, interpreting endpointer sensitivy as
  #     seconds of timeout value.
  # @!attribute [rw] models
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
  class SpeechSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ModelsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Define behaviors for DTMF (dual tone multi frequency).
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     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).
  # @!attribute [rw] max_digits
  #   @return [::Integer]
  #     Max length of DTMF digits.
  # @!attribute [rw] finish_digit
  #   @return [::String]
  #     The digit that terminates a DTMF digit sequence.
  # @!attribute [rw] interdigit_timeout_duration
  #   @return [::Google::Protobuf::Duration]
  #     Interdigit timeout setting for matching dtmf input to regex.
  # @!attribute [rw] endpointing_timeout_duration
  #   @return [::Google::Protobuf::Duration]
  #     Endpoint timeout setting for matching dtmf input to regex.
  class DtmfSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Define behaviors on logging.
  # @!attribute [rw] enable_stackdriver_logging
  #   @return [::Boolean]
  #     Enables Google Cloud Logging.
  # @!attribute [rw] enable_interaction_logging
  #   @return [::Boolean]
  #     Enables DF Interaction logging.
  # @!attribute [rw] enable_consent_based_redaction
  #   @return [::Boolean]
  #     Enables consent-based end-user input redaction, if true, a pre-defined
  #     session parameter `$session.params.conversation-redaction` will be
  #     used to determine if the utterance should be redacted.
  class LoggingSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#logging_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings::LoggingSettings

Returns Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels:

  • Agent level.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb', line 66

class AdvancedSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Define behaviors of speech to text detection.
  # @!attribute [rw] endpointer_sensitivity
  #   @return [::Integer]
  #     Sensitivity of the speech model that detects the end of speech.
  #     Scale from 0 to 100.
  # @!attribute [rw] no_speech_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Timeout before detecting no speech.
  # @!attribute [rw] use_timeout_based_endpointing
  #   @return [::Boolean]
  #     Use timeout based endpointing, interpreting endpointer sensitivy as
  #     seconds of timeout value.
  # @!attribute [rw] models
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
  class SpeechSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ModelsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Define behaviors for DTMF (dual tone multi frequency).
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     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).
  # @!attribute [rw] max_digits
  #   @return [::Integer]
  #     Max length of DTMF digits.
  # @!attribute [rw] finish_digit
  #   @return [::String]
  #     The digit that terminates a DTMF digit sequence.
  # @!attribute [rw] interdigit_timeout_duration
  #   @return [::Google::Protobuf::Duration]
  #     Interdigit timeout setting for matching dtmf input to regex.
  # @!attribute [rw] endpointing_timeout_duration
  #   @return [::Google::Protobuf::Duration]
  #     Endpoint timeout setting for matching dtmf input to regex.
  class DtmfSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Define behaviors on logging.
  # @!attribute [rw] enable_stackdriver_logging
  #   @return [::Boolean]
  #     Enables Google Cloud Logging.
  # @!attribute [rw] enable_interaction_logging
  #   @return [::Boolean]
  #     Enables DF Interaction logging.
  # @!attribute [rw] enable_consent_based_redaction
  #   @return [::Boolean]
  #     Enables consent-based end-user input redaction, if true, a pre-defined
  #     session parameter `$session.params.conversation-redaction` will be
  #     used to determine if the utterance should be redacted.
  class LoggingSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#speech_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings::SpeechSettings

Returns Settings for speech to text detection. Exposed at the following levels:

  • Agent level
  • Flow level
  • Page level
  • Parameter level.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb', line 66

class AdvancedSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Define behaviors of speech to text detection.
  # @!attribute [rw] endpointer_sensitivity
  #   @return [::Integer]
  #     Sensitivity of the speech model that detects the end of speech.
  #     Scale from 0 to 100.
  # @!attribute [rw] no_speech_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Timeout before detecting no speech.
  # @!attribute [rw] use_timeout_based_endpointing
  #   @return [::Boolean]
  #     Use timeout based endpointing, interpreting endpointer sensitivy as
  #     seconds of timeout value.
  # @!attribute [rw] models
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
  class SpeechSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class ModelsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Define behaviors for DTMF (dual tone multi frequency).
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     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).
  # @!attribute [rw] max_digits
  #   @return [::Integer]
  #     Max length of DTMF digits.
  # @!attribute [rw] finish_digit
  #   @return [::String]
  #     The digit that terminates a DTMF digit sequence.
  # @!attribute [rw] interdigit_timeout_duration
  #   @return [::Google::Protobuf::Duration]
  #     Interdigit timeout setting for matching dtmf input to regex.
  # @!attribute [rw] endpointing_timeout_duration
  #   @return [::Google::Protobuf::Duration]
  #     Endpoint timeout setting for matching dtmf input to regex.
  class DtmfSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Define behaviors on logging.
  # @!attribute [rw] enable_stackdriver_logging
  #   @return [::Boolean]
  #     Enables Google Cloud Logging.
  # @!attribute [rw] enable_interaction_logging
  #   @return [::Boolean]
  #     Enables DF Interaction logging.
  # @!attribute [rw] enable_consent_based_redaction
  #   @return [::Boolean]
  #     Enables consent-based end-user input redaction, if true, a pre-defined
  #     session parameter `$session.params.conversation-redaction` will be
  #     used to determine if the utterance should be redacted.
  class LoggingSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end