google-cloud-discovery_engine-v1beta 0.7.1 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +235 -4
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +801 -0
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +221 -4
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +1077 -0
  6. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +136 -0
  7. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest.rb +1 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/completion_service.rb +1 -0
  9. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +20 -3
  10. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +91 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +20 -3
  12. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +45 -0
  13. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +925 -0
  14. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/credentials.rb +47 -0
  15. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +801 -0
  16. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/paths.rb +97 -0
  17. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +864 -0
  18. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +1077 -0
  19. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/service_stub.rb +403 -0
  20. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest.rb +54 -0
  21. data/lib/google/cloud/discovery_engine/v1beta/data_store_service.rb +57 -0
  22. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +14 -0
  23. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +887 -0
  24. data/lib/google/cloud/discovery_engine/v1beta/engine_service/credentials.rb +47 -0
  25. data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +801 -0
  26. data/lib/google/cloud/discovery_engine/v1beta/engine_service/paths.rb +73 -0
  27. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +826 -0
  28. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +1077 -0
  29. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +366 -0
  30. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest.rb +54 -0
  31. data/lib/google/cloud/discovery_engine/v1beta/engine_service.rb +57 -0
  32. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +22 -3
  33. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/paths.rb +19 -0
  34. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +22 -3
  35. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/service_stub.rb +8 -0
  36. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +4 -0
  37. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +14 -0
  38. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +48 -10
  39. data/lib/google/cloud/discovery_engine/v1beta/search_service/paths.rb +19 -0
  40. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +48 -10
  41. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +8 -0
  42. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +646 -0
  43. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/credentials.rb +47 -0
  44. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/paths.rb +146 -0
  45. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +599 -0
  46. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/service_stub.rb +291 -0
  47. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest.rb +52 -0
  48. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service.rb +55 -0
  49. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +1635 -0
  50. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/credentials.rb +47 -0
  51. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +801 -0
  52. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/paths.rb +127 -0
  53. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +1525 -0
  54. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +1077 -0
  55. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +860 -0
  56. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest.rb +53 -0
  57. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service.rb +56 -0
  58. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +14 -0
  59. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  60. data/lib/google/cloud/discovery_engine/v1beta.rb +4 -0
  61. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +7 -2
  62. data/lib/google/cloud/discoveryengine/v1beta/completion_pb.rb +45 -0
  63. data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +5 -2
  64. data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +8 -0
  65. data/lib/google/cloud/discoveryengine/v1beta/conversation_pb.rb +2 -2
  66. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +2 -2
  67. data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +49 -0
  68. data/lib/google/cloud/discoveryengine/v1beta/data_store_service_pb.rb +62 -0
  69. data/lib/google/cloud/discoveryengine/v1beta/data_store_service_services_pb.rb +61 -0
  70. data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +1 -1
  71. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +2 -2
  72. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +53 -0
  73. data/lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb +62 -0
  74. data/lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb +55 -0
  75. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +8 -2
  76. data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +7 -2
  77. data/lib/google/cloud/discoveryengine/v1beta/recommendation_service_pb.rb +2 -2
  78. data/lib/google/cloud/discoveryengine/v1beta/schema_pb.rb +1 -1
  79. data/lib/google/cloud/discoveryengine/v1beta/schema_service_pb.rb +2 -2
  80. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +9 -2
  81. data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +53 -0
  82. data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_pb.rb +54 -0
  83. data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_services_pb.rb +53 -0
  84. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +54 -0
  85. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +82 -0
  86. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb +74 -0
  87. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  88. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +2 -2
  89. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +60 -0
  90. data/proto_docs/google/cloud/discoveryengine/v1beta/completion.rb +53 -0
  91. data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +10 -4
  92. data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +2 -0
  93. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +19 -1
  94. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +88 -0
  95. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +216 -0
  96. data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +1 -1
  97. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +219 -0
  98. data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +179 -0
  99. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +66 -0
  100. data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +41 -0
  101. data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +22 -3
  102. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +166 -15
  103. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +247 -0
  104. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +85 -0
  105. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +160 -0
  106. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +528 -0
  107. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +4 -3
  108. data/proto_docs/google/protobuf/any.rb +2 -1
  109. metadata +60 -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/v1beta/engine_service_pb"
20
+
21
+ module Google
22
+ module Cloud
23
+ module DiscoveryEngine
24
+ module V1beta
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::V1beta::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::V1beta::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::V1beta::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::V1beta::Engine]
150
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
151
+ #
152
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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::V1beta::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::V1beta::Engine]
188
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
189
+ #
190
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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::V1beta::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::V1beta::ListEnginesResponse]
226
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
227
+ #
228
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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::V1beta::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: "/v1beta/{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::V1beta::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: "/v1beta/{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::V1beta::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: "/v1beta/{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::V1beta::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: "/v1beta/{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::V1beta::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: "/v1beta/{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/v1beta/version"
24
+
25
+ require "google/cloud/discovery_engine/v1beta/engine_service/credentials"
26
+ require "google/cloud/discovery_engine/v1beta/engine_service/paths"
27
+ require "google/cloud/discovery_engine/v1beta/engine_service/rest/operations"
28
+ require "google/cloud/discovery_engine/v1beta/engine_service/rest/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module DiscoveryEngine
33
+ module V1beta
34
+ ##
35
+ # Service for managing {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}
36
+ # configuration.
37
+ #
38
+ # To load this service and instantiate a REST client:
39
+ #
40
+ # require "google/cloud/discovery_engine/v1beta/engine_service/rest"
41
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::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/v1beta/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/v1beta/version"
24
+
25
+ require "google/cloud/discovery_engine/v1beta/engine_service/credentials"
26
+ require "google/cloud/discovery_engine/v1beta/engine_service/paths"
27
+ require "google/cloud/discovery_engine/v1beta/engine_service/operations"
28
+ require "google/cloud/discovery_engine/v1beta/engine_service/client"
29
+ require "google/cloud/discovery_engine/v1beta/engine_service/rest"
30
+
31
+ module Google
32
+ module Cloud
33
+ module DiscoveryEngine
34
+ module V1beta
35
+ ##
36
+ # Service for managing {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}
37
+ # configuration.
38
+ #
39
+ # @example Load this service and instantiate a gRPC client
40
+ #
41
+ # require "google/cloud/discovery_engine/v1beta/engine_service"
42
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new
43
+ #
44
+ # @example Load this service and instantiate a REST client
45
+ #
46
+ # require "google/cloud/discovery_engine/v1beta/engine_service/rest"
47
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::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/v1beta/engine_service/helpers" if ::File.file? helper_path
@@ -199,11 +199,19 @@ module Google
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
- # Required. Full resource name of the format:
202
+ # Required. Full resource name of a
203
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig}:
204
+ # `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
203
205
  # `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
204
206
  #
205
- # Before you can request recommendations from your model, you must create at
206
- # least one serving config for it.
207
+ # One default serving config is created along with your recommendation engine
208
+ # creation. The engine ID will be used as the ID of the default serving
209
+ # config. For example, for Engine
210
+ # `projects/*/locations/global/collections/*/engines/my-engine`, you can use
211
+ # `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
212
+ # for your
213
+ # {::Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Client#recommend RecommendationService.Recommend}
214
+ # requests.
207
215
  # @param user_event [::Google::Cloud::DiscoveryEngine::V1beta::UserEvent, ::Hash]
208
216
  # Required. Context about the user, what they are looking at and what action
209
217
  # they took to trigger the Recommend request. Note that this user event
@@ -237,6 +245,14 @@ module Google
237
245
  # * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
238
246
  # * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
239
247
  #
248
+ # If `attributeFilteringSyntax` is set to true under the `params` field, then
249
+ # attribute-based expressions are expected instead of the above described
250
+ # tag-based syntax. Examples:
251
+ #
252
+ # * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
253
+ # * (available: true) AND
254
+ # (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
255
+ #
240
256
  # If your filter blocks all results, the API will return generic
241
257
  # (unfiltered) popular Documents. If you only want results strictly matching
242
258
  # the filters, set `strictFiltering` to True in
@@ -276,6 +292,9 @@ module Google
276
292
  # * `auto-diversity`
277
293
  # This gives request-level control and adjusts recommendation results
278
294
  # based on Document category.
295
+ # * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
296
+ # the `filter` field is interpreted according to the new,
297
+ # attribute-based syntax.
279
298
  # @param user_labels [::Hash{::String => ::String}]
280
299
  # The user labels applied to a resource must meet the following requirements:
281
300
  #
@@ -101,6 +101,17 @@ module Google
101
101
  # @param data_store [String]
102
102
  # @param serving_config [String]
103
103
  #
104
+ # @overload serving_config_path(project:, location:, collection:, engine:, serving_config:)
105
+ # The resource will be in the following format:
106
+ #
107
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}`
108
+ #
109
+ # @param project [String]
110
+ # @param location [String]
111
+ # @param collection [String]
112
+ # @param engine [String]
113
+ # @param serving_config [String]
114
+ #
104
115
  # @return [::String]
105
116
  def serving_config_path **args
106
117
  resources = {
@@ -118,6 +129,14 @@ module Google
118
129
  raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
119
130
 
120
131
  "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/servingConfigs/#{serving_config}"
132
+ end),
133
+ "collection:engine:location:project:serving_config" => (proc do |project:, location:, collection:, engine:, serving_config:|
134
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
135
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
136
+ raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
137
+ raise ::ArgumentError, "engine cannot contain /" if engine.to_s.include? "/"
138
+
139
+ "projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/servingConfigs/#{serving_config}"
121
140
  end)
122
141
  }
123
142
 
@@ -192,11 +192,19 @@ module Google
192
192
  # the default parameter values, pass an empty Hash as a request object (see above).
193
193
  #
194
194
  # @param serving_config [::String]
195
- # Required. Full resource name of the format:
195
+ # Required. Full resource name of a
196
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig}:
197
+ # `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
196
198
  # `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
197
199
  #
198
- # Before you can request recommendations from your model, you must create at
199
- # least one serving config for it.
200
+ # One default serving config is created along with your recommendation engine
201
+ # creation. The engine ID will be used as the ID of the default serving
202
+ # config. For example, for Engine
203
+ # `projects/*/locations/global/collections/*/engines/my-engine`, you can use
204
+ # `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
205
+ # for your
206
+ # {::Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Rest::Client#recommend RecommendationService.Recommend}
207
+ # requests.
200
208
  # @param user_event [::Google::Cloud::DiscoveryEngine::V1beta::UserEvent, ::Hash]
201
209
  # Required. Context about the user, what they are looking at and what action
202
210
  # they took to trigger the Recommend request. Note that this user event
@@ -230,6 +238,14 @@ module Google
230
238
  # * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
231
239
  # * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
232
240
  #
241
+ # If `attributeFilteringSyntax` is set to true under the `params` field, then
242
+ # attribute-based expressions are expected instead of the above described
243
+ # tag-based syntax. Examples:
244
+ #
245
+ # * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
246
+ # * (available: true) AND
247
+ # (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
248
+ #
233
249
  # If your filter blocks all results, the API will return generic
234
250
  # (unfiltered) popular Documents. If you only want results strictly matching
235
251
  # the filters, set `strictFiltering` to True in
@@ -269,6 +285,9 @@ module Google
269
285
  # * `auto-diversity`
270
286
  # This gives request-level control and adjusts recommendation results
271
287
  # based on Document category.
288
+ # * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
289
+ # the `filter` field is interpreted according to the new,
290
+ # attribute-based syntax.
272
291
  # @param user_labels [::Hash{::String => ::String}]
273
292
  # The user labels applied to a resource must meet the following requirements:
274
293
  #
@@ -126,6 +126,14 @@ module Google
126
126
  ["serving_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+/?$}, false]
127
127
  ]
128
128
  )
129
+ .with_bindings(
130
+ uri_method: :post,
131
+ uri_template: "/v1beta/{serving_config}:recommend",
132
+ body: "*",
133
+ matches: [
134
+ ["serving_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+/?$}, false]
135
+ ]
136
+ )
129
137
  transcoder.transcode request_pb
130
138
  end
131
139
  end
@@ -19,9 +19,13 @@
19
19
  require "google/cloud/discovery_engine/v1beta/completion_service/rest"
20
20
  require "google/cloud/discovery_engine/v1beta/search_service/rest"
21
21
  require "google/cloud/discovery_engine/v1beta/conversational_search_service/rest"
22
+ require "google/cloud/discovery_engine/v1beta/data_store_service/rest"
22
23
  require "google/cloud/discovery_engine/v1beta/document_service/rest"
24
+ require "google/cloud/discovery_engine/v1beta/engine_service/rest"
23
25
  require "google/cloud/discovery_engine/v1beta/recommendation_service/rest"
24
26
  require "google/cloud/discovery_engine/v1beta/schema_service/rest"
27
+ require "google/cloud/discovery_engine/v1beta/serving_config_service/rest"
28
+ require "google/cloud/discovery_engine/v1beta/site_search_engine_service/rest"
25
29
  require "google/cloud/discovery_engine/v1beta/user_event_service/rest"
26
30
  require "google/cloud/discovery_engine/v1beta/version"
27
31