google-cloud-dialogflow-cx-v3 0.22.0 → 0.24.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +2 -1
  4. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +33 -8
  5. data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +28 -6
  6. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +35 -7
  7. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/operations.rb +33 -8
  8. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/service_stub.rb +14 -2
  9. data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +2 -1
  10. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +32 -8
  11. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +34 -7
  12. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/service_stub.rb +14 -2
  13. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +32 -8
  14. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +34 -7
  15. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/service_stub.rb +14 -2
  16. data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +1 -1
  17. data/lib/google/cloud/dialogflow/cx/v3/entity_type_services_pb.rb +2 -2
  18. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +151 -127
  19. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +146 -119
  20. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/service_stub.rb +62 -50
  21. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +33 -8
  22. data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +28 -6
  23. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +35 -7
  24. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/operations.rb +33 -8
  25. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/service_stub.rb +14 -2
  26. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +32 -8
  27. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +34 -7
  28. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/service_stub.rb +14 -2
  29. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +33 -8
  30. data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +28 -6
  31. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +35 -7
  32. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/operations.rb +33 -8
  33. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/service_stub.rb +14 -2
  34. data/lib/google/cloud/dialogflow/cx/v3/generator_pb.rb +60 -0
  35. data/lib/google/cloud/dialogflow/cx/v3/generator_services_pb.rb +55 -0
  36. data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +851 -0
  37. data/lib/google/cloud/dialogflow/cx/v3/generators/credentials.rb +54 -0
  38. data/lib/google/cloud/dialogflow/cx/v3/generators/paths.rb +75 -0
  39. data/lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb +798 -0
  40. data/lib/google/cloud/dialogflow/cx/v3/generators/rest/service_stub.rb +359 -0
  41. data/lib/google/cloud/dialogflow/cx/v3/generators/rest.rb +55 -0
  42. data/lib/google/cloud/dialogflow/cx/v3/generators.rb +57 -0
  43. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +33 -8
  44. data/lib/google/cloud/dialogflow/cx/v3/intents/operations.rb +28 -6
  45. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +35 -7
  46. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/operations.rb +33 -8
  47. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/service_stub.rb +14 -2
  48. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +32 -8
  49. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +34 -7
  50. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/service_stub.rb +14 -2
  51. data/lib/google/cloud/dialogflow/cx/v3/rest.rb +1 -0
  52. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +32 -8
  53. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +34 -7
  54. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/service_stub.rb +14 -2
  55. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +32 -8
  56. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +34 -7
  57. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/service_stub.rb +14 -2
  58. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +12 -1
  59. data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +3 -0
  60. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +133 -8
  61. data/lib/google/cloud/dialogflow/cx/v3/sessions/paths.rb +45 -0
  62. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +128 -7
  63. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb +74 -2
  64. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +33 -8
  65. data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +28 -6
  66. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +35 -7
  67. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/operations.rb +33 -8
  68. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/service_stub.rb +14 -2
  69. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +32 -8
  70. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +34 -7
  71. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/service_stub.rb +14 -2
  72. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  73. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +33 -8
  74. data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +28 -6
  75. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +35 -7
  76. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb +33 -8
  77. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/service_stub.rb +14 -2
  78. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +32 -8
  79. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +34 -7
  80. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/service_stub.rb +14 -2
  81. data/lib/google/cloud/dialogflow/cx/v3.rb +1 -0
  82. data/proto_docs/google/api/client.rb +14 -0
  83. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +16 -0
  84. data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +47 -3
  85. data/proto_docs/google/cloud/dialogflow/cx/v3/generator.rb +187 -0
  86. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +187 -0
  87. data/proto_docs/google/cloud/dialogflow/cx/v3/validation_message.rb +1 -0
  88. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +2 -0
  89. metadata +17 -7
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -100,6 +100,7 @@ module Google
100
100
  # reference for the agent. Format: `projects/<Project ID>/locations/<Location
101
101
  # ID>/securitySettings/<Security Settings ID>`.
102
102
  # @!attribute [rw] enable_stackdriver_logging
103
+ # @deprecated This field is deprecated and may be removed in the next major version update.
103
104
  # @return [::Boolean]
104
105
  # Indicates if stackdriver logging is enabled for the agent.
105
106
  # Please use
@@ -127,6 +128,9 @@ module Google
127
128
  # @!attribute [rw] gen_app_builder_settings
128
129
  # @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GenAppBuilderSettings]
129
130
  # Gen App Builder-related agent-level settings.
131
+ # @!attribute [rw] answer_feedback_settings
132
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Agent::AnswerFeedbackSettings]
133
+ # Optional. Answer feedback collection settings.
130
134
  class Agent
131
135
  include ::Google::Protobuf::MessageExts
132
136
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -172,6 +176,18 @@ module Google
172
176
  include ::Google::Protobuf::MessageExts
173
177
  extend ::Google::Protobuf::MessageExts::ClassMethods
174
178
  end
179
+
180
+ # Settings for answer feedback collection.
181
+ # @!attribute [rw] enable_answer_feedback
182
+ # @return [::Boolean]
183
+ # Optional. If enabled, end users will be able to provide
184
+ # {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
185
+ # Dialogflow responses. Feature works only if interaction logging is
186
+ # enabled in the Dialogflow agent.
187
+ class AnswerFeedbackSettings
188
+ include ::Google::Protobuf::MessageExts
189
+ extend ::Google::Protobuf::MessageExts::ClassMethods
190
+ end
175
191
  end
176
192
 
177
193
  # The request message for
@@ -50,6 +50,42 @@ module Google
50
50
  extend ::Google::Protobuf::MessageExts::ClassMethods
51
51
  end
52
52
 
53
+ # Configuration of the barge-in behavior. Barge-in instructs the API to return
54
+ # a detected utterance at a proper time while the client is playing back the
55
+ # response audio from a previous request. When the client sees the
56
+ # utterance, it should stop the playback and immediately get ready for
57
+ # receiving the responses for the current request.
58
+ #
59
+ # The barge-in handling requires the client to start streaming audio input
60
+ # as soon as it starts playing back the audio from the previous response. The
61
+ # playback is modeled into two phases:
62
+ #
63
+ # * No barge-in phase: which goes first and during which speech detection
64
+ # should not be carried out.
65
+ #
66
+ # * Barge-in phase: which follows the no barge-in phase and during which
67
+ # the API starts speech detection and may inform the client that an utterance
68
+ # has been detected. Note that no-speech event is not expected in this
69
+ # phase.
70
+ #
71
+ # The client provides this configuration in terms of the durations of those
72
+ # two phases. The durations are measured in terms of the audio length from the
73
+ # the start of the input audio.
74
+ #
75
+ # No-speech event is a response with END_OF_UTTERANCE without any transcript
76
+ # following up.
77
+ # @!attribute [rw] no_barge_in_duration
78
+ # @return [::Google::Protobuf::Duration]
79
+ # Duration that is not eligible for barge-in at the beginning of the input
80
+ # audio.
81
+ # @!attribute [rw] total_duration
82
+ # @return [::Google::Protobuf::Duration]
83
+ # Total duration for the playback at the beginning of the input audio.
84
+ class BargeInConfig
85
+ include ::Google::Protobuf::MessageExts
86
+ extend ::Google::Protobuf::MessageExts::ClassMethods
87
+ end
88
+
53
89
  # Instructs the speech recognizer on how to process the audio content.
54
90
  # @!attribute [rw] audio_encoding
55
91
  # @return [::Google::Cloud::Dialogflow::CX::V3::AudioEncoding]
@@ -81,8 +117,8 @@ module Google
81
117
  # @return [::String]
82
118
  # Optional. Which Speech model to select for the given request. Select the
83
119
  # model best suited to your domain to get best results. If a model is not
84
- # explicitly specified, then we auto-select a model based on the parameters
85
- # in the InputAudioConfig.
120
+ # explicitly specified, then Dialogflow auto-selects a model based on other
121
+ # parameters in the InputAudioConfig and Agent settings.
86
122
  # If enhanced speech model is enabled for the agent and an enhanced
87
123
  # version of the specified model for the language does not exist, then the
88
124
  # speech is recognized using the standard version of the specified model.
@@ -95,7 +131,12 @@ module Google
95
131
  #
96
132
  # - phone_call (best for Agent Assist and telephony)
97
133
  # - latest_short (best for Dialogflow non-telephony)
98
- # - command_and_search (best for very short utterances and commands)
134
+ # - command_and_search
135
+ #
136
+ # Leave this field unspecified to use
137
+ # [Agent Speech
138
+ # settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech)
139
+ # for model selection.
99
140
  # @!attribute [rw] model_variant
100
141
  # @return [::Google::Cloud::Dialogflow::CX::V3::SpeechModelVariant]
101
142
  # Optional. Which variant of the [Speech
@@ -110,6 +151,9 @@ module Google
110
151
  # client should close the stream and start a new request with a new stream as
111
152
  # needed.
112
153
  # Note: This setting is relevant only for streaming methods.
154
+ # @!attribute [rw] barge_in_config
155
+ # @return [::Google::Cloud::Dialogflow::CX::V3::BargeInConfig]
156
+ # Configuration of barge-in behavior during the streaming of input audio.
113
157
  class InputAudioConfig
114
158
  include ::Google::Protobuf::MessageExts
115
159
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -0,0 +1,187 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Dialogflow
23
+ module CX
24
+ module V3
25
+ # Generators contain prompt to be sent to the LLM model to generate text. The
26
+ # prompt can contain parameters which will be resolved before calling the
27
+ # model. It can optionally contain banned phrases to ensure the model responses
28
+ # are safe.
29
+ # @!attribute [rw] name
30
+ # @return [::String]
31
+ # The unique identifier of the generator.
32
+ # Must be set for the
33
+ # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#update_generator Generators.UpdateGenerator}
34
+ # method. [Generators.CreateGenerate][] populates the name automatically.
35
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
36
+ # ID>/generators/<Generator ID>`.
37
+ # @!attribute [rw] display_name
38
+ # @return [::String]
39
+ # Required. The human-readable name of the generator, unique within the
40
+ # agent. The prompt contains pre-defined parameters such as $conversation,
41
+ # $last-user-utterance, etc. populated by Dialogflow. It can also contain
42
+ # custom placeholders which will be resolved during fulfillment.
43
+ # @!attribute [rw] prompt_text
44
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Phrase]
45
+ # Required. Prompt for the LLM model.
46
+ # @!attribute [rw] placeholders
47
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Generator::Placeholder>]
48
+ # Optional. List of custom placeholders in the prompt text.
49
+ class Generator
50
+ include ::Google::Protobuf::MessageExts
51
+ extend ::Google::Protobuf::MessageExts::ClassMethods
52
+
53
+ # Represents a custom placeholder in the prompt text.
54
+ # @!attribute [rw] id
55
+ # @return [::String]
56
+ # Unique ID used to map custom placeholder to parameters in fulfillment.
57
+ # @!attribute [rw] name
58
+ # @return [::String]
59
+ # Custom placeholder value in the prompt text.
60
+ class Placeholder
61
+ include ::Google::Protobuf::MessageExts
62
+ extend ::Google::Protobuf::MessageExts::ClassMethods
63
+ end
64
+ end
65
+
66
+ # Text input which can be used for prompt or banned phrases.
67
+ # @!attribute [rw] text
68
+ # @return [::String]
69
+ # Required. Text input which can be used for prompt or banned phrases.
70
+ class Phrase
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # The request message for
76
+ # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#list_generators Generators.ListGenerators}.
77
+ # @!attribute [rw] parent
78
+ # @return [::String]
79
+ # Required. The agent to list all generators for.
80
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
81
+ # @!attribute [rw] language_code
82
+ # @return [::String]
83
+ # The language to list generators for.
84
+ # @!attribute [rw] page_size
85
+ # @return [::Integer]
86
+ # The maximum number of items to return in a single page. By default 100 and
87
+ # at most 1000.
88
+ # @!attribute [rw] page_token
89
+ # @return [::String]
90
+ # The next_page_token value returned from a previous list request.
91
+ class ListGeneratorsRequest
92
+ include ::Google::Protobuf::MessageExts
93
+ extend ::Google::Protobuf::MessageExts::ClassMethods
94
+ end
95
+
96
+ # The response message for
97
+ # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#list_generators Generators.ListGenerators}.
98
+ # @!attribute [rw] generators
99
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Generator>]
100
+ # The list of generators. There will be a maximum number of items returned
101
+ # based on the page_size field in the request.
102
+ # @!attribute [rw] next_page_token
103
+ # @return [::String]
104
+ # Token to retrieve the next page of results, or empty if there are no more
105
+ # results in the list.
106
+ class ListGeneratorsResponse
107
+ include ::Google::Protobuf::MessageExts
108
+ extend ::Google::Protobuf::MessageExts::ClassMethods
109
+ end
110
+
111
+ # The request message for
112
+ # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#get_generator Generators.GetGenerator}.
113
+ # @!attribute [rw] name
114
+ # @return [::String]
115
+ # Required. The name of the generator.
116
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
117
+ # ID>/generators/<Generator ID>`.
118
+ # @!attribute [rw] language_code
119
+ # @return [::String]
120
+ # The language to list generators for.
121
+ class GetGeneratorRequest
122
+ include ::Google::Protobuf::MessageExts
123
+ extend ::Google::Protobuf::MessageExts::ClassMethods
124
+ end
125
+
126
+ # The request message for
127
+ # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#create_generator Generators.CreateGenerator}.
128
+ # @!attribute [rw] parent
129
+ # @return [::String]
130
+ # Required. The agent to create a generator for.
131
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
132
+ # @!attribute [rw] generator
133
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Generator]
134
+ # Required. The generator to create.
135
+ # @!attribute [rw] language_code
136
+ # @return [::String]
137
+ # The language to create generators for the following fields:
138
+ # * `Generator.prompt_text.text`
139
+ # If not specified, the agent's default language is used.
140
+ class CreateGeneratorRequest
141
+ include ::Google::Protobuf::MessageExts
142
+ extend ::Google::Protobuf::MessageExts::ClassMethods
143
+ end
144
+
145
+ # The request message for
146
+ # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#update_generator Generators.UpdateGenerator}.
147
+ # @!attribute [rw] generator
148
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Generator]
149
+ # Required. The generator to update.
150
+ # @!attribute [rw] language_code
151
+ # @return [::String]
152
+ # The language to list generators for.
153
+ # @!attribute [rw] update_mask
154
+ # @return [::Google::Protobuf::FieldMask]
155
+ # The mask to control which fields get updated. If the mask is not present,
156
+ # all fields will be updated.
157
+ class UpdateGeneratorRequest
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
+ end
161
+
162
+ # The request message for
163
+ # {::Google::Cloud::Dialogflow::CX::V3::Generators::Client#delete_generator Generators.DeleteGenerator}.
164
+ # @!attribute [rw] name
165
+ # @return [::String]
166
+ # Required. The name of the generator to delete.
167
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
168
+ # ID>/generators/<Generator ID>`.
169
+ # @!attribute [rw] force
170
+ # @return [::Boolean]
171
+ # This field has no effect for generators not being used.
172
+ # For generators that are used by pages/flows/transition route groups:
173
+ #
174
+ # * If `force` is set to false, an error will be returned with message
175
+ # indicating the referenced resources.
176
+ # * If `force` is set to true, Dialogflow will remove the generator, as well
177
+ # as any references to the generator (i.e.
178
+ # [Generator][Fulfillment.generator]) in fulfillments.
179
+ class DeleteGeneratorRequest
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+ end
184
+ end
185
+ end
186
+ end
187
+ end
@@ -22,6 +22,71 @@ module Google
22
22
  module Dialogflow
23
23
  module CX
24
24
  module V3
25
+ # Stores information about feedback provided by users about a response.
26
+ # @!attribute [rw] rating
27
+ # @return [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback::Rating]
28
+ # Optional. Rating from user for the specific Dialogflow response.
29
+ # @!attribute [rw] rating_reason
30
+ # @return [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback::RatingReason]
31
+ # Optional. In case of thumbs down rating provided, users can optionally
32
+ # provide context about the rating.
33
+ # @!attribute [rw] custom_rating
34
+ # @return [::String]
35
+ # Optional. Custom rating from the user about the provided answer, with
36
+ # maximum length of 1024 characters. For example, client could use a
37
+ # customized JSON object to indicate the rating.
38
+ class AnswerFeedback
39
+ include ::Google::Protobuf::MessageExts
40
+ extend ::Google::Protobuf::MessageExts::ClassMethods
41
+
42
+ # Stores extra information about why users provided thumbs down rating.
43
+ # @!attribute [rw] reason_labels
44
+ # @return [::Array<::String>]
45
+ # Optional. Custom reason labels for thumbs down rating provided by the
46
+ # user. The maximum number of labels allowed is 10 and the maximum length
47
+ # of a single label is 128 characters.
48
+ # @!attribute [rw] feedback
49
+ # @return [::String]
50
+ # Optional. Additional feedback about the rating.
51
+ # This field can be populated without choosing a predefined `reason`.
52
+ class RatingReason
53
+ include ::Google::Protobuf::MessageExts
54
+ extend ::Google::Protobuf::MessageExts::ClassMethods
55
+ end
56
+
57
+ # Represents thumbs up/down rating provided by user about a response.
58
+ module Rating
59
+ # Rating not specified.
60
+ RATING_UNSPECIFIED = 0
61
+
62
+ # Thumbs up feedback from user.
63
+ THUMBS_UP = 1
64
+
65
+ # Thumbs down feedback from user.
66
+ THUMBS_DOWN = 2
67
+ end
68
+ end
69
+
70
+ # The request to set the feedback for a bot answer.
71
+ # @!attribute [rw] session
72
+ # @return [::String]
73
+ # Required. The name of the session the feedback was sent to.
74
+ # @!attribute [rw] response_id
75
+ # @return [::String]
76
+ # Required. ID of the response to update its feedback. This is the same as
77
+ # DetectIntentResponse.response_id.
78
+ # @!attribute [rw] answer_feedback
79
+ # @return [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback]
80
+ # Required. Feedback provided for a bot answer.
81
+ # @!attribute [rw] update_mask
82
+ # @return [::Google::Protobuf::FieldMask]
83
+ # Optional. The mask to control which fields to update. If the mask is not
84
+ # present, all fields will be updated.
85
+ class SubmitAnswerFeedbackRequest
86
+ include ::Google::Protobuf::MessageExts
87
+ extend ::Google::Protobuf::MessageExts::ClassMethods
88
+ end
89
+
25
90
  # The request to detect user's intent.
26
91
  # @!attribute [rw] session
27
92
  # @return [::String]
@@ -516,6 +581,28 @@ module Google
516
581
  # By default, a Dialogflow session remains active and its data is stored for
517
582
  # 30 minutes after the last request is sent for the session.
518
583
  # This value should be no longer than 1 day.
584
+ # @!attribute [rw] end_user_metadata
585
+ # @return [::Google::Protobuf::Struct]
586
+ # Optional. Information about the end-user to improve the relevance and
587
+ # accuracy of generative answers.
588
+ #
589
+ # This will be interpreted and used by a language model, so, for good
590
+ # results, the data should be self-descriptive, and in a simple structure.
591
+ #
592
+ # Example:
593
+ #
594
+ # ```json
595
+ # {
596
+ # "subscription plan": "Business Premium Plus",
597
+ # "devices owned": [
598
+ # \\{"model": "Google Pixel 7"},
599
+ # \\{"model": "Google Pixel Tablet"}
600
+ # ]
601
+ # }
602
+ # ```
603
+ # @!attribute [rw] search_config
604
+ # @return [::Google::Cloud::Dialogflow::CX::V3::SearchConfig]
605
+ # Optional. Search configuration for UCS search queries.
519
606
  class QueryParameters
520
607
  include ::Google::Protobuf::MessageExts
521
608
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -530,6 +617,100 @@ module Google
530
617
  end
531
618
  end
532
619
 
620
+ # Search configuration for UCS search queries.
621
+ # @!attribute [rw] boost_specs
622
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::BoostSpecs>]
623
+ # Optional. Boosting configuration for the datastores.
624
+ # @!attribute [rw] filter_specs
625
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::FilterSpecs>]
626
+ # Optional. Filter configuration for the datastores.
627
+ class SearchConfig
628
+ include ::Google::Protobuf::MessageExts
629
+ extend ::Google::Protobuf::MessageExts::ClassMethods
630
+ end
631
+
632
+ # Boost specification to boost certain documents.
633
+ # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation
634
+ # is available at
635
+ # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
636
+ # @!attribute [rw] condition_boost_specs
637
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec>]
638
+ # Optional. Condition boost specifications. If a document matches multiple
639
+ # conditions in the specifictions, boost scores from these specifications are
640
+ # all applied and combined in a non-linear way. Maximum number of
641
+ # specifications is 20.
642
+ class BoostSpec
643
+ include ::Google::Protobuf::MessageExts
644
+ extend ::Google::Protobuf::MessageExts::ClassMethods
645
+
646
+ # Boost applies to documents which match a condition.
647
+ # @!attribute [rw] condition
648
+ # @return [::String]
649
+ # Optional. An expression which specifies a boost condition. The syntax and
650
+ # supported fields are the same as a filter expression.
651
+ # Examples:
652
+ #
653
+ # * To boost documents with document ID "doc_1" or "doc_2", and
654
+ # color
655
+ # "Red" or "Blue":
656
+ # * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
657
+ # @!attribute [rw] boost
658
+ # @return [::Float]
659
+ # Optional. Strength of the condition boost, which should be in [-1, 1].
660
+ # Negative boost means demotion. Default is 0.0.
661
+ #
662
+ # Setting to 1.0 gives the document a big promotion. However, it does not
663
+ # necessarily mean that the boosted document will be the top result at
664
+ # all times, nor that other documents will be excluded. Results could
665
+ # still be shown even when none of them matches the condition. And
666
+ # results that are significantly more relevant to the search query can
667
+ # still trump your heavily favored but irrelevant documents.
668
+ #
669
+ # Setting to -1.0 gives the document a big demotion. However, results
670
+ # that are deeply relevant might still be shown. The document will have
671
+ # an upstream battle to get a fairly high ranking, but it is not blocked
672
+ # out completely.
673
+ #
674
+ # Setting to 0.0 means no boost applied. The boosting condition is
675
+ # ignored.
676
+ class ConditionBoostSpec
677
+ include ::Google::Protobuf::MessageExts
678
+ extend ::Google::Protobuf::MessageExts::ClassMethods
679
+ end
680
+ end
681
+
682
+ # Boost specifications for data stores.
683
+ # @!attribute [rw] data_stores
684
+ # @return [::Array<::String>]
685
+ # Optional. Data Stores where the boosting configuration is applied. The full
686
+ # names of the referenced data stores. Formats:
687
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
688
+ # `projects/{project}/locations/{location}/dataStores/{data_store}`
689
+ # @!attribute [rw] spec
690
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::BoostSpec>]
691
+ # Optional. A list of boosting specifications.
692
+ class BoostSpecs
693
+ include ::Google::Protobuf::MessageExts
694
+ extend ::Google::Protobuf::MessageExts::ClassMethods
695
+ end
696
+
697
+ # Filter specifications for data stores.
698
+ # @!attribute [rw] data_stores
699
+ # @return [::Array<::String>]
700
+ # Optional. Data Stores where the boosting configuration is applied. The full
701
+ # names of the referenced data stores. Formats:
702
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
703
+ # `projects/{project}/locations/{location}/dataStores/{data_store}`
704
+ # @!attribute [rw] filter
705
+ # @return [::String]
706
+ # Optional. The filter expression to be applied.
707
+ # Expression syntax is documented at
708
+ # https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
709
+ class FilterSpecs
710
+ include ::Google::Protobuf::MessageExts
711
+ extend ::Google::Protobuf::MessageExts::ClassMethods
712
+ end
713
+
533
714
  # Represents the query input. It can contain one of:
534
715
  #
535
716
  # 1. A conversational query in the form of text.
@@ -635,6 +816,7 @@ module Google
635
816
  # fields are filled in this message, including but not limited to `name` and
636
817
  # `display_name`.
637
818
  # @!attribute [rw] intent
819
+ # @deprecated This field is deprecated and may be removed in the next major version update.
638
820
  # @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
639
821
  # The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that matched the
640
822
  # conversational query. Some, not all fields are filled in this message,
@@ -643,6 +825,7 @@ module Google
643
825
  # {::Google::Cloud::Dialogflow::CX::V3::QueryResult#match QueryResult.match}
644
826
  # instead.
645
827
  # @!attribute [rw] intent_detection_confidence
828
+ # @deprecated This field is deprecated and may be removed in the next major version update.
646
829
  # @return [::Float]
647
830
  # The intent detection confidence. Values range from 0.0 (completely
648
831
  # uncertain) to 1.0 (completely certain).
@@ -688,6 +871,10 @@ module Google
688
871
  # the client may need to perform special logic at the moment. For example, if
689
872
  # Dialogflow exports audio to Google Cloud Storage, then the client may need
690
873
  # to wait for the resulting object to appear in the bucket before proceeding.
874
+ # @!attribute [rw] allow_answer_feedback
875
+ # @return [::Boolean]
876
+ # Indicates whether the Thumbs up/Thumbs down rating controls are need to be
877
+ # shown for the response in the Dialogflow Messenger widget.
691
878
  class QueryResult
692
879
  include ::Google::Protobuf::MessageExts
693
880
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -27,6 +27,7 @@ module Google
27
27
  # @return [::Google::Cloud::Dialogflow::CX::V3::ValidationMessage::ResourceType]
28
28
  # The type of the resources where the message is found.
29
29
  # @!attribute [rw] resources
30
+ # @deprecated This field is deprecated and may be removed in the next major version update.
30
31
  # @return [::Array<::String>]
31
32
  # The names of the resources where the message is found.
32
33
  # @!attribute [rw] resource_names
@@ -63,9 +63,11 @@ module Google
63
63
  # Required. The webhook URI for receiving POST requests. It must use https
64
64
  # protocol.
65
65
  # @!attribute [rw] username
66
+ # @deprecated This field is deprecated and may be removed in the next major version update.
66
67
  # @return [::String]
67
68
  # The user name for HTTP Basic authentication.
68
69
  # @!attribute [rw] password
70
+ # @deprecated This field is deprecated and may be removed in the next major version update.
69
71
  # @return [::String]
70
72
  # The password for HTTP Basic authentication.
71
73
  # @!attribute [rw] request_headers
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dialogflow-cx-v3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.22.0
4
+ version: 0.24.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-29 00:00:00.000000000 Z
11
+ date: 2024-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.20.0
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -50,7 +50,7 @@ dependencies:
50
50
  requirements:
51
51
  - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '0.4'
53
+ version: '0.7'
54
54
  - - "<"
55
55
  - !ruby/object:Gem::Version
56
56
  version: 2.a
@@ -60,7 +60,7 @@ dependencies:
60
60
  requirements:
61
61
  - - ">="
62
62
  - !ruby/object:Gem::Version
63
- version: '0.4'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -272,6 +272,15 @@ files:
272
272
  - lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb
273
273
  - lib/google/cloud/dialogflow/cx/v3/gcs_pb.rb
274
274
  - lib/google/cloud/dialogflow/cx/v3/generative_settings_pb.rb
275
+ - lib/google/cloud/dialogflow/cx/v3/generator_pb.rb
276
+ - lib/google/cloud/dialogflow/cx/v3/generator_services_pb.rb
277
+ - lib/google/cloud/dialogflow/cx/v3/generators.rb
278
+ - lib/google/cloud/dialogflow/cx/v3/generators/client.rb
279
+ - lib/google/cloud/dialogflow/cx/v3/generators/credentials.rb
280
+ - lib/google/cloud/dialogflow/cx/v3/generators/paths.rb
281
+ - lib/google/cloud/dialogflow/cx/v3/generators/rest.rb
282
+ - lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb
283
+ - lib/google/cloud/dialogflow/cx/v3/generators/rest/service_stub.rb
275
284
  - lib/google/cloud/dialogflow/cx/v3/import_strategy_pb.rb
276
285
  - lib/google/cloud/dialogflow/cx/v3/inline_pb.rb
277
286
  - lib/google/cloud/dialogflow/cx/v3/intent_pb.rb
@@ -384,6 +393,7 @@ files:
384
393
  - proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb
385
394
  - proto_docs/google/cloud/dialogflow/cx/v3/gcs.rb
386
395
  - proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb
396
+ - proto_docs/google/cloud/dialogflow/cx/v3/generator.rb
387
397
  - proto_docs/google/cloud/dialogflow/cx/v3/import_strategy.rb
388
398
  - proto_docs/google/cloud/dialogflow/cx/v3/inline.rb
389
399
  - proto_docs/google/cloud/dialogflow/cx/v3/intent.rb
@@ -426,7 +436,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
426
436
  - !ruby/object:Gem::Version
427
437
  version: '0'
428
438
  requirements: []
429
- rubygems_version: 3.4.19
439
+ rubygems_version: 3.5.3
430
440
  signing_key:
431
441
  specification_version: 4
432
442
  summary: Builds conversational interfaces (for example, chatbots, and voice-powered