google-cloud-discovery_engine 1.1.0 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +7 -1
- data/lib/google/cloud/discovery_engine/version.rb +1 -1
- data/lib/google/cloud/discovery_engine.rb +540 -0
- metadata +4 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 708a9e4b0a385f0cb736f43fcce4e8147303acee6ac4e9853c264edf506350f6
|
4
|
+
data.tar.gz: 91062c97f3c6dfba4cf98a1567a06cdd9283096298de18d468a2eaab83ad1db7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c474c5aab2ee7a9b9acd79583a82bb82e6816e46d0df63d9ef57d5360ee94ceb519e3dcc932f85cdf5ceb35df715992122747b10d1c62086aa9e0966461cdc0c
|
7
|
+
data.tar.gz: bcea5286cf771a7cf53697bd5223b5df65f1757039a5cfbcf0ccf9f5d655a3d88b31b03e5b1900ef654800365ce9b273cb6533036db4479452747151b2f22486
|
data/README.md
CHANGED
@@ -59,9 +59,15 @@ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
|
|
59
59
|
results in logs appearing alongside your application logs in the
|
60
60
|
[Google Cloud Logging](https://cloud.google.com/logging/) service.
|
61
61
|
|
62
|
+
Debug logging also requires that the versioned clients for this service be
|
63
|
+
sufficiently recent, released after about Dec 10, 2024. If logging is not
|
64
|
+
working, try updating the versioned clients in your bundle or installed gems:
|
65
|
+
[google-cloud-discovery_engine-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest),
|
66
|
+
[google-cloud-discovery_engine-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest).
|
67
|
+
|
62
68
|
## Supported Ruby Versions
|
63
69
|
|
64
|
-
This library is supported on Ruby
|
70
|
+
This library is supported on Ruby 3.0+.
|
65
71
|
|
66
72
|
Google provides official support for Ruby versions that are actively supported
|
67
73
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
@@ -58,6 +58,11 @@ module Google
|
|
58
58
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
59
59
|
# the `transport` parameter.
|
60
60
|
#
|
61
|
+
# Raises an exception if the currently installed versioned client gem for the
|
62
|
+
# given API version does not support the given transport of the CompletionService service.
|
63
|
+
# You can determine whether the method will succeed by calling
|
64
|
+
# {Google::Cloud::DiscoveryEngine.completion_service_available?}.
|
65
|
+
#
|
61
66
|
# ## About CompletionService
|
62
67
|
#
|
63
68
|
# Service for Auto-Completion.
|
@@ -79,6 +84,37 @@ module Google
|
|
79
84
|
service_module.const_get(:Client).new(&block)
|
80
85
|
end
|
81
86
|
|
87
|
+
##
|
88
|
+
# Determines whether the CompletionService service is supported by the current client.
|
89
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.completion_service}.
|
90
|
+
# If false, that method will raise an exception. This could happen if the given
|
91
|
+
# API version does not exist or does not support the CompletionService service,
|
92
|
+
# or if the versioned client gem needs an update to support the CompletionService service.
|
93
|
+
#
|
94
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
95
|
+
# Defaults to `:v1`.
|
96
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
97
|
+
# @return [boolean] Whether the service is available.
|
98
|
+
#
|
99
|
+
def self.completion_service_available? version: :v1, transport: :grpc
|
100
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
101
|
+
package_name = Google::Cloud::DiscoveryEngine
|
102
|
+
.constants
|
103
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
104
|
+
.first
|
105
|
+
return false unless package_name
|
106
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
107
|
+
return false unless service_module.const_defined? :CompletionService
|
108
|
+
service_module = service_module.const_get :CompletionService
|
109
|
+
if transport == :rest
|
110
|
+
return false unless service_module.const_defined? :Rest
|
111
|
+
service_module = service_module.const_get :Rest
|
112
|
+
end
|
113
|
+
service_module.const_defined? :Client
|
114
|
+
rescue ::LoadError
|
115
|
+
false
|
116
|
+
end
|
117
|
+
|
82
118
|
##
|
83
119
|
# Create a new client object for ControlService.
|
84
120
|
#
|
@@ -92,6 +128,11 @@ module Google
|
|
92
128
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
93
129
|
# the `transport` parameter.
|
94
130
|
#
|
131
|
+
# Raises an exception if the currently installed versioned client gem for the
|
132
|
+
# given API version does not support the given transport of the ControlService service.
|
133
|
+
# You can determine whether the method will succeed by calling
|
134
|
+
# {Google::Cloud::DiscoveryEngine.control_service_available?}.
|
135
|
+
#
|
95
136
|
# ## About ControlService
|
96
137
|
#
|
97
138
|
# Service for performing CRUD operations on Controls.
|
@@ -116,6 +157,37 @@ module Google
|
|
116
157
|
service_module.const_get(:Client).new(&block)
|
117
158
|
end
|
118
159
|
|
160
|
+
##
|
161
|
+
# Determines whether the ControlService service is supported by the current client.
|
162
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.control_service}.
|
163
|
+
# If false, that method will raise an exception. This could happen if the given
|
164
|
+
# API version does not exist or does not support the ControlService service,
|
165
|
+
# or if the versioned client gem needs an update to support the ControlService service.
|
166
|
+
#
|
167
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
168
|
+
# Defaults to `:v1`.
|
169
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
170
|
+
# @return [boolean] Whether the service is available.
|
171
|
+
#
|
172
|
+
def self.control_service_available? version: :v1, transport: :grpc
|
173
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
174
|
+
package_name = Google::Cloud::DiscoveryEngine
|
175
|
+
.constants
|
176
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
177
|
+
.first
|
178
|
+
return false unless package_name
|
179
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
180
|
+
return false unless service_module.const_defined? :ControlService
|
181
|
+
service_module = service_module.const_get :ControlService
|
182
|
+
if transport == :rest
|
183
|
+
return false unless service_module.const_defined? :Rest
|
184
|
+
service_module = service_module.const_get :Rest
|
185
|
+
end
|
186
|
+
service_module.const_defined? :Client
|
187
|
+
rescue ::LoadError
|
188
|
+
false
|
189
|
+
end
|
190
|
+
|
119
191
|
##
|
120
192
|
# Create a new client object for SearchService.
|
121
193
|
#
|
@@ -129,6 +201,11 @@ module Google
|
|
129
201
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
130
202
|
# the `transport` parameter.
|
131
203
|
#
|
204
|
+
# Raises an exception if the currently installed versioned client gem for the
|
205
|
+
# given API version does not support the given transport of the SearchService service.
|
206
|
+
# You can determine whether the method will succeed by calling
|
207
|
+
# {Google::Cloud::DiscoveryEngine.search_service_available?}.
|
208
|
+
#
|
132
209
|
# ## About SearchService
|
133
210
|
#
|
134
211
|
# Service for search.
|
@@ -150,6 +227,37 @@ module Google
|
|
150
227
|
service_module.const_get(:Client).new(&block)
|
151
228
|
end
|
152
229
|
|
230
|
+
##
|
231
|
+
# Determines whether the SearchService service is supported by the current client.
|
232
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.search_service}.
|
233
|
+
# If false, that method will raise an exception. This could happen if the given
|
234
|
+
# API version does not exist or does not support the SearchService service,
|
235
|
+
# or if the versioned client gem needs an update to support the SearchService service.
|
236
|
+
#
|
237
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
238
|
+
# Defaults to `:v1`.
|
239
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
240
|
+
# @return [boolean] Whether the service is available.
|
241
|
+
#
|
242
|
+
def self.search_service_available? version: :v1, transport: :grpc
|
243
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
244
|
+
package_name = Google::Cloud::DiscoveryEngine
|
245
|
+
.constants
|
246
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
247
|
+
.first
|
248
|
+
return false unless package_name
|
249
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
250
|
+
return false unless service_module.const_defined? :SearchService
|
251
|
+
service_module = service_module.const_get :SearchService
|
252
|
+
if transport == :rest
|
253
|
+
return false unless service_module.const_defined? :Rest
|
254
|
+
service_module = service_module.const_get :Rest
|
255
|
+
end
|
256
|
+
service_module.const_defined? :Client
|
257
|
+
rescue ::LoadError
|
258
|
+
false
|
259
|
+
end
|
260
|
+
|
153
261
|
##
|
154
262
|
# Create a new client object for ConversationalSearchService.
|
155
263
|
#
|
@@ -163,6 +271,11 @@ module Google
|
|
163
271
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
164
272
|
# the `transport` parameter.
|
165
273
|
#
|
274
|
+
# Raises an exception if the currently installed versioned client gem for the
|
275
|
+
# given API version does not support the given transport of the ConversationalSearchService service.
|
276
|
+
# You can determine whether the method will succeed by calling
|
277
|
+
# {Google::Cloud::DiscoveryEngine.conversational_search_service_available?}.
|
278
|
+
#
|
166
279
|
# ## About ConversationalSearchService
|
167
280
|
#
|
168
281
|
# Service for conversational search.
|
@@ -184,6 +297,37 @@ module Google
|
|
184
297
|
service_module.const_get(:Client).new(&block)
|
185
298
|
end
|
186
299
|
|
300
|
+
##
|
301
|
+
# Determines whether the ConversationalSearchService service is supported by the current client.
|
302
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.conversational_search_service}.
|
303
|
+
# If false, that method will raise an exception. This could happen if the given
|
304
|
+
# API version does not exist or does not support the ConversationalSearchService service,
|
305
|
+
# or if the versioned client gem needs an update to support the ConversationalSearchService service.
|
306
|
+
#
|
307
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
308
|
+
# Defaults to `:v1`.
|
309
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
310
|
+
# @return [boolean] Whether the service is available.
|
311
|
+
#
|
312
|
+
def self.conversational_search_service_available? version: :v1, transport: :grpc
|
313
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
314
|
+
package_name = Google::Cloud::DiscoveryEngine
|
315
|
+
.constants
|
316
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
317
|
+
.first
|
318
|
+
return false unless package_name
|
319
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
320
|
+
return false unless service_module.const_defined? :ConversationalSearchService
|
321
|
+
service_module = service_module.const_get :ConversationalSearchService
|
322
|
+
if transport == :rest
|
323
|
+
return false unless service_module.const_defined? :Rest
|
324
|
+
service_module = service_module.const_get :Rest
|
325
|
+
end
|
326
|
+
service_module.const_defined? :Client
|
327
|
+
rescue ::LoadError
|
328
|
+
false
|
329
|
+
end
|
330
|
+
|
187
331
|
##
|
188
332
|
# Create a new client object for DataStoreService.
|
189
333
|
#
|
@@ -197,6 +341,11 @@ module Google
|
|
197
341
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
198
342
|
# the `transport` parameter.
|
199
343
|
#
|
344
|
+
# Raises an exception if the currently installed versioned client gem for the
|
345
|
+
# given API version does not support the given transport of the DataStoreService service.
|
346
|
+
# You can determine whether the method will succeed by calling
|
347
|
+
# {Google::Cloud::DiscoveryEngine.data_store_service_available?}.
|
348
|
+
#
|
200
349
|
# ## About DataStoreService
|
201
350
|
#
|
202
351
|
# Service for managing DataStore
|
@@ -219,6 +368,37 @@ module Google
|
|
219
368
|
service_module.const_get(:Client).new(&block)
|
220
369
|
end
|
221
370
|
|
371
|
+
##
|
372
|
+
# Determines whether the DataStoreService service is supported by the current client.
|
373
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.data_store_service}.
|
374
|
+
# If false, that method will raise an exception. This could happen if the given
|
375
|
+
# API version does not exist or does not support the DataStoreService service,
|
376
|
+
# or if the versioned client gem needs an update to support the DataStoreService service.
|
377
|
+
#
|
378
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
379
|
+
# Defaults to `:v1`.
|
380
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
381
|
+
# @return [boolean] Whether the service is available.
|
382
|
+
#
|
383
|
+
def self.data_store_service_available? version: :v1, transport: :grpc
|
384
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
385
|
+
package_name = Google::Cloud::DiscoveryEngine
|
386
|
+
.constants
|
387
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
388
|
+
.first
|
389
|
+
return false unless package_name
|
390
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
391
|
+
return false unless service_module.const_defined? :DataStoreService
|
392
|
+
service_module = service_module.const_get :DataStoreService
|
393
|
+
if transport == :rest
|
394
|
+
return false unless service_module.const_defined? :Rest
|
395
|
+
service_module = service_module.const_get :Rest
|
396
|
+
end
|
397
|
+
service_module.const_defined? :Client
|
398
|
+
rescue ::LoadError
|
399
|
+
false
|
400
|
+
end
|
401
|
+
|
222
402
|
##
|
223
403
|
# Create a new client object for DocumentService.
|
224
404
|
#
|
@@ -232,6 +412,11 @@ module Google
|
|
232
412
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
233
413
|
# the `transport` parameter.
|
234
414
|
#
|
415
|
+
# Raises an exception if the currently installed versioned client gem for the
|
416
|
+
# given API version does not support the given transport of the DocumentService service.
|
417
|
+
# You can determine whether the method will succeed by calling
|
418
|
+
# {Google::Cloud::DiscoveryEngine.document_service_available?}.
|
419
|
+
#
|
235
420
|
# ## About DocumentService
|
236
421
|
#
|
237
422
|
# Service for ingesting Document
|
@@ -254,6 +439,37 @@ module Google
|
|
254
439
|
service_module.const_get(:Client).new(&block)
|
255
440
|
end
|
256
441
|
|
442
|
+
##
|
443
|
+
# Determines whether the DocumentService service is supported by the current client.
|
444
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.document_service}.
|
445
|
+
# If false, that method will raise an exception. This could happen if the given
|
446
|
+
# API version does not exist or does not support the DocumentService service,
|
447
|
+
# or if the versioned client gem needs an update to support the DocumentService service.
|
448
|
+
#
|
449
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
450
|
+
# Defaults to `:v1`.
|
451
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
452
|
+
# @return [boolean] Whether the service is available.
|
453
|
+
#
|
454
|
+
def self.document_service_available? version: :v1, transport: :grpc
|
455
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
456
|
+
package_name = Google::Cloud::DiscoveryEngine
|
457
|
+
.constants
|
458
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
459
|
+
.first
|
460
|
+
return false unless package_name
|
461
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
462
|
+
return false unless service_module.const_defined? :DocumentService
|
463
|
+
service_module = service_module.const_get :DocumentService
|
464
|
+
if transport == :rest
|
465
|
+
return false unless service_module.const_defined? :Rest
|
466
|
+
service_module = service_module.const_get :Rest
|
467
|
+
end
|
468
|
+
service_module.const_defined? :Client
|
469
|
+
rescue ::LoadError
|
470
|
+
false
|
471
|
+
end
|
472
|
+
|
257
473
|
##
|
258
474
|
# Create a new client object for EngineService.
|
259
475
|
#
|
@@ -267,6 +483,11 @@ module Google
|
|
267
483
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
268
484
|
# the `transport` parameter.
|
269
485
|
#
|
486
|
+
# Raises an exception if the currently installed versioned client gem for the
|
487
|
+
# given API version does not support the given transport of the EngineService service.
|
488
|
+
# You can determine whether the method will succeed by calling
|
489
|
+
# {Google::Cloud::DiscoveryEngine.engine_service_available?}.
|
490
|
+
#
|
270
491
|
# ## About EngineService
|
271
492
|
#
|
272
493
|
# Service for managing Engine
|
@@ -289,6 +510,37 @@ module Google
|
|
289
510
|
service_module.const_get(:Client).new(&block)
|
290
511
|
end
|
291
512
|
|
513
|
+
##
|
514
|
+
# Determines whether the EngineService service is supported by the current client.
|
515
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.engine_service}.
|
516
|
+
# If false, that method will raise an exception. This could happen if the given
|
517
|
+
# API version does not exist or does not support the EngineService service,
|
518
|
+
# or if the versioned client gem needs an update to support the EngineService service.
|
519
|
+
#
|
520
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
521
|
+
# Defaults to `:v1`.
|
522
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
523
|
+
# @return [boolean] Whether the service is available.
|
524
|
+
#
|
525
|
+
def self.engine_service_available? version: :v1, transport: :grpc
|
526
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
527
|
+
package_name = Google::Cloud::DiscoveryEngine
|
528
|
+
.constants
|
529
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
530
|
+
.first
|
531
|
+
return false unless package_name
|
532
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
533
|
+
return false unless service_module.const_defined? :EngineService
|
534
|
+
service_module = service_module.const_get :EngineService
|
535
|
+
if transport == :rest
|
536
|
+
return false unless service_module.const_defined? :Rest
|
537
|
+
service_module = service_module.const_get :Rest
|
538
|
+
end
|
539
|
+
service_module.const_defined? :Client
|
540
|
+
rescue ::LoadError
|
541
|
+
false
|
542
|
+
end
|
543
|
+
|
292
544
|
##
|
293
545
|
# Create a new client object for GroundedGenerationService.
|
294
546
|
#
|
@@ -302,6 +554,11 @@ module Google
|
|
302
554
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
303
555
|
# the `transport` parameter.
|
304
556
|
#
|
557
|
+
# Raises an exception if the currently installed versioned client gem for the
|
558
|
+
# given API version does not support the given transport of the GroundedGenerationService service.
|
559
|
+
# You can determine whether the method will succeed by calling
|
560
|
+
# {Google::Cloud::DiscoveryEngine.grounded_generation_service_available?}.
|
561
|
+
#
|
305
562
|
# ## About GroundedGenerationService
|
306
563
|
#
|
307
564
|
# Service for grounded generation.
|
@@ -323,6 +580,37 @@ module Google
|
|
323
580
|
service_module.const_get(:Client).new(&block)
|
324
581
|
end
|
325
582
|
|
583
|
+
##
|
584
|
+
# Determines whether the GroundedGenerationService service is supported by the current client.
|
585
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.grounded_generation_service}.
|
586
|
+
# If false, that method will raise an exception. This could happen if the given
|
587
|
+
# API version does not exist or does not support the GroundedGenerationService service,
|
588
|
+
# or if the versioned client gem needs an update to support the GroundedGenerationService service.
|
589
|
+
#
|
590
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
591
|
+
# Defaults to `:v1`.
|
592
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
593
|
+
# @return [boolean] Whether the service is available.
|
594
|
+
#
|
595
|
+
def self.grounded_generation_service_available? version: :v1, transport: :grpc
|
596
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
597
|
+
package_name = Google::Cloud::DiscoveryEngine
|
598
|
+
.constants
|
599
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
600
|
+
.first
|
601
|
+
return false unless package_name
|
602
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
603
|
+
return false unless service_module.const_defined? :GroundedGenerationService
|
604
|
+
service_module = service_module.const_get :GroundedGenerationService
|
605
|
+
if transport == :rest
|
606
|
+
return false unless service_module.const_defined? :Rest
|
607
|
+
service_module = service_module.const_get :Rest
|
608
|
+
end
|
609
|
+
service_module.const_defined? :Client
|
610
|
+
rescue ::LoadError
|
611
|
+
false
|
612
|
+
end
|
613
|
+
|
326
614
|
##
|
327
615
|
# Create a new client object for ProjectService.
|
328
616
|
#
|
@@ -336,6 +624,11 @@ module Google
|
|
336
624
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
337
625
|
# the `transport` parameter.
|
338
626
|
#
|
627
|
+
# Raises an exception if the currently installed versioned client gem for the
|
628
|
+
# given API version does not support the given transport of the ProjectService service.
|
629
|
+
# You can determine whether the method will succeed by calling
|
630
|
+
# {Google::Cloud::DiscoveryEngine.project_service_available?}.
|
631
|
+
#
|
339
632
|
# ## About ProjectService
|
340
633
|
#
|
341
634
|
# Service for operations on the
|
@@ -358,6 +651,37 @@ module Google
|
|
358
651
|
service_module.const_get(:Client).new(&block)
|
359
652
|
end
|
360
653
|
|
654
|
+
##
|
655
|
+
# Determines whether the ProjectService service is supported by the current client.
|
656
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.project_service}.
|
657
|
+
# If false, that method will raise an exception. This could happen if the given
|
658
|
+
# API version does not exist or does not support the ProjectService service,
|
659
|
+
# or if the versioned client gem needs an update to support the ProjectService service.
|
660
|
+
#
|
661
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
662
|
+
# Defaults to `:v1`.
|
663
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
664
|
+
# @return [boolean] Whether the service is available.
|
665
|
+
#
|
666
|
+
def self.project_service_available? version: :v1, transport: :grpc
|
667
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
668
|
+
package_name = Google::Cloud::DiscoveryEngine
|
669
|
+
.constants
|
670
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
671
|
+
.first
|
672
|
+
return false unless package_name
|
673
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
674
|
+
return false unless service_module.const_defined? :ProjectService
|
675
|
+
service_module = service_module.const_get :ProjectService
|
676
|
+
if transport == :rest
|
677
|
+
return false unless service_module.const_defined? :Rest
|
678
|
+
service_module = service_module.const_get :Rest
|
679
|
+
end
|
680
|
+
service_module.const_defined? :Client
|
681
|
+
rescue ::LoadError
|
682
|
+
false
|
683
|
+
end
|
684
|
+
|
361
685
|
##
|
362
686
|
# Create a new client object for RankService.
|
363
687
|
#
|
@@ -371,6 +695,11 @@ module Google
|
|
371
695
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
372
696
|
# the `transport` parameter.
|
373
697
|
#
|
698
|
+
# Raises an exception if the currently installed versioned client gem for the
|
699
|
+
# given API version does not support the given transport of the RankService service.
|
700
|
+
# You can determine whether the method will succeed by calling
|
701
|
+
# {Google::Cloud::DiscoveryEngine.rank_service_available?}.
|
702
|
+
#
|
374
703
|
# ## About RankService
|
375
704
|
#
|
376
705
|
# Service for ranking text records.
|
@@ -392,6 +721,37 @@ module Google
|
|
392
721
|
service_module.const_get(:Client).new(&block)
|
393
722
|
end
|
394
723
|
|
724
|
+
##
|
725
|
+
# Determines whether the RankService service is supported by the current client.
|
726
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.rank_service}.
|
727
|
+
# If false, that method will raise an exception. This could happen if the given
|
728
|
+
# API version does not exist or does not support the RankService service,
|
729
|
+
# or if the versioned client gem needs an update to support the RankService service.
|
730
|
+
#
|
731
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
732
|
+
# Defaults to `:v1`.
|
733
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
734
|
+
# @return [boolean] Whether the service is available.
|
735
|
+
#
|
736
|
+
def self.rank_service_available? version: :v1, transport: :grpc
|
737
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
738
|
+
package_name = Google::Cloud::DiscoveryEngine
|
739
|
+
.constants
|
740
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
741
|
+
.first
|
742
|
+
return false unless package_name
|
743
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
744
|
+
return false unless service_module.const_defined? :RankService
|
745
|
+
service_module = service_module.const_get :RankService
|
746
|
+
if transport == :rest
|
747
|
+
return false unless service_module.const_defined? :Rest
|
748
|
+
service_module = service_module.const_get :Rest
|
749
|
+
end
|
750
|
+
service_module.const_defined? :Client
|
751
|
+
rescue ::LoadError
|
752
|
+
false
|
753
|
+
end
|
754
|
+
|
395
755
|
##
|
396
756
|
# Create a new client object for RecommendationService.
|
397
757
|
#
|
@@ -405,6 +765,11 @@ module Google
|
|
405
765
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
406
766
|
# the `transport` parameter.
|
407
767
|
#
|
768
|
+
# Raises an exception if the currently installed versioned client gem for the
|
769
|
+
# given API version does not support the given transport of the RecommendationService service.
|
770
|
+
# You can determine whether the method will succeed by calling
|
771
|
+
# {Google::Cloud::DiscoveryEngine.recommendation_service_available?}.
|
772
|
+
#
|
408
773
|
# ## About RecommendationService
|
409
774
|
#
|
410
775
|
# Service for making recommendations.
|
@@ -426,6 +791,37 @@ module Google
|
|
426
791
|
service_module.const_get(:Client).new(&block)
|
427
792
|
end
|
428
793
|
|
794
|
+
##
|
795
|
+
# Determines whether the RecommendationService service is supported by the current client.
|
796
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.recommendation_service}.
|
797
|
+
# If false, that method will raise an exception. This could happen if the given
|
798
|
+
# API version does not exist or does not support the RecommendationService service,
|
799
|
+
# or if the versioned client gem needs an update to support the RecommendationService service.
|
800
|
+
#
|
801
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
802
|
+
# Defaults to `:v1`.
|
803
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
804
|
+
# @return [boolean] Whether the service is available.
|
805
|
+
#
|
806
|
+
def self.recommendation_service_available? version: :v1, transport: :grpc
|
807
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
808
|
+
package_name = Google::Cloud::DiscoveryEngine
|
809
|
+
.constants
|
810
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
811
|
+
.first
|
812
|
+
return false unless package_name
|
813
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
814
|
+
return false unless service_module.const_defined? :RecommendationService
|
815
|
+
service_module = service_module.const_get :RecommendationService
|
816
|
+
if transport == :rest
|
817
|
+
return false unless service_module.const_defined? :Rest
|
818
|
+
service_module = service_module.const_get :Rest
|
819
|
+
end
|
820
|
+
service_module.const_defined? :Client
|
821
|
+
rescue ::LoadError
|
822
|
+
false
|
823
|
+
end
|
824
|
+
|
429
825
|
##
|
430
826
|
# Create a new client object for SchemaService.
|
431
827
|
#
|
@@ -439,6 +835,11 @@ module Google
|
|
439
835
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
440
836
|
# the `transport` parameter.
|
441
837
|
#
|
838
|
+
# Raises an exception if the currently installed versioned client gem for the
|
839
|
+
# given API version does not support the given transport of the SchemaService service.
|
840
|
+
# You can determine whether the method will succeed by calling
|
841
|
+
# {Google::Cloud::DiscoveryEngine.schema_service_available?}.
|
842
|
+
#
|
442
843
|
# ## About SchemaService
|
443
844
|
#
|
444
845
|
# Service for managing Schemas.
|
@@ -460,6 +861,37 @@ module Google
|
|
460
861
|
service_module.const_get(:Client).new(&block)
|
461
862
|
end
|
462
863
|
|
864
|
+
##
|
865
|
+
# Determines whether the SchemaService service is supported by the current client.
|
866
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.schema_service}.
|
867
|
+
# If false, that method will raise an exception. This could happen if the given
|
868
|
+
# API version does not exist or does not support the SchemaService service,
|
869
|
+
# or if the versioned client gem needs an update to support the SchemaService service.
|
870
|
+
#
|
871
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
872
|
+
# Defaults to `:v1`.
|
873
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
874
|
+
# @return [boolean] Whether the service is available.
|
875
|
+
#
|
876
|
+
def self.schema_service_available? version: :v1, transport: :grpc
|
877
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
878
|
+
package_name = Google::Cloud::DiscoveryEngine
|
879
|
+
.constants
|
880
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
881
|
+
.first
|
882
|
+
return false unless package_name
|
883
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
884
|
+
return false unless service_module.const_defined? :SchemaService
|
885
|
+
service_module = service_module.const_get :SchemaService
|
886
|
+
if transport == :rest
|
887
|
+
return false unless service_module.const_defined? :Rest
|
888
|
+
service_module = service_module.const_get :Rest
|
889
|
+
end
|
890
|
+
service_module.const_defined? :Client
|
891
|
+
rescue ::LoadError
|
892
|
+
false
|
893
|
+
end
|
894
|
+
|
463
895
|
##
|
464
896
|
# Create a new client object for SearchTuningService.
|
465
897
|
#
|
@@ -473,6 +905,11 @@ module Google
|
|
473
905
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
474
906
|
# the `transport` parameter.
|
475
907
|
#
|
908
|
+
# Raises an exception if the currently installed versioned client gem for the
|
909
|
+
# given API version does not support the given transport of the SearchTuningService service.
|
910
|
+
# You can determine whether the method will succeed by calling
|
911
|
+
# {Google::Cloud::DiscoveryEngine.search_tuning_service_available?}.
|
912
|
+
#
|
476
913
|
# ## About SearchTuningService
|
477
914
|
#
|
478
915
|
# Service for search tuning.
|
@@ -494,6 +931,37 @@ module Google
|
|
494
931
|
service_module.const_get(:Client).new(&block)
|
495
932
|
end
|
496
933
|
|
934
|
+
##
|
935
|
+
# Determines whether the SearchTuningService service is supported by the current client.
|
936
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.search_tuning_service}.
|
937
|
+
# If false, that method will raise an exception. This could happen if the given
|
938
|
+
# API version does not exist or does not support the SearchTuningService service,
|
939
|
+
# or if the versioned client gem needs an update to support the SearchTuningService service.
|
940
|
+
#
|
941
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
942
|
+
# Defaults to `:v1`.
|
943
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
944
|
+
# @return [boolean] Whether the service is available.
|
945
|
+
#
|
946
|
+
def self.search_tuning_service_available? version: :v1, transport: :grpc
|
947
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
948
|
+
package_name = Google::Cloud::DiscoveryEngine
|
949
|
+
.constants
|
950
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
951
|
+
.first
|
952
|
+
return false unless package_name
|
953
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
954
|
+
return false unless service_module.const_defined? :SearchTuningService
|
955
|
+
service_module = service_module.const_get :SearchTuningService
|
956
|
+
if transport == :rest
|
957
|
+
return false unless service_module.const_defined? :Rest
|
958
|
+
service_module = service_module.const_get :Rest
|
959
|
+
end
|
960
|
+
service_module.const_defined? :Client
|
961
|
+
rescue ::LoadError
|
962
|
+
false
|
963
|
+
end
|
964
|
+
|
497
965
|
##
|
498
966
|
# Create a new client object for SiteSearchEngineService.
|
499
967
|
#
|
@@ -507,6 +975,11 @@ module Google
|
|
507
975
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
508
976
|
# the `transport` parameter.
|
509
977
|
#
|
978
|
+
# Raises an exception if the currently installed versioned client gem for the
|
979
|
+
# given API version does not support the given transport of the SiteSearchEngineService service.
|
980
|
+
# You can determine whether the method will succeed by calling
|
981
|
+
# {Google::Cloud::DiscoveryEngine.site_search_engine_service_available?}.
|
982
|
+
#
|
510
983
|
# ## About SiteSearchEngineService
|
511
984
|
#
|
512
985
|
# Service for managing site search related resources.
|
@@ -528,6 +1001,37 @@ module Google
|
|
528
1001
|
service_module.const_get(:Client).new(&block)
|
529
1002
|
end
|
530
1003
|
|
1004
|
+
##
|
1005
|
+
# Determines whether the SiteSearchEngineService service is supported by the current client.
|
1006
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.site_search_engine_service}.
|
1007
|
+
# If false, that method will raise an exception. This could happen if the given
|
1008
|
+
# API version does not exist or does not support the SiteSearchEngineService service,
|
1009
|
+
# or if the versioned client gem needs an update to support the SiteSearchEngineService service.
|
1010
|
+
#
|
1011
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
1012
|
+
# Defaults to `:v1`.
|
1013
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
1014
|
+
# @return [boolean] Whether the service is available.
|
1015
|
+
#
|
1016
|
+
def self.site_search_engine_service_available? version: :v1, transport: :grpc
|
1017
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
1018
|
+
package_name = Google::Cloud::DiscoveryEngine
|
1019
|
+
.constants
|
1020
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
1021
|
+
.first
|
1022
|
+
return false unless package_name
|
1023
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
1024
|
+
return false unless service_module.const_defined? :SiteSearchEngineService
|
1025
|
+
service_module = service_module.const_get :SiteSearchEngineService
|
1026
|
+
if transport == :rest
|
1027
|
+
return false unless service_module.const_defined? :Rest
|
1028
|
+
service_module = service_module.const_get :Rest
|
1029
|
+
end
|
1030
|
+
service_module.const_defined? :Client
|
1031
|
+
rescue ::LoadError
|
1032
|
+
false
|
1033
|
+
end
|
1034
|
+
|
531
1035
|
##
|
532
1036
|
# Create a new client object for UserEventService.
|
533
1037
|
#
|
@@ -541,6 +1045,11 @@ module Google
|
|
541
1045
|
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
542
1046
|
# the `transport` parameter.
|
543
1047
|
#
|
1048
|
+
# Raises an exception if the currently installed versioned client gem for the
|
1049
|
+
# given API version does not support the given transport of the UserEventService service.
|
1050
|
+
# You can determine whether the method will succeed by calling
|
1051
|
+
# {Google::Cloud::DiscoveryEngine.user_event_service_available?}.
|
1052
|
+
#
|
544
1053
|
# ## About UserEventService
|
545
1054
|
#
|
546
1055
|
# Service for ingesting end user actions on a website to Discovery Engine API.
|
@@ -562,6 +1071,37 @@ module Google
|
|
562
1071
|
service_module.const_get(:Client).new(&block)
|
563
1072
|
end
|
564
1073
|
|
1074
|
+
##
|
1075
|
+
# Determines whether the UserEventService service is supported by the current client.
|
1076
|
+
# If true, you can retrieve a client object by calling {Google::Cloud::DiscoveryEngine.user_event_service}.
|
1077
|
+
# If false, that method will raise an exception. This could happen if the given
|
1078
|
+
# API version does not exist or does not support the UserEventService service,
|
1079
|
+
# or if the versioned client gem needs an update to support the UserEventService service.
|
1080
|
+
#
|
1081
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
1082
|
+
# Defaults to `:v1`.
|
1083
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
1084
|
+
# @return [boolean] Whether the service is available.
|
1085
|
+
#
|
1086
|
+
def self.user_event_service_available? version: :v1, transport: :grpc
|
1087
|
+
require "google/cloud/discovery_engine/#{version.to_s.downcase}"
|
1088
|
+
package_name = Google::Cloud::DiscoveryEngine
|
1089
|
+
.constants
|
1090
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
1091
|
+
.first
|
1092
|
+
return false unless package_name
|
1093
|
+
service_module = Google::Cloud::DiscoveryEngine.const_get package_name
|
1094
|
+
return false unless service_module.const_defined? :UserEventService
|
1095
|
+
service_module = service_module.const_get :UserEventService
|
1096
|
+
if transport == :rest
|
1097
|
+
return false unless service_module.const_defined? :Rest
|
1098
|
+
service_module = service_module.const_get :Rest
|
1099
|
+
end
|
1100
|
+
service_module.const_defined? :Client
|
1101
|
+
rescue ::LoadError
|
1102
|
+
false
|
1103
|
+
end
|
1104
|
+
|
565
1105
|
##
|
566
1106
|
# Configure the google-cloud-discovery_engine library.
|
567
1107
|
#
|
metadata
CHANGED
@@ -1,14 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-discovery_engine
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
|
-
autorequire:
|
9
8
|
bindir: bin
|
10
9
|
cert_chain: []
|
11
|
-
date:
|
10
|
+
date: 2025-01-29 00:00:00.000000000 Z
|
12
11
|
dependencies:
|
13
12
|
- !ruby/object:Gem::Dependency
|
14
13
|
name: google-cloud-core
|
@@ -75,7 +74,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
|
|
75
74
|
licenses:
|
76
75
|
- Apache-2.0
|
77
76
|
metadata: {}
|
78
|
-
post_install_message:
|
79
77
|
rdoc_options: []
|
80
78
|
require_paths:
|
81
79
|
- lib
|
@@ -83,15 +81,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
83
81
|
requirements:
|
84
82
|
- - ">="
|
85
83
|
- !ruby/object:Gem::Version
|
86
|
-
version: '
|
84
|
+
version: '3.0'
|
87
85
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
88
86
|
requirements:
|
89
87
|
- - ">="
|
90
88
|
- !ruby/object:Gem::Version
|
91
89
|
version: '0'
|
92
90
|
requirements: []
|
93
|
-
rubygems_version: 3.
|
94
|
-
signing_key:
|
91
|
+
rubygems_version: 3.6.2
|
95
92
|
specification_version: 4
|
96
93
|
summary: Discovery Engine API.
|
97
94
|
test_files: []
|