google-apis-aiplatform_v1 0.39.0 → 0.40.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.
@@ -598,6 +598,70 @@ module Google
598
598
  execute_or_queue_command(command, &block)
599
599
  end
600
600
 
601
+ # Gets a GenAI cache config.
602
+ # @param [String] name
603
+ # Required. Name of the cache config. Format: - `projects/`project`/cacheConfig`.
604
+ # @param [String] fields
605
+ # Selector specifying which fields to include in a partial response.
606
+ # @param [String] quota_user
607
+ # Available to use for quota purposes for server-side applications. Can be any
608
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
609
+ # @param [Google::Apis::RequestOptions] options
610
+ # Request-specific options
611
+ #
612
+ # @yield [result, err] Result & error if block supplied
613
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig] parsed result object
614
+ # @yieldparam err [StandardError] error object if request failed
615
+ #
616
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig]
617
+ #
618
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
619
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
620
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
621
+ def get_project_cache_config(name, fields: nil, quota_user: nil, options: nil, &block)
622
+ command = make_simple_command(:get, 'v1/{+name}', options)
623
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig::Representation
624
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig
625
+ command.params['name'] = name unless name.nil?
626
+ command.query['fields'] = fields unless fields.nil?
627
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
628
+ execute_or_queue_command(command, &block)
629
+ end
630
+
631
+ # Updates a cache config.
632
+ # @param [String] name
633
+ # Identifier. Name of the cache config. Format: - `projects/`project`/
634
+ # cacheConfig`.
635
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig] google_cloud_aiplatform_v1_cache_config_object
636
+ # @param [String] fields
637
+ # Selector specifying which fields to include in a partial response.
638
+ # @param [String] quota_user
639
+ # Available to use for quota purposes for server-side applications. Can be any
640
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
641
+ # @param [Google::Apis::RequestOptions] options
642
+ # Request-specific options
643
+ #
644
+ # @yield [result, err] Result & error if block supplied
645
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
646
+ # @yieldparam err [StandardError] error object if request failed
647
+ #
648
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
649
+ #
650
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
651
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
652
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
653
+ def update_project_cache_config(name, google_cloud_aiplatform_v1_cache_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
654
+ command = make_simple_command(:patch, 'v1/{+name}', options)
655
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig::Representation
656
+ command.request_object = google_cloud_aiplatform_v1_cache_config_object
657
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
658
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
659
+ command.params['name'] = name unless name.nil?
660
+ command.query['fields'] = fields unless fields.nil?
661
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
662
+ execute_or_queue_command(command, &block)
663
+ end
664
+
601
665
  # Evaluates instances based on a given metric.
602
666
  # @param [String] location
603
667
  # Required. The resource name of the Location to evaluate the instances. Format:
@@ -4017,6 +4081,41 @@ module Google
4017
4081
  execute_or_queue_command(command, &block)
4018
4082
  end
4019
4083
 
4084
+ # Fetch an asynchronous online prediction operation.
4085
+ # @param [String] endpoint
4086
+ # Required. The name of the Endpoint requested to serve the prediction. Format: `
4087
+ # projects/`project`/locations/`location`/endpoints/`endpoint`` or `projects/`
4088
+ # project`/locations/`location`/publishers/`publisher`/models/`model``
4089
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchPredictOperationRequest] google_cloud_aiplatform_v1_fetch_predict_operation_request_object
4090
+ # @param [String] fields
4091
+ # Selector specifying which fields to include in a partial response.
4092
+ # @param [String] quota_user
4093
+ # Available to use for quota purposes for server-side applications. Can be any
4094
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4095
+ # @param [Google::Apis::RequestOptions] options
4096
+ # Request-specific options
4097
+ #
4098
+ # @yield [result, err] Result & error if block supplied
4099
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
4100
+ # @yieldparam err [StandardError] error object if request failed
4101
+ #
4102
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
4103
+ #
4104
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4105
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4106
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4107
+ def fetch_project_location_endpoint_predict_operation(endpoint, google_cloud_aiplatform_v1_fetch_predict_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4108
+ command = make_simple_command(:post, 'v1/{+endpoint}:fetchPredictOperation', options)
4109
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchPredictOperationRequest::Representation
4110
+ command.request_object = google_cloud_aiplatform_v1_fetch_predict_operation_request_object
4111
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
4112
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
4113
+ command.params['endpoint'] = endpoint unless endpoint.nil?
4114
+ command.query['fields'] = fields unless fields.nil?
4115
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4116
+ execute_or_queue_command(command, &block)
4117
+ end
4118
+
4020
4119
  # Generate content with multimodal inputs.
4021
4120
  # @param [String] model
4022
4121
  # Required. The fully qualified name of the publisher model or tuned model
@@ -4251,6 +4350,41 @@ module Google
4251
4350
  execute_or_queue_command(command, &block)
4252
4351
  end
4253
4352
 
4353
+ #
4354
+ # @param [String] endpoint
4355
+ # Required. The name of the Endpoint requested to serve the prediction. Format: `
4356
+ # projects/`project`/locations/`location`/endpoints/`endpoint`` or `projects/`
4357
+ # project`/locations/`location`/publishers/`publisher`/models/`model``
4358
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictLongRunningRequest] google_cloud_aiplatform_v1_predict_long_running_request_object
4359
+ # @param [String] fields
4360
+ # Selector specifying which fields to include in a partial response.
4361
+ # @param [String] quota_user
4362
+ # Available to use for quota purposes for server-side applications. Can be any
4363
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4364
+ # @param [Google::Apis::RequestOptions] options
4365
+ # Request-specific options
4366
+ #
4367
+ # @yield [result, err] Result & error if block supplied
4368
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
4369
+ # @yieldparam err [StandardError] error object if request failed
4370
+ #
4371
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
4372
+ #
4373
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4374
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4375
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4376
+ def predict_project_location_endpoint_long_running(endpoint, google_cloud_aiplatform_v1_predict_long_running_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4377
+ command = make_simple_command(:post, 'v1/{+endpoint}:predictLongRunning', options)
4378
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictLongRunningRequest::Representation
4379
+ command.request_object = google_cloud_aiplatform_v1_predict_long_running_request_object
4380
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
4381
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
4382
+ command.params['endpoint'] = endpoint unless endpoint.nil?
4383
+ command.query['fields'] = fields unless fields.nil?
4384
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4385
+ execute_or_queue_command(command, &block)
4386
+ end
4387
+
4254
4388
  # Perform an online prediction with an arbitrary HTTP payload. The response
4255
4389
  # includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the
4256
4390
  # Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of
@@ -6005,7 +6139,8 @@ module Google
6005
6139
  # override all fields. Updatable fields: * `labels` * `service_agent_type` * `
6006
6140
  # big_query_source` * `big_query_source.uri` * `big_query_source.
6007
6141
  # entity_id_columns` * `feature_registry_source` * `feature_registry_source.
6008
- # feature_groups` * `sync_config` * `sync_config.cron`
6142
+ # feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.
6143
+ # automatic_resources`
6009
6144
  # @param [String] fields
6010
6145
  # Selector specifying which fields to include in a partial response.
6011
6146
  # @param [String] quota_user
@@ -15003,6 +15138,42 @@ module Google
15003
15138
  execute_or_queue_command(command, &block)
15004
15139
  end
15005
15140
 
15141
+ # Stops a NotebookRuntime.
15142
+ # @param [String] name
15143
+ # Required. The name of the NotebookRuntime resource to be stopped. Instead of
15144
+ # checking whether the name is in valid NotebookRuntime resource name format,
15145
+ # directly throw NotFound exception if there is no such NotebookRuntime in
15146
+ # spanner.
15147
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StopNotebookRuntimeRequest] google_cloud_aiplatform_v1_stop_notebook_runtime_request_object
15148
+ # @param [String] fields
15149
+ # Selector specifying which fields to include in a partial response.
15150
+ # @param [String] quota_user
15151
+ # Available to use for quota purposes for server-side applications. Can be any
15152
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
15153
+ # @param [Google::Apis::RequestOptions] options
15154
+ # Request-specific options
15155
+ #
15156
+ # @yield [result, err] Result & error if block supplied
15157
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
15158
+ # @yieldparam err [StandardError] error object if request failed
15159
+ #
15160
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
15161
+ #
15162
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
15163
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
15164
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
15165
+ def stop_project_location_notebook_runtime(name, google_cloud_aiplatform_v1_stop_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
15166
+ command = make_simple_command(:post, 'v1/{+name}:stop', options)
15167
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StopNotebookRuntimeRequest::Representation
15168
+ command.request_object = google_cloud_aiplatform_v1_stop_notebook_runtime_request_object
15169
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
15170
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
15171
+ command.params['name'] = name unless name.nil?
15172
+ command.query['fields'] = fields unless fields.nil?
15173
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
15174
+ execute_or_queue_command(command, &block)
15175
+ end
15176
+
15006
15177
  # Upgrades a NotebookRuntime.
15007
15178
  # @param [String] name
15008
15179
  # Required. The name of the NotebookRuntime resource to be upgrade. Instead of
@@ -16341,6 +16512,41 @@ module Google
16341
16512
  execute_or_queue_command(command, &block)
16342
16513
  end
16343
16514
 
16515
+ # Fetch an asynchronous online prediction operation.
16516
+ # @param [String] endpoint
16517
+ # Required. The name of the Endpoint requested to serve the prediction. Format: `
16518
+ # projects/`project`/locations/`location`/endpoints/`endpoint`` or `projects/`
16519
+ # project`/locations/`location`/publishers/`publisher`/models/`model``
16520
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchPredictOperationRequest] google_cloud_aiplatform_v1_fetch_predict_operation_request_object
16521
+ # @param [String] fields
16522
+ # Selector specifying which fields to include in a partial response.
16523
+ # @param [String] quota_user
16524
+ # Available to use for quota purposes for server-side applications. Can be any
16525
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16526
+ # @param [Google::Apis::RequestOptions] options
16527
+ # Request-specific options
16528
+ #
16529
+ # @yield [result, err] Result & error if block supplied
16530
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
16531
+ # @yieldparam err [StandardError] error object if request failed
16532
+ #
16533
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
16534
+ #
16535
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16536
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16537
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16538
+ def fetch_project_location_publisher_model_predict_operation(endpoint, google_cloud_aiplatform_v1_fetch_predict_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
16539
+ command = make_simple_command(:post, 'v1/{+endpoint}:fetchPredictOperation', options)
16540
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchPredictOperationRequest::Representation
16541
+ command.request_object = google_cloud_aiplatform_v1_fetch_predict_operation_request_object
16542
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
16543
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
16544
+ command.params['endpoint'] = endpoint unless endpoint.nil?
16545
+ command.query['fields'] = fields unless fields.nil?
16546
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16547
+ execute_or_queue_command(command, &block)
16548
+ end
16549
+
16344
16550
  # Generate content with multimodal inputs.
16345
16551
  # @param [String] model
16346
16552
  # Required. The fully qualified name of the publisher model or tuned model
@@ -16411,6 +16617,41 @@ module Google
16411
16617
  execute_or_queue_command(command, &block)
16412
16618
  end
16413
16619
 
16620
+ #
16621
+ # @param [String] endpoint
16622
+ # Required. The name of the Endpoint requested to serve the prediction. Format: `
16623
+ # projects/`project`/locations/`location`/endpoints/`endpoint`` or `projects/`
16624
+ # project`/locations/`location`/publishers/`publisher`/models/`model``
16625
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictLongRunningRequest] google_cloud_aiplatform_v1_predict_long_running_request_object
16626
+ # @param [String] fields
16627
+ # Selector specifying which fields to include in a partial response.
16628
+ # @param [String] quota_user
16629
+ # Available to use for quota purposes for server-side applications. Can be any
16630
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
16631
+ # @param [Google::Apis::RequestOptions] options
16632
+ # Request-specific options
16633
+ #
16634
+ # @yield [result, err] Result & error if block supplied
16635
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
16636
+ # @yieldparam err [StandardError] error object if request failed
16637
+ #
16638
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
16639
+ #
16640
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
16641
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
16642
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
16643
+ def predict_project_location_publisher_model_long_running(endpoint, google_cloud_aiplatform_v1_predict_long_running_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
16644
+ command = make_simple_command(:post, 'v1/{+endpoint}:predictLongRunning', options)
16645
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictLongRunningRequest::Representation
16646
+ command.request_object = google_cloud_aiplatform_v1_predict_long_running_request_object
16647
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
16648
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
16649
+ command.params['endpoint'] = endpoint unless endpoint.nil?
16650
+ command.query['fields'] = fields unless fields.nil?
16651
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
16652
+ execute_or_queue_command(command, &block)
16653
+ end
16654
+
16414
16655
  # Perform an online prediction with an arbitrary HTTP payload. The response
16415
16656
  # includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the
16416
16657
  # Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-aiplatform_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.39.0
4
+ version: 0.40.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-10-27 00:00:00.000000000 Z
11
+ date: 2024-11-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.39.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.40.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1
63
63
  post_install_message:
64
64
  rdoc_options: []