google-apis-aiplatform_v1 0.12.0 → 0.14.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.
@@ -3253,8 +3253,8 @@ module Google
3253
3253
  execute_or_queue_command(command, &block)
3254
3254
  end
3255
3255
 
3256
- # Perform an unary online prediction request for Vertex first-party products and
3257
- # frameworks.
3256
+ # Perform an unary online prediction request to a gRPC model server for Vertex
3257
+ # first-party products and frameworks.
3258
3258
  # @param [String] endpoint
3259
3259
  # Required. The name of the Endpoint requested to serve the prediction. Format: `
3260
3260
  # projects/`project`/locations/`location`/endpoints/`endpoint``
@@ -3288,7 +3288,8 @@ module Google
3288
3288
  execute_or_queue_command(command, &block)
3289
3289
  end
3290
3290
 
3291
- # Perform an online prediction request through gRPC.
3291
+ # Perform an unary online prediction request to a gRPC model server for custom
3292
+ # containers.
3292
3293
  # @param [String] endpoint
3293
3294
  # Required. The name of the Endpoint requested to serve the prediction. Format: `
3294
3295
  # projects/`project`/locations/`location`/endpoints/`endpoint``
@@ -3359,6 +3360,40 @@ module Google
3359
3360
  execute_or_queue_command(command, &block)
3360
3361
  end
3361
3362
 
3363
+ # Generate content with multimodal inputs.
3364
+ # @param [String] model
3365
+ # Required. The name of the publisher model requested to serve the prediction.
3366
+ # Format: `projects/`project`/locations/`location`/publishers/*/models/*`
3367
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest] google_cloud_aiplatform_v1_generate_content_request_object
3368
+ # @param [String] fields
3369
+ # Selector specifying which fields to include in a partial response.
3370
+ # @param [String] quota_user
3371
+ # Available to use for quota purposes for server-side applications. Can be any
3372
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3373
+ # @param [Google::Apis::RequestOptions] options
3374
+ # Request-specific options
3375
+ #
3376
+ # @yield [result, err] Result & error if block supplied
3377
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse] parsed result object
3378
+ # @yieldparam err [StandardError] error object if request failed
3379
+ #
3380
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse]
3381
+ #
3382
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3383
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3384
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3385
+ def generate_project_location_endpoint_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3386
+ command = make_simple_command(:post, 'v1/{+model}:generateContent', options)
3387
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
3388
+ command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
3389
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
3390
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
3391
+ command.params['model'] = model unless model.nil?
3392
+ command.query['fields'] = fields unless fields.nil?
3393
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3394
+ execute_or_queue_command(command, &block)
3395
+ end
3396
+
3362
3397
  # Gets an Endpoint.
3363
3398
  # @param [String] name
3364
3399
  # Required. The name of the Endpoint resource. Format: `projects/`project`/
@@ -3662,7 +3697,7 @@ module Google
3662
3697
  execute_or_queue_command(command, &block)
3663
3698
  end
3664
3699
 
3665
- #
3700
+ # Perform a streaming online prediction with an arbitrary HTTP payload.
3666
3701
  # @param [String] endpoint
3667
3702
  # Required. The name of the Endpoint requested to serve the prediction. Format: `
3668
3703
  # projects/`project`/locations/`location`/endpoints/`endpoint``
@@ -4818,7 +4853,7 @@ module Google
4818
4853
  # be overwritten if it is in the mask. If the user does not provide a mask then
4819
4854
  # only the non-empty fields present in the request will be overwritten. Set the
4820
4855
  # update_mask to `*` to override all fields. Updatable fields: * `
4821
- # big_query_source` * `labels` * `sync_config`
4856
+ # big_query_source` * `bigtable` * `labels` * `sync_config`
4822
4857
  # @param [String] fields
4823
4858
  # Selector specifying which fields to include in a partial response.
4824
4859
  # @param [String] quota_user
@@ -5064,7 +5099,7 @@ module Google
5064
5099
  # to the resource, not the full request. A field will be overwritten if it is in
5065
5100
  # the mask. If the user does not provide a mask then only the non-empty fields
5066
5101
  # present in the request will be overwritten. Set the update_mask to `*` to
5067
- # override all fields. Updatable fields: * `labels`
5102
+ # override all fields. Updatable fields: * `labels` * `serviceAgentType`
5068
5103
  # @param [String] fields
5069
5104
  # Selector specifying which fields to include in a partial response.
5070
5105
  # @param [String] quota_user
@@ -5095,6 +5130,42 @@ module Google
5095
5130
  execute_or_queue_command(command, &block)
5096
5131
  end
5097
5132
 
5133
+ # Search the nearest entities under a FeatureView. Search only works for
5134
+ # indexable feature view; if a feature view isn't indexable, returns Invalid
5135
+ # argument response.
5136
+ # @param [String] feature_view
5137
+ # Required. FeatureView resource format `projects/`project`/locations/`location`/
5138
+ # featureOnlineStores/`featureOnlineStore`/featureViews/`featureView``
5139
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesRequest] google_cloud_aiplatform_v1_search_nearest_entities_request_object
5140
+ # @param [String] fields
5141
+ # Selector specifying which fields to include in a partial response.
5142
+ # @param [String] quota_user
5143
+ # Available to use for quota purposes for server-side applications. Can be any
5144
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5145
+ # @param [Google::Apis::RequestOptions] options
5146
+ # Request-specific options
5147
+ #
5148
+ # @yield [result, err] Result & error if block supplied
5149
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesResponse] parsed result object
5150
+ # @yieldparam err [StandardError] error object if request failed
5151
+ #
5152
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesResponse]
5153
+ #
5154
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5155
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5156
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5157
+ def search_project_location_feature_online_store_feature_view_nearest_entities(feature_view, google_cloud_aiplatform_v1_search_nearest_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5158
+ command = make_simple_command(:post, 'v1/{+featureView}:searchNearestEntities', options)
5159
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesRequest::Representation
5160
+ command.request_object = google_cloud_aiplatform_v1_search_nearest_entities_request_object
5161
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesResponse::Representation
5162
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesResponse
5163
+ command.params['featureView'] = feature_view unless feature_view.nil?
5164
+ command.query['fields'] = fields unless fields.nil?
5165
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5166
+ execute_or_queue_command(command, &block)
5167
+ end
5168
+
5098
5169
  # Triggers on-demand sync for the FeatureView.
5099
5170
  # @param [String] feature_view
5100
5171
  # Required. Format: `projects/`project`/locations/`location`/featureOnlineStores/
@@ -11674,6 +11745,51 @@ module Google
11674
11745
  execute_or_queue_command(command, &block)
11675
11746
  end
11676
11747
 
11748
+ # Gets the access control policy for a resource. Returns an empty policy if the
11749
+ # resource exists and does not have a policy set.
11750
+ # @param [String] resource
11751
+ # REQUIRED: The resource for which the policy is being requested. See [Resource
11752
+ # names](https://cloud.google.com/apis/design/resource_names) for the
11753
+ # appropriate value for this field.
11754
+ # @param [Fixnum] options_requested_policy_version
11755
+ # Optional. The maximum policy version that will be used to format the policy.
11756
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
11757
+ # rejected. Requests for policies with any conditional role bindings must
11758
+ # specify version 3. Policies with no conditional role bindings may specify any
11759
+ # valid value or leave the field unset. The policy in the response might use the
11760
+ # policy version that you specified, or it might use a lower policy version. For
11761
+ # example, if you specify version 3, but the policy has no conditional role
11762
+ # bindings, the response uses version 1. To learn which resources support
11763
+ # conditions in their IAM policies, see the [IAM documentation](https://cloud.
11764
+ # google.com/iam/help/conditions/resource-policies).
11765
+ # @param [String] fields
11766
+ # Selector specifying which fields to include in a partial response.
11767
+ # @param [String] quota_user
11768
+ # Available to use for quota purposes for server-side applications. Can be any
11769
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11770
+ # @param [Google::Apis::RequestOptions] options
11771
+ # Request-specific options
11772
+ #
11773
+ # @yield [result, err] Result & error if block supplied
11774
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleIamV1Policy] parsed result object
11775
+ # @yieldparam err [StandardError] error object if request failed
11776
+ #
11777
+ # @return [Google::Apis::AiplatformV1::GoogleIamV1Policy]
11778
+ #
11779
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11780
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11781
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11782
+ def get_project_location_model_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
11783
+ command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
11784
+ command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
11785
+ command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
11786
+ command.params['resource'] = resource unless resource.nil?
11787
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
11788
+ command.query['fields'] = fields unless fields.nil?
11789
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
11790
+ execute_or_queue_command(command, &block)
11791
+ end
11792
+
11677
11793
  # Lists Models in a Location.
11678
11794
  # @param [String] parent
11679
11795
  # Required. The resource name of the Location to list the Models from. Format: `
@@ -11854,6 +11970,84 @@ module Google
11854
11970
  execute_or_queue_command(command, &block)
11855
11971
  end
11856
11972
 
11973
+ # Sets the access control policy on the specified resource. Replaces any
11974
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
11975
+ # PERMISSION_DENIED` errors.
11976
+ # @param [String] resource
11977
+ # REQUIRED: The resource for which the policy is being specified. See [Resource
11978
+ # names](https://cloud.google.com/apis/design/resource_names) for the
11979
+ # appropriate value for this field.
11980
+ # @param [Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
11981
+ # @param [String] fields
11982
+ # Selector specifying which fields to include in a partial response.
11983
+ # @param [String] quota_user
11984
+ # Available to use for quota purposes for server-side applications. Can be any
11985
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11986
+ # @param [Google::Apis::RequestOptions] options
11987
+ # Request-specific options
11988
+ #
11989
+ # @yield [result, err] Result & error if block supplied
11990
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleIamV1Policy] parsed result object
11991
+ # @yieldparam err [StandardError] error object if request failed
11992
+ #
11993
+ # @return [Google::Apis::AiplatformV1::GoogleIamV1Policy]
11994
+ #
11995
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11996
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11997
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11998
+ def set_project_location_model_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
11999
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
12000
+ command.request_representation = Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest::Representation
12001
+ command.request_object = google_iam_v1_set_iam_policy_request_object
12002
+ command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
12003
+ command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
12004
+ command.params['resource'] = resource unless resource.nil?
12005
+ command.query['fields'] = fields unless fields.nil?
12006
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
12007
+ execute_or_queue_command(command, &block)
12008
+ end
12009
+
12010
+ # Returns permissions that a caller has on the specified resource. If the
12011
+ # resource does not exist, this will return an empty set of permissions, not a `
12012
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
12013
+ # permission-aware UIs and command-line tools, not for authorization checking.
12014
+ # This operation may "fail open" without warning.
12015
+ # @param [String] resource
12016
+ # REQUIRED: The resource for which the policy detail is being requested. See [
12017
+ # Resource names](https://cloud.google.com/apis/design/resource_names) for the
12018
+ # appropriate value for this field.
12019
+ # @param [Array<String>, String] permissions
12020
+ # The set of permissions to check for the `resource`. Permissions with wildcards
12021
+ # (such as `*` or `storage.*`) are not allowed. For more information see [IAM
12022
+ # Overview](https://cloud.google.com/iam/docs/overview#permissions).
12023
+ # @param [String] fields
12024
+ # Selector specifying which fields to include in a partial response.
12025
+ # @param [String] quota_user
12026
+ # Available to use for quota purposes for server-side applications. Can be any
12027
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
12028
+ # @param [Google::Apis::RequestOptions] options
12029
+ # Request-specific options
12030
+ #
12031
+ # @yield [result, err] Result & error if block supplied
12032
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
12033
+ # @yieldparam err [StandardError] error object if request failed
12034
+ #
12035
+ # @return [Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse]
12036
+ #
12037
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
12038
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
12039
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
12040
+ def test_project_location_model_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block)
12041
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
12042
+ command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse::Representation
12043
+ command.response_class = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse
12044
+ command.params['resource'] = resource unless resource.nil?
12045
+ command.query['permissions'] = permissions unless permissions.nil?
12046
+ command.query['fields'] = fields unless fields.nil?
12047
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
12048
+ execute_or_queue_command(command, &block)
12049
+ end
12050
+
11857
12051
  # Incrementally update the dataset used for an examples model.
11858
12052
  # @param [String] model
11859
12053
  # Required. The resource name of the Model to update. Format: `projects/`project`
@@ -13531,9 +13725,6 @@ module Google
13531
13725
  # the PipelineJob name. If not provided, an ID will be automatically generated.
13532
13726
  # This value should be less than 128 characters, and valid characters are `/a-z-/
13533
13727
  # `.
13534
- # @param [Boolean] preflight_validations
13535
- # Optional. Whether to do component level validations before job creation.
13536
- # Currently we only support Google First Party Component/Pipelines.
13537
13728
  # @param [String] fields
13538
13729
  # Selector specifying which fields to include in a partial response.
13539
13730
  # @param [String] quota_user
@@ -13551,7 +13742,7 @@ module Google
13551
13742
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
13552
13743
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
13553
13744
  # @raise [Google::Apis::AuthorizationError] Authorization is required
13554
- def create_project_location_pipeline_job(parent, google_cloud_aiplatform_v1_pipeline_job_object = nil, pipeline_job_id: nil, preflight_validations: nil, fields: nil, quota_user: nil, options: nil, &block)
13745
+ def create_project_location_pipeline_job(parent, google_cloud_aiplatform_v1_pipeline_job_object = nil, pipeline_job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
13555
13746
  command = make_simple_command(:post, 'v1/{+parent}/pipelineJobs', options)
13556
13747
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob::Representation
13557
13748
  command.request_object = google_cloud_aiplatform_v1_pipeline_job_object
@@ -13559,7 +13750,6 @@ module Google
13559
13750
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob
13560
13751
  command.params['parent'] = parent unless parent.nil?
13561
13752
  command.query['pipelineJobId'] = pipeline_job_id unless pipeline_job_id.nil?
13562
- command.query['preflightValidations'] = preflight_validations unless preflight_validations.nil?
13563
13753
  command.query['fields'] = fields unless fields.nil?
13564
13754
  command.query['quotaUser'] = quota_user unless quota_user.nil?
13565
13755
  execute_or_queue_command(command, &block)
@@ -13951,6 +14141,40 @@ module Google
13951
14141
  execute_or_queue_command(command, &block)
13952
14142
  end
13953
14143
 
14144
+ # Generate content with multimodal inputs.
14145
+ # @param [String] model
14146
+ # Required. The name of the publisher model requested to serve the prediction.
14147
+ # Format: `projects/`project`/locations/`location`/publishers/*/models/*`
14148
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest] google_cloud_aiplatform_v1_generate_content_request_object
14149
+ # @param [String] fields
14150
+ # Selector specifying which fields to include in a partial response.
14151
+ # @param [String] quota_user
14152
+ # Available to use for quota purposes for server-side applications. Can be any
14153
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
14154
+ # @param [Google::Apis::RequestOptions] options
14155
+ # Request-specific options
14156
+ #
14157
+ # @yield [result, err] Result & error if block supplied
14158
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse] parsed result object
14159
+ # @yieldparam err [StandardError] error object if request failed
14160
+ #
14161
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse]
14162
+ #
14163
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
14164
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
14165
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
14166
+ def generate_project_location_publisher_model_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
14167
+ command = make_simple_command(:post, 'v1/{+model}:generateContent', options)
14168
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
14169
+ command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
14170
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
14171
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
14172
+ command.params['model'] = model unless model.nil?
14173
+ command.query['fields'] = fields unless fields.nil?
14174
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
14175
+ execute_or_queue_command(command, &block)
14176
+ end
14177
+
13954
14178
  # Perform an online prediction.
13955
14179
  # @param [String] endpoint
13956
14180
  # Required. The name of the Endpoint requested to serve the prediction. Format: `
@@ -14091,7 +14315,7 @@ module Google
14091
14315
  execute_or_queue_command(command, &block)
14092
14316
  end
14093
14317
 
14094
- #
14318
+ # Perform a streaming online prediction with an arbitrary HTTP payload.
14095
14319
  # @param [String] endpoint
14096
14320
  # Required. The name of the Endpoint requested to serve the prediction. Format: `
14097
14321
  # projects/`project`/locations/`location`/endpoints/`endpoint``
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.12.0
4
+ version: 0.14.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-01-28 00:00:00.000000000 Z
11
+ date: 2024-02-18 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.12.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.14.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: []