google-cloud-vector_search-v1 0.a → 0.1.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 (64) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +154 -8
  5. data/lib/google/cloud/vector_search/v1/bindings_override.rb +75 -0
  6. data/lib/google/cloud/vector_search/v1/data_object_search_service/client.rb +851 -0
  7. data/lib/google/cloud/vector_search/v1/data_object_search_service/credentials.rb +47 -0
  8. data/lib/google/cloud/vector_search/v1/data_object_search_service/paths.rb +73 -0
  9. data/lib/google/cloud/vector_search/v1/data_object_search_service/rest/client.rb +788 -0
  10. data/lib/google/cloud/vector_search/v1/data_object_search_service/rest/service_stub.rb +329 -0
  11. data/lib/google/cloud/vector_search/v1/data_object_search_service/rest.rb +53 -0
  12. data/lib/google/cloud/vector_search/v1/data_object_search_service.rb +55 -0
  13. data/lib/google/cloud/vector_search/v1/data_object_service/client.rb +1115 -0
  14. data/lib/google/cloud/vector_search/v1/data_object_service/credentials.rb +47 -0
  15. data/lib/google/cloud/vector_search/v1/data_object_service/paths.rb +73 -0
  16. data/lib/google/cloud/vector_search/v1/data_object_service/rest/client.rb +1031 -0
  17. data/lib/google/cloud/vector_search/v1/data_object_service/rest/service_stub.rb +513 -0
  18. data/lib/google/cloud/vector_search/v1/data_object_service/rest.rb +53 -0
  19. data/lib/google/cloud/vector_search/v1/data_object_service.rb +55 -0
  20. data/lib/google/cloud/vector_search/v1/rest.rb +40 -0
  21. data/lib/google/cloud/vector_search/v1/vector_search_service/client.rb +1831 -0
  22. data/lib/google/cloud/vector_search/v1/vector_search_service/credentials.rb +47 -0
  23. data/lib/google/cloud/vector_search/v1/vector_search_service/operations.rb +843 -0
  24. data/lib/google/cloud/vector_search/v1/vector_search_service/paths.rb +111 -0
  25. data/lib/google/cloud/vector_search/v1/vector_search_service/rest/client.rb +1712 -0
  26. data/lib/google/cloud/vector_search/v1/vector_search_service/rest/operations.rb +927 -0
  27. data/lib/google/cloud/vector_search/v1/vector_search_service/rest/service_stub.rb +819 -0
  28. data/lib/google/cloud/vector_search/v1/vector_search_service/rest.rb +58 -0
  29. data/lib/google/cloud/vector_search/v1/vector_search_service.rb +60 -0
  30. data/lib/google/cloud/vector_search/v1/version.rb +7 -2
  31. data/lib/google/cloud/vector_search/v1.rb +47 -0
  32. data/lib/google/cloud/vectorsearch/v1/common_pb.rb +21 -0
  33. data/lib/google/cloud/vectorsearch/v1/data_object_pb.rb +29 -0
  34. data/lib/google/cloud/vectorsearch/v1/data_object_search_service_pb.rb +50 -0
  35. data/lib/google/cloud/vectorsearch/v1/data_object_search_service_services_pb.rb +51 -0
  36. data/lib/google/cloud/vectorsearch/v1/data_object_service_pb.rb +37 -0
  37. data/lib/google/cloud/vectorsearch/v1/data_object_service_services_pb.rb +57 -0
  38. data/lib/google/cloud/vectorsearch/v1/embedding_config_pb.rb +24 -0
  39. data/lib/google/cloud/vectorsearch/v1/encryption_spec_pb.rb +24 -0
  40. data/lib/google/cloud/vectorsearch/v1/vectorsearch_service_pb.rb +69 -0
  41. data/lib/google/cloud/vectorsearch/v1/vectorsearch_service_services_pb.rb +71 -0
  42. data/lib/google-cloud-vector_search-v1.rb +21 -0
  43. data/proto_docs/README.md +4 -0
  44. data/proto_docs/google/api/client.rb +593 -0
  45. data/proto_docs/google/api/field_behavior.rb +85 -0
  46. data/proto_docs/google/api/field_info.rb +88 -0
  47. data/proto_docs/google/api/launch_stage.rb +71 -0
  48. data/proto_docs/google/api/resource.rb +227 -0
  49. data/proto_docs/google/cloud/vectorsearch/v1/common.rb +38 -0
  50. data/proto_docs/google/cloud/vectorsearch/v1/data_object.rb +104 -0
  51. data/proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb +397 -0
  52. data/proto_docs/google/cloud/vectorsearch/v1/data_object_service.rb +156 -0
  53. data/proto_docs/google/cloud/vectorsearch/v1/embedding_config.rb +76 -0
  54. data/proto_docs/google/cloud/vectorsearch/v1/encryption_spec.rb +40 -0
  55. data/proto_docs/google/cloud/vectorsearch/v1/vectorsearch_service.rb +723 -0
  56. data/proto_docs/google/longrunning/operations.rb +191 -0
  57. data/proto_docs/google/protobuf/any.rb +145 -0
  58. data/proto_docs/google/protobuf/duration.rb +98 -0
  59. data/proto_docs/google/protobuf/empty.rb +34 -0
  60. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  61. data/proto_docs/google/protobuf/struct.rb +108 -0
  62. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  63. data/proto_docs/google/rpc/status.rb +48 -0
  64. metadata +122 -9
@@ -0,0 +1,329 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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/vectorsearch/v1/data_object_search_service_pb"
20
+
21
+ module Google
22
+ module Cloud
23
+ module VectorSearch
24
+ module V1
25
+ module DataObjectSearchService
26
+ module Rest
27
+ ##
28
+ # REST service stub for the DataObjectSearchService service.
29
+ # Service stub contains baseline method implementations
30
+ # including transcoding, making the REST call, and deserialing the response.
31
+ #
32
+ class ServiceStub
33
+ # @private
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
35
+ # These require statements are intentionally placed here to initialize
36
+ # the REST modules only when it's required.
37
+ require "gapic/rest"
38
+
39
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
40
+ endpoint_template: endpoint_template,
41
+ universe_domain: universe_domain,
42
+ credentials: credentials,
43
+ numeric_enums: true,
44
+ service_name: self.class,
45
+ raise_faraday_errors: false,
46
+ logger: logger
47
+ end
48
+
49
+ ##
50
+ # The effective universe domain
51
+ #
52
+ # @return [String]
53
+ #
54
+ def universe_domain
55
+ @client_stub.universe_domain
56
+ end
57
+
58
+ ##
59
+ # The effective endpoint
60
+ #
61
+ # @return [String]
62
+ #
63
+ def endpoint
64
+ @client_stub.endpoint
65
+ end
66
+
67
+ ##
68
+ # The logger used for request/response debug logging.
69
+ #
70
+ # @return [Logger]
71
+ #
72
+ def logger stub: false
73
+ stub ? @client_stub.stub_logger : @client_stub.logger
74
+ end
75
+
76
+ ##
77
+ # Baseline implementation for the search_data_objects REST call
78
+ #
79
+ # @param request_pb [::Google::Cloud::VectorSearch::V1::SearchDataObjectsRequest]
80
+ # A request object representing the call parameters. Required.
81
+ # @param options [::Gapic::CallOptions]
82
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
83
+ #
84
+ # @yield [result, operation] Access the result along with the TransportOperation object
85
+ # @yieldparam result [::Google::Cloud::VectorSearch::V1::SearchDataObjectsResponse]
86
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
87
+ #
88
+ # @return [::Google::Cloud::VectorSearch::V1::SearchDataObjectsResponse]
89
+ # A result object deserialized from the server's reply
90
+ def search_data_objects request_pb, options = nil
91
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
92
+
93
+ verb, uri, query_string_params, body = ServiceStub.transcode_search_data_objects_request request_pb
94
+ query_string_params = if query_string_params.any?
95
+ query_string_params.to_h { |p| p.split "=", 2 }
96
+ else
97
+ {}
98
+ end
99
+
100
+ response = @client_stub.make_http_request(
101
+ verb,
102
+ uri: uri,
103
+ body: body || "",
104
+ params: query_string_params,
105
+ method_name: "search_data_objects",
106
+ options: options
107
+ )
108
+ operation = ::Gapic::Rest::TransportOperation.new response
109
+ result = ::Google::Cloud::VectorSearch::V1::SearchDataObjectsResponse.decode_json response.body, ignore_unknown_fields: true
110
+ catch :response do
111
+ yield result, operation if block_given?
112
+ result
113
+ end
114
+ end
115
+
116
+ ##
117
+ # Baseline implementation for the query_data_objects REST call
118
+ #
119
+ # @param request_pb [::Google::Cloud::VectorSearch::V1::QueryDataObjectsRequest]
120
+ # A request object representing the call parameters. Required.
121
+ # @param options [::Gapic::CallOptions]
122
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
123
+ #
124
+ # @yield [result, operation] Access the result along with the TransportOperation object
125
+ # @yieldparam result [::Google::Cloud::VectorSearch::V1::QueryDataObjectsResponse]
126
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
127
+ #
128
+ # @return [::Google::Cloud::VectorSearch::V1::QueryDataObjectsResponse]
129
+ # A result object deserialized from the server's reply
130
+ def query_data_objects request_pb, options = nil
131
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
132
+
133
+ verb, uri, query_string_params, body = ServiceStub.transcode_query_data_objects_request request_pb
134
+ query_string_params = if query_string_params.any?
135
+ query_string_params.to_h { |p| p.split "=", 2 }
136
+ else
137
+ {}
138
+ end
139
+
140
+ response = @client_stub.make_http_request(
141
+ verb,
142
+ uri: uri,
143
+ body: body || "",
144
+ params: query_string_params,
145
+ method_name: "query_data_objects",
146
+ options: options
147
+ )
148
+ operation = ::Gapic::Rest::TransportOperation.new response
149
+ result = ::Google::Cloud::VectorSearch::V1::QueryDataObjectsResponse.decode_json response.body, ignore_unknown_fields: true
150
+ catch :response do
151
+ yield result, operation if block_given?
152
+ result
153
+ end
154
+ end
155
+
156
+ ##
157
+ # Baseline implementation for the aggregate_data_objects REST call
158
+ #
159
+ # @param request_pb [::Google::Cloud::VectorSearch::V1::AggregateDataObjectsRequest]
160
+ # A request object representing the call parameters. Required.
161
+ # @param options [::Gapic::CallOptions]
162
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
163
+ #
164
+ # @yield [result, operation] Access the result along with the TransportOperation object
165
+ # @yieldparam result [::Google::Cloud::VectorSearch::V1::AggregateDataObjectsResponse]
166
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
167
+ #
168
+ # @return [::Google::Cloud::VectorSearch::V1::AggregateDataObjectsResponse]
169
+ # A result object deserialized from the server's reply
170
+ def aggregate_data_objects request_pb, options = nil
171
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
172
+
173
+ verb, uri, query_string_params, body = ServiceStub.transcode_aggregate_data_objects_request request_pb
174
+ query_string_params = if query_string_params.any?
175
+ query_string_params.to_h { |p| p.split "=", 2 }
176
+ else
177
+ {}
178
+ end
179
+
180
+ response = @client_stub.make_http_request(
181
+ verb,
182
+ uri: uri,
183
+ body: body || "",
184
+ params: query_string_params,
185
+ method_name: "aggregate_data_objects",
186
+ options: options
187
+ )
188
+ operation = ::Gapic::Rest::TransportOperation.new response
189
+ result = ::Google::Cloud::VectorSearch::V1::AggregateDataObjectsResponse.decode_json response.body, ignore_unknown_fields: true
190
+ catch :response do
191
+ yield result, operation if block_given?
192
+ result
193
+ end
194
+ end
195
+
196
+ ##
197
+ # Baseline implementation for the batch_search_data_objects REST call
198
+ #
199
+ # @param request_pb [::Google::Cloud::VectorSearch::V1::BatchSearchDataObjectsRequest]
200
+ # A request object representing the call parameters. Required.
201
+ # @param options [::Gapic::CallOptions]
202
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
203
+ #
204
+ # @yield [result, operation] Access the result along with the TransportOperation object
205
+ # @yieldparam result [::Google::Cloud::VectorSearch::V1::BatchSearchDataObjectsResponse]
206
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
207
+ #
208
+ # @return [::Google::Cloud::VectorSearch::V1::BatchSearchDataObjectsResponse]
209
+ # A result object deserialized from the server's reply
210
+ def batch_search_data_objects request_pb, options = nil
211
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
212
+
213
+ verb, uri, query_string_params, body = ServiceStub.transcode_batch_search_data_objects_request request_pb
214
+ query_string_params = if query_string_params.any?
215
+ query_string_params.to_h { |p| p.split "=", 2 }
216
+ else
217
+ {}
218
+ end
219
+
220
+ response = @client_stub.make_http_request(
221
+ verb,
222
+ uri: uri,
223
+ body: body || "",
224
+ params: query_string_params,
225
+ method_name: "batch_search_data_objects",
226
+ options: options
227
+ )
228
+ operation = ::Gapic::Rest::TransportOperation.new response
229
+ result = ::Google::Cloud::VectorSearch::V1::BatchSearchDataObjectsResponse.decode_json response.body, ignore_unknown_fields: true
230
+ catch :response do
231
+ yield result, operation if block_given?
232
+ result
233
+ end
234
+ end
235
+
236
+ ##
237
+ # @private
238
+ #
239
+ # GRPC transcoding helper method for the search_data_objects REST call
240
+ #
241
+ # @param request_pb [::Google::Cloud::VectorSearch::V1::SearchDataObjectsRequest]
242
+ # A request object representing the call parameters. Required.
243
+ # @return [Array(String, [String, nil], Hash{String => String})]
244
+ # Uri, Body, Query string parameters
245
+ def self.transcode_search_data_objects_request request_pb
246
+ transcoder = Gapic::Rest::GrpcTranscoder.new
247
+ .with_bindings(
248
+ uri_method: :post,
249
+ uri_template: "/v1/{parent}/dataObjects:search",
250
+ body: "*",
251
+ matches: [
252
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/?$}, false]
253
+ ]
254
+ )
255
+ transcoder.transcode request_pb
256
+ end
257
+
258
+ ##
259
+ # @private
260
+ #
261
+ # GRPC transcoding helper method for the query_data_objects REST call
262
+ #
263
+ # @param request_pb [::Google::Cloud::VectorSearch::V1::QueryDataObjectsRequest]
264
+ # A request object representing the call parameters. Required.
265
+ # @return [Array(String, [String, nil], Hash{String => String})]
266
+ # Uri, Body, Query string parameters
267
+ def self.transcode_query_data_objects_request request_pb
268
+ transcoder = Gapic::Rest::GrpcTranscoder.new
269
+ .with_bindings(
270
+ uri_method: :post,
271
+ uri_template: "/v1/{parent}/dataObjects:query",
272
+ body: "*",
273
+ matches: [
274
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/?$}, false]
275
+ ]
276
+ )
277
+ transcoder.transcode request_pb
278
+ end
279
+
280
+ ##
281
+ # @private
282
+ #
283
+ # GRPC transcoding helper method for the aggregate_data_objects REST call
284
+ #
285
+ # @param request_pb [::Google::Cloud::VectorSearch::V1::AggregateDataObjectsRequest]
286
+ # A request object representing the call parameters. Required.
287
+ # @return [Array(String, [String, nil], Hash{String => String})]
288
+ # Uri, Body, Query string parameters
289
+ def self.transcode_aggregate_data_objects_request request_pb
290
+ transcoder = Gapic::Rest::GrpcTranscoder.new
291
+ .with_bindings(
292
+ uri_method: :post,
293
+ uri_template: "/v1/{parent}/dataObjects:aggregate",
294
+ body: "*",
295
+ matches: [
296
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/?$}, false]
297
+ ]
298
+ )
299
+ transcoder.transcode request_pb
300
+ end
301
+
302
+ ##
303
+ # @private
304
+ #
305
+ # GRPC transcoding helper method for the batch_search_data_objects REST call
306
+ #
307
+ # @param request_pb [::Google::Cloud::VectorSearch::V1::BatchSearchDataObjectsRequest]
308
+ # A request object representing the call parameters. Required.
309
+ # @return [Array(String, [String, nil], Hash{String => String})]
310
+ # Uri, Body, Query string parameters
311
+ def self.transcode_batch_search_data_objects_request request_pb
312
+ transcoder = Gapic::Rest::GrpcTranscoder.new
313
+ .with_bindings(
314
+ uri_method: :post,
315
+ uri_template: "/v1/{parent}/dataObjects:batchSearch",
316
+ body: "*",
317
+ matches: [
318
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/?$}, false]
319
+ ]
320
+ )
321
+ transcoder.transcode request_pb
322
+ end
323
+ end
324
+ end
325
+ end
326
+ end
327
+ end
328
+ end
329
+ end
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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/vector_search/v1/version"
24
+ require "google/cloud/vector_search/v1/bindings_override"
25
+
26
+ require "google/cloud/vector_search/v1/data_object_search_service/credentials"
27
+ require "google/cloud/vector_search/v1/data_object_search_service/paths"
28
+ require "google/cloud/vector_search/v1/data_object_search_service/rest/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module VectorSearch
33
+ module V1
34
+ ##
35
+ # Service for searching data objects.
36
+ #
37
+ # To load this service and instantiate a REST client:
38
+ #
39
+ # require "google/cloud/vector_search/v1/data_object_search_service/rest"
40
+ # client = ::Google::Cloud::VectorSearch::V1::DataObjectSearchService::Rest::Client.new
41
+ #
42
+ module DataObjectSearchService
43
+ # Client for the REST transport
44
+ module Rest
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+
52
+ helper_path = ::File.join __dir__, "rest", "helpers.rb"
53
+ require "google/cloud/vector_search/v1/data_object_search_service/rest/helpers" if ::File.file? helper_path
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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/vector_search/v1/version"
24
+
25
+ require "google/cloud/vector_search/v1/data_object_search_service/credentials"
26
+ require "google/cloud/vector_search/v1/data_object_search_service/paths"
27
+ require "google/cloud/vector_search/v1/data_object_search_service/client"
28
+ require "google/cloud/vector_search/v1/data_object_search_service/rest"
29
+
30
+ module Google
31
+ module Cloud
32
+ module VectorSearch
33
+ module V1
34
+ ##
35
+ # Service for searching data objects.
36
+ #
37
+ # @example Load this service and instantiate a gRPC client
38
+ #
39
+ # require "google/cloud/vector_search/v1/data_object_search_service"
40
+ # client = ::Google::Cloud::VectorSearch::V1::DataObjectSearchService::Client.new
41
+ #
42
+ # @example Load this service and instantiate a REST client
43
+ #
44
+ # require "google/cloud/vector_search/v1/data_object_search_service/rest"
45
+ # client = ::Google::Cloud::VectorSearch::V1::DataObjectSearchService::Rest::Client.new
46
+ #
47
+ module DataObjectSearchService
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
53
+
54
+ helper_path = ::File.join __dir__, "data_object_search_service", "helpers.rb"
55
+ require "google/cloud/vector_search/v1/data_object_search_service/helpers" if ::File.file? helper_path