google-cloud-ai_platform-v1 0.15.0 → 0.17.0

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.
@@ -84,41 +93,55 @@ module Google
         #     The service account that the DeployedModel's container runs as. If not
         #     specified, a system generated one will be used, which
         #     has minimal permissions and the custom container, if used, may not have
-        #     enough permission to access other GCP resources.
+        #     enough permission to access other Google Cloud resources.
         #
         #     Users deploying the Model must have the `iam.serviceAccounts.actAs`
         #     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.
@@ -134,11 +157,11 @@ module Google
         #     Output only. Partial failures encountered.
         #     For example, single files that can't be read.
         #     This field never exceeds 20 entries.
-        #     Status details fields contain standard GCP error details.
+        #     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.

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

@@ -31,7 +31,7 @@ module Google
         # @!attribute [rw] display_name
         #   @return [::String]
         #     Required. The display name of the CustomJob.
-        #     The name can be up to 128 characters long and can be consist of any UTF-8
+        #     The name can be up to 128 characters long and can consist of any UTF-8
         #     characters.
         # @!attribute [rw] job_spec
         #   @return [::Google::Cloud::AIPlatform::V1::CustomJobSpec]
@@ -76,7 +76,8 @@ module Google
         #     Output only. URIs for accessing [interactive
         #     shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
         #     (one URI for each training node). Only available if
-        #     {::Google::Cloud::AIPlatform::V1::CustomJobSpec#enable_web_access job_spec.enable_web_access} is `true`.
+        #     {::Google::Cloud::AIPlatform::V1::CustomJobSpec#enable_web_access job_spec.enable_web_access}
+        #     is `true`.
         #
         #     The keys are names of each node in the training job; for example,
         #     `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
@@ -110,9 +111,9 @@ module Google
         # Represents the spec of a CustomJob.
         # @!attribute [rw] worker_pool_specs
         #   @return [::Array<::Google::Cloud::AIPlatform::V1::WorkerPoolSpec>]
-        #     Required. The spec of the worker pools including machine type and Docker image.
-        #     All worker pools except the first one are optional and can be skipped by
-        #     providing an empty value.
+        #     Required. The spec of the worker pools including machine type and Docker
+        #     image. All worker pools except the first one are optional and can be
+        #     skipped by providing an empty value.
         # @!attribute [rw] scheduling
         #   @return [::Google::Cloud::AIPlatform::V1::Scheduling]
         #     Scheduling options for a CustomJob.
@@ -154,8 +155,8 @@ module Google
         #     HyperparameterTuningJob. For HyperparameterTuningJob,
         #     the baseOutputDirectory of
         #     each child CustomJob backing a Trial is set to a subdirectory of name
-        #     {::Google::Cloud::AIPlatform::V1::Trial#id id} under its parent HyperparameterTuningJob's
-        #     baseOutputDirectory.
+        #     {::Google::Cloud::AIPlatform::V1::Trial#id id} under its parent
+        #     HyperparameterTuningJob's baseOutputDirectory.
         #
         #     The following Vertex AI environment variables will be passed to
         #     containers or python modules when this field is set:
@@ -173,9 +174,9 @@ module Google
         #       * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
         # @!attribute [rw] tensorboard
         #   @return [::String]
-        #     Optional. The name of a Vertex AI {::Google::Cloud::AIPlatform::V1::Tensorboard Tensorboard} resource to which this CustomJob
-        #     will upload Tensorboard logs.
-        #     Format:
+        #     Optional. The name of a Vertex AI
+        #     {::Google::Cloud::AIPlatform::V1::Tensorboard Tensorboard} resource to which
+        #     this CustomJob will upload Tensorboard logs. Format:
         #     `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
         # @!attribute [rw] enable_web_access
         #   @return [::Boolean]
@@ -184,7 +185,11 @@ module Google
         #     to training containers.
         #
         #     If set to `true`, you can access interactive shells at the URIs given
-        #     by {::Google::Cloud::AIPlatform::V1::CustomJob#web_access_uris CustomJob.web_access_uris} or {::Google::Cloud::AIPlatform::V1::Trial#web_access_uris Trial.web_access_uris} (within
+        #     by
+        #     {::Google::Cloud::AIPlatform::V1::CustomJob#web_access_uris CustomJob.web_access_uris}
+        #     or
+        #     {::Google::Cloud::AIPlatform::V1::Trial#web_access_uris Trial.web_access_uris}
+        #     (within
         #     {::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob#trials HyperparameterTuningJob.trials}).
         class CustomJobSpec
           include ::Google::Protobuf::MessageExts
@@ -218,8 +223,8 @@ module Google
         # The spec of a Container.
         # @!attribute [rw] image_uri
         #   @return [::String]
-        #     Required. The URI of a container image in the Container Registry that is to be run on
-        #     each worker replica.
+        #     Required. The URI of a container image in the Container Registry that is to
+        #     be run on each worker replica.
         # @!attribute [rw] command
         #   @return [::Array<::String>]
         #     The command to be invoked when the container is started.
@@ -239,17 +244,17 @@ module Google
         # The spec of a Python packaged code.
         # @!attribute [rw] executor_image_uri
         #   @return [::String]
-        #     Required. The URI of a container image in Artifact Registry that will run the
-        #     provided Python package. Vertex AI provides a wide range of executor
+        #     Required. The URI of a container image in Artifact Registry that will run
+        #     the provided Python package. Vertex AI provides a wide range of executor
         #     images with pre-installed packages to meet users' various use cases. See
         #     the list of [pre-built containers for
         #     training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
         #     You must use an image from this list.
         # @!attribute [rw] package_uris
         #   @return [::Array<::String>]
-        #     Required. The Google Cloud Storage location of the Python package files which are
-        #     the training program and its dependent packages.
-        #     The maximum number of package URIs is 100.
+        #     Required. The Google Cloud Storage location of the Python package files
+        #     which are the training program and its dependent packages. The maximum
+        #     number of package URIs is 100.
         # @!attribute [rw] python_module
         #   @return [::String]
         #     Required. The Python module name to run after installing the packages.

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

@@ -47,13 +47,14 @@ module Google
         #     and are immutable.
         # @!attribute [rw] payload
         #   @return [::Google::Protobuf::Value]
-        #     Required. The data that the DataItem represents (for example, an image or a text
-        #     snippet). The schema of the payload is stored in the parent Dataset's
-        #     [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] dataItemSchemaUri field.
+        #     Required. The data that the DataItem represents (for example, an image or a
+        #     text snippet). The schema of the payload is stored in the parent Dataset's
+        #     [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
+        #     dataItemSchemaUri field.
         # @!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 DataItem
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -29,14 +29,13 @@ module Google
         # @!attribute [rw] display_name
         #   @return [::String]
         #     Required. The user-defined name of the DataLabelingJob.
-        #     The name can be up to 128 characters long and can be consist of any UTF-8
+        #     The name can be up to 128 characters long and can consist of any UTF-8
         #     characters.
         #     Display name of a DataLabelingJob.
         # @!attribute [rw] datasets
         #   @return [::Array<::String>]
-        #     Required. Dataset resource names. Right now we only support labeling from a single
-        #     Dataset.
-        #     Format:
+        #     Required. Dataset resource names. Right now we only support labeling from a
+        #     single Dataset. Format:
         #     `projects/{project}/locations/{location}/datasets/{dataset}`
         # @!attribute [rw] annotation_labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
@@ -53,14 +52,14 @@ module Google
         #     Required. Number of labelers to work on each DataItem.
         # @!attribute [rw] instruction_uri
         #   @return [::String]
-        #     Required. The Google Cloud Storage location of the instruction pdf. This pdf is
-        #     shared with labelers, and provides detailed description on how to label
-        #     DataItems in Datasets.
+        #     Required. The Google Cloud Storage location of the instruction pdf. This
+        #     pdf is shared with labelers, and provides detailed description on how to
+        #     label DataItems in Datasets.
         # @!attribute [rw] inputs_schema_uri
         #   @return [::String]
-        #     Required. Points to a YAML file stored on Google Cloud Storage describing the
-        #     config for a specific type of DataLabelingJob.
-        #     The schema files that can be used here are found in the
+        #     Required. Points to a YAML file stored on Google Cloud Storage describing
+        #     the config for a specific type of DataLabelingJob. The schema files that
+        #     can be used here are found in the
         #     https://storage.googleapis.com/google-cloud-aiplatform bucket in the
         #     /schema/datalabelingjob/inputs/ folder.
         # @!attribute [rw] inputs
@@ -71,12 +70,12 @@ module Google
         #     Output only. The detailed state of the job.
         # @!attribute [r] labeling_progress
         #   @return [::Integer]
-        #     Output only. Current labeling job progress percentage scaled in interval [0, 100],
-        #     indicating the percentage of DataItems that has been finished.
+        #     Output only. Current labeling job progress percentage scaled in interval
+        #     [0, 100], indicating the percentage of DataItems that has been finished.
         # @!attribute [r] current_spend
         #   @return [::Google::Type::Money]
-        #     Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to
-        #     date.
+        #     Output only. Estimated cost(in US dollars) that the DataLabelingJob has
+        #     incurred to date.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Timestamp when this DataLabelingJob was created.
@@ -85,8 +84,8 @@ module Google
         #     Output only. Timestamp when this DataLabelingJob was updated most recently.
         # @!attribute [r] error
         #   @return [::Google::Rpc::Status]
-        #     Output only. DataLabelingJob errors. It is only populated when job's state is
-        #     `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
+        #     Output only. DataLabelingJob errors. It is only populated when job's state
+        #     is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     The labels with user-defined metadata to organize your DataLabelingJobs.
@@ -100,7 +99,8 @@ module Google
         #     and are immutable. Following system labels exist for each DataLabelingJob:
         #
         #     * "aiplatform.googleapis.com/schema": output only, its value is the
-        #       {::Google::Cloud::AIPlatform::V1::DataLabelingJob#inputs_schema_uri inputs_schema}'s title.
+        #       {::Google::Cloud::AIPlatform::V1::DataLabelingJob#inputs_schema_uri inputs_schema}'s
+        #       title.
         # @!attribute [rw] specialist_pools
         #   @return [::Array<::String>]
         #     The SpecialistPools' resource names associated with this job.