google-apis-aiplatform_v1 0.17.0 → 0.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4097,6 +4097,31 @@ module Google
4097
4097
  end
4098
4098
  end
4099
4099
 
4100
+ # Details of operations that perform create PersistentResource.
4101
+ class GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata
4102
+ include Google::Apis::Core::Hashable
4103
+
4104
+ # Generic Metadata shared by all operations.
4105
+ # Corresponds to the JSON property `genericMetadata`
4106
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenericOperationMetadata]
4107
+ attr_accessor :generic_metadata
4108
+
4109
+ # Progress Message for Create LRO
4110
+ # Corresponds to the JSON property `progressMessage`
4111
+ # @return [String]
4112
+ attr_accessor :progress_message
4113
+
4114
+ def initialize(**args)
4115
+ update!(**args)
4116
+ end
4117
+
4118
+ # Update properties of this object
4119
+ def update!(**args)
4120
+ @generic_metadata = args[:generic_metadata] if args.key?(:generic_metadata)
4121
+ @progress_message = args[:progress_message] if args.key?(:progress_message)
4122
+ end
4123
+ end
4124
+
4100
4125
  # Request message for PipelineService.CreatePipelineJob.
4101
4126
  class GoogleCloudAiplatformV1CreatePipelineJobRequest
4102
4127
  include Google::Apis::Core::Hashable
@@ -4473,6 +4498,15 @@ module Google
4473
4498
  # @return [String]
4474
4499
  attr_accessor :network
4475
4500
 
4501
+ # Optional. The ID of the PersistentResource in the same Project and Location
4502
+ # which to run If this is specified, the job will be run on existing machines
4503
+ # held by the PersistentResource instead of on-demand short-live machines. The
4504
+ # network and CMEK configs on the job should be consistent with those on the
4505
+ # PersistentResource, otherwise, the job will be rejected.
4506
+ # Corresponds to the JSON property `persistentResourceId`
4507
+ # @return [String]
4508
+ attr_accessor :persistent_resource_id
4509
+
4476
4510
  # The ID of the location to store protected artifacts. e.g. us-central1.
4477
4511
  # Populate only when the location is different than CustomJob location. List of
4478
4512
  # supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
@@ -4528,6 +4562,7 @@ module Google
4528
4562
  @experiment_run = args[:experiment_run] if args.key?(:experiment_run)
4529
4563
  @models = args[:models] if args.key?(:models)
4530
4564
  @network = args[:network] if args.key?(:network)
4565
+ @persistent_resource_id = args[:persistent_resource_id] if args.key?(:persistent_resource_id)
4531
4566
  @protected_artifact_location_id = args[:protected_artifact_location_id] if args.key?(:protected_artifact_location_id)
4532
4567
  @reserved_ip_ranges = args[:reserved_ip_ranges] if args.key?(:reserved_ip_ranges)
4533
4568
  @scheduling = args[:scheduling] if args.key?(:scheduling)
@@ -6060,11 +6095,6 @@ module Google
6060
6095
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig]
6061
6096
  attr_accessor :predict_request_response_logging_config
6062
6097
 
6063
- # Represents configuration for private service connect.
6064
- # Corresponds to the JSON property `privateServiceConnectConfig`
6065
- # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PrivateServiceConnectConfig]
6066
- attr_accessor :private_service_connect_config
6067
-
6068
6098
  # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic
6069
6099
  # that should be forwarded to that DeployedModel. If a DeployedModel's ID is not
6070
6100
  # listed in this map, then it receives no traffic. The traffic percentage values
@@ -6097,7 +6127,6 @@ module Google
6097
6127
  @name = args[:name] if args.key?(:name)
6098
6128
  @network = args[:network] if args.key?(:network)
6099
6129
  @predict_request_response_logging_config = args[:predict_request_response_logging_config] if args.key?(:predict_request_response_logging_config)
6100
- @private_service_connect_config = args[:private_service_connect_config] if args.key?(:private_service_connect_config)
6101
6130
  @traffic_split = args[:traffic_split] if args.key?(:traffic_split)
6102
6131
  @update_time = args[:update_time] if args.key?(:update_time)
6103
6132
  end
@@ -9146,6 +9175,11 @@ module Google
9146
9175
  class GoogleCloudAiplatformV1FetchFeatureValuesResponse
9147
9176
  include Google::Apis::Core::Hashable
9148
9177
 
9178
+ # Lookup key for a feature view.
9179
+ # Corresponds to the JSON property `dataKey`
9180
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureViewDataKey]
9181
+ attr_accessor :data_key
9182
+
9149
9183
  # Response structure in the format of key (feature name) and (feature) value
9150
9184
  # pair.
9151
9185
  # Corresponds to the JSON property `keyValues`
@@ -9163,6 +9197,7 @@ module Google
9163
9197
 
9164
9198
  # Update properties of this object
9165
9199
  def update!(**args)
9200
+ @data_key = args[:data_key] if args.key?(:data_key)
9166
9201
  @key_values = args[:key_values] if args.key?(:key_values)
9167
9202
  @proto_struct = args[:proto_struct] if args.key?(:proto_struct)
9168
9203
  end
@@ -9529,8 +9564,8 @@ module Google
9529
9564
  attr_accessor :description
9530
9565
 
9531
9566
  # Required. The name of the function to call. Must start with a letter or an
9532
- # underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a
9533
- # maximum length of 64.
9567
+ # underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes,
9568
+ # with a maximum length of 64.
9534
9569
  # Corresponds to the JSON property `name`
9535
9570
  # @return [String]
9536
9571
  attr_accessor :name
@@ -9864,6 +9899,28 @@ module Google
9864
9899
  end
9865
9900
  end
9866
9901
 
9902
+ # Tool to retrieve public web data for grounding, powered by Google.
9903
+ class GoogleCloudAiplatformV1GoogleSearchRetrieval
9904
+ include Google::Apis::Core::Hashable
9905
+
9906
+ # Optional. Disable using the result from this tool in detecting grounding
9907
+ # attribution. This does not affect how the result is given to the model for
9908
+ # generation.
9909
+ # Corresponds to the JSON property `disableAttribution`
9910
+ # @return [Boolean]
9911
+ attr_accessor :disable_attribution
9912
+ alias_method :disable_attribution?, :disable_attribution
9913
+
9914
+ def initialize(**args)
9915
+ update!(**args)
9916
+ end
9917
+
9918
+ # Update properties of this object
9919
+ def update!(**args)
9920
+ @disable_attribution = args[:disable_attribution] if args.key?(:disable_attribution)
9921
+ end
9922
+ end
9923
+
9867
9924
  # Grounding attribution.
9868
9925
  class GoogleCloudAiplatformV1GroundingAttribution
9869
9926
  include Google::Apis::Core::Hashable
@@ -12028,6 +12085,32 @@ module Google
12028
12085
  end
12029
12086
  end
12030
12087
 
12088
+ # Response message for PersistentResourceService.ListPersistentResources
12089
+ class GoogleCloudAiplatformV1ListPersistentResourcesResponse
12090
+ include Google::Apis::Core::Hashable
12091
+
12092
+ # A token to retrieve next page of results. Pass to
12093
+ # ListPersistentResourcesRequest.page_token to obtain that page.
12094
+ # Corresponds to the JSON property `nextPageToken`
12095
+ # @return [String]
12096
+ attr_accessor :next_page_token
12097
+
12098
+ #
12099
+ # Corresponds to the JSON property `persistentResources`
12100
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentResource>]
12101
+ attr_accessor :persistent_resources
12102
+
12103
+ def initialize(**args)
12104
+ update!(**args)
12105
+ end
12106
+
12107
+ # Update properties of this object
12108
+ def update!(**args)
12109
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
12110
+ @persistent_resources = args[:persistent_resources] if args.key?(:persistent_resources)
12111
+ end
12112
+ end
12113
+
12031
12114
  # Response message for PipelineService.ListPipelineJobs
12032
12115
  class GoogleCloudAiplatformV1ListPipelineJobsResponse
12033
12116
  include Google::Apis::Core::Hashable
@@ -16158,6 +16241,131 @@ module Google
16158
16241
  end
16159
16242
  end
16160
16243
 
16244
+ # Represents long-lasting resources that are dedicated to users to runs custom
16245
+ # workloads. A PersistentResource can have multiple node pools and each node
16246
+ # pool can have its own machine spec.
16247
+ class GoogleCloudAiplatformV1PersistentResource
16248
+ include Google::Apis::Core::Hashable
16249
+
16250
+ # Output only. Time when the PersistentResource was created.
16251
+ # Corresponds to the JSON property `createTime`
16252
+ # @return [String]
16253
+ attr_accessor :create_time
16254
+
16255
+ # Optional. The display name of the PersistentResource. The name can be up to
16256
+ # 128 characters long and can consist of any UTF-8 characters.
16257
+ # Corresponds to the JSON property `displayName`
16258
+ # @return [String]
16259
+ attr_accessor :display_name
16260
+
16261
+ # Represents a customer-managed encryption key spec that can be applied to a top-
16262
+ # level resource.
16263
+ # Corresponds to the JSON property `encryptionSpec`
16264
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec]
16265
+ attr_accessor :encryption_spec
16266
+
16267
+ # The `Status` type defines a logical error model that is suitable for different
16268
+ # programming environments, including REST APIs and RPC APIs. It is used by [
16269
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
16270
+ # data: error code, error message, and error details. You can find out more
16271
+ # about this error model and how to work with it in the [API Design Guide](https:
16272
+ # //cloud.google.com/apis/design/errors).
16273
+ # Corresponds to the JSON property `error`
16274
+ # @return [Google::Apis::AiplatformV1::GoogleRpcStatus]
16275
+ attr_accessor :error
16276
+
16277
+ # Optional. The labels with user-defined metadata to organize PersistentResource.
16278
+ # Label keys and values can be no longer than 64 characters (Unicode codepoints)
16279
+ # , can only contain lowercase letters, numeric characters, underscores and
16280
+ # dashes. International characters are allowed. See https://goo.gl/xmQnxf for
16281
+ # more information and examples of labels.
16282
+ # Corresponds to the JSON property `labels`
16283
+ # @return [Hash<String,String>]
16284
+ attr_accessor :labels
16285
+
16286
+ # Immutable. Resource name of a PersistentResource.
16287
+ # Corresponds to the JSON property `name`
16288
+ # @return [String]
16289
+ attr_accessor :name
16290
+
16291
+ # Optional. The full name of the Compute Engine [network](/compute/docs/networks-
16292
+ # and-firewalls#networks) to peered with Vertex AI to host the persistent
16293
+ # resources. For example, `projects/12345/global/networks/myVPC`. [Format](/
16294
+ # compute/docs/reference/rest/v1/networks/insert) is of the form `projects/`
16295
+ # project`/global/networks/`network``. Where `project` is a project number, as
16296
+ # in `12345`, and `network` is a network name. To specify this field, you must
16297
+ # have already [configured VPC Network Peering for Vertex AI](https://cloud.
16298
+ # google.com/vertex-ai/docs/general/vpc-peering). If this field is left
16299
+ # unspecified, the resources aren't peered with any network.
16300
+ # Corresponds to the JSON property `network`
16301
+ # @return [String]
16302
+ attr_accessor :network
16303
+
16304
+ # Optional. A list of names for the reserved IP ranges under the VPC network
16305
+ # that can be used for this persistent resource. If set, we will deploy the
16306
+ # persistent resource within the provided IP ranges. Otherwise, the persistent
16307
+ # resource is deployed to any IP ranges under the provided VPC network. Example:
16308
+ # ['vertex-ai-ip-range'].
16309
+ # Corresponds to the JSON property `reservedIpRanges`
16310
+ # @return [Array<String>]
16311
+ attr_accessor :reserved_ip_ranges
16312
+
16313
+ # Required. The spec of the pools of different resources.
16314
+ # Corresponds to the JSON property `resourcePools`
16315
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResourcePool>]
16316
+ attr_accessor :resource_pools
16317
+
16318
+ # Persistent Cluster runtime information as output
16319
+ # Corresponds to the JSON property `resourceRuntime`
16320
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResourceRuntime]
16321
+ attr_accessor :resource_runtime
16322
+
16323
+ # Configuration for the runtime on a PersistentResource instance, including but
16324
+ # not limited to: * Service accounts used to run the workloads. * Whether to
16325
+ # make it a dedicated Ray Cluster.
16326
+ # Corresponds to the JSON property `resourceRuntimeSpec`
16327
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResourceRuntimeSpec]
16328
+ attr_accessor :resource_runtime_spec
16329
+
16330
+ # Output only. Time when the PersistentResource for the first time entered the `
16331
+ # RUNNING` state.
16332
+ # Corresponds to the JSON property `startTime`
16333
+ # @return [String]
16334
+ attr_accessor :start_time
16335
+
16336
+ # Output only. The detailed state of a Study.
16337
+ # Corresponds to the JSON property `state`
16338
+ # @return [String]
16339
+ attr_accessor :state
16340
+
16341
+ # Output only. Time when the PersistentResource was most recently updated.
16342
+ # Corresponds to the JSON property `updateTime`
16343
+ # @return [String]
16344
+ attr_accessor :update_time
16345
+
16346
+ def initialize(**args)
16347
+ update!(**args)
16348
+ end
16349
+
16350
+ # Update properties of this object
16351
+ def update!(**args)
16352
+ @create_time = args[:create_time] if args.key?(:create_time)
16353
+ @display_name = args[:display_name] if args.key?(:display_name)
16354
+ @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
16355
+ @error = args[:error] if args.key?(:error)
16356
+ @labels = args[:labels] if args.key?(:labels)
16357
+ @name = args[:name] if args.key?(:name)
16358
+ @network = args[:network] if args.key?(:network)
16359
+ @reserved_ip_ranges = args[:reserved_ip_ranges] if args.key?(:reserved_ip_ranges)
16360
+ @resource_pools = args[:resource_pools] if args.key?(:resource_pools)
16361
+ @resource_runtime = args[:resource_runtime] if args.key?(:resource_runtime)
16362
+ @resource_runtime_spec = args[:resource_runtime_spec] if args.key?(:resource_runtime_spec)
16363
+ @start_time = args[:start_time] if args.key?(:start_time)
16364
+ @state = args[:state] if args.key?(:state)
16365
+ @update_time = args[:update_time] if args.key?(:update_time)
16366
+ end
16367
+ end
16368
+
16161
16369
  # An instance of a machine learning PipelineJob.
16162
16370
  class GoogleCloudAiplatformV1PipelineJob
16163
16371
  include Google::Apis::Core::Hashable
@@ -17208,6 +17416,11 @@ module Google
17208
17416
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke]
17209
17417
  attr_accessor :deploy_gke
17210
17418
 
17419
+ # Multiple setups to deploy the PublisherModel.
17420
+ # Corresponds to the JSON property `multiDeployVertex`
17421
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex]
17422
+ attr_accessor :multi_deploy_vertex
17423
+
17211
17424
  # The regional resource name or the URI. Key is region, e.g., us-central1,
17212
17425
  # europe-west2, global, etc..
17213
17426
  # Corresponds to the JSON property `openEvaluationPipeline`
@@ -17274,6 +17487,7 @@ module Google
17274
17487
  @create_application = args[:create_application] if args.key?(:create_application)
17275
17488
  @deploy = args[:deploy] if args.key?(:deploy)
17276
17489
  @deploy_gke = args[:deploy_gke] if args.key?(:deploy_gke)
17490
+ @multi_deploy_vertex = args[:multi_deploy_vertex] if args.key?(:multi_deploy_vertex)
17277
17491
  @open_evaluation_pipeline = args[:open_evaluation_pipeline] if args.key?(:open_evaluation_pipeline)
17278
17492
  @open_fine_tuning_pipeline = args[:open_fine_tuning_pipeline] if args.key?(:open_fine_tuning_pipeline)
17279
17493
  @open_fine_tuning_pipelines = args[:open_fine_tuning_pipelines] if args.key?(:open_fine_tuning_pipelines)
@@ -17383,6 +17597,25 @@ module Google
17383
17597
  end
17384
17598
  end
17385
17599
 
17600
+ # Multiple setups to deploy the PublisherModel.
17601
+ class GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex
17602
+ include Google::Apis::Core::Hashable
17603
+
17604
+ # Optional. One click deployment configurations.
17605
+ # Corresponds to the JSON property `multiDeployVertex`
17606
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PublisherModelCallToActionDeploy>]
17607
+ attr_accessor :multi_deploy_vertex
17608
+
17609
+ def initialize(**args)
17610
+ update!(**args)
17611
+ end
17612
+
17613
+ # Update properties of this object
17614
+ def update!(**args)
17615
+ @multi_deploy_vertex = args[:multi_deploy_vertex] if args.key?(:multi_deploy_vertex)
17616
+ end
17617
+ end
17618
+
17386
17619
  # Open fine tuning pipelines.
17387
17620
  class GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines
17388
17621
  include Google::Apis::Core::Hashable
@@ -17908,6 +18141,76 @@ module Google
17908
18141
  end
17909
18142
  end
17910
18143
 
18144
+ # Configuration for the Ray metrics.
18145
+ class GoogleCloudAiplatformV1RayMetricSpec
18146
+ include Google::Apis::Core::Hashable
18147
+
18148
+ # Optional. Flag to disable the Ray metrics collection.
18149
+ # Corresponds to the JSON property `disabled`
18150
+ # @return [Boolean]
18151
+ attr_accessor :disabled
18152
+ alias_method :disabled?, :disabled
18153
+
18154
+ def initialize(**args)
18155
+ update!(**args)
18156
+ end
18157
+
18158
+ # Update properties of this object
18159
+ def update!(**args)
18160
+ @disabled = args[:disabled] if args.key?(:disabled)
18161
+ end
18162
+ end
18163
+
18164
+ # Configuration information for the Ray cluster. For experimental launch, Ray
18165
+ # cluster creation and Persistent cluster creation are 1:1 mapping: We will
18166
+ # provision all the nodes within the Persistent cluster as Ray nodes.
18167
+ class GoogleCloudAiplatformV1RaySpec
18168
+ include Google::Apis::Core::Hashable
18169
+
18170
+ # Optional. This will be used to indicate which resource pool will serve as the
18171
+ # Ray head node(the first node within that pool). Will use the machine from the
18172
+ # first workerpool as the head node by default if this field isn't set.
18173
+ # Corresponds to the JSON property `headNodeResourcePoolId`
18174
+ # @return [String]
18175
+ attr_accessor :head_node_resource_pool_id
18176
+
18177
+ # Optional. Default image for user to choose a preferred ML framework (for
18178
+ # example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](
18179
+ # https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either
18180
+ # this or the resource_pool_images is required. Use this field if you need all
18181
+ # the resource pools to have the same Ray image. Otherwise, use the `@code
18182
+ # resource_pool_images` field.
18183
+ # Corresponds to the JSON property `imageUri`
18184
+ # @return [String]
18185
+ attr_accessor :image_uri
18186
+
18187
+ # Configuration for the Ray metrics.
18188
+ # Corresponds to the JSON property `rayMetricSpec`
18189
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RayMetricSpec]
18190
+ attr_accessor :ray_metric_spec
18191
+
18192
+ # Optional. Required if image_uri isn't set. A map of resource_pool_id to
18193
+ # prebuild Ray image if user need to use different images for different head/
18194
+ # worker pools. This map needs to cover all the resource pool ids. Example: ` "
18195
+ # ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "
18196
+ # ray_worker_node_pool2": "another worker image" `
18197
+ # Corresponds to the JSON property `resourcePoolImages`
18198
+ # @return [Hash<String,String>]
18199
+ attr_accessor :resource_pool_images
18200
+
18201
+ def initialize(**args)
18202
+ update!(**args)
18203
+ end
18204
+
18205
+ # Update properties of this object
18206
+ def update!(**args)
18207
+ @head_node_resource_pool_id = args[:head_node_resource_pool_id] if args.key?(:head_node_resource_pool_id)
18208
+ @image_uri = args[:image_uri] if args.key?(:image_uri)
18209
+ @ray_metric_spec = args[:ray_metric_spec] if args.key?(:ray_metric_spec)
18210
+ @resource_pool_images = args[:resource_pool_images] if args.key?(:resource_pool_images)
18211
+ end
18212
+ end
18213
+
17911
18214
  # Request message for FeaturestoreOnlineServingService.ReadFeatureValues.
17912
18215
  class GoogleCloudAiplatformV1ReadFeatureValuesRequest
17913
18216
  include Google::Apis::Core::Hashable
@@ -18226,6 +18529,44 @@ module Google
18226
18529
  end
18227
18530
  end
18228
18531
 
18532
+ # Details of operations that perform reboot PersistentResource.
18533
+ class GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata
18534
+ include Google::Apis::Core::Hashable
18535
+
18536
+ # Generic Metadata shared by all operations.
18537
+ # Corresponds to the JSON property `genericMetadata`
18538
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenericOperationMetadata]
18539
+ attr_accessor :generic_metadata
18540
+
18541
+ # Progress Message for Reboot LRO
18542
+ # Corresponds to the JSON property `progressMessage`
18543
+ # @return [String]
18544
+ attr_accessor :progress_message
18545
+
18546
+ def initialize(**args)
18547
+ update!(**args)
18548
+ end
18549
+
18550
+ # Update properties of this object
18551
+ def update!(**args)
18552
+ @generic_metadata = args[:generic_metadata] if args.key?(:generic_metadata)
18553
+ @progress_message = args[:progress_message] if args.key?(:progress_message)
18554
+ end
18555
+ end
18556
+
18557
+ # Request message for PersistentResourceService.RebootPersistentResource.
18558
+ class GoogleCloudAiplatformV1RebootPersistentResourceRequest
18559
+ include Google::Apis::Core::Hashable
18560
+
18561
+ def initialize(**args)
18562
+ update!(**args)
18563
+ end
18564
+
18565
+ # Update properties of this object
18566
+ def update!(**args)
18567
+ end
18568
+ end
18569
+
18229
18570
  # Request message for MetadataService.DeleteContextChildrenRequest.
18230
18571
  class GoogleCloudAiplatformV1RemoveContextChildrenRequest
18231
18572
  include Google::Apis::Core::Hashable
@@ -18290,6 +18631,145 @@ module Google
18290
18631
  end
18291
18632
  end
18292
18633
 
18634
+ # Represents the spec of a group of resources of the same type, for example
18635
+ # machine type, disk, and accelerators, in a PersistentResource.
18636
+ class GoogleCloudAiplatformV1ResourcePool
18637
+ include Google::Apis::Core::Hashable
18638
+
18639
+ # The min/max number of replicas allowed if enabling autoscaling
18640
+ # Corresponds to the JSON property `autoscalingSpec`
18641
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec]
18642
+ attr_accessor :autoscaling_spec
18643
+
18644
+ # Represents the spec of disk options.
18645
+ # Corresponds to the JSON property `diskSpec`
18646
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DiskSpec]
18647
+ attr_accessor :disk_spec
18648
+
18649
+ # Immutable. The unique ID in a PersistentResource for referring to this
18650
+ # resource pool. User can specify it if necessary. Otherwise, it's generated
18651
+ # automatically.
18652
+ # Corresponds to the JSON property `id`
18653
+ # @return [String]
18654
+ attr_accessor :id
18655
+
18656
+ # Specification of a single machine.
18657
+ # Corresponds to the JSON property `machineSpec`
18658
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MachineSpec]
18659
+ attr_accessor :machine_spec
18660
+
18661
+ # Optional. The total number of machines to use for this resource pool.
18662
+ # Corresponds to the JSON property `replicaCount`
18663
+ # @return [Fixnum]
18664
+ attr_accessor :replica_count
18665
+
18666
+ # Output only. The number of machines currently in use by training jobs for this
18667
+ # resource pool. Will replace idle_replica_count.
18668
+ # Corresponds to the JSON property `usedReplicaCount`
18669
+ # @return [Fixnum]
18670
+ attr_accessor :used_replica_count
18671
+
18672
+ def initialize(**args)
18673
+ update!(**args)
18674
+ end
18675
+
18676
+ # Update properties of this object
18677
+ def update!(**args)
18678
+ @autoscaling_spec = args[:autoscaling_spec] if args.key?(:autoscaling_spec)
18679
+ @disk_spec = args[:disk_spec] if args.key?(:disk_spec)
18680
+ @id = args[:id] if args.key?(:id)
18681
+ @machine_spec = args[:machine_spec] if args.key?(:machine_spec)
18682
+ @replica_count = args[:replica_count] if args.key?(:replica_count)
18683
+ @used_replica_count = args[:used_replica_count] if args.key?(:used_replica_count)
18684
+ end
18685
+ end
18686
+
18687
+ # The min/max number of replicas allowed if enabling autoscaling
18688
+ class GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec
18689
+ include Google::Apis::Core::Hashable
18690
+
18691
+ # Optional. max replicas in the node pool, must be ≥ replica_count and >
18692
+ # min_replica_count or will throw error
18693
+ # Corresponds to the JSON property `maxReplicaCount`
18694
+ # @return [Fixnum]
18695
+ attr_accessor :max_replica_count
18696
+
18697
+ # Optional. min replicas in the node pool, must be ≤ replica_count and <
18698
+ # max_replica_count or will throw error
18699
+ # Corresponds to the JSON property `minReplicaCount`
18700
+ # @return [Fixnum]
18701
+ attr_accessor :min_replica_count
18702
+
18703
+ def initialize(**args)
18704
+ update!(**args)
18705
+ end
18706
+
18707
+ # Update properties of this object
18708
+ def update!(**args)
18709
+ @max_replica_count = args[:max_replica_count] if args.key?(:max_replica_count)
18710
+ @min_replica_count = args[:min_replica_count] if args.key?(:min_replica_count)
18711
+ end
18712
+ end
18713
+
18714
+ # Persistent Cluster runtime information as output
18715
+ class GoogleCloudAiplatformV1ResourceRuntime
18716
+ include Google::Apis::Core::Hashable
18717
+
18718
+ # Output only. URIs for user to connect to the Cluster. Example: ` "
18719
+ # RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-
18720
+ # dashboard-address:8888" `
18721
+ # Corresponds to the JSON property `accessUris`
18722
+ # @return [Hash<String,String>]
18723
+ attr_accessor :access_uris
18724
+
18725
+ # Output only. The resource name of NotebookRuntimeTemplate for the RoV
18726
+ # Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if
18727
+ # set), and with the same Ray and Python version as the Persistent Cluster.
18728
+ # Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
18729
+ # Corresponds to the JSON property `notebookRuntimeTemplate`
18730
+ # @return [String]
18731
+ attr_accessor :notebook_runtime_template
18732
+
18733
+ def initialize(**args)
18734
+ update!(**args)
18735
+ end
18736
+
18737
+ # Update properties of this object
18738
+ def update!(**args)
18739
+ @access_uris = args[:access_uris] if args.key?(:access_uris)
18740
+ @notebook_runtime_template = args[:notebook_runtime_template] if args.key?(:notebook_runtime_template)
18741
+ end
18742
+ end
18743
+
18744
+ # Configuration for the runtime on a PersistentResource instance, including but
18745
+ # not limited to: * Service accounts used to run the workloads. * Whether to
18746
+ # make it a dedicated Ray Cluster.
18747
+ class GoogleCloudAiplatformV1ResourceRuntimeSpec
18748
+ include Google::Apis::Core::Hashable
18749
+
18750
+ # Configuration information for the Ray cluster. For experimental launch, Ray
18751
+ # cluster creation and Persistent cluster creation are 1:1 mapping: We will
18752
+ # provision all the nodes within the Persistent cluster as Ray nodes.
18753
+ # Corresponds to the JSON property `raySpec`
18754
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RaySpec]
18755
+ attr_accessor :ray_spec
18756
+
18757
+ # Configuration for the use of custom service account to run the workloads.
18758
+ # Corresponds to the JSON property `serviceAccountSpec`
18759
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ServiceAccountSpec]
18760
+ attr_accessor :service_account_spec
18761
+
18762
+ def initialize(**args)
18763
+ update!(**args)
18764
+ end
18765
+
18766
+ # Update properties of this object
18767
+ def update!(**args)
18768
+ @ray_spec = args[:ray_spec] if args.key?(:ray_spec)
18769
+ @service_account_spec = args[:service_account_spec] if args.key?(:service_account_spec)
18770
+ end
18771
+ end
18772
+
18293
18773
  # Statistics information about resource consumption.
18294
18774
  class GoogleCloudAiplatformV1ResourcesConsumed
18295
18775
  include Google::Apis::Core::Hashable
@@ -18366,6 +18846,35 @@ module Google
18366
18846
  end
18367
18847
  end
18368
18848
 
18849
+ # Defines a retrieval tool that model can call to access external knowledge.
18850
+ class GoogleCloudAiplatformV1Retrieval
18851
+ include Google::Apis::Core::Hashable
18852
+
18853
+ # Optional. Disable using the result from this tool in detecting grounding
18854
+ # attribution. This does not affect how the result is given to the model for
18855
+ # generation.
18856
+ # Corresponds to the JSON property `disableAttribution`
18857
+ # @return [Boolean]
18858
+ attr_accessor :disable_attribution
18859
+ alias_method :disable_attribution?, :disable_attribution
18860
+
18861
+ # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.
18862
+ # google.com/vertex-ai-search-and-conversation
18863
+ # Corresponds to the JSON property `vertexAiSearch`
18864
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VertexAiSearch]
18865
+ attr_accessor :vertex_ai_search
18866
+
18867
+ def initialize(**args)
18868
+ update!(**args)
18869
+ end
18870
+
18871
+ # Update properties of this object
18872
+ def update!(**args)
18873
+ @disable_attribution = args[:disable_attribution] if args.key?(:disable_attribution)
18874
+ @vertex_ai_search = args[:vertex_ai_search] if args.key?(:vertex_ai_search)
18875
+ end
18876
+ end
18877
+
18369
18878
  # Safety rating corresponding to the generated content.
18370
18879
  class GoogleCloudAiplatformV1SafetyRating
18371
18880
  include Google::Apis::Core::Hashable
@@ -18426,6 +18935,12 @@ module Google
18426
18935
  # @return [String]
18427
18936
  attr_accessor :category
18428
18937
 
18938
+ # Optional. Specify if the threshold is used for probability or severity score.
18939
+ # If not specified, the threshold is used for probability score.
18940
+ # Corresponds to the JSON property `method`
18941
+ # @return [String]
18942
+ attr_accessor :method_prop
18943
+
18429
18944
  # Required. The harm block threshold.
18430
18945
  # Corresponds to the JSON property `threshold`
18431
18946
  # @return [String]
@@ -18438,6 +18953,7 @@ module Google
18438
18953
  # Update properties of this object
18439
18954
  def update!(**args)
18440
18955
  @category = args[:category] if args.key?(:category)
18956
+ @method_prop = args[:method_prop] if args.key?(:method_prop)
18441
18957
  @threshold = args[:threshold] if args.key?(:threshold)
18442
18958
  end
18443
18959
  end
@@ -18852,6 +19368,11 @@ module Google
18852
19368
  class GoogleCloudAiplatformV1Schema
18853
19369
  include Google::Apis::Core::Hashable
18854
19370
 
19371
+ # Optional. Default value of the data.
19372
+ # Corresponds to the JSON property `default`
19373
+ # @return [Object]
19374
+ attr_accessor :default
19375
+
18855
19376
  # Optional. The description of the data.
18856
19377
  # Corresponds to the JSON property `description`
18857
19378
  # @return [String]
@@ -18870,8 +19391,9 @@ module Google
18870
19391
  # @return [Object]
18871
19392
  attr_accessor :example
18872
19393
 
18873
- # Optional. The format of the data. Supported formats: for NUMBER type: float,
18874
- # double for INTEGER type: int32, int64
19394
+ # Optional. The format of the data. Supported formats: for NUMBER type: "float",
19395
+ # "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte",
19396
+ # etc
18875
19397
  # Corresponds to the JSON property `format`
18876
19398
  # @return [String]
18877
19399
  attr_accessor :format
@@ -18883,13 +19405,60 @@ module Google
18883
19405
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema]
18884
19406
  attr_accessor :items
18885
19407
 
19408
+ # Optional. Maximum number of the elements for Type.ARRAY.
19409
+ # Corresponds to the JSON property `maxItems`
19410
+ # @return [Fixnum]
19411
+ attr_accessor :max_items
19412
+
19413
+ # Optional. Maximum length of the Type.STRING
19414
+ # Corresponds to the JSON property `maxLength`
19415
+ # @return [Fixnum]
19416
+ attr_accessor :max_length
19417
+
19418
+ # Optional. Maximum number of the properties for Type.OBJECT.
19419
+ # Corresponds to the JSON property `maxProperties`
19420
+ # @return [Fixnum]
19421
+ attr_accessor :max_properties
19422
+
19423
+ # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
19424
+ # Corresponds to the JSON property `maximum`
19425
+ # @return [Float]
19426
+ attr_accessor :maximum
19427
+
19428
+ # Optional. Minimum number of the elements for Type.ARRAY.
19429
+ # Corresponds to the JSON property `minItems`
19430
+ # @return [Fixnum]
19431
+ attr_accessor :min_items
19432
+
19433
+ # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
19434
+ # Corresponds to the JSON property `minLength`
19435
+ # @return [Fixnum]
19436
+ attr_accessor :min_length
19437
+
19438
+ # Optional. Minimum number of the properties for Type.OBJECT.
19439
+ # Corresponds to the JSON property `minProperties`
19440
+ # @return [Fixnum]
19441
+ attr_accessor :min_properties
19442
+
19443
+ # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.
19444
+ # INTEGER and Type.NUMBER
19445
+ # Corresponds to the JSON property `minimum`
19446
+ # @return [Float]
19447
+ attr_accessor :minimum
19448
+
18886
19449
  # Optional. Indicates if the value may be null.
18887
19450
  # Corresponds to the JSON property `nullable`
18888
19451
  # @return [Boolean]
18889
19452
  attr_accessor :nullable
18890
19453
  alias_method :nullable?, :nullable
18891
19454
 
18892
- # Optional. Properties of Type.OBJECT.
19455
+ # Optional. Pattern of the Type.STRING to restrict a string to a regular
19456
+ # expression.
19457
+ # Corresponds to the JSON property `pattern`
19458
+ # @return [String]
19459
+ attr_accessor :pattern
19460
+
19461
+ # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
18893
19462
  # Corresponds to the JSON property `properties`
18894
19463
  # @return [Hash<String,Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema>]
18895
19464
  attr_accessor :properties
@@ -18899,6 +19468,11 @@ module Google
18899
19468
  # @return [Array<String>]
18900
19469
  attr_accessor :required
18901
19470
 
19471
+ # Optional. The title of the Schema.
19472
+ # Corresponds to the JSON property `title`
19473
+ # @return [String]
19474
+ attr_accessor :title
19475
+
18902
19476
  # Optional. The type of the data.
18903
19477
  # Corresponds to the JSON property `type`
18904
19478
  # @return [String]
@@ -18910,14 +19484,25 @@ module Google
18910
19484
 
18911
19485
  # Update properties of this object
18912
19486
  def update!(**args)
19487
+ @default = args[:default] if args.key?(:default)
18913
19488
  @description = args[:description] if args.key?(:description)
18914
19489
  @enum = args[:enum] if args.key?(:enum)
18915
19490
  @example = args[:example] if args.key?(:example)
18916
19491
  @format = args[:format] if args.key?(:format)
18917
19492
  @items = args[:items] if args.key?(:items)
19493
+ @max_items = args[:max_items] if args.key?(:max_items)
19494
+ @max_length = args[:max_length] if args.key?(:max_length)
19495
+ @max_properties = args[:max_properties] if args.key?(:max_properties)
19496
+ @maximum = args[:maximum] if args.key?(:maximum)
19497
+ @min_items = args[:min_items] if args.key?(:min_items)
19498
+ @min_length = args[:min_length] if args.key?(:min_length)
19499
+ @min_properties = args[:min_properties] if args.key?(:min_properties)
19500
+ @minimum = args[:minimum] if args.key?(:minimum)
18918
19501
  @nullable = args[:nullable] if args.key?(:nullable)
19502
+ @pattern = args[:pattern] if args.key?(:pattern)
18919
19503
  @properties = args[:properties] if args.key?(:properties)
18920
19504
  @required = args[:required] if args.key?(:required)
19505
+ @title = args[:title] if args.key?(:title)
18921
19506
  @type = args[:type] if args.key?(:type)
18922
19507
  end
18923
19508
  end
@@ -25262,6 +25847,41 @@ module Google
25262
25847
  end
25263
25848
  end
25264
25849
 
25850
+ # Configuration for the use of custom service account to run the workloads.
25851
+ class GoogleCloudAiplatformV1ServiceAccountSpec
25852
+ include Google::Apis::Core::Hashable
25853
+
25854
+ # Required. If true, custom user-managed service account is enforced to run any
25855
+ # workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [
25856
+ # Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/
25857
+ # general/access-control#service-agents).
25858
+ # Corresponds to the JSON property `enableCustomServiceAccount`
25859
+ # @return [Boolean]
25860
+ attr_accessor :enable_custom_service_account
25861
+ alias_method :enable_custom_service_account?, :enable_custom_service_account
25862
+
25863
+ # Optional. Default service account that this PersistentResource's workloads run
25864
+ # as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec`
25865
+ # on creation time, for example, Ray. * Jobs submitted to PersistentResource, if
25866
+ # no other service account specified in the job specs. Only works when custom
25867
+ # service account is enabled and users have the `iam.serviceAccounts.actAs`
25868
+ # permission on this service account. Required if any containers are specified
25869
+ # in `ResourceRuntimeSpec`.
25870
+ # Corresponds to the JSON property `serviceAccount`
25871
+ # @return [String]
25872
+ attr_accessor :service_account
25873
+
25874
+ def initialize(**args)
25875
+ update!(**args)
25876
+ end
25877
+
25878
+ # Update properties of this object
25879
+ def update!(**args)
25880
+ @enable_custom_service_account = args[:enable_custom_service_account] if args.key?(:enable_custom_service_account)
25881
+ @service_account = args[:service_account] if args.key?(:service_account)
25882
+ end
25883
+ end
25884
+
25265
25885
  # A set of Shielded Instance options. See [Images using supported Shielded VM
25266
25886
  # features](https://cloud.google.com/compute/docs/instances/modifying-shielded-
25267
25887
  # vm).
@@ -27220,6 +27840,16 @@ module Google
27220
27840
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionDeclaration>]
27221
27841
  attr_accessor :function_declarations
27222
27842
 
27843
+ # Tool to retrieve public web data for grounding, powered by Google.
27844
+ # Corresponds to the JSON property `googleSearchRetrieval`
27845
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GoogleSearchRetrieval]
27846
+ attr_accessor :google_search_retrieval
27847
+
27848
+ # Defines a retrieval tool that model can call to access external knowledge.
27849
+ # Corresponds to the JSON property `retrieval`
27850
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Retrieval]
27851
+ attr_accessor :retrieval
27852
+
27223
27853
  def initialize(**args)
27224
27854
  update!(**args)
27225
27855
  end
@@ -27227,6 +27857,8 @@ module Google
27227
27857
  # Update properties of this object
27228
27858
  def update!(**args)
27229
27859
  @function_declarations = args[:function_declarations] if args.key?(:function_declarations)
27860
+ @google_search_retrieval = args[:google_search_retrieval] if args.key?(:google_search_retrieval)
27861
+ @retrieval = args[:retrieval] if args.key?(:retrieval)
27230
27862
  end
27231
27863
  end
27232
27864
 
@@ -27927,6 +28559,31 @@ module Google
27927
28559
  end
27928
28560
  end
27929
28561
 
28562
+ # Details of operations that perform update PersistentResource.
28563
+ class GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata
28564
+ include Google::Apis::Core::Hashable
28565
+
28566
+ # Generic Metadata shared by all operations.
28567
+ # Corresponds to the JSON property `genericMetadata`
28568
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenericOperationMetadata]
28569
+ attr_accessor :generic_metadata
28570
+
28571
+ # Progress Message for Update LRO
28572
+ # Corresponds to the JSON property `progressMessage`
28573
+ # @return [String]
28574
+ attr_accessor :progress_message
28575
+
28576
+ def initialize(**args)
28577
+ update!(**args)
28578
+ end
28579
+
28580
+ # Update properties of this object
28581
+ def update!(**args)
28582
+ @generic_metadata = args[:generic_metadata] if args.key?(:generic_metadata)
28583
+ @progress_message = args[:progress_message] if args.key?(:progress_message)
28584
+ end
28585
+ end
28586
+
27930
28587
  # Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.
27931
28588
  class GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata
27932
28589
  include Google::Apis::Core::Hashable
@@ -28213,6 +28870,28 @@ module Google
28213
28870
  end
28214
28871
  end
28215
28872
 
28873
+ # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.
28874
+ # google.com/vertex-ai-search-and-conversation
28875
+ class GoogleCloudAiplatformV1VertexAiSearch
28876
+ include Google::Apis::Core::Hashable
28877
+
28878
+ # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format:
28879
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
28880
+ # dataStore`
28881
+ # Corresponds to the JSON property `datastore`
28882
+ # @return [String]
28883
+ attr_accessor :datastore
28884
+
28885
+ def initialize(**args)
28886
+ update!(**args)
28887
+ end
28888
+
28889
+ # Update properties of this object
28890
+ def update!(**args)
28891
+ @datastore = args[:datastore] if args.key?(:datastore)
28892
+ end
28893
+ end
28894
+
28216
28895
  # Metadata describes the input video content.
28217
28896
  class GoogleCloudAiplatformV1VideoMetadata
28218
28897
  include Google::Apis::Core::Hashable
@@ -30379,7 +31058,7 @@ module Google
30379
31058
  include Google::Apis::Core::Hashable
30380
31059
 
30381
31060
  # Index in the prediction output where the citation ends (exclusive). Must be >
30382
- # start_index and < len(output).
31061
+ # start_index and <= len(output).
30383
31062
  # Corresponds to the JSON property `endIndex`
30384
31063
  # @return [Fixnum]
30385
31064
  attr_accessor :end_index