google-cloud-ai_platform-v1 0.16.0 → 0.18.0

data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb

@@ -45,21 +45,26 @@ module Google
             rpc :UpdateModel, ::Google::Cloud::AIPlatform::V1::UpdateModelRequest, ::Google::Cloud::AIPlatform::V1::Model
             # Deletes a Model.
             #
-            # A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a
-            # [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its
-            # [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
+            # A model cannot be deleted if any
+            # [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a
+            # [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the
+            # model in its
+            # [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
+            # field.
             rpc :DeleteModel, ::Google::Cloud::AIPlatform::V1::DeleteModelRequest, ::Google::Longrunning::Operation
             # Deletes a Model version.
             #
             # Model version can only be deleted if there are no [DeployedModels][]
             # created from it. Deleting the only version in the Model is not allowed. Use
-            # [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
+            # [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for
+            # deleting the Model instead.
             rpc :DeleteModelVersion, ::Google::Cloud::AIPlatform::V1::DeleteModelVersionRequest, ::Google::Longrunning::Operation
             # Merges a set of aliases for a Model version.
             rpc :MergeVersionAliases, ::Google::Cloud::AIPlatform::V1::MergeVersionAliasesRequest, ::Google::Cloud::AIPlatform::V1::Model
             # Exports a trained, exportable Model to a location specified by the
             # user. A Model is considered to be exportable if it has at least one
-            # [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].
+            # [supported export
+            # format][google.cloud.aiplatform.v1.Model.supported_export_formats].
             rpc :ExportModel, ::Google::Cloud::AIPlatform::V1::ExportModelRequest, ::Google::Longrunning::Operation
             # Imports an externally generated ModelEvaluation.
             rpc :ImportModelEvaluation, ::Google::Cloud::AIPlatform::V1::ImportModelEvaluationRequest, ::Google::Cloud::AIPlatform::V1::ModelEvaluation

data/lib/google/cloud/aiplatform/v1/pipeline_service_services_pb.rb

@@ -47,13 +47,17 @@ module Google
             # Cancels a TrainingPipeline.
             # Starts asynchronous cancellation on the TrainingPipeline. The server
             # makes a best effort to cancel the pipeline, but success is not
-            # guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline] or
-            # other methods to check whether the cancellation succeeded or whether the
+            # guaranteed. Clients can use
+            # [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
+            # or other methods to check whether the cancellation succeeded or whether the
             # pipeline completed despite cancellation. On successful cancellation,
             # the TrainingPipeline is not deleted; instead it becomes a pipeline with
-            # a [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
-            # corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to
-            # `CANCELLED`.
+            # a
+            # [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error]
+            # value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
+            # corresponding to `Code.CANCELLED`, and
+            # [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state]
+            # is set to `CANCELLED`.
             rpc :CancelTrainingPipeline, ::Google::Cloud::AIPlatform::V1::CancelTrainingPipelineRequest, ::Google::Protobuf::Empty
             # Creates a PipelineJob. A PipelineJob will run immediately when created.
             rpc :CreatePipelineJob, ::Google::Cloud::AIPlatform::V1::CreatePipelineJobRequest, ::Google::Cloud::AIPlatform::V1::PipelineJob
@@ -66,12 +70,15 @@ module Google
             # Cancels a PipelineJob.
             # Starts asynchronous cancellation on the PipelineJob. The server
             # makes a best effort to cancel the pipeline, but success is not
-            # guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob] or
-            # other methods to check whether the cancellation succeeded or whether the
+            # guaranteed. Clients can use
+            # [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]
+            # or other methods to check whether the cancellation succeeded or whether the
             # pipeline completed despite cancellation. On successful cancellation,
             # the PipelineJob is not deleted; instead it becomes a pipeline with
-            # a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
-            # corresponding to `Code.CANCELLED`, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
+            # a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value
+            # with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
+            # to `Code.CANCELLED`, and
+            # [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
             # `CANCELLED`.
             rpc :CancelPipelineJob, ::Google::Cloud::AIPlatform::V1::CancelPipelineJobRequest, ::Google::Protobuf::Empty
           end

data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb

@@ -39,18 +39,22 @@ module Google
             #
             # The response includes the following HTTP headers:
             #
-            # * `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this
+            # * `X-Vertex-AI-Endpoint-Id`: ID of the
+            # [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this
             # prediction.
             #
-            # * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1.DeployedModel]
-            # that served this prediction.
+            # * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
+            # [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this
+            # prediction.
             rpc :RawPredict, ::Google::Cloud::AIPlatform::V1::RawPredictRequest, ::Google::Api::HttpBody
             # Perform an online explanation.
             #
-            # If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id] is specified,
-            # the corresponding DeployModel must have
+            # If
+            # [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
+            # is specified, the corresponding DeployModel must have
             # [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
-            # populated. If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
+            # populated. If
+            # [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
             # is not specified, all DeployedModels must have
             # [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
             # populated. Only deployed AutoML tabular Models have

data/lib/google/cloud/aiplatform/v1/study_pb.rb

@@ -136,6 +136,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :min_measurement_count, :int64, 3
       optional :learning_rate_parameter_name, :string, 4
       optional :use_elapsed_duration, :bool, 5
+      proto3_optional :update_all_stopped_trials, :bool, 6
     end
     add_enum "google.cloud.aiplatform.v1.StudySpec.Algorithm" do
       value :ALGORITHM_UNSPECIFIED, 0

data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb

@@ -25,6 +25,19 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.aiplatform.v1.GetTensorboardRequest" do
       optional :name, :string, 1
     end
+    add_message "google.cloud.aiplatform.v1.ReadTensorboardUsageRequest" do
+      optional :tensorboard, :string, 1
+    end
+    add_message "google.cloud.aiplatform.v1.ReadTensorboardUsageResponse" do
+      map :monthly_usage_data, :string, :message, 1, "google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData"
+    end
+    add_message "google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData" do
+      optional :username, :string, 1
+      optional :view_count, :int64, 2
+    end
+    add_message "google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData" do
+      repeated :user_usage_data, :message, 1, "google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData"
+    end
     add_message "google.cloud.aiplatform.v1.ListTensorboardsRequest" do
       optional :parent, :string, 1
       optional :filter, :string, 2
@@ -199,6 +212,10 @@ module Google
       module V1
         CreateTensorboardRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.CreateTensorboardRequest").msgclass
         GetTensorboardRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.GetTensorboardRequest").msgclass
+        ReadTensorboardUsageRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ReadTensorboardUsageRequest").msgclass
+        ReadTensorboardUsageResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ReadTensorboardUsageResponse").msgclass
+        ReadTensorboardUsageResponse::PerUserUsageData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData").msgclass
+        ReadTensorboardUsageResponse::PerMonthUsageData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData").msgclass
         ListTensorboardsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ListTensorboardsRequest").msgclass
         ListTensorboardsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ListTensorboardsResponse").msgclass
         UpdateTensorboardRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.UpdateTensorboardRequest").msgclass

data/lib/google/cloud/aiplatform/v1/tensorboard_service_services_pb.rb

@@ -37,6 +37,8 @@ module Google
             rpc :CreateTensorboard, ::Google::Cloud::AIPlatform::V1::CreateTensorboardRequest, ::Google::Longrunning::Operation
             # Gets a Tensorboard.
             rpc :GetTensorboard, ::Google::Cloud::AIPlatform::V1::GetTensorboardRequest, ::Google::Cloud::AIPlatform::V1::Tensorboard
+            # Returns a list of monthly active users for a given TensorBoard instance.
+            rpc :ReadTensorboardUsage, ::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageRequest, ::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse
             # Updates a Tensorboard.
             rpc :UpdateTensorboard, ::Google::Cloud::AIPlatform::V1::UpdateTensorboardRequest, ::Google::Longrunning::Operation
             # Lists Tensorboards in a Location.
@@ -79,13 +81,13 @@ module Google
             rpc :DeleteTensorboardTimeSeries, ::Google::Cloud::AIPlatform::V1::DeleteTensorboardTimeSeriesRequest, ::Google::Longrunning::Operation
             # Reads multiple TensorboardTimeSeries' data. The data point number limit is
             # 1000 for scalars, 100 for tensors and blob references. If the number of
-            # data points stored is less than the limit, all data will be returned.
-            # Otherwise, that limit number of data points will be randomly selected from
+            # data points stored is less than the limit, all data is returned.
+            # Otherwise, the number limit of data points is randomly selected from
             # this time series and returned.
             rpc :BatchReadTensorboardTimeSeriesData, ::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest, ::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse
             # Reads a TensorboardTimeSeries' data. By default, if the number of data
-            # points stored is less than 1000, all data will be returned. Otherwise, 1000
-            # data points will be randomly selected from this time series and returned.
+            # points stored is less than 1000, all data is returned. Otherwise, 1000
+            # data points is randomly selected from this time series and returned.
             # This value can be changed by changing max_data_points, which can't be
             # greater than 10k.
             rpc :ReadTensorboardTimeSeriesData, ::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataRequest, ::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse
@@ -95,12 +97,10 @@ module Google
             # permission.
             rpc :ReadTensorboardBlobData, ::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataRequest, stream(::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse)
             # Write time series data points of multiple TensorboardTimeSeries in multiple
-            # TensorboardRun's. If any data fail to be ingested, an error will be
-            # returned.
+            # TensorboardRun's. If any data fail to be ingested, an error is returned.
             rpc :WriteTensorboardExperimentData, ::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataRequest, ::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse
             # Write time series data points into multiple TensorboardTimeSeries under
-            # a TensorboardRun. If any data fail to be ingested, an error will be
-            # returned.
+            # a TensorboardRun. If any data fail to be ingested, an error is returned.
             rpc :WriteTensorboardRunData, ::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataRequest, ::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse
             # Exports a TensorboardTimeSeries' data. Data is returned in paginated
             # responses.

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

@@ -28,8 +28,9 @@ module Google
         #     Output only. Resource name of the Annotation.
         # @!attribute [rw] payload_schema_uri
         #   @return [::String]
-        #     Required. Google Cloud Storage URI points to a YAML file describing {::Google::Cloud::AIPlatform::V1::Annotation#payload payload}. The
-        #     schema is defined as an [OpenAPI 3.0.2 Schema
+        #     Required. Google Cloud Storage URI points to a YAML file describing
+        #     {::Google::Cloud::AIPlatform::V1::Annotation#payload payload}. The schema is
+        #     defined as an [OpenAPI 3.0.2 Schema
         #     Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
         #     The schema files that can be used here are found in
         #     gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
@@ -47,14 +48,15 @@ module Google
         #     Output only. Timestamp when this Annotation was last updated.
         # @!attribute [rw] etag
         #   @return [::String]
-        #     Optional. Used to perform consistent read-modify-write updates. If not set, a blind
-        #     "overwrite" update happens.
+        #     Optional. Used to perform consistent read-modify-write updates. If not set,
+        #     a blind "overwrite" update happens.
         # @!attribute [r] annotation_source
         #   @return [::Google::Cloud::AIPlatform::V1::UserActionReference]
         #     Output only. The source of the Annotation.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
-        #     Optional. The labels with user-defined metadata to organize your Annotations.
+        #     Optional. The labels with user-defined metadata to organize your
+        #     Annotations.
         #
         #     Label keys and values can be no longer than 64 characters
         #     (Unicode codepoints), can only contain lowercase letters, numeric
@@ -71,7 +73,8 @@ module Google
         #       If not set, the Annotation is not visible in the UI.
         #
         #     * "aiplatform.googleapis.com/payload_schema":
-        #       output only, its value is the [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
+        #       output only, its value is the
+        #       [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
         #       title.
         class Annotation
           include ::Google::Protobuf::MessageExts

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

@@ -38,8 +38,8 @@ module Google
         #     Output only. Timestamp when AnnotationSpec was last updated.
         # @!attribute [rw] etag
         #   @return [::String]
-        #     Optional. Used to perform consistent read-modify-write updates. If not set, a blind
-        #     "overwrite" update happens.
+        #     Optional. Used to perform consistent read-modify-write updates. If not set,
+        #     a blind "overwrite" update happens.
         class AnnotationSpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -21,8 +21,10 @@ module Google
   module Cloud
     module AIPlatform
       module V1
-        # A job that uses a {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#model Model} to produce predictions
-        # on multiple {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#input_config input instances}. If
+        # A job that uses a
+        # {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#model Model} to produce
+        # predictions on multiple [input
+        # instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If
         # predictions for significant portion of the instances fail, the job may finish
         # without attempting predictions for all remaining instances.
         # @!attribute [r] name
@@ -43,7 +45,8 @@ module Google
         #     the version, if no version is specified, the default version will be used.
         # @!attribute [r] model_version_id
         #   @return [::String]
-        #     Output only. The version ID of the Model that produces the predictions via this job.
+        #     Output only. The version ID of the Model that produces the predictions via
+        #     this job.
         # @!attribute [rw] unmanaged_container_model
         #   @return [::Google::Cloud::AIPlatform::V1::UnmanagedContainerModel]
         #     Contains model information necessary to perform batch prediction without
@@ -51,15 +54,20 @@ module Google
         #     Exactly one of model and unmanaged_container_model must be set.
         # @!attribute [rw] input_config
         #   @return [::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InputConfig]
-        #     Required. Input configuration of the instances on which predictions are performed.
-        #     The schema of any single instance may be specified via
-        #     the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
+        #     Required. Input configuration of the instances on which predictions are
+        #     performed. The schema of any single instance may be specified via the
+        #     [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
         #     [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
         #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri instance_schema_uri}.
+        # @!attribute [rw] instance_config
+        #   @return [::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig]
+        #     Configuration for how to convert batch prediction input instances to the
+        #     prediction instances that are sent to the Model.
         # @!attribute [rw] model_parameters
         #   @return [::Google::Protobuf::Value]
         #     The parameters that govern the predictions. The schema of the parameters
-        #     may be specified via the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
+        #     may be specified via the
+        #     [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
         #     [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
         #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#parameters_schema_uri parameters_schema_uri}.
         # @!attribute [rw] output_config
@@ -75,7 +83,8 @@ module Google
         # @!attribute [rw] dedicated_resources
         #   @return [::Google::Cloud::AIPlatform::V1::BatchDedicatedResources]
         #     The config of resources used by the Model during the batch prediction. If
-        #     the Model {::Google::Cloud::AIPlatform::V1::Model#supported_deployment_resources_types supports}
+        #     the Model
+        #     {::Google::Cloud::AIPlatform::V1::Model#supported_deployment_resources_types supports}
         #     DEDICATED_RESOURCES this config may be provided (and the job will use these
         #     resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config
         #     must be provided.
@@ -90,35 +99,49 @@ module Google
         #     permission on this service account.
         # @!attribute [rw] manual_batch_tuning_parameters
         #   @return [::Google::Cloud::AIPlatform::V1::ManualBatchTuningParameters]
-        #     Immutable. Parameters configuring the batch behavior. Currently only applicable when
-        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#dedicated_resources dedicated_resources} are used (in other cases Vertex AI does
-        #     the tuning itself).
+        #     Immutable. Parameters configuring the batch behavior. Currently only
+        #     applicable when
+        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#dedicated_resources dedicated_resources}
+        #     are used (in other cases Vertex AI does the tuning itself).
         # @!attribute [rw] generate_explanation
         #   @return [::Boolean]
         #     Generate explanation with the batch prediction results.
         #
         #     When set to `true`, the batch prediction output changes based on the
         #     `predictions_format` field of the
-        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#output_config BatchPredictionJob.output_config} object:
+        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#output_config BatchPredictionJob.output_config}
+        #     object:
         #
         #      * `bigquery`: output includes a column named `explanation`. The value
-        #        is a struct that conforms to the {::Google::Cloud::AIPlatform::V1::Explanation Explanation} object.
+        #        is a struct that conforms to the
+        #        {::Google::Cloud::AIPlatform::V1::Explanation Explanation} object.
         #      * `jsonl`: The JSON objects on each line include an additional entry
         #        keyed `explanation`. The value of the entry is a JSON object that
-        #        conforms to the {::Google::Cloud::AIPlatform::V1::Explanation Explanation} object.
+        #        conforms to the {::Google::Cloud::AIPlatform::V1::Explanation Explanation}
+        #        object.
         #      * `csv`: Generating explanations for CSV format is not supported.
         #
-        #     If this field is set to true, either the {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec} or
-        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#explanation_spec explanation_spec} must be populated.
+        #     If this field is set to true, either the
+        #     {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}
+        #     or
+        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#explanation_spec explanation_spec}
+        #     must be populated.
         # @!attribute [rw] explanation_spec
         #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
         #     Explanation configuration for this BatchPredictionJob. Can be
-        #     specified only if {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#generate_explanation generate_explanation} is set to `true`.
+        #     specified only if
+        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#generate_explanation generate_explanation}
+        #     is set to `true`.
         #
-        #     This value overrides the value of {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}. All fields of
-        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#explanation_spec explanation_spec} are optional in the request. If a field of the
-        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#explanation_spec explanation_spec} object is not populated, the corresponding field of
-        #     the {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec} object is inherited.
+        #     This value overrides the value of
+        #     {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}.
+        #     All fields of
+        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#explanation_spec explanation_spec}
+        #     are optional in the request. If a field of the
+        #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#explanation_spec explanation_spec}
+        #     object is not populated, the corresponding field of the
+        #     {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}
+        #     object is inherited.
         # @!attribute [r] output_info
         #   @return [::Google::Cloud::AIPlatform::V1::BatchPredictionJob::OutputInfo]
         #     Output only. Information further describing the output of this job.
@@ -137,8 +160,8 @@ module Google
         #     Status details fields contain standard Google Cloud error details.
         # @!attribute [r] resources_consumed
         #   @return [::Google::Cloud::AIPlatform::V1::ResourcesConsumed]
-        #     Output only. Information about resources that had been consumed by this job.
-        #     Provided in real time at best effort basis, as well as a final value
+        #     Output only. Information about resources that had been consumed by this
+        #     job. Provided in real time at best effort basis, as well as a final value
         #     once the job completes.
         #
         #     Note: This field currently may be not populated for batch predictions that
@@ -151,12 +174,12 @@ module Google
         #     Output only. Time when the BatchPredictionJob was created.
         # @!attribute [r] start_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. Time when the BatchPredictionJob for the first time entered the
-        #     `JOB_STATE_RUNNING` state.
+        #     Output only. Time when the BatchPredictionJob for the first time entered
+        #     the `JOB_STATE_RUNNING` state.
         # @!attribute [r] end_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. Time when the BatchPredictionJob entered any of the following states:
-        #     `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
+        #     Output only. Time when the BatchPredictionJob entered any of the following
+        #     states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
         # @!attribute [r] update_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Time when the BatchPredictionJob was most recently updated.
@@ -178,9 +201,11 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # Configures the input to {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob}.
-          # See {::Google::Cloud::AIPlatform::V1::Model#supported_input_storage_formats Model.supported_input_storage_formats} for Model's supported input
-          # formats, and how instances should be expressed via any of them.
+          # Configures the input to
+          # {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob}. See
+          # {::Google::Cloud::AIPlatform::V1::Model#supported_input_storage_formats Model.supported_input_storage_formats}
+          # for Model's supported input formats, and how instances should be expressed
+          # via any of them.
           # @!attribute [rw] gcs_source
           #   @return [::Google::Cloud::AIPlatform::V1::GcsSource]
           #     The Cloud Storage location for the input instances.
@@ -201,9 +226,112 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Configures the output of {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob}.
-          # See {::Google::Cloud::AIPlatform::V1::Model#supported_output_storage_formats Model.supported_output_storage_formats} for supported output
-          # formats, and how predictions are expressed via any of them.
+          # Configuration defining how to transform batch prediction input instances to
+          # the instances that the Model accepts.
+          # @!attribute [rw] instance_type
+          #   @return [::String]
+          #     The format of the instance that the Model accepts. Vertex AI will
+          #     convert compatible
+          #     [batch prediction input instance
+          #     formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format]
+          #     to the specified format.
+          #
+          #     Supported values are:
+          #
+          #     * `object`: Each input is converted to JSON object format.
+          #         * For `bigquery`, each row is converted to an object.
+          #         * For `jsonl`, each line of the JSONL input must be an object.
+          #         * Does not apply to `csv`, `file-list`, `tf-record`, or
+          #           `tf-record-gzip`.
+          #
+          #     * `array`: Each input is converted to JSON array format.
+          #         * For `bigquery`, each row is converted to an array. The order
+          #           of columns is determined by the BigQuery column order, unless
+          #           {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig#included_fields included_fields}
+          #           is populated.
+          #           {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig#included_fields included_fields}
+          #           must be populated for specifying field orders.
+          #         * For `jsonl`, if each line of the JSONL input is an object,
+          #           {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig#included_fields included_fields}
+          #           must be populated for specifying field orders.
+          #         * Does not apply to `csv`, `file-list`, `tf-record`, or
+          #           `tf-record-gzip`.
+          #
+          #     If not specified, Vertex AI converts the batch prediction input as
+          #     follows:
+          #
+          #      * For `bigquery` and `csv`, the behavior is the same as `array`. The
+          #        order of columns is the same as defined in the file or table, unless
+          #        {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig#included_fields included_fields}
+          #        is populated.
+          #      * For `jsonl`, the prediction instance format is determined by
+          #        each line of the input.
+          #      * For `tf-record`/`tf-record-gzip`, each record will be converted to
+          #        an object in the format of `{"b64": <value>}`, where `<value>` is
+          #        the Base64-encoded string of the content of the record.
+          #      * For `file-list`, each file in the list will be converted to an
+          #        object in the format of `{"b64": <value>}`, where `<value>` is
+          #        the Base64-encoded string of the content of the file.
+          # @!attribute [rw] key_field
+          #   @return [::String]
+          #     The name of the field that is considered as a key.
+          #
+          #     The values identified by the key field is not included in the transformed
+          #     instances that is sent to the Model. This is similar to
+          #     specifying this name of the field in
+          #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig#excluded_fields excluded_fields}.
+          #     In addition, the batch prediction output will not include the instances.
+          #     Instead the output will only include the value of the key field, in a
+          #     field named `key` in the output:
+          #
+          #      * For `jsonl` output format, the output will have a `key` field
+          #        instead of the `instance` field.
+          #      * For `csv`/`bigquery` output format, the output will have have a `key`
+          #        column instead of the instance feature columns.
+          #
+          #     The input must be JSONL with objects at each line, CSV, BigQuery
+          #     or TfRecord.
+          # @!attribute [rw] included_fields
+          #   @return [::Array<::String>]
+          #     Fields that will be included in the prediction instance that is
+          #     sent to the Model.
+          #
+          #     If
+          #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig#instance_type instance_type}
+          #     is `array`, the order of field names in included_fields also determines
+          #     the order of the values in the array.
+          #
+          #     When included_fields is populated,
+          #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig#excluded_fields excluded_fields}
+          #     must be empty.
+          #
+          #     The input must be JSONL with objects at each line, CSV, BigQuery
+          #     or TfRecord.
+          # @!attribute [rw] excluded_fields
+          #   @return [::Array<::String>]
+          #     Fields that will be excluded in the prediction instance that is
+          #     sent to the Model.
+          #
+          #     Excluded will be attached to the batch prediction output if
+          #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig#key_field key_field}
+          #     is not specified.
+          #
+          #     When excluded_fields is populated,
+          #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::InstanceConfig#included_fields included_fields}
+          #     must be empty.
+          #
+          #     The input must be JSONL with objects at each line, CSV, BigQuery
+          #     or TfRecord.
+          class InstanceConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configures the output of
+          # {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob}. See
+          # {::Google::Cloud::AIPlatform::V1::Model#supported_output_storage_formats Model.supported_output_storage_formats}
+          # for supported output formats, and how predictions are expressed via any of
+          # them.
           # @!attribute [rw] gcs_destination
           #   @return [::Google::Cloud::AIPlatform::V1::GcsDestination]
           #     The Cloud Storage location of the directory where the output is
@@ -213,11 +341,13 @@ module Google
           #     Inside of it files `predictions_0001.<extension>`,
           #     `predictions_0002.<extension>`, ..., `predictions_N.<extension>`
           #     are created where `<extension>` depends on chosen
-          #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::OutputConfig#predictions_format predictions_format}, and N may equal 0001 and depends on the total
-          #     number of successfully predicted instances.
-          #     If the Model has both {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri instance}
-          #     and {::Google::Cloud::AIPlatform::V1::PredictSchemata#parameters_schema_uri prediction} schemata
-          #     defined then each such file contains predictions as per the
+          #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::OutputConfig#predictions_format predictions_format},
+          #     and N may equal 0001 and depends on the total number of successfully
+          #     predicted instances. If the Model has both
+          #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri instance}
+          #     and
+          #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#parameters_schema_uri prediction}
+          #     schemata defined then each such file contains predictions as per the
           #     {::Google::Cloud::AIPlatform::V1::BatchPredictionJob::OutputConfig#predictions_format predictions_format}.
           #     If prediction for any instance failed (partially or completely), then
           #     an additional `errors_0001.<extension>`, `errors_0002.<extension>`,...,
@@ -236,20 +366,22 @@ module Google
           #     become underscores), and timestamp is in
           #     YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset
           #     two tables will be created, `predictions`, and `errors`.
-          #     If the Model has both {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri instance}
-          #     and {::Google::Cloud::AIPlatform::V1::PredictSchemata#parameters_schema_uri prediction} schemata
-          #     defined then the tables have columns as follows: The `predictions`
-          #     table contains instances for which the prediction succeeded, it
-          #     has columns as per a concatenation of the Model's instance and
-          #     prediction schemata. The `errors` table contains rows for which the
-          #     prediction has failed, it has instance columns, as per the
+          #     If the Model has both
+          #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri instance}
+          #     and
+          #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#parameters_schema_uri prediction}
+          #     schemata defined then the tables have columns as follows: The
+          #     `predictions` table contains instances for which the prediction
+          #     succeeded, it has columns as per a concatenation of the Model's
+          #     instance and prediction schemata. The `errors` table contains rows for
+          #     which the prediction has failed, it has instance columns, as per the
           #     instance schema, followed by a single "errors" column, which as values
           #     has {::Google::Rpc::Status google.rpc.Status}
           #     represented as a STRUCT, and containing only `code` and `message`.
           # @!attribute [rw] predictions_format
           #   @return [::String]
-          #     Required. The format in which Vertex AI gives the predictions, must be one of the
-          #     [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
+          #     Required. The format in which Vertex AI gives the predictions, must be
+          #     one of the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
           #     {::Google::Cloud::AIPlatform::V1::Model#supported_output_storage_formats supported_output_storage_formats}.
           class OutputConfig
             include ::Google::Protobuf::MessageExts
@@ -257,11 +389,12 @@ module Google
           end
 
           # Further describes this job's output.
-          # Supplements {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#output_config output_config}.
+          # Supplements
+          # {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#output_config output_config}.
           # @!attribute [r] gcs_output_directory
           #   @return [::String]
-          #     Output only. The full path of the Cloud Storage directory created, into which
-          #     the prediction output is written.
+          #     Output only. The full path of the Cloud Storage directory created, into
+          #     which the prediction output is written.
           # @!attribute [r] bigquery_output_dataset
           #   @return [::String]
           #     Output only. The path of the BigQuery dataset created, in

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

@@ -31,15 +31,16 @@ module Google
         #     Output only. The number of entities for which any error was encountered.
         # @!attribute [r] incomplete_count
         #   @return [::Integer]
-        #     Output only. In cases when enough errors are encountered a job, pipeline, or operation
-        #     may be failed as a whole. Below is the number of entities for which the
-        #     processing had not been finished (either in successful or failed state).
-        #     Set to -1 if the number is unknown (for example, the operation failed
-        #     before the total entity number could be collected).
+        #     Output only. In cases when enough errors are encountered a job, pipeline,
+        #     or operation may be failed as a whole. Below is the number of entities for
+        #     which the processing had not been finished (either in successful or failed
+        #     state). Set to -1 if the number is unknown (for example, the operation
+        #     failed before the total entity number could be collected).
         # @!attribute [r] successful_forecast_point_count
         #   @return [::Integer]
-        #     Output only. The number of the successful forecast points that are generated by the
-        #     forecasting model. This is ONLY used by the forecasting batch prediction.
+        #     Output only. The number of the successful forecast points that are
+        #     generated by the forecasting model. This is ONLY used by the forecasting
+        #     batch prediction.
         class CompletionStats
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -50,8 +50,8 @@ module Google
         #     Output only. Timestamp when this Context was last updated.
         # @!attribute [r] parent_contexts
         #   @return [::Array<::String>]
-        #     Output only. A list of resource names of Contexts that are parents of this Context.
-        #     A Context may have at most 10 parent_contexts.
+        #     Output only. A list of resource names of Contexts that are parents of this
+        #     Context. A Context may have at most 10 parent_contexts.
         # @!attribute [rw] schema_title
         #   @return [::String]
         #     The title of the schema describing the metadata.