google-cloud-ai_platform-v1 0.38.0 → 0.40.0

data/proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb

@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # Represents long-lasting resources that are dedicated to users to runs custom
+        # workloads.
+        # A PersistentResource can have multiple node pools and each node
+        # pool can have its own machine spec.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Resource name of a PersistentResource.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. The display name of the PersistentResource.
+        #     The name can be up to 128 characters long and can consist of any UTF-8
+        #     characters.
+        # @!attribute [rw] resource_pools
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::ResourcePool>]
+        #     Required. The spec of the pools of different resources.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AIPlatform::V1::PersistentResource::State]
+        #     Output only. The detailed state of a Study.
+        # @!attribute [r] error
+        #   @return [::Google::Rpc::Status]
+        #     Output only. Only populated when persistent resource's state is `STOPPING`
+        #     or `ERROR`.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when the PersistentResource was created.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when the PersistentResource for the first time entered
+        #     the `RUNNING` state.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when the PersistentResource was most recently updated.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. The labels with user-defined metadata to organize
+        #     PersistentResource.
+        #
+        #     Label keys and values can be no longer than 64 characters
+        #     (Unicode codepoints), can only contain lowercase letters, numeric
+        #     characters, underscores and dashes. International characters are allowed.
+        #
+        #     See https://goo.gl/xmQnxf for more information and examples of labels.
+        # @!attribute [rw] network
+        #   @return [::String]
+        #     Optional. The full name of the Compute Engine
+        #     [network](/compute/docs/networks-and-firewalls#networks) to peered with
+        #     Vertex AI to host the persistent resources.
+        #     For example, `projects/12345/global/networks/myVPC`.
+        #     [Format](/compute/docs/reference/rest/v1/networks/insert)
+        #     is of the form `projects/{project}/global/networks/{network}`.
+        #     Where \\{project} is a project number, as in `12345`, and \\{network} is a
+        #     network name.
+        #
+        #     To specify this field, you must have already [configured VPC Network
+        #     Peering for Vertex
+        #     AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).
+        #
+        #     If this field is left unspecified, the resources aren't peered with any
+        #     network.
+        # @!attribute [rw] encryption_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::EncryptionSpec]
+        #     Optional. Customer-managed encryption key spec for a PersistentResource.
+        #     If set, this PersistentResource and all sub-resources of this
+        #     PersistentResource will be secured by this key.
+        # @!attribute [rw] resource_runtime_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::ResourceRuntimeSpec]
+        #     Optional. Persistent Resource runtime spec.
+        #     For example, used for Ray cluster configuration.
+        # @!attribute [r] resource_runtime
+        #   @return [::Google::Cloud::AIPlatform::V1::ResourceRuntime]
+        #     Output only. Runtime information of the Persistent Resource.
+        # @!attribute [rw] reserved_ip_ranges
+        #   @return [::Array<::String>]
+        #     Optional. A list of names for the reserved IP ranges under the VPC network
+        #     that can be used for this persistent resource.
+        #
+        #     If set, we will deploy the persistent resource within the provided IP
+        #     ranges. Otherwise, the persistent resource is deployed to any IP
+        #     ranges under the provided VPC network.
+        #
+        #     Example: ['vertex-ai-ip-range'].
+        class PersistentResource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes the PersistentResource state.
+          module State
+            # Not set.
+            STATE_UNSPECIFIED = 0
+
+            # The PROVISIONING state indicates the persistent resources is being
+            # created.
+            PROVISIONING = 1
+
+            # The RUNNING state indicates the persistent resource is healthy and fully
+            # usable.
+            RUNNING = 3
+
+            # The STOPPING state indicates the persistent resource is being deleted.
+            STOPPING = 4
+
+            # The ERROR state indicates the persistent resource may be unusable.
+            # Details can be found in the `error` field.
+            ERROR = 5
+
+            # The REBOOTING state indicates the persistent resource is being rebooted
+            # (PR is not available right now but is expected to be ready again later).
+            REBOOTING = 6
+
+            # The UPDATING state indicates the persistent resource is being updated.
+            UPDATING = 7
+          end
+        end
+
+        # Represents the spec of a group of resources of the same type,
+        # for example machine type, disk, and accelerators, in a PersistentResource.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     Immutable. The unique ID in a PersistentResource for referring to this
+        #     resource pool. User can specify it if necessary. Otherwise, it's generated
+        #     automatically.
+        # @!attribute [rw] machine_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
+        #     Required. Immutable. The specification of a single machine.
+        # @!attribute [rw] replica_count
+        #   @return [::Integer]
+        #     Optional. The total number of machines to use for this resource pool.
+        # @!attribute [rw] disk_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::DiskSpec]
+        #     Optional. Disk spec for the machine in this node pool.
+        # @!attribute [r] used_replica_count
+        #   @return [::Integer]
+        #     Output only. The number of machines currently in use by training jobs for
+        #     this resource pool. Will replace idle_replica_count.
+        # @!attribute [rw] autoscaling_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::ResourcePool::AutoscalingSpec]
+        #     Optional. Optional spec to configure GKE autoscaling
+        class ResourcePool
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The min/max number of replicas allowed if enabling autoscaling
+          # @!attribute [rw] min_replica_count
+          #   @return [::Integer]
+          #     Optional. min replicas in the node pool,
+          #     must be ≤ replica_count and < max_replica_count or will throw error
+          # @!attribute [rw] max_replica_count
+          #   @return [::Integer]
+          #     Optional. max replicas in the node pool,
+          #     must be ≥ replica_count and > min_replica_count or will throw error
+          class AutoscalingSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Configuration for the runtime on a PersistentResource instance, including
+        # but not limited to:
+        #
+        # * Service accounts used to run the workloads.
+        # * Whether to make it a dedicated Ray Cluster.
+        # @!attribute [rw] service_account_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::ServiceAccountSpec]
+        #     Optional. Configure the use of workload identity on the PersistentResource
+        # @!attribute [rw] ray_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::RaySpec]
+        #     Optional. Ray cluster configuration.
+        #     Required when creating a dedicated RayCluster on the PersistentResource.
+        class ResourceRuntimeSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration information for the Ray cluster.
+        # For experimental launch, Ray cluster creation and Persistent
+        # cluster creation are 1:1 mapping: We will provision all the nodes within the
+        # Persistent cluster as Ray nodes.
+        class RaySpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Persistent Cluster runtime information as output
+        class ResourceRuntime
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for the use of custom service account to run the workloads.
+        # @!attribute [rw] enable_custom_service_account
+        #   @return [::Boolean]
+        #     Required. If true, custom user-managed service account is enforced to run
+        #     any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses
+        #     the [Vertex AI Custom Code Service
+        #     Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+        # @!attribute [rw] service_account
+        #   @return [::String]
+        #     Optional. Required when all below conditions are met
+        #      * `enable_custom_service_account` is true;
+        #      * any runtime is specified via `ResourceRuntimeSpec` on creation time,
+        #        for example, Ray
+        #
+        #     The users must have `iam.serviceAccounts.actAs` permission on this service
+        #     account and then the specified runtime containers will run as it.
+        #
+        #     Do not set this field if you want to submit jobs using custom service
+        #     account to this PersistentResource after creation, but only specify the
+        #     `service_account` inside the job.
+        class ServiceAccountSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/persistent_resource_service.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::PersistentResourceService::Client#create_persistent_resource PersistentResourceService.CreatePersistentResource}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location to create the
+        #     PersistentResource in. Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] persistent_resource
+        #   @return [::Google::Cloud::AIPlatform::V1::PersistentResource]
+        #     Required. The PersistentResource to create.
+        # @!attribute [rw] persistent_resource_id
+        #   @return [::String]
+        #     Required. The ID to use for the PersistentResource, which become the final
+        #     component of the PersistentResource's resource name.
+        #
+        #     The maximum length is 63 characters, and valid characters
+        #     are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
+        class CreatePersistentResourceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of operations that perform create PersistentResource.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     Operation metadata for PersistentResource.
+        # @!attribute [rw] progress_message
+        #   @return [::String]
+        #     Progress Message for Create LRO
+        class CreatePersistentResourceOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of operations that perform update PersistentResource.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     Operation metadata for PersistentResource.
+        # @!attribute [rw] progress_message
+        #   @return [::String]
+        #     Progress Message for Update LRO
+        class UpdatePersistentResourceOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of operations that perform reboot PersistentResource.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     Operation metadata for PersistentResource.
+        # @!attribute [rw] progress_message
+        #   @return [::String]
+        #     Progress Message for Reboot LRO
+        class RebootPersistentResourceOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::PersistentResourceService::Client#get_persistent_resource PersistentResourceService.GetPersistentResource}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the PersistentResource resource.
+        #     Format:
+        #     `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
+        class GetPersistentResourceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for [PersistentResourceService.ListPersistentResource][].
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location to list the PersistentResources
+        #     from. Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The standard list page size.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The standard list page token.
+        #     Typically obtained via
+        #     [ListPersistentResourceResponse.next_page_token][] of the previous
+        #     [PersistentResourceService.ListPersistentResource][] call.
+        class ListPersistentResourcesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::PersistentResourceService::Client#list_persistent_resources PersistentResourceService.ListPersistentResources}
+        # @!attribute [rw] persistent_resources
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::PersistentResource>]
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve next page of results.
+        #     Pass to
+        #     {::Google::Cloud::AIPlatform::V1::ListPersistentResourcesRequest#page_token ListPersistentResourcesRequest.page_token}
+        #     to obtain that page.
+        class ListPersistentResourcesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::PersistentResourceService::Client#delete_persistent_resource PersistentResourceService.DeletePersistentResource}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the PersistentResource to be deleted.
+        #     Format:
+        #     `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
+        class DeletePersistentResourceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for UpdatePersistentResource method.
+        # @!attribute [rw] persistent_resource
+        #   @return [::Google::Cloud::AIPlatform::V1::PersistentResource]
+        #     Required. The PersistentResource to update.
+        #
+        #     The PersistentResource's `name` field is used to identify the
+        #     PersistentResource to update. Format:
+        #     `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. Specify the fields to be overwritten in the PersistentResource by
+        #     the update method.
+        class UpdatePersistentResourceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::PersistentResourceService::Client#reboot_persistent_resource PersistentResourceService.RebootPersistentResource}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the PersistentResource resource.
+        #     Format:
+        #     `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
+        class RebootPersistentResourceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb

@@ -472,6 +472,11 @@ module Google
         #     For single-turn queries, this is a single instance. For multi-turn queries,
         #     this is a repeated field that contains conversation history + latest
         #     request.
+        # @!attribute [rw] system_instruction
+        #   @return [::Google::Cloud::AIPlatform::V1::Content]
+        #     Optional. The user provided system instructions for the model.
+        #     Note: only text should be used in parts and content in each part will be in
+        #     a separate paragraph.
         # @!attribute [rw] tools
         #   @return [::Array<::Google::Cloud::AIPlatform::V1::Tool>]
         #     Optional. A list of `Tools` the model may use to generate the next
@@ -532,6 +537,13 @@ module Google
 
               # Candidates blocked due to other reason.
               OTHER = 2
+
+              # Candidates blocked due to the terms which are included from the
+              # terminology blocklist.
+              BLOCKLIST = 3
+
+              # Candidates blocked due to prohibited content.
+              PROHIBITED_CONTENT = 4
             end
           end
 

data/proto_docs/google/cloud/aiplatform/v1/publisher_model.rb

@@ -228,6 +228,10 @@ module Google
             #   @return [::String]
             #     Optional. The path to the directory containing the Model artifact and
             #     any of its supporting files.
+            # @!attribute [rw] deploy_task_name
+            #   @return [::String]
+            #     Optional. The name of the deploy task (e.g., "text to image
+            #     generation").
             # @!attribute [rw] title
             #   @return [::String]
             #     Required. The title of the regional resource reference.

data/proto_docs/google/cloud/aiplatform/v1/tool.rb

@@ -62,8 +62,8 @@ module Google
         #   @return [::String]
         #     Required. The name of the function to call.
         #     Must start with a letter or an underscore.
-        #     Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum
-        #     length of 64.
+        #     Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a
+        #     maximum length of 64.
         # @!attribute [rw] description
         #   @return [::String]
         #     Optional. Description and purpose of the function.
@@ -74,8 +74,10 @@ module Google
         #     format. Reflects the Open API 3.03 Parameter Object. string Key: the name
         #     of the parameter. Parameter names are case sensitive. Schema Value: the
         #     Schema defining the type used for the parameter. For function with no
-        #     parameters, this can be left unset. Example with 1 required and 1 optional
-        #     parameter: type: OBJECT properties:
+        #     parameters, this can be left unset. Parameter names must start with a
+        #     letter or an underscore and must only contain chars a-z, A-Z, 0-9, or
+        #     underscores with a maximum length of 64. Example with 1 required and 1
+        #     optional parameter: type: OBJECT properties:
         #      param1:
         #        type: STRING
         #      param2:
@@ -139,7 +141,7 @@ module Google
         #   @return [::String]
         #     Required. Fully-qualified Vertex AI Search's datastore resource ID.
         #     Format:
-        #     projects/\\{project}/locations/\\{location}/collections/\\{collection}/dataStores/\\{dataStore}
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
         class VertexAISearch
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods