google-cloud-discovery_engine-v1beta 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +21 -3
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +21 -3
  5. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +959 -0
  6. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/credentials.rb +47 -0
  7. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +176 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +797 -0
  9. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +450 -0
  10. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest.rb +52 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service.rb +55 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +19 -4
  13. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +19 -4
  14. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +42 -0
  15. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +14 -0
  16. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +14 -0
  17. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +2 -1
  18. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +14 -0
  19. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +14 -0
  20. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +42 -0
  21. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +57 -12
  22. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +57 -12
  23. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +16 -2
  24. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +16 -2
  25. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +42 -0
  26. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  27. data/lib/google/cloud/discovery_engine/v1beta.rb +2 -1
  28. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
  29. data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +1 -1
  30. data/lib/google/cloud/discoveryengine/v1beta/conversation_pb.rb +55 -0
  31. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +61 -0
  32. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +67 -0
  33. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +7 -1
  34. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  35. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +1 -1
  36. data/proto_docs/google/api/field_behavior.rb +14 -0
  37. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +10 -2
  38. data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +13 -2
  39. data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +138 -0
  40. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +209 -0
  41. data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +2 -4
  42. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +2 -1
  43. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +17 -17
  44. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +295 -61
  45. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +41 -29
  46. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +1 -1
  47. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  48. metadata +36 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fb1dee36ab960da08a6d19850c1d28c65a185d77fae4dc99d3cdd24da46d207d
4
- data.tar.gz: 1ec5ed0e2c7edc520ae0af03a864244feb8aba2c581d28e950169c64c6525ebc
3
+ metadata.gz: 0e4a17a1b826777691e17ecf0261e73facf5117e570d387450afe09f29698b94
4
+ data.tar.gz: ad54b4f89578fb6ac4c9cd23f24090423529f8c82722e7808375fbe132405f83
5
5
  SHA512:
6
- metadata.gz: 0b7f0f69a6078bca452a551f57409b7e9bed09203fdcb2318ec69dfc290d5af019d407a99f9eb2de1968c7207deda19dca395623a68455c0b8f69b0210d484b6
7
- data.tar.gz: 63734a0f89e7bf4477f94cc2092516b141bd3de0291f1436e1cdd8dc7a893e1f737407a6acf2f9157718d5c135e332d3777c2c21c6c662124933c20490f75f96
6
+ metadata.gz: b0b5bfcb4937f7d7f829a4cb53b611216edff46abd9dd518fb2139873f70a37be2759d727233a12cc2c1c039fa03fd66b6e0b53eefcb66652f21898c4f7abcd4
7
+ data.tar.gz: a558e3290182274f61d40586f4e52b1e776557a69be78bac1dce3342c1b1a5b03be2e6648a0c893c466bcea067278311e6d4273a766580963ce5d432faec1810
data/README.md CHANGED
@@ -40,7 +40,7 @@ response = client.complete_query request
40
40
  View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest)
41
41
  for class and method documentation.
42
42
 
43
- See also the [Product Documentation](https://cloud.google.com/discovery-engine/media/docs)
43
+ See also the [Product Documentation](https://cloud.google.com/generative-ai-app-builder/docs)
44
44
  for general usage information.
45
45
 
46
46
  ## Enabling Logging
@@ -18,6 +18,7 @@
18
18
 
19
19
  require "google/cloud/errors"
20
20
  require "google/cloud/discoveryengine/v1beta/completion_service_pb"
21
+ require "google/cloud/location"
21
22
 
22
23
  module Google
23
24
  module Cloud
@@ -138,6 +139,12 @@ module Google
138
139
  @quota_project_id = @config.quota_project
139
140
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
140
141
 
142
+ @location_client = Google::Cloud::Location::Locations::Client.new do |config|
143
+ config.credentials = credentials
144
+ config.quota_project = @quota_project_id
145
+ config.endpoint = @config.endpoint
146
+ end
147
+
141
148
  @completion_service_stub = ::Gapic::ServiceStub.new(
142
149
  ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Stub,
143
150
  credentials: credentials,
@@ -147,6 +154,13 @@ module Google
147
154
  )
148
155
  end
149
156
 
157
+ ##
158
+ # Get the associated client for mix-in of the Locations.
159
+ #
160
+ # @return [Google::Cloud::Location::Locations::Client]
161
+ #
162
+ attr_reader :location_client
163
+
150
164
  # Service calls
151
165
 
152
166
  ##
@@ -162,7 +176,7 @@ module Google
162
176
  # @param options [::Gapic::CallOptions, ::Hash]
163
177
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
164
178
  #
165
- # @overload complete_query(data_store: nil, query: nil, query_model: nil, user_pseudo_id: nil)
179
+ # @overload complete_query(data_store: nil, query: nil, query_model: nil, user_pseudo_id: nil, include_tail_suggestions: nil)
166
180
  # Pass arguments to `complete_query` via keyword arguments. Note that at
167
181
  # least one keyword argument is required. To specify no parameters, or to keep all
168
182
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -191,8 +205,7 @@ module Google
191
205
  #
192
206
  # * `document` is the default model for regular dataStores.
193
207
  # * `search-history` is the default model for
194
- # [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
195
- # dataStores.
208
+ # [IndustryVertical.SITE_SEARCH][] dataStores.
196
209
  # @param user_pseudo_id [::String]
197
210
  # A unique identifier for tracking visitors. For example, this could be
198
211
  # implemented with an HTTP cookie, which should be able to uniquely identify
@@ -208,6 +221,11 @@ module Google
208
221
  #
209
222
  # The field must be a UTF-8 encoded string with a length limit of 128
210
223
  # characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
224
+ # @param include_tail_suggestions [::Boolean]
225
+ # Indicates if tail suggestions should be returned if there are no
226
+ # suggestions that match the full query. Even if set to true, if there are
227
+ # suggestions that match the full query, those are returned and no
228
+ # tail suggestions are returned.
211
229
  #
212
230
  # @yield [response, operation] Access the result along with the RPC operation
213
231
  # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryResponse]
@@ -19,6 +19,7 @@
19
19
  require "google/cloud/errors"
20
20
  require "google/cloud/discoveryengine/v1beta/completion_service_pb"
21
21
  require "google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub"
22
+ require "google/cloud/location/rest"
22
23
 
23
24
  module Google
24
25
  module Cloud
@@ -135,9 +136,22 @@ module Google
135
136
  @quota_project_id = @config.quota_project
136
137
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
137
138
 
139
+ @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
140
+ config.credentials = credentials
141
+ config.quota_project = @quota_project_id
142
+ config.endpoint = @config.endpoint
143
+ end
144
+
138
145
  @completion_service_stub = ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
139
146
  end
140
147
 
148
+ ##
149
+ # Get the associated client for mix-in of the Locations.
150
+ #
151
+ # @return [Google::Cloud::Location::Locations::Rest::Client]
152
+ #
153
+ attr_reader :location_client
154
+
141
155
  # Service calls
142
156
 
143
157
  ##
@@ -153,7 +167,7 @@ module Google
153
167
  # @param options [::Gapic::CallOptions, ::Hash]
154
168
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
155
169
  #
156
- # @overload complete_query(data_store: nil, query: nil, query_model: nil, user_pseudo_id: nil)
170
+ # @overload complete_query(data_store: nil, query: nil, query_model: nil, user_pseudo_id: nil, include_tail_suggestions: nil)
157
171
  # Pass arguments to `complete_query` via keyword arguments. Note that at
158
172
  # least one keyword argument is required. To specify no parameters, or to keep all
159
173
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -182,8 +196,7 @@ module Google
182
196
  #
183
197
  # * `document` is the default model for regular dataStores.
184
198
  # * `search-history` is the default model for
185
- # [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
186
- # dataStores.
199
+ # [IndustryVertical.SITE_SEARCH][] dataStores.
187
200
  # @param user_pseudo_id [::String]
188
201
  # A unique identifier for tracking visitors. For example, this could be
189
202
  # implemented with an HTTP cookie, which should be able to uniquely identify
@@ -199,6 +212,11 @@ module Google
199
212
  #
200
213
  # The field must be a UTF-8 encoded string with a length limit of 128
201
214
  # characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
215
+ # @param include_tail_suggestions [::Boolean]
216
+ # Indicates if tail suggestions should be returned if there are no
217
+ # suggestions that match the full query. Even if set to true, if there are
218
+ # suggestions that match the full query, those are returned and no
219
+ # tail suggestions are returned.
202
220
  # @yield [result, operation] Access the result along with the TransportOperation object
203
221
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryResponse]
204
222
  # @yieldparam operation [::Gapic::Rest::TransportOperation]