Class: Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb

Overview

REST client for the ModelGardenService service.

The interface of Model Garden Service.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#location_path, #publisher_model_path, #reservation_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ModelGardenService REST client object.

Examples:


# 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

Yields:

  • (config) —

    Configure the ModelGardenService client.

Yield Parameters:



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 128

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @model_garden_service_stub = ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @model_garden_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @model_garden_service_stub.endpoint
    config.universe_domain = @model_garden_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @model_garden_service_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @model_garden_service_stub.endpoint
    config.universe_domain = @model_garden_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @model_garden_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

Get the associated client for mix-in of the IAMPolicy.

Returns:

  • (Google::Iam::V1::IAMPolicy::Rest::Client) 


214
215
216
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 214

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Rest::Client) 


207
208
209
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 207

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



200
201
202
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 200

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ModelGardenService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ModelGardenService clients
::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 66

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "AIPlatform", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



98
99
100
101
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 98

def configure
  yield @config if block_given?
  @config
end

#deploy(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #deploy(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to deploy via a request object, either of type DeployRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #deploy(publisher_model_name: nil, hugging_face_model_id: nil, destination: nil, model_config: nil, endpoint_config: nil, deploy_config: nil) ⇒ ::Gapic::Operation

    Pass arguments to 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).

    Parameters:

    • publisher_model_name (::String) (defaults to: nil) —

      The Model Garden model to deploy. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001.

      Note: The following parameters are mutually exclusive: publisher_model_name, hugging_face_model_id. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • hugging_face_model_id (::String) (defaults to: nil) —

      The Hugging Face model to deploy. Format: Hugging Face model ID like google/gemma-2-2b-it.

      Note: The following parameters are mutually exclusive: hugging_face_model_id, publisher_model_name. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • destination (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 389

def deploy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeployRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.deploy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.deploy.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.deploy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @model_garden_service_stub.deploy request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_publisher_model(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::PublisherModel #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.

Examples:

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

Overloads:

  • #get_publisher_model(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::PublisherModel

    Pass arguments to get_publisher_model via a request object, either of type GetPublisherModelRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_publisher_model(name: nil, language_code: nil, view: nil, is_hugging_face_model: nil, hugging_face_token: nil) ⇒ ::Google::Cloud::AIPlatform::V1::PublisherModel

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}

    • language_code (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. PublisherModel view specifying which fields to read.

    • is_hugging_face_model (::Boolean) (defaults to: nil) —

      Optional. Boolean indicates whether the requested model is a Hugging Face model.

    • hugging_face_token (::String) (defaults to: nil) —

      Optional. Token used to access Hugging Face gated models.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 282

def get_publisher_model request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetPublisherModelRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_publisher_model.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_publisher_model.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_publisher_model.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @model_garden_service_stub.get_publisher_model request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


221
222
223
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 221

def logger
  @model_garden_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


108
109
110
 
# File 'lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb', line 108

def universe_domain
  @model_garden_service_stub.universe_domain
end