google-cloud-ai_platform-v1 0.32.0 → 0.34.0

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

@@ -110,7 +110,7 @@ module Google
             INDEX_UPDATE_METHOD_UNSPECIFIED = 0
 
             # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
-            # datapoints to update.
+            # Datapoints to update.
             BATCH_UPDATE = 1
 
             # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
@@ -132,8 +132,13 @@ module Google
         #   @return [::Array<::Google::Cloud::AIPlatform::V1::IndexDatapoint::Restriction>]
         #     Optional. List of Restrict of the datapoint, used to perform "restricted
         #     searches" where boolean rule are used to filter the subset of the database
-        #     eligible for matching. See:
+        #     eligible for matching. This uses categorical tokens. See:
         #     https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
+        # @!attribute [rw] numeric_restricts
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::IndexDatapoint::NumericRestriction>]
+        #     Optional. List of Restrict of the datapoint, used to perform "restricted
+        #     searches" where boolean rule are used to filter the subset of the database
+        #     eligible for matching. This uses numeric comparisons.
         # @!attribute [rw] crowding_tag
         #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint::CrowdingTag]
         #     Optional. CrowdingTag of the datapoint, the number of neighbors to return
@@ -146,18 +151,66 @@ module Google
           # of several attribute categories(namespaces).
           # @!attribute [rw] namespace
           #   @return [::String]
-          #     The namespace of this restriction. eg: color.
+          #     The namespace of this restriction. e.g.: color.
           # @!attribute [rw] allow_list
           #   @return [::Array<::String>]
-          #     The attributes to allow in this namespace. eg: 'red'
+          #     The attributes to allow in this namespace. e.g.: 'red'
           # @!attribute [rw] deny_list
           #   @return [::Array<::String>]
-          #     The attributes to deny in this namespace. eg: 'blue'
+          #     The attributes to deny in this namespace. e.g.: 'blue'
           class Restriction
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # This field allows restricts to be based on numeric comparisons rather
+          # than categorical tokens.
+          # @!attribute [rw] value_int
+          #   @return [::Integer]
+          #     Represents 64 bit integer.
+          # @!attribute [rw] value_float
+          #   @return [::Float]
+          #     Represents 32 bit float.
+          # @!attribute [rw] value_double
+          #   @return [::Float]
+          #     Represents 64 bit float.
+          # @!attribute [rw] namespace
+          #   @return [::String]
+          #     The namespace of this restriction. e.g.: cost.
+          # @!attribute [rw] op
+          #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint::NumericRestriction::Operator]
+          #     This MUST be specified for queries and must NOT be specified for
+          #     datapoints.
+          class NumericRestriction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Which comparison operator to use.  Should be specified for queries only;
+            # specifying this for a datapoint is an error.
+            #
+            # Datapoints for which Operator is true relative to the query's Value
+            # field will be allowlisted.
+            module Operator
+              # Default value of the enum.
+              OPERATOR_UNSPECIFIED = 0
+
+              # Datapoints are eligible iff their value is < the query's.
+              LESS = 1
+
+              # Datapoints are eligible iff their value is <= the query's.
+              LESS_EQUAL = 2
+
+              # Datapoints are eligible iff their value is == the query's.
+              EQUAL = 3
+
+              # Datapoints are eligible iff their value is >= the query's.
+              GREATER_EQUAL = 4
+
+              # Datapoints are eligible iff their value is > the query's.
+              GREATER = 5
+            end
+          end
+
           # Crowding tag is a constraint on a neighbor list produced by nearest
           # neighbor search requiring that no more than some value k' of the k
           # neighbors returned have the same value of crowding_attribute.

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

@@ -173,10 +173,11 @@ module Google
         # @!attribute [rw] dedicated_resources
         #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
         #     Optional. A description of resources that are dedicated to the
-        #     DeployedIndex, and that need a higher degree of manual configuration. If
-        #     min_replica_count is not set, the default value is 2 (we don't provide SLA
-        #     when min_replica_count=1). If max_replica_count is not set, the default
-        #     value is min_replica_count. The max allowed replica count is 1000.
+        #     DeployedIndex, and that need a higher degree of manual configuration. The
+        #     field min_replica_count must be set to a value strictly greater than 0, or
+        #     else validation will fail. We don't provide SLA when min_replica_count=1.
+        #     If max_replica_count is not set, the default value is min_replica_count.
+        #     The max allowed replica count is 1000.
         #
         #     Available machine types for SMALL shard:
         #     e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
@@ -214,7 +215,10 @@ module Google
         #
         #     The value should be the name of the address
         #     (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
-        #     Example: 'vertex-ai-ip-range'.
+        #     Example: ['vertex-ai-ip-range'].
+        #
+        #     For more information about subnets and network IP ranges, please see
+        #     https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.
         # @!attribute [rw] deployment_group
         #   @return [::String]
         #     Optional. The deployment group can be no longer than 64 characters (eg:

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

@@ -45,6 +45,10 @@ module Google
         # @!attribute [rw] accelerator_count
         #   @return [::Integer]
         #     The number of accelerators to attach to the machine.
+        # @!attribute [rw] tpu_topology
+        #   @return [::String]
+        #     Immutable. The topology of the TPUs. Corresponds to the TPU topologies
+        #     available from GKE. (Example: tpu_topology: "2x2x1").
         class MachineSpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -182,6 +186,23 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Represents the spec of [persistent
+        # disk][https://cloud.google.com/compute/docs/disks/persistent-disks] options.
+        # @!attribute [rw] disk_type
+        #   @return [::String]
+        #     Type of the disk (default is "pd-standard").
+        #     Valid values: "pd-ssd" (Persistent Disk Solid State Drive)
+        #     "pd-standard" (Persistent Disk Hard Disk Drive)
+        #     "pd-balanced" (Balanced Persistent Disk)
+        #     "pd-extreme" (Extreme Persistent Disk)
+        # @!attribute [rw] disk_size_gb
+        #   @return [::Integer]
+        #     Size in GB of the disk (default is 100GB).
+        class PersistentDiskSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Represents a mount configuration for Network File System (NFS) to mount.
         # @!attribute [rw] server
         #   @return [::String]

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

@@ -215,6 +215,11 @@ module Google
         #     [google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry][].
         #     This can be further sinked to Pub/Sub or any other services supported
         #     by Cloud Logging.
+        # @!attribute [rw] notification_channels
+        #   @return [::Array<::String>]
+        #     Resource names of the NotificationChannels to send alert.
+        #     Must be of the format
+        #     `projects/<project_id_or_number>/notificationChannels/<channel_id>`
         class ModelMonitoringAlertConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -114,7 +114,9 @@ module Google
         #   @return [::String]
         #     A template uri from where the
         #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec},
-        #     if empty, will be downloaded.
+        #     if empty, will be downloaded. Currently, only uri from Vertex Template
+        #     Registry & Gallery is supported. Reference to
+        #     https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
         # @!attribute [r] template_metadata
         #   @return [::Google::Cloud::AIPlatform::V1::PipelineTemplateMetadata]
         #     Output only. Pipeline template metadata. Will fill up fields if

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

@@ -150,7 +150,7 @@ module Google
         #     generated.
         #
         #     This value should be less than 128 characters, and valid characters
-        #     are /[a-z][0-9]-/.
+        #     are `/[a-z][0-9]-/`.
         class CreatePipelineJobRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -216,6 +216,34 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for [PredictionService.CountTokens][].
+        # @!attribute [rw] endpoint
+        #   @return [::String]
+        #     Required. The name of the Endpoint requested to perform token counting.
+        #     Format:
+        #     `projects/{project}/locations/{location}/endpoints/{endpoint}`
+        # @!attribute [rw] instances
+        #   @return [::Array<::Google::Protobuf::Value>]
+        #     Required. The instances that are the input to token counting call.
+        #     Schema is identical to the prediction schema of the underlying model.
+        class CountTokensRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for [PredictionService.CountTokens][].
+        # @!attribute [rw] total_tokens
+        #   @return [::Integer]
+        #     The total number of tokens counted across all instances from the request.
+        # @!attribute [rw] total_billable_characters
+        #   @return [::Integer]
+        #     The total number of billable characters counted across all instances from
+        #     the request.
+        class CountTokensResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -205,6 +205,18 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Time-based Constraint for Study
+        # @!attribute [rw] max_duration
+        #   @return [::Google::Protobuf::Duration]
+        #     Counts the wallclock time passed since the creation of this Study.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Compares the wallclock time to this time. Must use UTC timezone.
+        class StudyTimeConstraint
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Represents specification of a Study.
         # @!attribute [rw] decay_curve_stopping_spec
         #   @return [::Google::Cloud::AIPlatform::V1::StudySpec::DecayCurveAutomatedStoppingSpec]
@@ -232,6 +244,10 @@ module Google
         # @!attribute [rw] measurement_selection_type
         #   @return [::Google::Cloud::AIPlatform::V1::StudySpec::MeasurementSelectionType]
         #     Describe which measurement selection type will be used
+        # @!attribute [rw] study_stopping_config
+        #   @return [::Google::Cloud::AIPlatform::V1::StudySpec::StudyStoppingConfig]
+        #     Conditions for automated stopping of a Study. Enable automated stopping by
+        #     configuring at least one condition.
         class StudySpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -561,6 +577,65 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # The configuration (stopping conditions) for automated stopping of a Study.
+          # Conditions include trial budgets, time budgets, and convergence detection.
+          # @!attribute [rw] should_stop_asap
+          #   @return [::Google::Protobuf::BoolValue]
+          #     If true, a Study enters STOPPING_ASAP whenever it would normally enters
+          #     STOPPING state.
+          #
+          #     The bottom line is: set to true if you want to interrupt on-going
+          #     evaluations of Trials as soon as the study stopping condition is met.
+          #     (Please see Study.State documentation for the source of truth).
+          # @!attribute [rw] minimum_runtime_constraint
+          #   @return [::Google::Cloud::AIPlatform::V1::StudyTimeConstraint]
+          #     Each "stopping rule" in this proto specifies an "if" condition. Before
+          #     Vizier would generate a new suggestion, it first checks each specified
+          #     stopping rule, from top to bottom in this list.
+          #     Note that the first few rules (e.g. minimum_runtime_constraint,
+          #     min_num_trials) will prevent other stopping rules from being evaluated
+          #     until they are met. For example, setting `min_num_trials=5` and
+          #     `always_stop_after= 1 hour` means that the Study will ONLY stop after it
+          #     has 5 COMPLETED trials, even if more than an hour has passed since its
+          #     creation. It follows the first applicable rule (whose "if" condition is
+          #     satisfied) to make a stopping decision. If none of the specified rules
+          #     are applicable, then Vizier decides that the study should not stop.
+          #     If Vizier decides that the study should stop, the study enters
+          #     STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
+          #     IMPORTANT: The automatic study state transition happens precisely as
+          #     described above; that is, deleting trials or updating StudyConfig NEVER
+          #     automatically moves the study state back to ACTIVE. If you want to
+          #     _resume_ a Study that was stopped, 1) change the stopping conditions if
+          #     necessary, 2) activate the study, and then 3) ask for suggestions.
+          #     If the specified time or duration has not passed, do not stop the
+          #     study.
+          # @!attribute [rw] maximum_runtime_constraint
+          #   @return [::Google::Cloud::AIPlatform::V1::StudyTimeConstraint]
+          #     If the specified time or duration has passed, stop the study.
+          # @!attribute [rw] min_num_trials
+          #   @return [::Google::Protobuf::Int32Value]
+          #     If there are fewer than this many COMPLETED trials, do not stop the
+          #     study.
+          # @!attribute [rw] max_num_trials
+          #   @return [::Google::Protobuf::Int32Value]
+          #     If there are more than this many trials, stop the study.
+          # @!attribute [rw] max_num_trials_no_progress
+          #   @return [::Google::Protobuf::Int32Value]
+          #     If the objective value has not improved for this many consecutive
+          #     trials, stop the study.
+          #
+          #     WARNING: Effective only for single-objective studies.
+          # @!attribute [rw] max_duration_no_progress
+          #   @return [::Google::Protobuf::Duration]
+          #     If the objective value has not improved for this much time, stop the
+          #     study.
+          #
+          #     WARNING: Effective only for single-objective studies.
+          class StudyStoppingConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The available search algorithms for the Study.
           module Algorithm
             # The default algorithm used by Vertex AI for [hyperparameter

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

@@ -221,7 +221,7 @@ module Google
         #     final component of the Tensorboard experiment's resource name.
         #
         #     This value should be 1-128 characters, and valid characters
-        #     are /[a-z][0-9]-/.
+        #     are `/[a-z][0-9]-/`.
         class CreateTensorboardExperimentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -367,7 +367,7 @@ module Google
         #     component of the Tensorboard run's resource name.
         #
         #     This value should be 1-128 characters, and valid characters
-        #     are /[a-z][0-9]-/.
+        #     are `/[a-z][0-9]-/`.
         class CreateTensorboardRunRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-ai_platform-v1
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.34.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2023-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -222,6 +222,20 @@ files:
 - lib/google/cloud/ai_platform/v1/endpoint_service/credentials.rb
 - lib/google/cloud/ai_platform/v1/endpoint_service/operations.rb
 - lib/google/cloud/ai_platform/v1/endpoint_service/paths.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/client.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/credentials.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/operations.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/paths.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_service.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_service/credentials.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_service/paths.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service/client.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service/credentials.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service/operations.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service/paths.rb
 - lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb
 - lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb
 - lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/credentials.rb
@@ -312,6 +326,7 @@ files:
 - lib/google/cloud/aiplatform/v1/dataset_pb.rb
 - lib/google/cloud/aiplatform/v1/dataset_service_pb.rb
 - lib/google/cloud/aiplatform/v1/dataset_service_services_pb.rb
+- lib/google/cloud/aiplatform/v1/dataset_version_pb.rb
 - lib/google/cloud/aiplatform/v1/deployed_index_ref_pb.rb
 - lib/google/cloud/aiplatform/v1/deployed_model_ref_pb.rb
 - lib/google/cloud/aiplatform/v1/encryption_spec_pb.rb
@@ -325,9 +340,19 @@ files:
 - lib/google/cloud/aiplatform/v1/execution_pb.rb
 - lib/google/cloud/aiplatform/v1/explanation_metadata_pb.rb
 - lib/google/cloud/aiplatform/v1/explanation_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_group_pb.rb
 - lib/google/cloud/aiplatform/v1/feature_monitoring_stats_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_admin_service_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_admin_service_services_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_service_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_service_services_pb.rb
 - lib/google/cloud/aiplatform/v1/feature_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_registry_service_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_registry_service_services_pb.rb
 - lib/google/cloud/aiplatform/v1/feature_selector_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_view_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_view_sync_pb.rb
 - lib/google/cloud/aiplatform/v1/featurestore_monitoring_pb.rb
 - lib/google/cloud/aiplatform/v1/featurestore_online_service_pb.rb
 - lib/google/cloud/aiplatform/v1/featurestore_online_service_services_pb.rb
@@ -417,6 +442,7 @@ files:
 - proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb
 - proto_docs/google/cloud/aiplatform/v1/dataset.rb
 - proto_docs/google/cloud/aiplatform/v1/dataset_service.rb
+- proto_docs/google/cloud/aiplatform/v1/dataset_version.rb
 - proto_docs/google/cloud/aiplatform/v1/deployed_index_ref.rb
 - proto_docs/google/cloud/aiplatform/v1/deployed_model_ref.rb
 - proto_docs/google/cloud/aiplatform/v1/encryption_spec.rb
@@ -430,8 +456,15 @@ files:
 - proto_docs/google/cloud/aiplatform/v1/explanation.rb
 - proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb
 - proto_docs/google/cloud/aiplatform/v1/feature.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_group.rb
 - proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_online_store.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_online_store_admin_service.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_online_store_service.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_registry_service.rb
 - proto_docs/google/cloud/aiplatform/v1/feature_selector.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_view.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_view_sync.rb
 - proto_docs/google/cloud/aiplatform/v1/featurestore.rb
 - proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb
 - proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb