google-cloud-ai_platform-v1 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98f7d8f409a0656e86ea3744a2ed6260f176da3a39bb8ea406e1f96dbc592e77
-  data.tar.gz: 4db0501bc675af9c343f7a5050c03969ef53f2f8271f00a124ef4f5160644be5
+  metadata.gz: 48215fb7157d8fe8cefbc130ace576c649d2f919aa6037f77720c4055ec58961
+  data.tar.gz: f1fb5d1cd35c6dfea61af093daf6fb31cfb818304247b650e23724239c56b1cf
 SHA512:
-  metadata.gz: fa2215f9237b2716edca6db142b559ca9e0fdf98350acd2d9f9d62d0cb728cde5e089e9bbb1fb2a9c75d88c5681d8fbca55ca9d984ffbc18c3c56c5b582e1c8d
-  data.tar.gz: a7c17033076f265064f75bee5d6df8103773d05307d7e4322823a9c48d97d95a2ef6af7f5b2812f641b369e4012cb435466e9ac3ac6878636fedd9dc7141b36a
+  metadata.gz: '08ac444312daefd5c8f36f476ad935b94b432514c6b448d7d7290953f51243c0425db11d2258bb40eeadd59bf118ff9bf5a6906b9f6eed54931f82f28f9d1d73'
+  data.tar.gz: 5eba79765efd6fe4ca33185092ee96890eaf953b0dadb92841907cc45d08d396c9c6bba727cd0279ce7e0816f2f657f0ad14e9e68e5b1559d05dd84faadd971a

data/lib/google/cloud/ai_platform/v1/model_garden_service/client.rb

@@ -151,6 +151,13 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @operations_client = 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 = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::AIPlatform::V1::ModelGardenService::Stub,
                 credentials: credentials,
@@ -190,6 +197,13 @@ module Google
               end
             end
 
+            ##
+            # Get the associated client for long-running operations.
+            #
+            # @return [::Google::Cloud::AIPlatform::V1::ModelGardenService::Operations]
+            #
+            attr_reader :operations_client
+
             ##
             # Get the associated client for mix-in of the Locations.
             #
@@ -312,6 +326,122 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Deploys a model to a new endpoint.
+            #
+            # @overload deploy(request, options = nil)
+            #   Pass arguments to `deploy` via a request object, either of type
+            #   {::Google::Cloud::AIPlatform::V1::DeployRequest} or an equivalent Hash.
+            #
+            #   @param 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.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload deploy(publisher_model_name: nil, hugging_face_model_id: nil, destination: nil, model_config: nil, endpoint_config: nil, deploy_config: nil)
+            #   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).
+            #
+            #   @param publisher_model_name [::String]
+            #     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 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.
+            #   @param 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.
+            #   @param destination [::String]
+            #     Required. The resource name of the Location to deploy the model in.
+            #     Format: `projects/{project}/locations/{location}`
+            #   @param 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.
+            #   @param 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.
+            #   @param 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.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example 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::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
+            #
+            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
+              metadata = @config.rpcs.deploy.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.destination
+                header_params["destination"] = request.destination
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.deploy.timeout,
+                                     metadata:     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.call_rpc :deploy, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                throw :response, response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the ModelGardenService API.
             #
@@ -483,11 +613,18 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :get_publisher_model
+                ##
+                # RPC-specific configuration for `deploy`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :deploy
 
                 # @private
                 def initialize parent_rpcs = nil
                   get_publisher_model_config = parent_rpcs.get_publisher_model if parent_rpcs.respond_to? :get_publisher_model
                   @get_publisher_model = ::Gapic::Config::Method.new get_publisher_model_config
+                  deploy_config = parent_rpcs.deploy if parent_rpcs.respond_to? :deploy
+                  @deploy = ::Gapic::Config::Method.new deploy_config
 
                   yield self if block_given?
                 end