google-cloud-discovery_engine-v1 0.4.1 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (91) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +235 -4
  3. data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +801 -0
  4. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +221 -4
  5. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +1091 -0
  6. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +136 -0
  7. data/lib/google/cloud/discovery_engine/v1/completion_service/rest.rb +1 -0
  8. data/lib/google/cloud/discovery_engine/v1/completion_service.rb +1 -0
  9. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +20 -3
  10. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +91 -0
  11. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +20 -3
  12. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +45 -0
  13. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +924 -0
  14. data/lib/google/cloud/discovery_engine/v1/data_store_service/credentials.rb +47 -0
  15. data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +801 -0
  16. data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +97 -0
  17. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +863 -0
  18. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +1091 -0
  19. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/service_stub.rb +403 -0
  20. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest.rb +54 -0
  21. data/lib/google/cloud/discovery_engine/v1/data_store_service.rb +57 -0
  22. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +14 -0
  23. data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +885 -0
  24. data/lib/google/cloud/discovery_engine/v1/engine_service/credentials.rb +47 -0
  25. data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +801 -0
  26. data/lib/google/cloud/discovery_engine/v1/engine_service/paths.rb +73 -0
  27. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +824 -0
  28. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +1091 -0
  29. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/service_stub.rb +366 -0
  30. data/lib/google/cloud/discovery_engine/v1/engine_service/rest.rb +54 -0
  31. data/lib/google/cloud/discovery_engine/v1/engine_service.rb +57 -0
  32. data/lib/google/cloud/discovery_engine/v1/rest.rb +3 -0
  33. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +14 -0
  34. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +40 -4
  35. data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +19 -0
  36. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +40 -4
  37. data/lib/google/cloud/discovery_engine/v1/search_service/rest/service_stub.rb +8 -0
  38. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +1631 -0
  39. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +801 -0
  41. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/paths.rb +127 -0
  42. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +1521 -0
  43. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +1091 -0
  44. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/service_stub.rb +860 -0
  45. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest.rb +53 -0
  46. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service.rb +56 -0
  47. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +14 -0
  48. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  49. data/lib/google/cloud/discovery_engine/v1.rb +3 -0
  50. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +6 -2
  51. data/lib/google/cloud/discoveryengine/v1/completion_pb.rb +45 -0
  52. data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +5 -2
  53. data/lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb +8 -0
  54. data/lib/google/cloud/discoveryengine/v1/conversation_pb.rb +2 -2
  55. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +2 -2
  56. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +49 -0
  57. data/lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb +62 -0
  58. data/lib/google/cloud/discoveryengine/v1/data_store_service_services_pb.rb +61 -0
  59. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +1 -1
  60. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +2 -2
  61. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +53 -0
  62. data/lib/google/cloud/discoveryengine/v1/engine_service_pb.rb +62 -0
  63. data/lib/google/cloud/discoveryengine/v1/engine_service_services_pb.rb +55 -0
  64. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +8 -2
  65. data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +7 -2
  66. data/lib/google/cloud/discoveryengine/v1/schema_pb.rb +1 -1
  67. data/lib/google/cloud/discoveryengine/v1/schema_service_pb.rb +2 -2
  68. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +9 -2
  69. data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +54 -0
  70. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb +82 -0
  71. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_services_pb.rb +73 -0
  72. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
  73. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +2 -2
  74. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +51 -0
  75. data/proto_docs/google/cloud/discoveryengine/v1/completion.rb +53 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb +10 -4
  77. data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +2 -0
  78. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +19 -1
  79. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +88 -0
  80. data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +214 -0
  81. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +1 -1
  82. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +214 -0
  83. data/proto_docs/google/cloud/discoveryengine/v1/engine_service.rb +177 -0
  84. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +66 -0
  85. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +41 -0
  86. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +149 -4
  87. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +160 -0
  88. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb +525 -0
  89. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +3 -3
  90. data/proto_docs/google/protobuf/any.rb +2 -1
  91. metadata +48 -2
@@ -0,0 +1,366 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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
+ require "google/cloud/discoveryengine/v1/engine_service_pb"
20
+
21
+ module Google
22
+ module Cloud
23
+ module DiscoveryEngine
24
+ module V1
25
+ module EngineService
26
+ module Rest
27
+ ##
28
+ # REST service stub for the EngineService service.
29
+ # Service stub contains baseline method implementations
30
+ # including transcoding, making the REST call, and deserialing the response.
31
+ #
32
+ class ServiceStub
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
+ # These require statements are intentionally placed here to initialize
35
+ # the REST modules only when it's required.
36
+ require "gapic/rest"
37
+
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
42
+ numeric_enums: true,
43
+ raise_faraday_errors: false
44
+ end
45
+
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
55
+ ##
56
+ # The effective endpoint
57
+ #
58
+ # @return [String]
59
+ #
60
+ def endpoint
61
+ @client_stub.endpoint
62
+ end
63
+
64
+ ##
65
+ # Baseline implementation for the create_engine REST call
66
+ #
67
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::CreateEngineRequest]
68
+ # A request object representing the call parameters. Required.
69
+ # @param options [::Gapic::CallOptions]
70
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
71
+ #
72
+ # @yield [result, operation] Access the result along with the TransportOperation object
73
+ # @yieldparam result [::Google::Longrunning::Operation]
74
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
75
+ #
76
+ # @return [::Google::Longrunning::Operation]
77
+ # A result object deserialized from the server's reply
78
+ def create_engine request_pb, options = nil
79
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
80
+
81
+ verb, uri, query_string_params, body = ServiceStub.transcode_create_engine_request request_pb
82
+ query_string_params = if query_string_params.any?
83
+ query_string_params.to_h { |p| p.split "=", 2 }
84
+ else
85
+ {}
86
+ end
87
+
88
+ response = @client_stub.make_http_request(
89
+ verb,
90
+ uri: uri,
91
+ body: body || "",
92
+ params: query_string_params,
93
+ options: options
94
+ )
95
+ operation = ::Gapic::Rest::TransportOperation.new response
96
+ result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
97
+
98
+ yield result, operation if block_given?
99
+ result
100
+ end
101
+
102
+ ##
103
+ # Baseline implementation for the delete_engine REST call
104
+ #
105
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::DeleteEngineRequest]
106
+ # A request object representing the call parameters. Required.
107
+ # @param options [::Gapic::CallOptions]
108
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
109
+ #
110
+ # @yield [result, operation] Access the result along with the TransportOperation object
111
+ # @yieldparam result [::Google::Longrunning::Operation]
112
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
113
+ #
114
+ # @return [::Google::Longrunning::Operation]
115
+ # A result object deserialized from the server's reply
116
+ def delete_engine request_pb, options = nil
117
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
118
+
119
+ verb, uri, query_string_params, body = ServiceStub.transcode_delete_engine_request request_pb
120
+ query_string_params = if query_string_params.any?
121
+ query_string_params.to_h { |p| p.split "=", 2 }
122
+ else
123
+ {}
124
+ end
125
+
126
+ response = @client_stub.make_http_request(
127
+ verb,
128
+ uri: uri,
129
+ body: body || "",
130
+ params: query_string_params,
131
+ options: options
132
+ )
133
+ operation = ::Gapic::Rest::TransportOperation.new response
134
+ result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
135
+
136
+ yield result, operation if block_given?
137
+ result
138
+ end
139
+
140
+ ##
141
+ # Baseline implementation for the update_engine REST call
142
+ #
143
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::UpdateEngineRequest]
144
+ # A request object representing the call parameters. Required.
145
+ # @param options [::Gapic::CallOptions]
146
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
147
+ #
148
+ # @yield [result, operation] Access the result along with the TransportOperation object
149
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::Engine]
150
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
151
+ #
152
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine]
153
+ # A result object deserialized from the server's reply
154
+ def update_engine request_pb, options = nil
155
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
156
+
157
+ verb, uri, query_string_params, body = ServiceStub.transcode_update_engine_request request_pb
158
+ query_string_params = if query_string_params.any?
159
+ query_string_params.to_h { |p| p.split "=", 2 }
160
+ else
161
+ {}
162
+ end
163
+
164
+ response = @client_stub.make_http_request(
165
+ verb,
166
+ uri: uri,
167
+ body: body || "",
168
+ params: query_string_params,
169
+ options: options
170
+ )
171
+ operation = ::Gapic::Rest::TransportOperation.new response
172
+ result = ::Google::Cloud::DiscoveryEngine::V1::Engine.decode_json response.body, ignore_unknown_fields: true
173
+
174
+ yield result, operation if block_given?
175
+ result
176
+ end
177
+
178
+ ##
179
+ # Baseline implementation for the get_engine REST call
180
+ #
181
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::GetEngineRequest]
182
+ # A request object representing the call parameters. Required.
183
+ # @param options [::Gapic::CallOptions]
184
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
185
+ #
186
+ # @yield [result, operation] Access the result along with the TransportOperation object
187
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::Engine]
188
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
189
+ #
190
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine]
191
+ # A result object deserialized from the server's reply
192
+ def get_engine request_pb, options = nil
193
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
194
+
195
+ verb, uri, query_string_params, body = ServiceStub.transcode_get_engine_request request_pb
196
+ query_string_params = if query_string_params.any?
197
+ query_string_params.to_h { |p| p.split "=", 2 }
198
+ else
199
+ {}
200
+ end
201
+
202
+ response = @client_stub.make_http_request(
203
+ verb,
204
+ uri: uri,
205
+ body: body || "",
206
+ params: query_string_params,
207
+ options: options
208
+ )
209
+ operation = ::Gapic::Rest::TransportOperation.new response
210
+ result = ::Google::Cloud::DiscoveryEngine::V1::Engine.decode_json response.body, ignore_unknown_fields: true
211
+
212
+ yield result, operation if block_given?
213
+ result
214
+ end
215
+
216
+ ##
217
+ # Baseline implementation for the list_engines REST call
218
+ #
219
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::ListEnginesRequest]
220
+ # A request object representing the call parameters. Required.
221
+ # @param options [::Gapic::CallOptions]
222
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
223
+ #
224
+ # @yield [result, operation] Access the result along with the TransportOperation object
225
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::ListEnginesResponse]
226
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
227
+ #
228
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ListEnginesResponse]
229
+ # A result object deserialized from the server's reply
230
+ def list_engines request_pb, options = nil
231
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
232
+
233
+ verb, uri, query_string_params, body = ServiceStub.transcode_list_engines_request request_pb
234
+ query_string_params = if query_string_params.any?
235
+ query_string_params.to_h { |p| p.split "=", 2 }
236
+ else
237
+ {}
238
+ end
239
+
240
+ response = @client_stub.make_http_request(
241
+ verb,
242
+ uri: uri,
243
+ body: body || "",
244
+ params: query_string_params,
245
+ options: options
246
+ )
247
+ operation = ::Gapic::Rest::TransportOperation.new response
248
+ result = ::Google::Cloud::DiscoveryEngine::V1::ListEnginesResponse.decode_json response.body, ignore_unknown_fields: true
249
+
250
+ yield result, operation if block_given?
251
+ result
252
+ end
253
+
254
+ ##
255
+ # @private
256
+ #
257
+ # GRPC transcoding helper method for the create_engine REST call
258
+ #
259
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::CreateEngineRequest]
260
+ # A request object representing the call parameters. Required.
261
+ # @return [Array(String, [String, nil], Hash{String => String})]
262
+ # Uri, Body, Query string parameters
263
+ def self.transcode_create_engine_request request_pb
264
+ transcoder = Gapic::Rest::GrpcTranscoder.new
265
+ .with_bindings(
266
+ uri_method: :post,
267
+ uri_template: "/v1/{parent}/engines",
268
+ body: "engine",
269
+ matches: [
270
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/?$}, false]
271
+ ]
272
+ )
273
+ transcoder.transcode request_pb
274
+ end
275
+
276
+ ##
277
+ # @private
278
+ #
279
+ # GRPC transcoding helper method for the delete_engine REST call
280
+ #
281
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::DeleteEngineRequest]
282
+ # A request object representing the call parameters. Required.
283
+ # @return [Array(String, [String, nil], Hash{String => String})]
284
+ # Uri, Body, Query string parameters
285
+ def self.transcode_delete_engine_request request_pb
286
+ transcoder = Gapic::Rest::GrpcTranscoder.new
287
+ .with_bindings(
288
+ uri_method: :delete,
289
+ uri_template: "/v1/{name}",
290
+ matches: [
291
+ ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/?$}, false]
292
+ ]
293
+ )
294
+ transcoder.transcode request_pb
295
+ end
296
+
297
+ ##
298
+ # @private
299
+ #
300
+ # GRPC transcoding helper method for the update_engine REST call
301
+ #
302
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::UpdateEngineRequest]
303
+ # A request object representing the call parameters. Required.
304
+ # @return [Array(String, [String, nil], Hash{String => String})]
305
+ # Uri, Body, Query string parameters
306
+ def self.transcode_update_engine_request request_pb
307
+ transcoder = Gapic::Rest::GrpcTranscoder.new
308
+ .with_bindings(
309
+ uri_method: :patch,
310
+ uri_template: "/v1/{engine.name}",
311
+ body: "engine",
312
+ matches: [
313
+ ["engine.name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/?$}, false]
314
+ ]
315
+ )
316
+ transcoder.transcode request_pb
317
+ end
318
+
319
+ ##
320
+ # @private
321
+ #
322
+ # GRPC transcoding helper method for the get_engine REST call
323
+ #
324
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::GetEngineRequest]
325
+ # A request object representing the call parameters. Required.
326
+ # @return [Array(String, [String, nil], Hash{String => String})]
327
+ # Uri, Body, Query string parameters
328
+ def self.transcode_get_engine_request request_pb
329
+ transcoder = Gapic::Rest::GrpcTranscoder.new
330
+ .with_bindings(
331
+ uri_method: :get,
332
+ uri_template: "/v1/{name}",
333
+ matches: [
334
+ ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/?$}, false]
335
+ ]
336
+ )
337
+ transcoder.transcode request_pb
338
+ end
339
+
340
+ ##
341
+ # @private
342
+ #
343
+ # GRPC transcoding helper method for the list_engines REST call
344
+ #
345
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::ListEnginesRequest]
346
+ # A request object representing the call parameters. Required.
347
+ # @return [Array(String, [String, nil], Hash{String => String})]
348
+ # Uri, Body, Query string parameters
349
+ def self.transcode_list_engines_request request_pb
350
+ transcoder = Gapic::Rest::GrpcTranscoder.new
351
+ .with_bindings(
352
+ uri_method: :get,
353
+ uri_template: "/v1/{parent}/engines",
354
+ matches: [
355
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/?$}, false]
356
+ ]
357
+ )
358
+ transcoder.transcode request_pb
359
+ end
360
+ end
361
+ end
362
+ end
363
+ end
364
+ end
365
+ end
366
+ end
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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
+ require "gapic/rest"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/discovery_engine/v1/version"
24
+
25
+ require "google/cloud/discovery_engine/v1/engine_service/credentials"
26
+ require "google/cloud/discovery_engine/v1/engine_service/paths"
27
+ require "google/cloud/discovery_engine/v1/engine_service/rest/operations"
28
+ require "google/cloud/discovery_engine/v1/engine_service/rest/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module DiscoveryEngine
33
+ module V1
34
+ ##
35
+ # Service for managing {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}
36
+ # configuration.
37
+ #
38
+ # To load this service and instantiate a REST client:
39
+ #
40
+ # require "google/cloud/discovery_engine/v1/engine_service/rest"
41
+ # client = ::Google::Cloud::DiscoveryEngine::V1::EngineService::Rest::Client.new
42
+ #
43
+ module EngineService
44
+ # Client for the REST transport
45
+ module Rest
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
52
+
53
+ helper_path = ::File.join __dir__, "rest", "helpers.rb"
54
+ require "google/cloud/discovery_engine/v1/engine_service/rest/helpers" if ::File.file? helper_path
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/discovery_engine/v1/version"
24
+
25
+ require "google/cloud/discovery_engine/v1/engine_service/credentials"
26
+ require "google/cloud/discovery_engine/v1/engine_service/paths"
27
+ require "google/cloud/discovery_engine/v1/engine_service/operations"
28
+ require "google/cloud/discovery_engine/v1/engine_service/client"
29
+ require "google/cloud/discovery_engine/v1/engine_service/rest"
30
+
31
+ module Google
32
+ module Cloud
33
+ module DiscoveryEngine
34
+ module V1
35
+ ##
36
+ # Service for managing {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}
37
+ # configuration.
38
+ #
39
+ # @example Load this service and instantiate a gRPC client
40
+ #
41
+ # require "google/cloud/discovery_engine/v1/engine_service"
42
+ # client = ::Google::Cloud::DiscoveryEngine::V1::EngineService::Client.new
43
+ #
44
+ # @example Load this service and instantiate a REST client
45
+ #
46
+ # require "google/cloud/discovery_engine/v1/engine_service/rest"
47
+ # client = ::Google::Cloud::DiscoveryEngine::V1::EngineService::Rest::Client.new
48
+ #
49
+ module EngineService
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
55
+
56
+ helper_path = ::File.join __dir__, "engine_service", "helpers.rb"
57
+ require "google/cloud/discovery_engine/v1/engine_service/helpers" if ::File.file? helper_path
@@ -19,8 +19,11 @@
19
19
  require "google/cloud/discovery_engine/v1/completion_service/rest"
20
20
  require "google/cloud/discovery_engine/v1/search_service/rest"
21
21
  require "google/cloud/discovery_engine/v1/conversational_search_service/rest"
22
+ require "google/cloud/discovery_engine/v1/data_store_service/rest"
22
23
  require "google/cloud/discovery_engine/v1/document_service/rest"
24
+ require "google/cloud/discovery_engine/v1/engine_service/rest"
23
25
  require "google/cloud/discovery_engine/v1/schema_service/rest"
26
+ require "google/cloud/discovery_engine/v1/site_search_engine_service/rest"
24
27
  require "google/cloud/discovery_engine/v1/user_event_service/rest"
25
28
  require "google/cloud/discovery_engine/v1/version"
26
29
 
@@ -820,6 +820,13 @@ module Google
820
820
  ["name", %r{^projects/[^/]+/?$}, false]
821
821
  ]
822
822
  )
823
+ .with_bindings(
824
+ uri_method: :get,
825
+ uri_template: "/v1/{name}/operations",
826
+ matches: [
827
+ ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/?$}, false]
828
+ ]
829
+ )
823
830
  .with_bindings(
824
831
  uri_method: :get,
825
832
  uri_template: "/v1/{name}/operations",
@@ -932,6 +939,13 @@ module Google
932
939
  ["name", %r{^projects/[^/]+/operations/[^/]+/?$}, false]
933
940
  ]
934
941
  )
942
+ .with_bindings(
943
+ uri_method: :get,
944
+ uri_template: "/v1/{name}",
945
+ matches: [
946
+ ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/operations/[^/]+/?$}, false]
947
+ ]
948
+ )
935
949
  .with_bindings(
936
950
  uri_method: :get,
937
951
  uri_template: "/v1/{name}",
@@ -193,13 +193,15 @@ module Google
193
193
  # @param options [::Gapic::CallOptions, ::Hash]
194
194
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
195
195
  #
196
- # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, order_by: nil, user_info: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil)
196
+ # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil)
197
197
  # Pass arguments to `search` via keyword arguments. Note that at
198
198
  # least one keyword argument is required. To specify no parameters, or to keep all
199
199
  # the default parameter values, pass an empty Hash as a request object (see above).
200
200
  #
201
201
  # @param serving_config [::String]
202
202
  # Required. The resource name of the Search serving config, such as
203
+ # `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
204
+ # or
203
205
  # `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
204
206
  # This field is used to identify the serving configuration name, set
205
207
  # of models used to make the search.
@@ -243,11 +245,35 @@ module Google
243
245
  # expression is case-sensitive.
244
246
  #
245
247
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
248
+ #
249
+ # Filtering in Vertex AI Search is done by mapping the LHS filter key to a
250
+ # key property defined in the Vertex AI Search backend -- this mapping is
251
+ # defined by the customer in their schema. For example a media customer might
252
+ # have a field 'name' in their schema. In this case the filter would look
253
+ # like this: filter --> name:'ANY("king kong")'
254
+ #
255
+ # For more information about filtering including syntax and filter
256
+ # operators, see
257
+ # [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
258
+ # @param canonical_filter [::String]
259
+ # The default filter that is applied when a user performs a search without
260
+ # checking any filters on the search page.
261
+ #
262
+ # The filter applied to every search request when quality improvement such as
263
+ # query expansion is needed. In the case a query does not have a sufficient
264
+ # amount of results this filter will be used to determine whether or not to
265
+ # enable the query expansion flow. The original filter will still be used for
266
+ # the query expanded search.
267
+ # This field is strongly recommended to achieve high search quality.
268
+ #
269
+ # For more information about filter syntax, see
270
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#filter SearchRequest.filter}.
246
271
  # @param order_by [::String]
247
272
  # The order in which documents are returned. Documents can be ordered by
248
273
  # a field in an {::Google::Cloud::DiscoveryEngine::V1::Document Document} object.
249
274
  # Leave it unset if ordered by relevance. `order_by` expression is
250
- # case-sensitive.
275
+ # case-sensitive. For more information on ordering, see
276
+ # [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
251
277
  #
252
278
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
253
279
  # @param user_info [::Google::Cloud::DiscoveryEngine::V1::UserInfo, ::Hash]
@@ -262,6 +288,8 @@ module Google
262
288
  # error is returned.
263
289
  # @param boost_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec, ::Hash]
264
290
  # Boost specification to boost certain documents.
291
+ # For more information on boosting, see
292
+ # [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
265
293
  # @param params [::Hash{::String => ::Google::Protobuf::Value, ::Hash}]
266
294
  # Additional search parameters.
267
295
  #
@@ -269,9 +297,17 @@ module Google
269
297
  #
270
298
  # * `user_country_code`: string. Default empty. If set to non-empty, results
271
299
  # are restricted or boosted based on the location provided.
300
+ # Example:
301
+ # user_country_code: "au"
302
+ #
303
+ # For available codes see [Country
304
+ # Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
305
+ #
272
306
  # * `search_type`: double. Default empty. Enables non-webpage searching
273
- # depending on the value. The only valid non-default value is 1,
274
- # which enables image searching.
307
+ # depending on the value. The only valid non-default value is 1,
308
+ # which enables image searching.
309
+ # Example:
310
+ # search_type: 1
275
311
  # @param query_expansion_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec, ::Hash]
276
312
  # The query expansion specification that specifies the conditions under which
277
313
  # query expansion occurs.
@@ -97,6 +97,17 @@ module Google
97
97
  # @param data_store [String]
98
98
  # @param serving_config [String]
99
99
  #
100
+ # @overload serving_config_path(project:, location:, collection:, engine:, serving_config:)
101
+ # The resource will be in the following format:
102
+ #
103
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}`
104
+ #
105
+ # @param project [String]
106
+ # @param location [String]
107
+ # @param collection [String]
108
+ # @param engine [String]
109
+ # @param serving_config [String]
110
+ #
100
111
  # @return [::String]
101
112
  def serving_config_path **args
102
113
  resources = {
@@ -114,6 +125,14 @@ module Google
114
125
  raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
115
126
 
116
127
  "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/servingConfigs/#{serving_config}"
128
+ end),
129
+ "collection:engine:location:project:serving_config" => (proc do |project:, location:, collection:, engine:, serving_config:|
130
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
131
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
132
+ raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
133
+ raise ::ArgumentError, "engine cannot contain /" if engine.to_s.include? "/"
134
+
135
+ "projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/servingConfigs/#{serving_config}"
117
136
  end)
118
137
  }
119
138