google-apis-aiplatform_v1 0.42.0 → 0.44.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.
@@ -206,7 +206,8 @@ module Google
206
206
 
207
207
  # Updates a Dataset.
208
208
  # @param [String] name
209
- # Output only. Identifier. The resource name of the Dataset.
209
+ # Output only. Identifier. The resource name of the Dataset. Format: `projects/`
210
+ # project`/locations/`location`/datasets/`dataset``
210
211
  # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset] google_cloud_aiplatform_v1_dataset_object
211
212
  # @param [String] update_mask
212
213
  # Required. The update mask applies to the resource. For the `FieldMask`
@@ -392,7 +393,9 @@ module Google
392
393
 
393
394
  # Updates a DatasetVersion.
394
395
  # @param [String] name
395
- # Output only. Identifier. The resource name of the DatasetVersion.
396
+ # Output only. Identifier. The resource name of the DatasetVersion. Format: `
397
+ # projects/`project`/locations/`location`/datasets/`dataset`/datasetVersions/`
398
+ # dataset_version``
396
399
  # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion] google_cloud_aiplatform_v1_dataset_version_object
397
400
  # @param [String] update_mask
398
401
  # Required. The update mask applies to the resource. For the `FieldMask`
@@ -562,6 +565,40 @@ module Google
562
565
  execute_or_queue_command(command, &block)
563
566
  end
564
567
 
568
+ # Perform an online prediction.
569
+ # @param [String] endpoint
570
+ # Required. The name of the Endpoint requested to serve the prediction. Format: `
571
+ # projects/`project`/locations/`location`/endpoints/`endpoint``
572
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequest] google_cloud_aiplatform_v1_predict_request_object
573
+ # @param [String] fields
574
+ # Selector specifying which fields to include in a partial response.
575
+ # @param [String] quota_user
576
+ # Available to use for quota purposes for server-side applications. Can be any
577
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
578
+ # @param [Google::Apis::RequestOptions] options
579
+ # Request-specific options
580
+ #
581
+ # @yield [result, err] Result & error if block supplied
582
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse] parsed result object
583
+ # @yieldparam err [StandardError] error object if request failed
584
+ #
585
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse]
586
+ #
587
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
588
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
589
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
590
+ def predict_endpoint(endpoint, google_cloud_aiplatform_v1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
591
+ command = make_simple_command(:post, 'v1/{+endpoint}:predict', options)
592
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequest::Representation
593
+ command.request_object = google_cloud_aiplatform_v1_predict_request_object
594
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse::Representation
595
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse
596
+ command.params['endpoint'] = endpoint unless endpoint.nil?
597
+ command.query['fields'] = fields unless fields.nil?
598
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
599
+ execute_or_queue_command(command, &block)
600
+ end
601
+
565
602
  # Generate content with multimodal inputs with streaming support.
566
603
  # @param [String] model
567
604
  # Required. The fully qualified name of the publisher model or tuned model
@@ -779,6 +816,40 @@ module Google
779
816
  execute_or_queue_command(command, &block)
780
817
  end
781
818
 
819
+ # Evaluates a dataset based on a set of given metrics.
820
+ # @param [String] location
821
+ # Required. The resource name of the Location to evaluate the dataset. Format: `
822
+ # projects/`project`/locations/`location``
823
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluateDatasetRequest] google_cloud_aiplatform_v1_evaluate_dataset_request_object
824
+ # @param [String] fields
825
+ # Selector specifying which fields to include in a partial response.
826
+ # @param [String] quota_user
827
+ # Available to use for quota purposes for server-side applications. Can be any
828
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
829
+ # @param [Google::Apis::RequestOptions] options
830
+ # Request-specific options
831
+ #
832
+ # @yield [result, err] Result & error if block supplied
833
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
834
+ # @yieldparam err [StandardError] error object if request failed
835
+ #
836
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
837
+ #
838
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
839
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
840
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
841
+ def evaluate_project_location_dataset(location, google_cloud_aiplatform_v1_evaluate_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
842
+ command = make_simple_command(:post, 'v1/{+location}:evaluateDataset', options)
843
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluateDatasetRequest::Representation
844
+ command.request_object = google_cloud_aiplatform_v1_evaluate_dataset_request_object
845
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
846
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
847
+ command.params['location'] = location unless location.nil?
848
+ command.query['fields'] = fields unless fields.nil?
849
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
850
+ execute_or_queue_command(command, &block)
851
+ end
852
+
782
853
  # Evaluates instances based on a given metric.
783
854
  # @param [String] location
784
855
  # Required. The resource name of the Location to evaluate the instances. Format:
@@ -2252,7 +2323,8 @@ module Google
2252
2323
 
2253
2324
  # Updates a Dataset.
2254
2325
  # @param [String] name
2255
- # Output only. Identifier. The resource name of the Dataset.
2326
+ # Output only. Identifier. The resource name of the Dataset. Format: `projects/`
2327
+ # project`/locations/`location`/datasets/`dataset``
2256
2328
  # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset] google_cloud_aiplatform_v1_dataset_object
2257
2329
  # @param [String] update_mask
2258
2330
  # Required. The update mask applies to the resource. For the `FieldMask`
@@ -3210,7 +3282,9 @@ module Google
3210
3282
 
3211
3283
  # Updates a DatasetVersion.
3212
3284
  # @param [String] name
3213
- # Output only. Identifier. The resource name of the DatasetVersion.
3285
+ # Output only. Identifier. The resource name of the DatasetVersion. Format: `
3286
+ # projects/`project`/locations/`location`/datasets/`dataset`/datasetVersions/`
3287
+ # dataset_version``
3214
3288
  # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion] google_cloud_aiplatform_v1_dataset_version_object
3215
3289
  # @param [String] update_mask
3216
3290
  # Required. The update mask applies to the resource. For the `FieldMask`
@@ -5312,7 +5386,7 @@ module Google
5312
5386
  # the mask. If the user does not provide a mask then only the non-empty fields
5313
5387
  # present in the request will be overwritten. Set the update_mask to `*` to
5314
5388
  # override all fields. Updatable fields: * `labels` * `description` * `big_query`
5315
- # * `big_query.entity_id_columns`
5389
+ # * `big_query.entity_id_columns` * `service_agent_type`
5316
5390
  # @param [String] fields
5317
5391
  # Selector specifying which fields to include in a partial response.
5318
5392
  # @param [String] quota_user
@@ -9347,7 +9421,6 @@ module Google
9347
9421
  end
9348
9422
 
9349
9423
  # Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
9350
- # Only non-empty Indexes can be deployed.
9351
9424
  # @param [String] index_endpoint
9352
9425
  # Required. The name of the IndexEndpoint resource into which to deploy an Index.
9353
9426
  # Format: `projects/`project`/locations/`location`/indexEndpoints/`
@@ -13327,6 +13400,47 @@ module Google
13327
13400
  execute_or_queue_command(command, &block)
13328
13401
  end
13329
13402
 
13403
+ # Lists checkpoints of the specified model version.
13404
+ # @param [String] name
13405
+ # Required. The name of the model version to list checkpoints for. `projects/`
13406
+ # project`/locations/`location`/models/`model`@`version`` Example: `projects/`
13407
+ # project`/locations/`location`/models/`model`@2` or `projects/`project`/
13408
+ # locations/`location`/models/`model`@golden` If no version ID or alias is
13409
+ # specified, the latest version will be used.
13410
+ # @param [Fixnum] page_size
13411
+ # Optional. The standard list page size.
13412
+ # @param [String] page_token
13413
+ # Optional. The standard list page token. Typically obtained via next_page_token
13414
+ # of the previous ListModelVersionCheckpoints call.
13415
+ # @param [String] fields
13416
+ # Selector specifying which fields to include in a partial response.
13417
+ # @param [String] quota_user
13418
+ # Available to use for quota purposes for server-side applications. Can be any
13419
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
13420
+ # @param [Google::Apis::RequestOptions] options
13421
+ # Request-specific options
13422
+ #
13423
+ # @yield [result, err] Result & error if block supplied
13424
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse] parsed result object
13425
+ # @yieldparam err [StandardError] error object if request failed
13426
+ #
13427
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse]
13428
+ #
13429
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13430
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13431
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
13432
+ def list_project_location_model_checkpoints(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
13433
+ command = make_simple_command(:get, 'v1/{+name}:listCheckpoints', options)
13434
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse::Representation
13435
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse
13436
+ command.params['name'] = name unless name.nil?
13437
+ command.query['pageSize'] = page_size unless page_size.nil?
13438
+ command.query['pageToken'] = page_token unless page_token.nil?
13439
+ command.query['fields'] = fields unless fields.nil?
13440
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
13441
+ execute_or_queue_command(command, &block)
13442
+ end
13443
+
13330
13444
  # Lists versions of the specified model.
13331
13445
  # @param [String] name
13332
13446
  # Required. The name of the model to list versions for.
@@ -18037,6 +18151,40 @@ module Google
18037
18151
  execute_or_queue_command(command, &block)
18038
18152
  end
18039
18153
 
18154
+ # Streams queries using a reasoning engine.
18155
+ # @param [String] name
18156
+ # Required. The name of the ReasoningEngine resource to use. Format: `projects/`
18157
+ # project`/locations/`location`/reasoningEngines/`reasoning_engine``
18158
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest] google_cloud_aiplatform_v1_stream_query_reasoning_engine_request_object
18159
+ # @param [String] fields
18160
+ # Selector specifying which fields to include in a partial response.
18161
+ # @param [String] quota_user
18162
+ # Available to use for quota purposes for server-side applications. Can be any
18163
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
18164
+ # @param [Google::Apis::RequestOptions] options
18165
+ # Request-specific options
18166
+ #
18167
+ # @yield [result, err] Result & error if block supplied
18168
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleApiHttpBody] parsed result object
18169
+ # @yieldparam err [StandardError] error object if request failed
18170
+ #
18171
+ # @return [Google::Apis::AiplatformV1::GoogleApiHttpBody]
18172
+ #
18173
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
18174
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
18175
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
18176
+ def stream_project_location_reasoning_engine_query(name, google_cloud_aiplatform_v1_stream_query_reasoning_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
18177
+ command = make_simple_command(:post, 'v1/{+name}:streamQuery', options)
18178
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest::Representation
18179
+ command.request_object = google_cloud_aiplatform_v1_stream_query_reasoning_engine_request_object
18180
+ command.response_representation = Google::Apis::AiplatformV1::GoogleApiHttpBody::Representation
18181
+ command.response_class = Google::Apis::AiplatformV1::GoogleApiHttpBody
18182
+ command.params['name'] = name unless name.nil?
18183
+ command.query['fields'] = fields unless fields.nil?
18184
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
18185
+ execute_or_queue_command(command, &block)
18186
+ end
18187
+
18040
18188
  # Starts asynchronous cancellation on a long-running operation. The server makes
18041
18189
  # a best effort to cancel the operation, but success is not guaranteed. If the
18042
18190
  # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
@@ -22646,6 +22794,40 @@ module Google
22646
22794
  execute_or_queue_command(command, &block)
22647
22795
  end
22648
22796
 
22797
+ # Perform an online prediction.
22798
+ # @param [String] endpoint
22799
+ # Required. The name of the Endpoint requested to serve the prediction. Format: `
22800
+ # projects/`project`/locations/`location`/endpoints/`endpoint``
22801
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequest] google_cloud_aiplatform_v1_predict_request_object
22802
+ # @param [String] fields
22803
+ # Selector specifying which fields to include in a partial response.
22804
+ # @param [String] quota_user
22805
+ # Available to use for quota purposes for server-side applications. Can be any
22806
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
22807
+ # @param [Google::Apis::RequestOptions] options
22808
+ # Request-specific options
22809
+ #
22810
+ # @yield [result, err] Result & error if block supplied
22811
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse] parsed result object
22812
+ # @yieldparam err [StandardError] error object if request failed
22813
+ #
22814
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse]
22815
+ #
22816
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
22817
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
22818
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
22819
+ def predict_publisher_model(endpoint, google_cloud_aiplatform_v1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
22820
+ command = make_simple_command(:post, 'v1/{+endpoint}:predict', options)
22821
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequest::Representation
22822
+ command.request_object = google_cloud_aiplatform_v1_predict_request_object
22823
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse::Representation
22824
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse
22825
+ command.params['endpoint'] = endpoint unless endpoint.nil?
22826
+ command.query['fields'] = fields unless fields.nil?
22827
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
22828
+ execute_or_queue_command(command, &block)
22829
+ end
22830
+
22649
22831
  # Generate content with multimodal inputs with streaming support.
22650
22832
  # @param [String] model
22651
22833
  # Required. The fully qualified name of the publisher model or tuned model
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-aiplatform_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.42.0
4
+ version: 0.44.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-12-08 00:00:00.000000000 Z
10
+ date: 2025-03-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-apis-core
@@ -58,9 +57,8 @@ licenses:
58
57
  metadata:
59
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
59
  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.42.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.44.0
62
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1
63
- post_install_message:
64
62
  rdoc_options: []
65
63
  require_paths:
66
64
  - lib
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
73
  - !ruby/object:Gem::Version
76
74
  version: '0'
77
75
  requirements: []
78
- rubygems_version: 3.5.23
79
- signing_key:
76
+ rubygems_version: 3.6.5
80
77
  specification_version: 4
81
78
  summary: Simple REST client for Vertex AI API V1
82
79
  test_files: []