google-apis-dialogflow_v2 0.68.0 → 0.69.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -22,6 +22,108 @@ module Google
22
22
  module Apis
23
23
  module DialogflowV2
24
24
 
25
+ # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
26
+ # Settings exposed at lower level overrides the settings exposed at higher level.
27
+ # Overriding occurs at the sub-setting level. For example, the
28
+ # playback_interruption_settings at fulfillment level only overrides the
29
+ # playback_interruption_settings at the agent level, leaving other settings at
30
+ # the agent level unchanged. DTMF settings does not override each other. DTMF
31
+ # settings set at different levels define DTMF detections running in parallel.
32
+ # Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
33
+ class GoogleCloudDialogflowCxV3AdvancedSettings
34
+ include Google::Apis::Core::Hashable
35
+
36
+ # Google Cloud Storage location for a Dialogflow operation that writes or
37
+ # exports objects (e.g. exported agent or transcripts) outside of Dialogflow.
38
+ # Corresponds to the JSON property `audioExportGcsDestination`
39
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3GcsDestination]
40
+ attr_accessor :audio_export_gcs_destination
41
+
42
+ # Define behaviors for DTMF (dual tone multi frequency).
43
+ # Corresponds to the JSON property `dtmfSettings`
44
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings]
45
+ attr_accessor :dtmf_settings
46
+
47
+ # Define behaviors on logging.
48
+ # Corresponds to the JSON property `loggingSettings`
49
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings]
50
+ attr_accessor :logging_settings
51
+
52
+ def initialize(**args)
53
+ update!(**args)
54
+ end
55
+
56
+ # Update properties of this object
57
+ def update!(**args)
58
+ @audio_export_gcs_destination = args[:audio_export_gcs_destination] if args.key?(:audio_export_gcs_destination)
59
+ @dtmf_settings = args[:dtmf_settings] if args.key?(:dtmf_settings)
60
+ @logging_settings = args[:logging_settings] if args.key?(:logging_settings)
61
+ end
62
+ end
63
+
64
+ # Define behaviors for DTMF (dual tone multi frequency).
65
+ class GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings
66
+ include Google::Apis::Core::Hashable
67
+
68
+ # If true, incoming audio is processed for DTMF (dual tone multi frequency)
69
+ # events. For example, if the caller presses a button on their telephone keypad
70
+ # and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3"
71
+ # was pressed) in the incoming audio and pass the event to the bot to drive
72
+ # business logic (e.g. when 3 is pressed, return the account balance).
73
+ # Corresponds to the JSON property `enabled`
74
+ # @return [Boolean]
75
+ attr_accessor :enabled
76
+ alias_method :enabled?, :enabled
77
+
78
+ # The digit that terminates a DTMF digit sequence.
79
+ # Corresponds to the JSON property `finishDigit`
80
+ # @return [String]
81
+ attr_accessor :finish_digit
82
+
83
+ # Max length of DTMF digits.
84
+ # Corresponds to the JSON property `maxDigits`
85
+ # @return [Fixnum]
86
+ attr_accessor :max_digits
87
+
88
+ def initialize(**args)
89
+ update!(**args)
90
+ end
91
+
92
+ # Update properties of this object
93
+ def update!(**args)
94
+ @enabled = args[:enabled] if args.key?(:enabled)
95
+ @finish_digit = args[:finish_digit] if args.key?(:finish_digit)
96
+ @max_digits = args[:max_digits] if args.key?(:max_digits)
97
+ end
98
+ end
99
+
100
+ # Define behaviors on logging.
101
+ class GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings
102
+ include Google::Apis::Core::Hashable
103
+
104
+ # If true, DF Interaction logging is currently enabled.
105
+ # Corresponds to the JSON property `enableInteractionLogging`
106
+ # @return [Boolean]
107
+ attr_accessor :enable_interaction_logging
108
+ alias_method :enable_interaction_logging?, :enable_interaction_logging
109
+
110
+ # If true, StackDriver logging is currently enabled.
111
+ # Corresponds to the JSON property `enableStackdriverLogging`
112
+ # @return [Boolean]
113
+ attr_accessor :enable_stackdriver_logging
114
+ alias_method :enable_stackdriver_logging?, :enable_stackdriver_logging
115
+
116
+ def initialize(**args)
117
+ update!(**args)
118
+ end
119
+
120
+ # Update properties of this object
121
+ def update!(**args)
122
+ @enable_interaction_logging = args[:enable_interaction_logging] if args.key?(:enable_interaction_logging)
123
+ @enable_stackdriver_logging = args[:enable_stackdriver_logging] if args.key?(:enable_stackdriver_logging)
124
+ end
125
+ end
126
+
25
127
  # Represents the natural speech audio to be processed.
26
128
  class GoogleCloudDialogflowCxV3AudioInput
27
129
  include Google::Apis::Core::Hashable
@@ -807,6 +909,18 @@ module Google
807
909
  class GoogleCloudDialogflowCxV3FormParameter
808
910
  include Google::Apis::Core::Hashable
809
911
 
912
+ # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
913
+ # Settings exposed at lower level overrides the settings exposed at higher level.
914
+ # Overriding occurs at the sub-setting level. For example, the
915
+ # playback_interruption_settings at fulfillment level only overrides the
916
+ # playback_interruption_settings at the agent level, leaving other settings at
917
+ # the agent level unchanged. DTMF settings does not override each other. DTMF
918
+ # settings set at different levels define DTMF detections running in parallel.
919
+ # Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
920
+ # Corresponds to the JSON property `advancedSettings`
921
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3AdvancedSettings]
922
+ attr_accessor :advanced_settings
923
+
810
924
  # The default value of an optional parameter. If the parameter is required, the
811
925
  # default value will be ignored.
812
926
  # Corresponds to the JSON property `defaultValue`
@@ -860,6 +974,7 @@ module Google
860
974
 
861
975
  # Update properties of this object
862
976
  def update!(**args)
977
+ @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
863
978
  @default_value = args[:default_value] if args.key?(:default_value)
864
979
  @display_name = args[:display_name] if args.key?(:display_name)
865
980
  @entity_type = args[:entity_type] if args.key?(:entity_type)
@@ -930,11 +1045,32 @@ module Google
930
1045
  class GoogleCloudDialogflowCxV3Fulfillment
931
1046
  include Google::Apis::Core::Hashable
932
1047
 
1048
+ # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
1049
+ # Settings exposed at lower level overrides the settings exposed at higher level.
1050
+ # Overriding occurs at the sub-setting level. For example, the
1051
+ # playback_interruption_settings at fulfillment level only overrides the
1052
+ # playback_interruption_settings at the agent level, leaving other settings at
1053
+ # the agent level unchanged. DTMF settings does not override each other. DTMF
1054
+ # settings set at different levels define DTMF detections running in parallel.
1055
+ # Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
1056
+ # Corresponds to the JSON property `advancedSettings`
1057
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3AdvancedSettings]
1058
+ attr_accessor :advanced_settings
1059
+
933
1060
  # Conditional cases for this fulfillment.
934
1061
  # Corresponds to the JSON property `conditionalCases`
935
1062
  # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3FulfillmentConditionalCases>]
936
1063
  attr_accessor :conditional_cases
937
1064
 
1065
+ # If the flag is true, the agent will utilize LLM to generate a text response.
1066
+ # If LLM generation fails, the defined responses in the fulfillment will be
1067
+ # respected. This flag is only useful for fulfillments associated with no-match
1068
+ # event handlers.
1069
+ # Corresponds to the JSON property `enableGenerativeFallback`
1070
+ # @return [Boolean]
1071
+ attr_accessor :enable_generative_fallback
1072
+ alias_method :enable_generative_fallback?, :enable_generative_fallback
1073
+
938
1074
  # The list of rich message responses to present to the user.
939
1075
  # Corresponds to the JSON property `messages`
940
1076
  # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3ResponseMessage>]
@@ -977,7 +1113,9 @@ module Google
977
1113
 
978
1114
  # Update properties of this object
979
1115
  def update!(**args)
1116
+ @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
980
1117
  @conditional_cases = args[:conditional_cases] if args.key?(:conditional_cases)
1118
+ @enable_generative_fallback = args[:enable_generative_fallback] if args.key?(:enable_generative_fallback)
981
1119
  @messages = args[:messages] if args.key?(:messages)
982
1120
  @return_partial_responses = args[:return_partial_responses] if args.key?(:return_partial_responses)
983
1121
  @set_parameter_actions = args[:set_parameter_actions] if args.key?(:set_parameter_actions)
@@ -1097,6 +1235,28 @@ module Google
1097
1235
  end
1098
1236
  end
1099
1237
 
1238
+ # Google Cloud Storage location for a Dialogflow operation that writes or
1239
+ # exports objects (e.g. exported agent or transcripts) outside of Dialogflow.
1240
+ class GoogleCloudDialogflowCxV3GcsDestination
1241
+ include Google::Apis::Core::Hashable
1242
+
1243
+ # Required. The Google Cloud Storage URI for the exported objects. A URI is of
1244
+ # the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or
1245
+ # just a prefix, its usage depends on the Dialogflow operation.
1246
+ # Corresponds to the JSON property `uri`
1247
+ # @return [String]
1248
+ attr_accessor :uri
1249
+
1250
+ def initialize(**args)
1251
+ update!(**args)
1252
+ end
1253
+
1254
+ # Update properties of this object
1255
+ def update!(**args)
1256
+ @uri = args[:uri] if args.key?(:uri)
1257
+ end
1258
+ end
1259
+
1100
1260
  # Metadata in google::longrunning::Operation for Knowledge operations.
1101
1261
  class GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata
1102
1262
  include Google::Apis::Core::Hashable
@@ -1580,6 +1740,18 @@ module Google
1580
1740
  class GoogleCloudDialogflowCxV3Page
1581
1741
  include Google::Apis::Core::Hashable
1582
1742
 
1743
+ # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
1744
+ # Settings exposed at lower level overrides the settings exposed at higher level.
1745
+ # Overriding occurs at the sub-setting level. For example, the
1746
+ # playback_interruption_settings at fulfillment level only overrides the
1747
+ # playback_interruption_settings at the agent level, leaving other settings at
1748
+ # the agent level unchanged. DTMF settings does not override each other. DTMF
1749
+ # settings set at different levels define DTMF detections running in parallel.
1750
+ # Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
1751
+ # Corresponds to the JSON property `advancedSettings`
1752
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3AdvancedSettings]
1753
+ attr_accessor :advanced_settings
1754
+
1583
1755
  # Required. The human-readable name of the page, unique within the flow.
1584
1756
  # Corresponds to the JSON property `displayName`
1585
1757
  # @return [String]
@@ -1660,6 +1832,7 @@ module Google
1660
1832
 
1661
1833
  # Update properties of this object
1662
1834
  def update!(**args)
1835
+ @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
1663
1836
  @display_name = args[:display_name] if args.key?(:display_name)
1664
1837
  @entry_fulfillment = args[:entry_fulfillment] if args.key?(:entry_fulfillment)
1665
1838
  @event_handlers = args[:event_handlers] if args.key?(:event_handlers)
@@ -3237,6 +3410,108 @@ module Google
3237
3410
  end
3238
3411
  end
3239
3412
 
3413
+ # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
3414
+ # Settings exposed at lower level overrides the settings exposed at higher level.
3415
+ # Overriding occurs at the sub-setting level. For example, the
3416
+ # playback_interruption_settings at fulfillment level only overrides the
3417
+ # playback_interruption_settings at the agent level, leaving other settings at
3418
+ # the agent level unchanged. DTMF settings does not override each other. DTMF
3419
+ # settings set at different levels define DTMF detections running in parallel.
3420
+ # Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
3421
+ class GoogleCloudDialogflowCxV3beta1AdvancedSettings
3422
+ include Google::Apis::Core::Hashable
3423
+
3424
+ # Google Cloud Storage location for a Dialogflow operation that writes or
3425
+ # exports objects (e.g. exported agent or transcripts) outside of Dialogflow.
3426
+ # Corresponds to the JSON property `audioExportGcsDestination`
3427
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1GcsDestination]
3428
+ attr_accessor :audio_export_gcs_destination
3429
+
3430
+ # Define behaviors for DTMF (dual tone multi frequency).
3431
+ # Corresponds to the JSON property `dtmfSettings`
3432
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings]
3433
+ attr_accessor :dtmf_settings
3434
+
3435
+ # Define behaviors on logging.
3436
+ # Corresponds to the JSON property `loggingSettings`
3437
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings]
3438
+ attr_accessor :logging_settings
3439
+
3440
+ def initialize(**args)
3441
+ update!(**args)
3442
+ end
3443
+
3444
+ # Update properties of this object
3445
+ def update!(**args)
3446
+ @audio_export_gcs_destination = args[:audio_export_gcs_destination] if args.key?(:audio_export_gcs_destination)
3447
+ @dtmf_settings = args[:dtmf_settings] if args.key?(:dtmf_settings)
3448
+ @logging_settings = args[:logging_settings] if args.key?(:logging_settings)
3449
+ end
3450
+ end
3451
+
3452
+ # Define behaviors for DTMF (dual tone multi frequency).
3453
+ class GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings
3454
+ include Google::Apis::Core::Hashable
3455
+
3456
+ # If true, incoming audio is processed for DTMF (dual tone multi frequency)
3457
+ # events. For example, if the caller presses a button on their telephone keypad
3458
+ # and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3"
3459
+ # was pressed) in the incoming audio and pass the event to the bot to drive
3460
+ # business logic (e.g. when 3 is pressed, return the account balance).
3461
+ # Corresponds to the JSON property `enabled`
3462
+ # @return [Boolean]
3463
+ attr_accessor :enabled
3464
+ alias_method :enabled?, :enabled
3465
+
3466
+ # The digit that terminates a DTMF digit sequence.
3467
+ # Corresponds to the JSON property `finishDigit`
3468
+ # @return [String]
3469
+ attr_accessor :finish_digit
3470
+
3471
+ # Max length of DTMF digits.
3472
+ # Corresponds to the JSON property `maxDigits`
3473
+ # @return [Fixnum]
3474
+ attr_accessor :max_digits
3475
+
3476
+ def initialize(**args)
3477
+ update!(**args)
3478
+ end
3479
+
3480
+ # Update properties of this object
3481
+ def update!(**args)
3482
+ @enabled = args[:enabled] if args.key?(:enabled)
3483
+ @finish_digit = args[:finish_digit] if args.key?(:finish_digit)
3484
+ @max_digits = args[:max_digits] if args.key?(:max_digits)
3485
+ end
3486
+ end
3487
+
3488
+ # Define behaviors on logging.
3489
+ class GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings
3490
+ include Google::Apis::Core::Hashable
3491
+
3492
+ # If true, DF Interaction logging is currently enabled.
3493
+ # Corresponds to the JSON property `enableInteractionLogging`
3494
+ # @return [Boolean]
3495
+ attr_accessor :enable_interaction_logging
3496
+ alias_method :enable_interaction_logging?, :enable_interaction_logging
3497
+
3498
+ # If true, StackDriver logging is currently enabled.
3499
+ # Corresponds to the JSON property `enableStackdriverLogging`
3500
+ # @return [Boolean]
3501
+ attr_accessor :enable_stackdriver_logging
3502
+ alias_method :enable_stackdriver_logging?, :enable_stackdriver_logging
3503
+
3504
+ def initialize(**args)
3505
+ update!(**args)
3506
+ end
3507
+
3508
+ # Update properties of this object
3509
+ def update!(**args)
3510
+ @enable_interaction_logging = args[:enable_interaction_logging] if args.key?(:enable_interaction_logging)
3511
+ @enable_stackdriver_logging = args[:enable_stackdriver_logging] if args.key?(:enable_stackdriver_logging)
3512
+ end
3513
+ end
3514
+
3240
3515
  # Represents the natural speech audio to be processed.
3241
3516
  class GoogleCloudDialogflowCxV3beta1AudioInput
3242
3517
  include Google::Apis::Core::Hashable
@@ -4022,6 +4297,18 @@ module Google
4022
4297
  class GoogleCloudDialogflowCxV3beta1FormParameter
4023
4298
  include Google::Apis::Core::Hashable
4024
4299
 
4300
+ # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
4301
+ # Settings exposed at lower level overrides the settings exposed at higher level.
4302
+ # Overriding occurs at the sub-setting level. For example, the
4303
+ # playback_interruption_settings at fulfillment level only overrides the
4304
+ # playback_interruption_settings at the agent level, leaving other settings at
4305
+ # the agent level unchanged. DTMF settings does not override each other. DTMF
4306
+ # settings set at different levels define DTMF detections running in parallel.
4307
+ # Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
4308
+ # Corresponds to the JSON property `advancedSettings`
4309
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1AdvancedSettings]
4310
+ attr_accessor :advanced_settings
4311
+
4025
4312
  # The default value of an optional parameter. If the parameter is required, the
4026
4313
  # default value will be ignored.
4027
4314
  # Corresponds to the JSON property `defaultValue`
@@ -4075,6 +4362,7 @@ module Google
4075
4362
 
4076
4363
  # Update properties of this object
4077
4364
  def update!(**args)
4365
+ @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
4078
4366
  @default_value = args[:default_value] if args.key?(:default_value)
4079
4367
  @display_name = args[:display_name] if args.key?(:display_name)
4080
4368
  @entity_type = args[:entity_type] if args.key?(:entity_type)
@@ -4145,11 +4433,32 @@ module Google
4145
4433
  class GoogleCloudDialogflowCxV3beta1Fulfillment
4146
4434
  include Google::Apis::Core::Hashable
4147
4435
 
4436
+ # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
4437
+ # Settings exposed at lower level overrides the settings exposed at higher level.
4438
+ # Overriding occurs at the sub-setting level. For example, the
4439
+ # playback_interruption_settings at fulfillment level only overrides the
4440
+ # playback_interruption_settings at the agent level, leaving other settings at
4441
+ # the agent level unchanged. DTMF settings does not override each other. DTMF
4442
+ # settings set at different levels define DTMF detections running in parallel.
4443
+ # Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
4444
+ # Corresponds to the JSON property `advancedSettings`
4445
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1AdvancedSettings]
4446
+ attr_accessor :advanced_settings
4447
+
4148
4448
  # Conditional cases for this fulfillment.
4149
4449
  # Corresponds to the JSON property `conditionalCases`
4150
4450
  # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases>]
4151
4451
  attr_accessor :conditional_cases
4152
4452
 
4453
+ # If the flag is true, the agent will utilize LLM to generate a text response.
4454
+ # If LLM generation fails, the defined responses in the fulfillment will be
4455
+ # respected. This flag is only useful for fulfillments associated with no-match
4456
+ # event handlers.
4457
+ # Corresponds to the JSON property `enableGenerativeFallback`
4458
+ # @return [Boolean]
4459
+ attr_accessor :enable_generative_fallback
4460
+ alias_method :enable_generative_fallback?, :enable_generative_fallback
4461
+
4153
4462
  # The list of rich message responses to present to the user.
4154
4463
  # Corresponds to the JSON property `messages`
4155
4464
  # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
@@ -4192,7 +4501,9 @@ module Google
4192
4501
 
4193
4502
  # Update properties of this object
4194
4503
  def update!(**args)
4504
+ @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
4195
4505
  @conditional_cases = args[:conditional_cases] if args.key?(:conditional_cases)
4506
+ @enable_generative_fallback = args[:enable_generative_fallback] if args.key?(:enable_generative_fallback)
4196
4507
  @messages = args[:messages] if args.key?(:messages)
4197
4508
  @return_partial_responses = args[:return_partial_responses] if args.key?(:return_partial_responses)
4198
4509
  @set_parameter_actions = args[:set_parameter_actions] if args.key?(:set_parameter_actions)
@@ -4312,6 +4623,28 @@ module Google
4312
4623
  end
4313
4624
  end
4314
4625
 
4626
+ # Google Cloud Storage location for a Dialogflow operation that writes or
4627
+ # exports objects (e.g. exported agent or transcripts) outside of Dialogflow.
4628
+ class GoogleCloudDialogflowCxV3beta1GcsDestination
4629
+ include Google::Apis::Core::Hashable
4630
+
4631
+ # Required. The Google Cloud Storage URI for the exported objects. A URI is of
4632
+ # the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or
4633
+ # just a prefix, its usage depends on the Dialogflow operation.
4634
+ # Corresponds to the JSON property `uri`
4635
+ # @return [String]
4636
+ attr_accessor :uri
4637
+
4638
+ def initialize(**args)
4639
+ update!(**args)
4640
+ end
4641
+
4642
+ # Update properties of this object
4643
+ def update!(**args)
4644
+ @uri = args[:uri] if args.key?(:uri)
4645
+ end
4646
+ end
4647
+
4315
4648
  # Metadata in google::longrunning::Operation for Knowledge operations.
4316
4649
  class GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata
4317
4650
  include Google::Apis::Core::Hashable
@@ -4795,6 +5128,18 @@ module Google
4795
5128
  class GoogleCloudDialogflowCxV3beta1Page
4796
5129
  include Google::Apis::Core::Hashable
4797
5130
 
5131
+ # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
5132
+ # Settings exposed at lower level overrides the settings exposed at higher level.
5133
+ # Overriding occurs at the sub-setting level. For example, the
5134
+ # playback_interruption_settings at fulfillment level only overrides the
5135
+ # playback_interruption_settings at the agent level, leaving other settings at
5136
+ # the agent level unchanged. DTMF settings does not override each other. DTMF
5137
+ # settings set at different levels define DTMF detections running in parallel.
5138
+ # Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
5139
+ # Corresponds to the JSON property `advancedSettings`
5140
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1AdvancedSettings]
5141
+ attr_accessor :advanced_settings
5142
+
4798
5143
  # Required. The human-readable name of the page, unique within the flow.
4799
5144
  # Corresponds to the JSON property `displayName`
4800
5145
  # @return [String]
@@ -4875,6 +5220,7 @@ module Google
4875
5220
 
4876
5221
  # Update properties of this object
4877
5222
  def update!(**args)
5223
+ @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
4878
5224
  @display_name = args[:display_name] if args.key?(:display_name)
4879
5225
  @entry_fulfillment = args[:entry_fulfillment] if args.key?(:entry_fulfillment)
4880
5226
  @event_handlers = args[:event_handlers] if args.key?(:event_handlers)
@@ -6583,6 +6929,11 @@ module Google
6583
6929
  # @return [String]
6584
6930
  attr_accessor :document_efficiency
6585
6931
 
6932
+ # Feedback for knowledge search.
6933
+ # Corresponds to the JSON property `knowledgeSearchFeedback`
6934
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback]
6935
+ attr_accessor :knowledge_search_feedback
6936
+
6586
6937
  # Feedback for conversation summarization.
6587
6938
  # Corresponds to the JSON property `summarizationFeedback`
6588
6939
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AgentAssistantFeedbackSummarizationFeedback]
@@ -6597,10 +6948,40 @@ module Google
6597
6948
  @answer_relevance = args[:answer_relevance] if args.key?(:answer_relevance)
6598
6949
  @document_correctness = args[:document_correctness] if args.key?(:document_correctness)
6599
6950
  @document_efficiency = args[:document_efficiency] if args.key?(:document_efficiency)
6951
+ @knowledge_search_feedback = args[:knowledge_search_feedback] if args.key?(:knowledge_search_feedback)
6600
6952
  @summarization_feedback = args[:summarization_feedback] if args.key?(:summarization_feedback)
6601
6953
  end
6602
6954
  end
6603
6955
 
6956
+ # Feedback for knowledge search.
6957
+ class GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback
6958
+ include Google::Apis::Core::Hashable
6959
+
6960
+ # Whether the answer was copied by the human agent or not. If the value is set
6961
+ # to be true, AnswerFeedback.clicked will be updated to be true.
6962
+ # Corresponds to the JSON property `answerCopied`
6963
+ # @return [Boolean]
6964
+ attr_accessor :answer_copied
6965
+ alias_method :answer_copied?, :answer_copied
6966
+
6967
+ # The URIs clicked by the human agent. The value is appended for each
6968
+ # UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked
6969
+ # will be updated to be true.
6970
+ # Corresponds to the JSON property `clickedUris`
6971
+ # @return [Array<String>]
6972
+ attr_accessor :clicked_uris
6973
+
6974
+ def initialize(**args)
6975
+ update!(**args)
6976
+ end
6977
+
6978
+ # Update properties of this object
6979
+ def update!(**args)
6980
+ @answer_copied = args[:answer_copied] if args.key?(:answer_copied)
6981
+ @clicked_uris = args[:clicked_uris] if args.key?(:clicked_uris)
6982
+ end
6983
+ end
6984
+
6604
6985
  # Feedback for conversation summarization.
6605
6986
  class GoogleCloudDialogflowV2AgentAssistantFeedbackSummarizationFeedback
6606
6987
  include Google::Apis::Core::Hashable
@@ -6641,6 +7022,11 @@ module Google
6641
7022
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ArticleAnswer]
6642
7023
  attr_accessor :article_suggestion_answer
6643
7024
 
7025
+ # Represents a Dialogflow assist answer.
7026
+ # Corresponds to the JSON property `dialogflowAssistAnswer`
7027
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DialogflowAssistAnswer]
7028
+ attr_accessor :dialogflow_assist_answer
7029
+
6644
7030
  # Represents answer from "frequently asked questions".
6645
7031
  # Corresponds to the JSON property `faqAnswer`
6646
7032
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2FaqAnswer]
@@ -6653,6 +7039,7 @@ module Google
6653
7039
  # Update properties of this object
6654
7040
  def update!(**args)
6655
7041
  @article_suggestion_answer = args[:article_suggestion_answer] if args.key?(:article_suggestion_answer)
7042
+ @dialogflow_assist_answer = args[:dialogflow_assist_answer] if args.key?(:dialogflow_assist_answer)
6656
7043
  @faq_answer = args[:faq_answer] if args.key?(:faq_answer)
6657
7044
  end
6658
7045
  end
@@ -6701,6 +7088,11 @@ module Google
6701
7088
  # @return [String]
6702
7089
  attr_accessor :request_id
6703
7090
 
7091
+ # Represents the selection of a suggestion.
7092
+ # Corresponds to the JSON property `suggestionInput`
7093
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionInput]
7094
+ attr_accessor :suggestion_input
7095
+
6704
7096
  # Auxiliary proto messages. Represents the natural language text to be processed.
6705
7097
  # Corresponds to the JSON property `textInput`
6706
7098
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput]
@@ -6718,6 +7110,7 @@ module Google
6718
7110
  @query_params = args[:query_params] if args.key?(:query_params)
6719
7111
  @reply_audio_config = args[:reply_audio_config] if args.key?(:reply_audio_config)
6720
7112
  @request_id = args[:request_id] if args.key?(:request_id)
7113
+ @suggestion_input = args[:suggestion_input] if args.key?(:suggestion_input)
6721
7114
  @text_input = args[:text_input] if args.key?(:text_input)
6722
7115
  end
6723
7116
  end
@@ -8256,6 +8649,38 @@ module Google
8256
8649
  end
8257
8650
  end
8258
8651
 
8652
+ # Represents a Dialogflow assist answer.
8653
+ class GoogleCloudDialogflowV2DialogflowAssistAnswer
8654
+ include Google::Apis::Core::Hashable
8655
+
8656
+ # The name of answer record, in the format of "projects//locations//
8657
+ # answerRecords/"
8658
+ # Corresponds to the JSON property `answerRecord`
8659
+ # @return [String]
8660
+ attr_accessor :answer_record
8661
+
8662
+ # Represents an intent suggestion.
8663
+ # Corresponds to the JSON property `intentSuggestion`
8664
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentSuggestion]
8665
+ attr_accessor :intent_suggestion
8666
+
8667
+ # Represents the result of conversational query or event processing.
8668
+ # Corresponds to the JSON property `queryResult`
8669
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryResult]
8670
+ attr_accessor :query_result
8671
+
8672
+ def initialize(**args)
8673
+ update!(**args)
8674
+ end
8675
+
8676
+ # Update properties of this object
8677
+ def update!(**args)
8678
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
8679
+ @intent_suggestion = args[:intent_suggestion] if args.key?(:intent_suggestion)
8680
+ @query_result = args[:query_result] if args.key?(:query_result)
8681
+ end
8682
+ end
8683
+
8259
8684
  # A knowledge document to be used by a KnowledgeBase. For more information, see
8260
8685
  # the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/
8261
8686
  # knowledge-bases). Note: The `projects.agent.knowledgeBases.documents` resource
@@ -9436,8 +9861,17 @@ module Google
9436
9861
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig]
9437
9862
  attr_accessor :conversation_process_config
9438
9863
 
9864
+ # Optional. Disable the logging of search queries sent by human agents. It can
9865
+ # prevent those queries from being stored at answer records. Supported features:
9866
+ # KNOWLEDGE_SEARCH.
9867
+ # Corresponds to the JSON property `disableAgentQueryLogging`
9868
+ # @return [Boolean]
9869
+ attr_accessor :disable_agent_query_logging
9870
+ alias_method :disable_agent_query_logging?, :disable_agent_query_logging
9871
+
9439
9872
  # Automatically iterates all participants and tries to compile suggestions.
9440
- # Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST.
9873
+ # Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST,
9874
+ # KNOWLEDGE_ASSIST.
9441
9875
  # Corresponds to the JSON property `enableEventBasedSuggestion`
9442
9876
  # @return [Boolean]
9443
9877
  attr_accessor :enable_event_based_suggestion
@@ -9468,6 +9902,7 @@ module Google
9468
9902
  def update!(**args)
9469
9903
  @conversation_model_config = args[:conversation_model_config] if args.key?(:conversation_model_config)
9470
9904
  @conversation_process_config = args[:conversation_process_config] if args.key?(:conversation_process_config)
9905
+ @disable_agent_query_logging = args[:disable_agent_query_logging] if args.key?(:disable_agent_query_logging)
9471
9906
  @enable_event_based_suggestion = args[:enable_event_based_suggestion] if args.key?(:enable_event_based_suggestion)
9472
9907
  @query_config = args[:query_config] if args.key?(:query_config)
9473
9908
  @suggestion_feature = args[:suggestion_feature] if args.key?(:suggestion_feature)
@@ -9583,6 +10018,32 @@ module Google
9583
10018
  # @return [String]
9584
10019
  attr_accessor :agent
9585
10020
 
10021
+ # The configuration used for human agent side Dialogflow assist suggestion.
10022
+ # Corresponds to the JSON property `humanAgentSideConfig`
10023
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig]
10024
+ attr_accessor :human_agent_side_config
10025
+
10026
+ def initialize(**args)
10027
+ update!(**args)
10028
+ end
10029
+
10030
+ # Update properties of this object
10031
+ def update!(**args)
10032
+ @agent = args[:agent] if args.key?(:agent)
10033
+ @human_agent_side_config = args[:human_agent_side_config] if args.key?(:human_agent_side_config)
10034
+ end
10035
+ end
10036
+
10037
+ # The configuration used for human agent side Dialogflow assist suggestion.
10038
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig
10039
+ include Google::Apis::Core::Hashable
10040
+
10041
+ # Optional. The name of a dialogflow virtual agent used for intent detection and
10042
+ # suggestion triggered by human agent. Format: `projects//locations//agent`.
10043
+ # Corresponds to the JSON property `agent`
10044
+ # @return [String]
10045
+ attr_accessor :agent
10046
+
9586
10047
  def initialize(**args)
9587
10048
  update!(**args)
9588
10049
  end
@@ -11314,6 +11775,39 @@ module Google
11314
11775
  end
11315
11776
  end
11316
11777
 
11778
+ # Represents an intent suggestion.
11779
+ class GoogleCloudDialogflowV2IntentSuggestion
11780
+ include Google::Apis::Core::Hashable
11781
+
11782
+ # Human readable description for better understanding an intent like its scope,
11783
+ # content, result etc. Maximum character limit: 140 characters.
11784
+ # Corresponds to the JSON property `description`
11785
+ # @return [String]
11786
+ attr_accessor :description
11787
+
11788
+ # The display name of the intent.
11789
+ # Corresponds to the JSON property `displayName`
11790
+ # @return [String]
11791
+ attr_accessor :display_name
11792
+
11793
+ # The unique identifier of this intent. Format: `projects//locations//agent/
11794
+ # intents/`.
11795
+ # Corresponds to the JSON property `intentV2`
11796
+ # @return [String]
11797
+ attr_accessor :intent_v2
11798
+
11799
+ def initialize(**args)
11800
+ update!(**args)
11801
+ end
11802
+
11803
+ # Update properties of this object
11804
+ def update!(**args)
11805
+ @description = args[:description] if args.key?(:description)
11806
+ @display_name = args[:display_name] if args.key?(:display_name)
11807
+ @intent_v2 = args[:intent_v2] if args.key?(:intent_v2)
11808
+ end
11809
+ end
11810
+
11317
11811
  # Represents an example that the agent is trained on.
11318
11812
  class GoogleCloudDialogflowV2IntentTrainingPhrase
11319
11813
  include Google::Apis::Core::Hashable
@@ -12619,6 +13113,153 @@ module Google
12619
13113
  end
12620
13114
  end
12621
13115
 
13116
+ # Represents a SearchKnowledge answer.
13117
+ class GoogleCloudDialogflowV2SearchKnowledgeAnswer
13118
+ include Google::Apis::Core::Hashable
13119
+
13120
+ # The piece of text from the knowledge base documents that answers the search
13121
+ # query
13122
+ # Corresponds to the JSON property `answer`
13123
+ # @return [String]
13124
+ attr_accessor :answer
13125
+
13126
+ # The name of the answer record. Format: `projects//locations//answer Records/`
13127
+ # Corresponds to the JSON property `answerRecord`
13128
+ # @return [String]
13129
+ attr_accessor :answer_record
13130
+
13131
+ # All sources used to generate the answer.
13132
+ # Corresponds to the JSON property `answerSources`
13133
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeAnswerAnswerSource>]
13134
+ attr_accessor :answer_sources
13135
+
13136
+ # The type of the answer.
13137
+ # Corresponds to the JSON property `answerType`
13138
+ # @return [String]
13139
+ attr_accessor :answer_type
13140
+
13141
+ def initialize(**args)
13142
+ update!(**args)
13143
+ end
13144
+
13145
+ # Update properties of this object
13146
+ def update!(**args)
13147
+ @answer = args[:answer] if args.key?(:answer)
13148
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
13149
+ @answer_sources = args[:answer_sources] if args.key?(:answer_sources)
13150
+ @answer_type = args[:answer_type] if args.key?(:answer_type)
13151
+ end
13152
+ end
13153
+
13154
+ # The sources of the answers.
13155
+ class GoogleCloudDialogflowV2SearchKnowledgeAnswerAnswerSource
13156
+ include Google::Apis::Core::Hashable
13157
+
13158
+ # The relevant snippet of the article.
13159
+ # Corresponds to the JSON property `snippet`
13160
+ # @return [String]
13161
+ attr_accessor :snippet
13162
+
13163
+ # The title of the article.
13164
+ # Corresponds to the JSON property `title`
13165
+ # @return [String]
13166
+ attr_accessor :title
13167
+
13168
+ # The URI of the article.
13169
+ # Corresponds to the JSON property `uri`
13170
+ # @return [String]
13171
+ attr_accessor :uri
13172
+
13173
+ def initialize(**args)
13174
+ update!(**args)
13175
+ end
13176
+
13177
+ # Update properties of this object
13178
+ def update!(**args)
13179
+ @snippet = args[:snippet] if args.key?(:snippet)
13180
+ @title = args[:title] if args.key?(:title)
13181
+ @uri = args[:uri] if args.key?(:uri)
13182
+ end
13183
+ end
13184
+
13185
+ # The request message for Conversations.SearchKnowledge.
13186
+ class GoogleCloudDialogflowV2SearchKnowledgeRequest
13187
+ include Google::Apis::Core::Hashable
13188
+
13189
+ # The conversation (between human agent and end user) where the search request
13190
+ # is triggered. Format: `projects//locations//conversations/`.
13191
+ # Corresponds to the JSON property `conversation`
13192
+ # @return [String]
13193
+ attr_accessor :conversation
13194
+
13195
+ # Required. The conversation profile used to configure the search. Format: `
13196
+ # projects//locations//conversationProfiles/`.
13197
+ # Corresponds to the JSON property `conversationProfile`
13198
+ # @return [String]
13199
+ attr_accessor :conversation_profile
13200
+
13201
+ # The name of the latest conversation message when the request is triggered.
13202
+ # Format: `projects//locations//conversations//messages/`.
13203
+ # Corresponds to the JSON property `latestMessage`
13204
+ # @return [String]
13205
+ attr_accessor :latest_message
13206
+
13207
+ # The parent resource contains the conversation profile Format: 'projects/' or `
13208
+ # projects//locations/`.
13209
+ # Corresponds to the JSON property `parent`
13210
+ # @return [String]
13211
+ attr_accessor :parent
13212
+
13213
+ # Auxiliary proto messages. Represents the natural language text to be processed.
13214
+ # Corresponds to the JSON property `query`
13215
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput]
13216
+ attr_accessor :query
13217
+
13218
+ # The ID of the search session. The session_id can be combined with Dialogflow
13219
+ # V3 Agent ID retrieved from conversation profile or on its own to identify a
13220
+ # search session. The search history of the same session will impact the search
13221
+ # result. It's up to the API caller to choose an appropriate `Session ID`. It
13222
+ # can be a random number or some type of session identifiers (preferably hashed).
13223
+ # The length must not exceed 36 characters.
13224
+ # Corresponds to the JSON property `sessionId`
13225
+ # @return [String]
13226
+ attr_accessor :session_id
13227
+
13228
+ def initialize(**args)
13229
+ update!(**args)
13230
+ end
13231
+
13232
+ # Update properties of this object
13233
+ def update!(**args)
13234
+ @conversation = args[:conversation] if args.key?(:conversation)
13235
+ @conversation_profile = args[:conversation_profile] if args.key?(:conversation_profile)
13236
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
13237
+ @parent = args[:parent] if args.key?(:parent)
13238
+ @query = args[:query] if args.key?(:query)
13239
+ @session_id = args[:session_id] if args.key?(:session_id)
13240
+ end
13241
+ end
13242
+
13243
+ # The response message for Conversations.SearchKnowledge.
13244
+ class GoogleCloudDialogflowV2SearchKnowledgeResponse
13245
+ include Google::Apis::Core::Hashable
13246
+
13247
+ # Most relevant snippets extracted from articles in the given knowledge base,
13248
+ # ordered by confidence.
13249
+ # Corresponds to the JSON property `answers`
13250
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeAnswer>]
13251
+ attr_accessor :answers
13252
+
13253
+ def initialize(**args)
13254
+ update!(**args)
13255
+ end
13256
+
13257
+ # Update properties of this object
13258
+ def update!(**args)
13259
+ @answers = args[:answers] if args.key?(:answers)
13260
+ end
13261
+ end
13262
+
12622
13263
  # The sentiment, such as positive/negative feeling or association, for a unit of
12623
13264
  # analysis, such as the query text. See: https://cloud.google.com/natural-
12624
13265
  # language/docs/basics#interpreting_sentiment_analysis_values for how to
@@ -12978,6 +13619,13 @@ module Google
12978
13619
  # @return [String]
12979
13620
  attr_accessor :speech_model_variant
12980
13621
 
13622
+ # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of
13623
+ # timeout value.
13624
+ # Corresponds to the JSON property `useTimeoutBasedEndpointing`
13625
+ # @return [Boolean]
13626
+ attr_accessor :use_timeout_based_endpointing
13627
+ alias_method :use_timeout_based_endpointing?, :use_timeout_based_endpointing
13628
+
12981
13629
  def initialize(**args)
12982
13630
  update!(**args)
12983
13631
  end
@@ -12986,6 +13634,7 @@ module Google
12986
13634
  def update!(**args)
12987
13635
  @model = args[:model] if args.key?(:model)
12988
13636
  @speech_model_variant = args[:speech_model_variant] if args.key?(:speech_model_variant)
13637
+ @use_timeout_based_endpointing = args[:use_timeout_based_endpointing] if args.key?(:use_timeout_based_endpointing)
12989
13638
  end
12990
13639
  end
12991
13640
 
@@ -13325,6 +13974,27 @@ module Google
13325
13974
  end
13326
13975
  end
13327
13976
 
13977
+ # Represents the selection of a suggestion.
13978
+ class GoogleCloudDialogflowV2SuggestionInput
13979
+ include Google::Apis::Core::Hashable
13980
+
13981
+ # Required. The ID of a suggestion selected by the human agent. The suggestion(s)
13982
+ # were generated in a previous call to request Dialogflow assist. The format is:
13983
+ # `projects//locations//answerRecords/` where is an alphanumeric string.
13984
+ # Corresponds to the JSON property `answerRecord`
13985
+ # @return [String]
13986
+ attr_accessor :answer_record
13987
+
13988
+ def initialize(**args)
13989
+ update!(**args)
13990
+ end
13991
+
13992
+ # Update properties of this object
13993
+ def update!(**args)
13994
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
13995
+ end
13996
+ end
13997
+
13328
13998
  # One response of different type of suggestion response which is used in the
13329
13999
  # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
13330
14000
  # well as HumanAgentAssistantEvent.