Vertex AI API - Module Google::Cloud::AIPlatform (v1.4.0)

Reference documentation and code samples for the Vertex AI API module Google::Cloud::AIPlatform.

Methods

.configure

def self.configure() -> ::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
  • (::Google::Cloud.configure.ai_platform)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.dataset_service

def self.dataset_service(version: :v1, &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.

About DatasetService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.deployment_resource_pool_service

def self.deployment_resource_pool_service(version: :v1, &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.

About DeploymentResourcePoolService

A service that manages the DeploymentResourcePool resource.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.endpoint_service

def self.endpoint_service(version: :v1, &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.

About EndpointService

A service for managing Vertex AI's Endpoints.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.evaluation_service

def self.evaluation_service(version: :v1, &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.

About EvaluationService

Vertex AI Online Evaluation Service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.feature_online_store_admin_service

def self.feature_online_store_admin_service(version: :v1, &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.

About FeatureOnlineStoreAdminService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.feature_online_store_service

def self.feature_online_store_service(version: :v1, &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.

About FeatureOnlineStoreService

A service for fetching feature values from the online store.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.feature_registry_service

def self.feature_registry_service(version: :v1, &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.

About FeatureRegistryService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.featurestore_online_serving_service

def self.featurestore_online_serving_service(version: :v1, &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.

About FeaturestoreOnlineServingService

A service for serving online feature values.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.featurestore_service

def self.featurestore_service(version: :v1, &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.

About FeaturestoreService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.gen_ai_tuning_service

def self.gen_ai_tuning_service(version: :v1, &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.

About GenAiTuningService

A service for creating and managing GenAI Tuning Jobs.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.index_endpoint_service

def self.index_endpoint_service(version: :v1, &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.

About IndexEndpointService

A service for managing Vertex AI's IndexEndpoints.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.index_service

def self.index_service(version: :v1, &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.

About IndexService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.job_service

def self.job_service(version: :v1, &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.

About JobService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.llm_utility_service

def self.llm_utility_service(version: :v1, &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.

About LlmUtilityService

Service for LLM related utility functions.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.match_service

def self.match_service(version: :v1, &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.

About MatchService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.metadata_service

def self.metadata_service(version: :v1, &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.

About MetadataService

Service for reading and writing metadata entries.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.migration_service

def self.migration_service(version: :v1, &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.

About MigrationService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.model_garden_service

def self.model_garden_service(version: :v1, &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.

About ModelGardenService

The interface of Model Garden Service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.model_service

def self.model_service(version: :v1, &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.

About ModelService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.notebook_service

def self.notebook_service(version: :v1, &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.

About NotebookService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.persistent_resource_service

def self.persistent_resource_service(version: :v1, &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.

About PersistentResourceService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.pipeline_service

def self.pipeline_service(version: :v1, &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.

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).

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.prediction_service

def self.prediction_service(version: :v1, &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.

About PredictionService

A service for online predictions and explanations.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.schedule_service

def self.schedule_service(version: :v1, &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.

About ScheduleService

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

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.specialist_pool_service

def self.specialist_pool_service(version: :v1, &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.

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.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.tensorboard_service

def self.tensorboard_service(version: :v1, &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.

About TensorboardService

TensorboardService

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.vizier_service

def self.vizier_service(version: :v1, &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.

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.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

Constants

VERSION

value: "1.4.0"