- 1.17.0 (latest)
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.61.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.
REST client for the ModelGardenService service.
The interface of Model Garden Service.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the ModelGardenService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all ModelGardenService clients ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the ModelGardenService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#deploy
def deploy(request, options = nil) -> ::Gapic::Operation
def deploy(publisher_model_name: nil, hugging_face_model_id: nil, destination: nil, model_config: nil, endpoint_config: nil, deploy_config: nil) -> ::Gapic::Operation
Deploys a model to a new endpoint.
def deploy(request, options = nil) -> ::Gapic::Operation
deploy
via a request object, either of type
DeployRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::DeployRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def deploy(publisher_model_name: nil, hugging_face_model_id: nil, destination: nil, model_config: nil, endpoint_config: nil, deploy_config: nil) -> ::Gapic::Operation
deploy
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
publisher_model_name (::String) — The Model Garden model to deploy.
Format:
publishers/{publisher}/models/{publisher_model}@{version_id}
, orpublishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001
.Note: The following fields are mutually exclusive:
publisher_model_name
,hugging_face_model_id
. If a field in that set is populated, all other fields in the set will automatically be cleared. -
hugging_face_model_id (::String) — The Hugging Face model to deploy.
Format: Hugging Face model ID like
google/gemma-2-2b-it
.Note: The following fields are mutually exclusive:
hugging_face_model_id
,publisher_model_name
. If a field in that set is populated, all other fields in the set will automatically be cleared. -
destination (::String) — Required. The resource name of the Location to deploy the model in.
Format:
projects/{project}/locations/{location}
- model_config (::Google::Cloud::AIPlatform::V1::DeployRequest::ModelConfig, ::Hash) — Optional. The model config to use for the deployment. If not specified, the default model config will be used.
- endpoint_config (::Google::Cloud::AIPlatform::V1::DeployRequest::EndpointConfig, ::Hash) — Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.
- deploy_config (::Google::Cloud::AIPlatform::V1::DeployRequest::DeployConfig, ::Hash) — Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::DeployRequest.new # Call the deploy method. result = client.deploy request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#get_publisher_model
def get_publisher_model(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PublisherModel
def get_publisher_model(name: nil, language_code: nil, view: nil, is_hugging_face_model: nil, hugging_face_token: nil) -> ::Google::Cloud::AIPlatform::V1::PublisherModel
Gets a Model Garden publisher model.
def get_publisher_model(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PublisherModel
get_publisher_model
via a request object, either of type
GetPublisherModelRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::GetPublisherModelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_publisher_model(name: nil, language_code: nil, view: nil, is_hugging_face_model: nil, hugging_face_token: nil) -> ::Google::Cloud::AIPlatform::V1::PublisherModel
get_publisher_model
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the PublisherModel resource.
Format:
publishers/{publisher}/models/{publisher_model}
- language_code (::String) — Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
- view (::Google::Cloud::AIPlatform::V1::PublisherModelView) — Optional. PublisherModel view specifying which fields to read.
- is_hugging_face_model (::Boolean) — Optional. Boolean indicates whether the requested model is a Hugging Face model.
- hugging_face_token (::String) — Optional. Token used to access Hugging Face gated models.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::AIPlatform::V1::PublisherModel)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::GetPublisherModelRequest.new # Call the get_publisher_model method. result = client.get_publisher_model request # The returned object is of type Google::Cloud::AIPlatform::V1::PublisherModel. p result
#iam_policy_client
def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client
Get the associated client for mix-in of the IAMPolicy.
- (Google::Iam::V1::IAMPolicy::Rest::Client)
#initialize
def initialize() { |config| ... } -> Client
Create a new ModelGardenService REST client object.
- (config) — Configure the ModelGardenService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.new do |config| config.timeout = 10.0 end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Rest::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Rest::Client)
#logger
def logger() -> Logger
The logger used for request/response debug logging.
- (Logger)
#operations_client
def operations_client() -> ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Operations
Get the associated client for long-running operations.
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)