Module: Google::Cloud::AIPlatform

Defined in:
lib/google/cloud/ai_platform.rb,
lib/google/cloud/ai_platform/version.rb

Constant Summary collapse

VERSION =
"2.1.0"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.ai_platform| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-ai_platform library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config)

    The default configuration used by this library



2402
2403
2404
2405
2406
# File 'lib/google/cloud/ai_platform.rb', line 2402

def self.configure
  yield ::Google::Cloud.configure.ai_platform if block_given?

  ::Google::Cloud.configure.ai_platform
end

.data_foundry_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for DataFoundryService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::DataFoundryService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DataFoundryService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DataFoundryService service. You can determine whether the method will succeed by calling data_foundry_service_available?.

About DataFoundryService

Service for generating and preparing datasets for Gen AI evaluation.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



75
76
77
78
79
80
81
82
83
84
85
# File 'lib/google/cloud/ai_platform.rb', line 75

def self.data_foundry_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:DataFoundryService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.data_foundry_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the DataFoundryService service is supported by the current client. If true, you can retrieve a client object by calling data_foundry_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DataFoundryService service, or if the versioned client gem needs an update to support the DataFoundryService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/google/cloud/ai_platform.rb', line 99

def self.data_foundry_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :DataFoundryService
  service_module = service_module.const_get :DataFoundryService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.dataset_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for DatasetService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::DatasetService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DatasetService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DatasetService service. You can determine whether the method will succeed by calling dataset_service_available?.

About DatasetService

The service that manages Vertex AI Dataset and its child resources.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



145
146
147
148
149
150
151
152
153
154
155
# File 'lib/google/cloud/ai_platform.rb', line 145

def self.dataset_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:DatasetService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.dataset_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the DatasetService service is supported by the current client. If true, you can retrieve a client object by calling dataset_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DatasetService service, or if the versioned client gem needs an update to support the DatasetService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/google/cloud/ai_platform.rb', line 169

def self.dataset_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :DatasetService
  service_module = service_module.const_get :DatasetService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.deployment_resource_pool_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for DeploymentResourcePoolService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::DeploymentResourcePoolService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DeploymentResourcePoolService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DeploymentResourcePoolService service. You can determine whether the method will succeed by calling deployment_resource_pool_service_available?.

About DeploymentResourcePoolService

A service that manages the DeploymentResourcePool resource.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



215
216
217
218
219
220
221
222
223
224
225
# File 'lib/google/cloud/ai_platform.rb', line 215

def self.deployment_resource_pool_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:DeploymentResourcePoolService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.deployment_resource_pool_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the DeploymentResourcePoolService service is supported by the current client. If true, you can retrieve a client object by calling deployment_resource_pool_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DeploymentResourcePoolService service, or if the versioned client gem needs an update to support the DeploymentResourcePoolService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/google/cloud/ai_platform.rb', line 239

def self.deployment_resource_pool_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :DeploymentResourcePoolService
  service_module = service_module.const_get :DeploymentResourcePoolService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.endpoint_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for EndpointService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::EndpointService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the EndpointService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the EndpointService service. You can determine whether the method will succeed by calling endpoint_service_available?.

About EndpointService

A service for managing Vertex AI's Endpoints.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



285
286
287
288
289
290
291
292
293
294
295
# File 'lib/google/cloud/ai_platform.rb', line 285

def self.endpoint_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:EndpointService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.endpoint_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the EndpointService service is supported by the current client. If true, you can retrieve a client object by calling endpoint_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the EndpointService service, or if the versioned client gem needs an update to support the EndpointService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/google/cloud/ai_platform.rb', line 309

def self.endpoint_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :EndpointService
  service_module = service_module.const_get :EndpointService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.evaluation_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for EvaluationService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::EvaluationService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the EvaluationService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the EvaluationService service. You can determine whether the method will succeed by calling evaluation_service_available?.

About EvaluationService

Vertex AI Online Evaluation Service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



355
356
357
358
359
360
361
362
363
364
365
# File 'lib/google/cloud/ai_platform.rb', line 355

def self.evaluation_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:EvaluationService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.evaluation_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the EvaluationService service is supported by the current client. If true, you can retrieve a client object by calling evaluation_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the EvaluationService service, or if the versioned client gem needs an update to support the EvaluationService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
# File 'lib/google/cloud/ai_platform.rb', line 379

def self.evaluation_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :EvaluationService
  service_module = service_module.const_get :EvaluationService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.feature_online_store_admin_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for FeatureOnlineStoreAdminService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::FeatureOnlineStoreAdminService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the FeatureOnlineStoreAdminService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the FeatureOnlineStoreAdminService service. You can determine whether the method will succeed by calling feature_online_store_admin_service_available?.

About FeatureOnlineStoreAdminService

The service that handles CRUD and List for resources for FeatureOnlineStore.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



426
427
428
429
430
431
432
433
434
435
436
# File 'lib/google/cloud/ai_platform.rb', line 426

def self.feature_online_store_admin_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:FeatureOnlineStoreAdminService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.feature_online_store_admin_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the FeatureOnlineStoreAdminService service is supported by the current client. If true, you can retrieve a client object by calling feature_online_store_admin_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the FeatureOnlineStoreAdminService service, or if the versioned client gem needs an update to support the FeatureOnlineStoreAdminService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/google/cloud/ai_platform.rb', line 450

def self.feature_online_store_admin_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :FeatureOnlineStoreAdminService
  service_module = service_module.const_get :FeatureOnlineStoreAdminService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.feature_online_store_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for FeatureOnlineStoreService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::FeatureOnlineStoreService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the FeatureOnlineStoreService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the FeatureOnlineStoreService service. You can determine whether the method will succeed by calling feature_online_store_service_available?.

About FeatureOnlineStoreService

A service for fetching feature values from the online store.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



566
567
568
569
570
571
572
573
574
575
576
# File 'lib/google/cloud/ai_platform.rb', line 566

def self.feature_online_store_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:FeatureOnlineStoreService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.feature_online_store_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the FeatureOnlineStoreService service is supported by the current client. If true, you can retrieve a client object by calling feature_online_store_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the FeatureOnlineStoreService service, or if the versioned client gem needs an update to support the FeatureOnlineStoreService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
# File 'lib/google/cloud/ai_platform.rb', line 590

def self.feature_online_store_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :FeatureOnlineStoreService
  service_module = service_module.const_get :FeatureOnlineStoreService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.feature_registry_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for FeatureRegistryService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::FeatureRegistryService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the FeatureRegistryService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the FeatureRegistryService service. You can determine whether the method will succeed by calling feature_registry_service_available?.

About FeatureRegistryService

The service that handles CRUD and List for resources for FeatureRegistry.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



707
708
709
710
711
712
713
714
715
716
717
# File 'lib/google/cloud/ai_platform.rb', line 707

def self.feature_registry_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:FeatureRegistryService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.feature_registry_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the FeatureRegistryService service is supported by the current client. If true, you can retrieve a client object by calling feature_registry_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the FeatureRegistryService service, or if the versioned client gem needs an update to support the FeatureRegistryService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
# File 'lib/google/cloud/ai_platform.rb', line 731

def self.feature_registry_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :FeatureRegistryService
  service_module = service_module.const_get :FeatureRegistryService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.featurestore_online_serving_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for FeaturestoreOnlineServingService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the FeaturestoreOnlineServingService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the FeaturestoreOnlineServingService service. You can determine whether the method will succeed by calling featurestore_online_serving_service_available?.

About FeaturestoreOnlineServingService

A service for serving online feature values.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



496
497
498
499
500
501
502
503
504
505
506
# File 'lib/google/cloud/ai_platform.rb', line 496

def self.featurestore_online_serving_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:FeaturestoreOnlineServingService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.featurestore_online_serving_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the FeaturestoreOnlineServingService service is supported by the current client. If true, you can retrieve a client object by calling featurestore_online_serving_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the FeaturestoreOnlineServingService service, or if the versioned client gem needs an update to support the FeaturestoreOnlineServingService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
# File 'lib/google/cloud/ai_platform.rb', line 520

def self.featurestore_online_serving_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :FeaturestoreOnlineServingService
  service_module = service_module.const_get :FeaturestoreOnlineServingService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.featurestore_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for FeaturestoreService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::FeaturestoreService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the FeaturestoreService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the FeaturestoreService service. You can determine whether the method will succeed by calling featurestore_service_available?.

About FeaturestoreService

The service that handles CRUD and List for resources for Featurestore.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



636
637
638
639
640
641
642
643
644
645
646
# File 'lib/google/cloud/ai_platform.rb', line 636

def self.featurestore_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:FeaturestoreService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.featurestore_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the FeaturestoreService service is supported by the current client. If true, you can retrieve a client object by calling featurestore_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the FeaturestoreService service, or if the versioned client gem needs an update to support the FeaturestoreService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'lib/google/cloud/ai_platform.rb', line 660

def self.featurestore_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :FeaturestoreService
  service_module = service_module.const_get :FeaturestoreService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.gen_ai_cache_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for GenAiCacheService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::GenAiCacheService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the GenAiCacheService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the GenAiCacheService service. You can determine whether the method will succeed by calling gen_ai_cache_service_available?.

About GenAiCacheService

Service for managing Vertex AI's CachedContent resource.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



777
778
779
780
781
782
783
784
785
786
787
# File 'lib/google/cloud/ai_platform.rb', line 777

def self.gen_ai_cache_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:GenAiCacheService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.gen_ai_cache_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the GenAiCacheService service is supported by the current client. If true, you can retrieve a client object by calling gen_ai_cache_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the GenAiCacheService service, or if the versioned client gem needs an update to support the GenAiCacheService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
# File 'lib/google/cloud/ai_platform.rb', line 801

def self.gen_ai_cache_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :GenAiCacheService
  service_module = service_module.const_get :GenAiCacheService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.gen_ai_tuning_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for GenAiTuningService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::GenAiTuningService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the GenAiTuningService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the GenAiTuningService service. You can determine whether the method will succeed by calling gen_ai_tuning_service_available?.

About GenAiTuningService

A service for creating and managing GenAI Tuning Jobs.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



847
848
849
850
851
852
853
854
855
856
857
# File 'lib/google/cloud/ai_platform.rb', line 847

def self.gen_ai_tuning_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:GenAiTuningService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.gen_ai_tuning_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the GenAiTuningService service is supported by the current client. If true, you can retrieve a client object by calling gen_ai_tuning_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the GenAiTuningService service, or if the versioned client gem needs an update to support the GenAiTuningService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'lib/google/cloud/ai_platform.rb', line 871

def self.gen_ai_tuning_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :GenAiTuningService
  service_module = service_module.const_get :GenAiTuningService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.index_endpoint_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for IndexEndpointService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::IndexEndpointService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the IndexEndpointService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the IndexEndpointService service. You can determine whether the method will succeed by calling index_endpoint_service_available?.

About IndexEndpointService

A service for managing Vertex AI's IndexEndpoints.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



917
918
919
920
921
922
923
924
925
926
927
# File 'lib/google/cloud/ai_platform.rb', line 917

def self.index_endpoint_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:IndexEndpointService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.index_endpoint_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the IndexEndpointService service is supported by the current client. If true, you can retrieve a client object by calling index_endpoint_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the IndexEndpointService service, or if the versioned client gem needs an update to support the IndexEndpointService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
# File 'lib/google/cloud/ai_platform.rb', line 941

def self.index_endpoint_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :IndexEndpointService
  service_module = service_module.const_get :IndexEndpointService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.index_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for IndexService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::IndexService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the IndexService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the IndexService service. You can determine whether the method will succeed by calling index_service_available?.

About IndexService

A service for creating and managing Vertex AI's Index resources.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



987
988
989
990
991
992
993
994
995
996
997
# File 'lib/google/cloud/ai_platform.rb', line 987

def self.index_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:IndexService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.index_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the IndexService service is supported by the current client. If true, you can retrieve a client object by calling index_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the IndexService service, or if the versioned client gem needs an update to support the IndexService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
# File 'lib/google/cloud/ai_platform.rb', line 1011

def self.index_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :IndexService
  service_module = service_module.const_get :IndexService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.job_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for JobService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::JobService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the JobService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the JobService service. You can determine whether the method will succeed by calling job_service_available?.

About JobService

A service for creating and managing Vertex AI's jobs.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'lib/google/cloud/ai_platform.rb', line 1057

def self.job_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:JobService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.job_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the JobService service is supported by the current client. If true, you can retrieve a client object by calling job_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the JobService service, or if the versioned client gem needs an update to support the JobService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'lib/google/cloud/ai_platform.rb', line 1081

def self.job_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :JobService
  service_module = service_module.const_get :JobService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.llm_utility_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for LlmUtilityService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::LlmUtilityService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the LlmUtilityService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the LlmUtilityService service. You can determine whether the method will succeed by calling llm_utility_service_available?.

About LlmUtilityService

Service for LLM related utility functions.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'lib/google/cloud/ai_platform.rb', line 1197

def self.llm_utility_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:LlmUtilityService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.llm_utility_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the LlmUtilityService service is supported by the current client. If true, you can retrieve a client object by calling llm_utility_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the LlmUtilityService service, or if the versioned client gem needs an update to support the LlmUtilityService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
# File 'lib/google/cloud/ai_platform.rb', line 1221

def self.llm_utility_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :LlmUtilityService
  service_module = service_module.const_get :LlmUtilityService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.match_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for MatchService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::MatchService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the MatchService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the MatchService service. You can determine whether the method will succeed by calling match_service_available?.

About MatchService

MatchService is a Google managed service for efficient vector similarity search at scale.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
# File 'lib/google/cloud/ai_platform.rb', line 1268

def self.match_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:MatchService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.match_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the MatchService service is supported by the current client. If true, you can retrieve a client object by calling match_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the MatchService service, or if the versioned client gem needs an update to support the MatchService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'lib/google/cloud/ai_platform.rb', line 1292

def self.match_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :MatchService
  service_module = service_module.const_get :MatchService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.metadata_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for MetadataService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::MetadataService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the MetadataService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the MetadataService service. You can determine whether the method will succeed by calling metadata_service_available?.

About MetadataService

Service for reading and writing metadata entries.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'lib/google/cloud/ai_platform.rb', line 1338

def self. version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:MetadataService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.metadata_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the MetadataService service is supported by the current client. If true, you can retrieve a client object by calling metadata_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the MetadataService service, or if the versioned client gem needs an update to support the MetadataService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
# File 'lib/google/cloud/ai_platform.rb', line 1362

def self. version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :MetadataService
  service_module = service_module.const_get :MetadataService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.migration_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for MigrationService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::MigrationService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the MigrationService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the MigrationService service. You can determine whether the method will succeed by calling migration_service_available?.

About MigrationService

A service that migrates resources from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
# File 'lib/google/cloud/ai_platform.rb', line 1409

def self.migration_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:MigrationService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.migration_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the MigrationService service is supported by the current client. If true, you can retrieve a client object by calling migration_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the MigrationService service, or if the versioned client gem needs an update to support the MigrationService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
# File 'lib/google/cloud/ai_platform.rb', line 1433

def self.migration_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :MigrationService
  service_module = service_module.const_get :MigrationService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.model_garden_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ModelGardenService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::ModelGardenService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ModelGardenService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ModelGardenService service. You can determine whether the method will succeed by calling model_garden_service_available?.

About ModelGardenService

The interface of Model Garden Service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'lib/google/cloud/ai_platform.rb', line 1479

def self.model_garden_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:ModelGardenService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.model_garden_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the ModelGardenService service is supported by the current client. If true, you can retrieve a client object by calling model_garden_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ModelGardenService service, or if the versioned client gem needs an update to support the ModelGardenService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
# File 'lib/google/cloud/ai_platform.rb', line 1503

def self.model_garden_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :ModelGardenService
  service_module = service_module.const_get :ModelGardenService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.model_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ModelService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::ModelService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ModelService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ModelService service. You can determine whether the method will succeed by calling model_service_available?.

About ModelService

A service for managing Vertex AI's machine learning Models.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
# File 'lib/google/cloud/ai_platform.rb', line 1549

def self.model_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:ModelService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.model_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the ModelService service is supported by the current client. If true, you can retrieve a client object by calling model_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ModelService service, or if the versioned client gem needs an update to support the ModelService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
# File 'lib/google/cloud/ai_platform.rb', line 1573

def self.model_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :ModelService
  service_module = service_module.const_get :ModelService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.notebook_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for NotebookService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::NotebookService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the NotebookService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the NotebookService service. You can determine whether the method will succeed by calling notebook_service_available?.

About NotebookService

The interface for Vertex Notebook service (a.k.a. Colab on Workbench).

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
# File 'lib/google/cloud/ai_platform.rb', line 1619

def self.notebook_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:NotebookService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.notebook_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the NotebookService service is supported by the current client. If true, you can retrieve a client object by calling notebook_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the NotebookService service, or if the versioned client gem needs an update to support the NotebookService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
# File 'lib/google/cloud/ai_platform.rb', line 1643

def self.notebook_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :NotebookService
  service_module = service_module.const_get :NotebookService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.persistent_resource_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for PersistentResourceService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::PersistentResourceService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the PersistentResourceService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the PersistentResourceService service. You can determine whether the method will succeed by calling persistent_resource_service_available?.

About PersistentResourceService

A service for managing Vertex AI's machine learning PersistentResource.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'lib/google/cloud/ai_platform.rb', line 1689

def self.persistent_resource_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:PersistentResourceService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.persistent_resource_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the PersistentResourceService service is supported by the current client. If true, you can retrieve a client object by calling persistent_resource_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the PersistentResourceService service, or if the versioned client gem needs an update to support the PersistentResourceService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
# File 'lib/google/cloud/ai_platform.rb', line 1713

def self.persistent_resource_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :PersistentResourceService
  service_module = service_module.const_get :PersistentResourceService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.pipeline_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for PipelineService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::PipelineService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the PipelineService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the PipelineService service. You can determine whether the method will succeed by calling pipeline_service_available?.

About PipelineService

A service for creating and managing Vertex AI's pipelines. This includes both TrainingPipeline resources (used for AutoML and custom training) and PipelineJob resources (used for Vertex AI Pipelines).

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
# File 'lib/google/cloud/ai_platform.rb', line 1761

def self.pipeline_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:PipelineService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.pipeline_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the PipelineService service is supported by the current client. If true, you can retrieve a client object by calling pipeline_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the PipelineService service, or if the versioned client gem needs an update to support the PipelineService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
# File 'lib/google/cloud/ai_platform.rb', line 1785

def self.pipeline_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :PipelineService
  service_module = service_module.const_get :PipelineService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.prediction_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for PredictionService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::PredictionService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the PredictionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the PredictionService service. You can determine whether the method will succeed by calling prediction_service_available?.

About PredictionService

A service for online predictions and explanations.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'lib/google/cloud/ai_platform.rb', line 1127

def self.prediction_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:PredictionService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.prediction_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the PredictionService service is supported by the current client. If true, you can retrieve a client object by calling prediction_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the PredictionService service, or if the versioned client gem needs an update to support the PredictionService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
# File 'lib/google/cloud/ai_platform.rb', line 1151

def self.prediction_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :PredictionService
  service_module = service_module.const_get :PredictionService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.reasoning_engine_execution_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ReasoningEngineExecutionService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ReasoningEngineExecutionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ReasoningEngineExecutionService service. You can determine whether the method will succeed by calling reasoning_engine_execution_service_available?.

About ReasoningEngineExecutionService

A service for executing queries on Reasoning Engine.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'lib/google/cloud/ai_platform.rb', line 1831

def self.reasoning_engine_execution_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:ReasoningEngineExecutionService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.reasoning_engine_execution_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the ReasoningEngineExecutionService service is supported by the current client. If true, you can retrieve a client object by calling reasoning_engine_execution_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ReasoningEngineExecutionService service, or if the versioned client gem needs an update to support the ReasoningEngineExecutionService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
# File 'lib/google/cloud/ai_platform.rb', line 1855

def self.reasoning_engine_execution_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :ReasoningEngineExecutionService
  service_module = service_module.const_get :ReasoningEngineExecutionService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.reasoning_engine_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ReasoningEngineService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::ReasoningEngineService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ReasoningEngineService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ReasoningEngineService service. You can determine whether the method will succeed by calling reasoning_engine_service_available?.

About ReasoningEngineService

A service for managing Vertex AI's Reasoning Engines.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File 'lib/google/cloud/ai_platform.rb', line 1901

def self.reasoning_engine_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:ReasoningEngineService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.reasoning_engine_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the ReasoningEngineService service is supported by the current client. If true, you can retrieve a client object by calling reasoning_engine_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ReasoningEngineService service, or if the versioned client gem needs an update to support the ReasoningEngineService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'lib/google/cloud/ai_platform.rb', line 1925

def self.reasoning_engine_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :ReasoningEngineService
  service_module = service_module.const_get :ReasoningEngineService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.schedule_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ScheduleService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::ScheduleService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ScheduleService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ScheduleService service. You can determine whether the method will succeed by calling schedule_service_available?.

About ScheduleService

A service for creating and managing Vertex AI's Schedule resources to periodically launch shceudled runs to make API calls.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
# File 'lib/google/cloud/ai_platform.rb', line 1972

def self.schedule_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:ScheduleService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.schedule_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the ScheduleService service is supported by the current client. If true, you can retrieve a client object by calling schedule_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ScheduleService service, or if the versioned client gem needs an update to support the ScheduleService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
# File 'lib/google/cloud/ai_platform.rb', line 1996

def self.schedule_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :ScheduleService
  service_module = service_module.const_get :ScheduleService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.specialist_pool_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for SpecialistPoolService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the SpecialistPoolService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the SpecialistPoolService service. You can determine whether the method will succeed by calling specialist_pool_service_available?.

About SpecialistPoolService

A service for creating and managing Customer SpecialistPools. When customers start Data Labeling jobs, they can reuse/create Specialist Pools to bring their own Specialists to label the data. Customers can add/remove Managers for the Specialist Pool on Cloud console, then Managers will get email notifications to manage Specialists and tasks on CrowdCompute console.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
# File 'lib/google/cloud/ai_platform.rb', line 2047

def self.specialist_pool_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:SpecialistPoolService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.specialist_pool_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the SpecialistPoolService service is supported by the current client. If true, you can retrieve a client object by calling specialist_pool_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SpecialistPoolService service, or if the versioned client gem needs an update to support the SpecialistPoolService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
# File 'lib/google/cloud/ai_platform.rb', line 2071

def self.specialist_pool_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :SpecialistPoolService
  service_module = service_module.const_get :SpecialistPoolService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.tensorboard_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for TensorboardService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::TensorboardService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the TensorboardService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TensorboardService service. You can determine whether the method will succeed by calling tensorboard_service_available?.

About TensorboardService

TensorboardService

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/google/cloud/ai_platform.rb', line 2117

def self.tensorboard_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:TensorboardService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.tensorboard_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the TensorboardService service is supported by the current client. If true, you can retrieve a client object by calling tensorboard_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TensorboardService service, or if the versioned client gem needs an update to support the TensorboardService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'lib/google/cloud/ai_platform.rb', line 2141

def self.tensorboard_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :TensorboardService
  service_module = service_module.const_get :TensorboardService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.vertex_rag_data_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for VertexRagDataService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::VertexRagDataService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the VertexRagDataService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the VertexRagDataService service. You can determine whether the method will succeed by calling vertex_rag_data_service_available?.

About VertexRagDataService

A service for managing user data for RAG.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
# File 'lib/google/cloud/ai_platform.rb', line 2187

def self.vertex_rag_data_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:VertexRagDataService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.vertex_rag_data_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the VertexRagDataService service is supported by the current client. If true, you can retrieve a client object by calling vertex_rag_data_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the VertexRagDataService service, or if the versioned client gem needs an update to support the VertexRagDataService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
# File 'lib/google/cloud/ai_platform.rb', line 2211

def self.vertex_rag_data_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :VertexRagDataService
  service_module = service_module.const_get :VertexRagDataService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.vertex_rag_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for VertexRagService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::VertexRagService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the VertexRagService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the VertexRagService service. You can determine whether the method will succeed by calling vertex_rag_service_available?.

About VertexRagService

A service for retrieving relevant contexts.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'lib/google/cloud/ai_platform.rb', line 2257

def self.vertex_rag_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:VertexRagService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.vertex_rag_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the VertexRagService service is supported by the current client. If true, you can retrieve a client object by calling vertex_rag_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the VertexRagService service, or if the versioned client gem needs an update to support the VertexRagService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
# File 'lib/google/cloud/ai_platform.rb', line 2281

def self.vertex_rag_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :VertexRagService
  service_module = service_module.const_get :VertexRagService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.vizier_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for VizierService.

By default, this returns an instance of Google::Cloud::AIPlatform::V1::VizierService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the VizierService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the VizierService service. You can determine whether the method will succeed by calling vizier_service_available?.

About VizierService

Vertex AI Vizier API.

Vertex AI Vizier is a service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
# File 'lib/google/cloud/ai_platform.rb', line 2331

def self.vizier_service version: :v1, transport: :grpc, &block
  require "google/cloud/ai_platform/#{version.to_s.downcase}"

  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::AIPlatform.const_get(package_name).const_get(:VizierService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.vizier_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the VizierService service is supported by the current client. If true, you can retrieve a client object by calling vizier_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the VizierService service, or if the versioned client gem needs an update to support the VizierService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean)

    Whether the service is available.



2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
# File 'lib/google/cloud/ai_platform.rb', line 2355

def self.vizier_service_available? version: :v1, transport: :grpc
  require "google/cloud/ai_platform/#{version.to_s.downcase}"
  package_name = Google::Cloud::AIPlatform
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::AIPlatform.const_get package_name
  return false unless service_module.const_defined? :VizierService
  service_module = service_module.const_get :VizierService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end