google-cloud-ai_platform-v1 0.39.0 → 0.41.0

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

@@ -221,6 +221,9 @@ module Google
         # @!attribute [rw] bytes_value
         #   @return [::String]
         #     Bytes feature value.
+        # @!attribute [rw] struct_value
+        #   @return [::Google::Cloud::AIPlatform::V1::StructValue]
+        #     A struct type feature value.
         # @!attribute [rw] metadata
         #   @return [::Google::Cloud::AIPlatform::V1::FeatureValue::Metadata]
         #     Metadata of feature value.
@@ -243,6 +246,27 @@ module Google
           end
         end
 
+        # Struct (or object) type feature value.
+        # @!attribute [rw] values
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::StructFieldValue>]
+        #     A list of field values.
+        class StructValue
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # One field of a Struct (or object) type feature value.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Name of the field in the struct feature.
+        # @!attribute [rw] value
+        #   @return [::Google::Cloud::AIPlatform::V1::FeatureValue]
+        #     The value for this field.
+        class StructFieldValue
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Container for list of values.
         # @!attribute [rw] values
         #   @return [::Array<::Google::Cloud::AIPlatform::V1::FeatureValue>]

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

@@ -126,8 +126,11 @@ module Google
         #     Required. Unique identifier of the datapoint.
         # @!attribute [rw] feature_vector
         #   @return [::Array<::Float>]
-        #     Required. Feature embedding vector. An array of numbers with the length of
-        #     [NearestNeighborSearchConfig.dimensions].
+        #     Required. Feature embedding vector for dense index. An array of numbers
+        #     with the length of [NearestNeighborSearchConfig.dimensions].
+        # @!attribute [rw] sparse_embedding
+        #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint::SparseEmbedding]
+        #     Optional. Feature embedding vector for sparse index.
         # @!attribute [rw] restricts
         #   @return [::Array<::Google::Cloud::AIPlatform::V1::IndexDatapoint::Restriction>]
         #     Optional. List of Restrict of the datapoint, used to perform "restricted
@@ -147,6 +150,20 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
+          # Feature embedding vector for sparse index. An array of numbers whose values
+          # are located in the specified dimensions.
+          # @!attribute [rw] values
+          #   @return [::Array<::Float>]
+          #     Required. The list of embedding values of the sparse vector.
+          # @!attribute [rw] dimensions
+          #   @return [::Array<::Integer>]
+          #     Required. The list of indexes for the embedding values of the sparse
+          #     vector.
+          class SparseEmbedding
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Restriction of a datapoint which describe its attributes(tokens) from each
           # of several attribute categories(namespaces).
           # @!attribute [rw] namespace
@@ -233,7 +250,10 @@ module Google
         # Stats of the Index.
         # @!attribute [r] vectors_count
         #   @return [::Integer]
-        #     Output only. The number of vectors in the Index.
+        #     Output only. The number of dense vectors in the Index.
+        # @!attribute [r] sparse_vectors_count
+        #   @return [::Integer]
+        #     Output only. The number of sparse vectors in the Index.
         # @!attribute [r] shards_count
         #   @return [::Integer]
         #     Output only. The number of shards in the Index.

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

@@ -253,8 +253,8 @@ module Google
               # The embedding id is not valid.
               INVALID_EMBEDDING_ID = 5
 
-              # The size of the embedding vectors does not match with the specified
-              # dimension.
+              # The size of the dense embedding vectors does not match with the
+              # specified dimension.
               EMBEDDING_SIZE_MISMATCH = 6
 
               # The `namespace` field is missing.
@@ -278,6 +278,18 @@ module Google
 
               # File is not in UTF_8 format.
               INVALID_ENCODING = 13
+
+              # Error parsing sparse dimensions field.
+              INVALID_SPARSE_DIMENSIONS = 14
+
+              # Token restrict value is invalid.
+              INVALID_TOKEN_VALUE = 15
+
+              # Invalid sparse embedding.
+              INVALID_SPARSE_EMBEDDING = 16
+
+              # Invalid dense embedding.
+              INVALID_EMBEDDING = 17
             end
           end
 
@@ -295,6 +307,12 @@ module Google
           #     The detail information of the partial failures encountered for those
           #     invalid records that couldn't be parsed.
           #     Up to 50 partial errors will be reported.
+          # @!attribute [rw] valid_sparse_record_count
+          #   @return [::Integer]
+          #     Number of sparse records in this file that were successfully processed.
+          # @!attribute [rw] invalid_sparse_record_count
+          #   @return [::Integer]
+          #     Number of sparse records in this file we skipped due to validate errors.
           class ContentValidationStats
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -51,6 +51,9 @@ module Google
 
           # A query to find a number of the nearest neighbors (most similar vectors)
           # of a vector.
+          # @!attribute [rw] rrf
+          #   @return [::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query::RRF]
+          #     Optional. Represents RRF algorithm that combines search results.
           # @!attribute [rw] datapoint
           #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint]
           #     Required. The datapoint/vector whose nearest neighbors should be searched
@@ -83,6 +86,17 @@ module Google
           class Query
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Parameters for RRF algorithm that combines search results.
+            # @!attribute [rw] alpha
+            #   @return [::Float]
+            #     Required. Users can provide an alpha value to give more weight to dense
+            #     vs sparse results. For example, if the alpha is 0, we only return
+            #     sparse and if the alpha is 1, we only return dense.
+            class RRF
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
         end
 
@@ -104,7 +118,10 @@ module Google
           #     fields are populated.
           # @!attribute [rw] distance
           #   @return [::Float]
-          #     The distance between the neighbor and the query vector.
+          #     The distance between the neighbor and the dense embedding query.
+          # @!attribute [rw] sparse_distance
+          #   @return [::Float]
+          #     The distance between the neighbor and the query sparse_embedding.
           class Neighbor
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -43,6 +43,9 @@ module Google
         # @!attribute [r] state
         #   @return [::Google::Cloud::AIPlatform::V1::MetadataStore::MetadataStoreState]
         #     Output only. State information of the MetadataStore.
+        # @!attribute [rw] dataplex_config
+        #   @return [::Google::Cloud::AIPlatform::V1::MetadataStore::DataplexConfig]
+        #     Optional. Dataplex integration settings.
         class MetadataStore
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -55,6 +58,16 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Represents Dataplex integration settings.
+          # @!attribute [rw] enabled_pipelines_lineage
+          #   @return [::Boolean]
+          #     Optional. Whether or not Data Lineage synchronization is enabled for
+          #     Vertex Pipelines.
+          class DataplexConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

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

@@ -830,7 +830,7 @@ module Google
         # determine whether it is alive or ready to receive traffic.
         # @!attribute [rw] exec
         #   @return [::Google::Cloud::AIPlatform::V1::Probe::ExecAction]
-        #     Exec specifies the action to take.
+        #     ExecAction probes the health of a container by executing a command.
         # @!attribute [rw] period_seconds
         #   @return [::Integer]
         #     How often (in seconds) to perform the probe. Default to 10 seconds.

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

@@ -24,9 +24,9 @@ module Google
         # A template that specifies runtime configurations such as machine type,
         # runtime version, network configurations, etc.
         # Multiple runtimes can be created from a runtime template.
-        # @!attribute [r] name
+        # @!attribute [rw] name
         #   @return [::String]
-        #     Output only. The resource name of the NotebookRuntimeTemplate.
+        #     The resource name of the NotebookRuntimeTemplate.
         # @!attribute [rw] display_name
         #   @return [::String]
         #     Required. The display name of the NotebookRuntimeTemplate.
@@ -97,6 +97,9 @@ module Google
         #   @return [::Array<::String>]
         #     Optional. The Compute Engine tags to add to runtime (see [Tagging
         #     instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
+        # @!attribute [rw] encryption_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::EncryptionSpec]
+        #     Customer-managed encryption key spec for the notebook runtime.
         class NotebookRuntimeTemplate
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -186,10 +189,22 @@ module Google
         # @!attribute [r] notebook_runtime_type
         #   @return [::Google::Cloud::AIPlatform::V1::NotebookRuntimeType]
         #     Output only. The type of the notebook runtime.
+        # @!attribute [r] idle_shutdown_config
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookIdleShutdownConfig]
+        #     Output only. The idle shutdown configuration of the notebook runtime.
         # @!attribute [rw] network_tags
         #   @return [::Array<::String>]
         #     Optional. The Compute Engine tags to add to runtime (see [Tagging
         #     instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
+        # @!attribute [r] encryption_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::EncryptionSpec]
+        #     Output only. Customer-managed encryption key spec for the notebook runtime.
+        # @!attribute [r] satisfies_pzs
+        #   @return [::Boolean]
+        #     Output only. Reserved for future use.
+        # @!attribute [r] satisfies_pzi
+        #   @return [::Boolean]
+        #     Output only. Reserved for future use.
         class NotebookRuntime
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -147,6 +147,24 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#update_notebook_runtime_template NotebookService.UpdateNotebookRuntimeTemplate}.
+        # @!attribute [rw] notebook_runtime_template
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate]
+        #     Required. The NotebookRuntimeTemplate to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The update mask applies to the resource.
+        #     For the `FieldMask` definition, see
+        #     {::Google::Protobuf::FieldMask google.protobuf.FieldMask}. Input format:
+        #     `{paths: "${updated_filed}"}` Updatable fields:
+        #
+        #       * `encryption_spec.kms_key_name`
+        class UpdateNotebookRuntimeTemplateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for
         # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#assign_notebook_runtime NotebookService.AssignNotebookRuntime}.
         # @!attribute [rw] parent

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

@@ -207,15 +207,69 @@ module Google
         # 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.
+        # @!attribute [rw] image_uri
+        #   @return [::String]
+        #     Optional. Default image for user to choose a preferred ML framework
+        #     (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt
+        #     images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
+        #     Either this or the resource_pool_images is required. Use this field if
+        #     you need all the resource pools to have the same Ray image. Otherwise, use
+        #     the \\{@code resource_pool_images} field.
+        # @!attribute [rw] resource_pool_images
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Required if image_uri isn't set. A map of resource_pool_id to
+        #     prebuild Ray image if user need to use different images for different
+        #     head/worker pools. This map needs to cover all the resource pool ids.
+        #     Example:
+        #     {
+        #       "ray_head_node_pool": "head image"
+        #       "ray_worker_node_pool1": "worker image"
+        #       "ray_worker_node_pool2": "another worker image"
+        #     }
+        # @!attribute [rw] head_node_resource_pool_id
+        #   @return [::String]
+        #     Optional. This will be used to indicate which resource pool will serve as
+        #     the Ray head node(the first node within that pool). Will use the machine
+        #     from the first workerpool as the head node by default if this field isn't
+        #     set.
+        # @!attribute [rw] ray_metric_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::RayMetricSpec]
+        #     Optional. Ray metrics configurations.
         class RaySpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class ResourcePoolImagesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Persistent Cluster runtime information as output
+        # @!attribute [r] access_uris
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Output only. URIs for user to connect to the Cluster.
+        #     Example:
+        #     {
+        #       "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001"
+        #       "RAY_DASHBOARD_URI": "ray-dashboard-address:8888"
+        #     }
         class ResourceRuntime
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class AccessUrisEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Configuration for the use of custom service account to run the workloads.
@@ -242,6 +296,15 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Configuration for the Ray metrics.
+        # @!attribute [rw] disabled
+        #   @return [::Boolean]
+        #     Optional. Flag to disable the Ray metrics collection.
+        class RayMetricSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -485,6 +485,10 @@ module Google
         #     A `Tool` is a piece of code that enables the system to interact with
         #     external systems to perform an action, or set of actions, outside of
         #     knowledge and scope of the model.
+        # @!attribute [rw] tool_config
+        #   @return [::Google::Cloud::AIPlatform::V1::ToolConfig]
+        #     Optional. Tool config. This config is shared for all tools provided in the
+        #     request.
         # @!attribute [rw] safety_settings
         #   @return [::Array<::Google::Cloud::AIPlatform::V1::SafetySetting>]
         #     Optional. Per request settings for blocking unsafe content.

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

@@ -148,15 +148,53 @@ module Google
         end
 
         # Tool to retrieve public web data for grounding, powered by Google.
-        # @!attribute [rw] disable_attribution
-        #   @return [::Boolean]
-        #     Optional. Disable using the result from this tool in detecting grounding
-        #     attribution. This does not affect how the result is given to the model for
-        #     generation.
         class GoogleSearchRetrieval
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Tool config. This config is shared for all tools provided in the request.
+        # @!attribute [rw] function_calling_config
+        #   @return [::Google::Cloud::AIPlatform::V1::FunctionCallingConfig]
+        #     Optional. Function calling config.
+        class ToolConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Function calling config.
+        # @!attribute [rw] mode
+        #   @return [::Google::Cloud::AIPlatform::V1::FunctionCallingConfig::Mode]
+        #     Optional. Function calling mode.
+        # @!attribute [rw] allowed_function_names
+        #   @return [::Array<::String>]
+        #     Optional. Function names to call. Only set when the Mode is ANY. Function
+        #     names should match [FunctionDeclaration.name]. With mode set to ANY, model
+        #     will predict a function call from the set of function names provided.
+        class FunctionCallingConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Function calling mode.
+          module Mode
+            # Unspecified function calling mode. This value should not be used.
+            MODE_UNSPECIFIED = 0
+
+            # Default model behavior, model decides to predict either a function call
+            # or a natural language repspose.
+            AUTO = 1
+
+            # Model is constrained to always predicting a function call only.
+            # If "allowed_function_names" are set, the predicted function call will be
+            # limited to any one of "allowed_function_names", else the predicted
+            # function call will be any one of the provided "function_declarations".
+            ANY = 2
+
+            # Model will not predict any function call. Model behavior is same as when
+            # not passing any function declarations.
+            NONE = 3
+          end
+        end
       end
     end
   end

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

@@ -24,7 +24,7 @@ module Google
         # Represents a TuningJob that runs with Google owned models.
         # @!attribute [rw] base_model
         #   @return [::String]
-        #     Model name for tuning, e.g., "gemini-1.0-pro-002".
+        #     The base model that is being tuned, e.g., "gemini-1.0-pro-002".
         # @!attribute [rw] supervised_tuning_spec
         #   @return [::Google::Cloud::AIPlatform::V1::SupervisedTuningSpec]
         #     Tuning Spec for Supervised Fine Tuning.
@@ -35,8 +35,8 @@ module Google
         # @!attribute [rw] tuned_model_display_name
         #   @return [::String]
         #     Optional. The display name of the
-        #     {::Google::Cloud::AIPlatform::V1::Model TunedModel}. The name can be up to
-        #     128 characters long and can consist of any UTF-8 characters.
+        #     {::Google::Cloud::AIPlatform::V1::Model TunedModel}. The name can be up to 128
+        #     characters long and can consist of any UTF-8 characters.
         # @!attribute [rw] description
         #   @return [::String]
         #     Optional. The description of the
@@ -209,10 +209,11 @@ module Google
         # Hyperparameters for SFT.
         # @!attribute [rw] epoch_count
         #   @return [::Integer]
-        #     Optional. Number of training epoches for this tuning job.
+        #     Optional. Number of complete passes the model makes over the entire
+        #     training dataset during training.
         # @!attribute [rw] learning_rate_multiplier
         #   @return [::Float]
-        #     Optional. Learning rate multiplier for tuning.
+        #     Optional. Multiplier for adjusting the default learning rate.
         # @!attribute [rw] adapter_size
         #   @return [::Google::Cloud::AIPlatform::V1::SupervisedHyperParameters::AdapterSize]
         #     Optional. Adapter size for tuning.
@@ -243,11 +244,11 @@ module Google
         # @!attribute [rw] training_dataset_uri
         #   @return [::String]
         #     Required. Cloud Storage path to file containing training dataset for
-        #     tuning.
+        #     tuning. The dataset must be formatted as a JSONL file.
         # @!attribute [rw] validation_dataset_uri
         #   @return [::String]
         #     Optional. Cloud Storage path to file containing validation dataset for
-        #     tuning.
+        #     tuning. The dataset must be formatted as a JSONL file.
         # @!attribute [rw] hyper_parameters
         #   @return [::Google::Cloud::AIPlatform::V1::SupervisedHyperParameters]
         #     Optional. Hyperparameters for SFT.