google-cloud-ai_platform-v1 0.16.0 → 0.18.0

data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb

@@ -207,8 +207,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The resource name of the Location to create the TrainingPipeline in.
-            #     Format: `projects/{project}/locations/{location}`
+            #     Required. The resource name of the Location to create the TrainingPipeline
+            #     in. Format: `projects/{project}/locations/{location}`
             #   @param training_pipeline [::Google::Cloud::AIPlatform::V1::TrainingPipeline, ::Hash]
             #     Required. The TrainingPipeline to create.
             #
@@ -382,8 +382,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The resource name of the Location to list the TrainingPipelines from.
-            #     Format: `projects/{project}/locations/{location}`
+            #     Required. The resource name of the Location to list the TrainingPipelines
+            #     from. Format: `projects/{project}/locations/{location}`
             #   @param filter [::String]
             #     The standard list filter.
             #
@@ -410,8 +410,10 @@ module Google
             #   @param page_token [::String]
             #     The standard list page token.
             #     Typically obtained via
-            #     {::Google::Cloud::AIPlatform::V1::ListTrainingPipelinesResponse#next_page_token ListTrainingPipelinesResponse.next_page_token} of the previous
-            #     {::Google::Cloud::AIPlatform::V1::PipelineService::Client#list_training_pipelines PipelineService.ListTrainingPipelines} call.
+            #     {::Google::Cloud::AIPlatform::V1::ListTrainingPipelinesResponse#next_page_token ListTrainingPipelinesResponse.next_page_token}
+            #     of the previous
+            #     {::Google::Cloud::AIPlatform::V1::PipelineService::Client#list_training_pipelines PipelineService.ListTrainingPipelines}
+            #     call.
             #   @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Mask specifying which fields to read.
             #
@@ -585,13 +587,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 {::Google::Cloud::AIPlatform::V1::PipelineService::Client#get_training_pipeline PipelineService.GetTrainingPipeline} or
-            # other methods to check whether the cancellation succeeded or whether the
+            # guaranteed. Clients can use
+            # {::Google::Cloud::AIPlatform::V1::PipelineService::Client#get_training_pipeline 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 {::Google::Cloud::AIPlatform::V1::TrainingPipeline#error TrainingPipeline.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
-            # corresponding to `Code.CANCELLED`, and {::Google::Cloud::AIPlatform::V1::TrainingPipeline#state TrainingPipeline.state} is set to
-            # `CANCELLED`.
+            # a
+            # {::Google::Cloud::AIPlatform::V1::TrainingPipeline#error TrainingPipeline.error}
+            # value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
+            # corresponding to `Code.CANCELLED`, and
+            # {::Google::Cloud::AIPlatform::V1::TrainingPipeline#state TrainingPipeline.state}
+            # is set to `CANCELLED`.
             #
             # @overload cancel_training_pipeline(request, options = nil)
             #   Pass arguments to `cancel_training_pipeline` via a request object, either of type
@@ -920,8 +926,10 @@ module Google
             #   @param page_token [::String]
             #     The standard list page token.
             #     Typically obtained via
-            #     {::Google::Cloud::AIPlatform::V1::ListPipelineJobsResponse#next_page_token ListPipelineJobsResponse.next_page_token} of the previous
-            #     {::Google::Cloud::AIPlatform::V1::PipelineService::Client#list_pipeline_jobs PipelineService.ListPipelineJobs} call.
+            #     {::Google::Cloud::AIPlatform::V1::ListPipelineJobsResponse#next_page_token ListPipelineJobsResponse.next_page_token}
+            #     of the previous
+            #     {::Google::Cloud::AIPlatform::V1::PipelineService::Client#list_pipeline_jobs PipelineService.ListPipelineJobs}
+            #     call.
             #   @param order_by [::String]
             #     A comma-separated list of fields to order by. The default sort order is in
             #     ascending order. Use "desc" after a field name for descending. You can have
@@ -1109,12 +1117,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 {::Google::Cloud::AIPlatform::V1::PipelineService::Client#get_pipeline_job PipelineService.GetPipelineJob} or
-            # other methods to check whether the cancellation succeeded or whether the
+            # guaranteed. Clients can use
+            # {::Google::Cloud::AIPlatform::V1::PipelineService::Client#get_pipeline_job 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 {::Google::Cloud::AIPlatform::V1::PipelineJob#error PipelineJob.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
-            # corresponding to `Code.CANCELLED`, and {::Google::Cloud::AIPlatform::V1::PipelineJob#state PipelineJob.state} is set to
+            # a {::Google::Cloud::AIPlatform::V1::PipelineJob#error PipelineJob.error} value
+            # with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding
+            # to `Code.CANCELLED`, and
+            # {::Google::Cloud::AIPlatform::V1::PipelineJob#state PipelineJob.state} is set to
             # `CANCELLED`.
             #
             # @overload cancel_pipeline_job(request, options = nil)

data/lib/google/cloud/ai_platform/v1/pipeline_service.rb

@@ -36,7 +36,7 @@ module Google
         # `TrainingPipeline` resources (used for AutoML and custom training) and
         # `PipelineJob` resources (used for Vertex AI Pipelines).
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/ai_platform/v1/pipeline_service"
         #     client = ::Google::Cloud::AIPlatform::V1::PipelineService::Client.new

data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb

@@ -206,7 +206,8 @@ module Google
             #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri instance_schema_uri}.
             #   @param parameters [::Google::Protobuf::Value, ::Hash]
             #     The parameters that govern the prediction. The schema of the parameters may
-            #     be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
+            #     be specified via Endpoint's DeployedModels' [Model's
+            #     ][google.cloud.aiplatform.v1.DeployedModel.model]
             #     [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
             #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#parameters_schema_uri parameters_schema_uri}.
             #
@@ -279,11 +280,13 @@ module Google
             #
             # The response includes the following HTTP headers:
             #
-            # * `X-Vertex-AI-Endpoint-Id`: ID of the {::Google::Cloud::AIPlatform::V1::Endpoint Endpoint} that served this
+            # * `X-Vertex-AI-Endpoint-Id`: ID of the
+            # {::Google::Cloud::AIPlatform::V1::Endpoint Endpoint} that served this
             # prediction.
             #
-            # * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}
-            # that served this prediction.
+            # * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
+            # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel} that served this
+            # prediction.
             #
             # @overload raw_predict(request, options = nil)
             #   Pass arguments to `raw_predict` via a request object, either of type
@@ -307,16 +310,18 @@ module Google
             #   @param http_body [::Google::Api::HttpBody, ::Hash]
             #     The prediction input. Supports HTTP headers and arbitrary data payload.
             #
-            #     A {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel} may have an upper limit on the number of instances it
-            #     supports per request. When this limit it is exceeded for an AutoML model,
-            #     the {::Google::Cloud::AIPlatform::V1::PredictionService::Client#raw_predict RawPredict} method returns an error.
-            #     When this limit is exceeded for a custom-trained model, the behavior varies
-            #     depending on the model.
+            #     A {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel} may have an
+            #     upper limit on the number of instances it supports per request. When this
+            #     limit it is exceeded for an AutoML model, the
+            #     {::Google::Cloud::AIPlatform::V1::PredictionService::Client#raw_predict RawPredict}
+            #     method returns an error. When this limit is exceeded for a custom-trained
+            #     model, the behavior varies depending on the model.
             #
             #     You can specify the schema for each instance in the
             #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri predict_schemata.instance_schema_uri}
-            #     field when you create a {::Google::Cloud::AIPlatform::V1::Model Model}. This schema applies when you deploy the
-            #     `Model` as a `DeployedModel` to an {::Google::Cloud::AIPlatform::V1::Endpoint Endpoint} and use the `RawPredict`
+            #     field when you create a {::Google::Cloud::AIPlatform::V1::Model Model}. This
+            #     schema applies when you deploy the `Model` as a `DeployedModel` to an
+            #     {::Google::Cloud::AIPlatform::V1::Endpoint Endpoint} and use the `RawPredict`
             #     method.
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -386,10 +391,12 @@ module Google
             ##
             # Perform an online explanation.
             #
-            # If {::Google::Cloud::AIPlatform::V1::ExplainRequest#deployed_model_id deployed_model_id} is specified,
-            # the corresponding DeployModel must have
+            # If
+            # {::Google::Cloud::AIPlatform::V1::ExplainRequest#deployed_model_id deployed_model_id}
+            # is specified, the corresponding DeployModel must have
             # {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
-            # populated. If {::Google::Cloud::AIPlatform::V1::ExplainRequest#deployed_model_id deployed_model_id}
+            # populated. If
+            # {::Google::Cloud::AIPlatform::V1::ExplainRequest#deployed_model_id deployed_model_id}
             # is not specified, all DeployedModels must have
             # {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
             # populated. Only deployed AutoML tabular Models have
@@ -426,21 +433,23 @@ module Google
             #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri instance_schema_uri}.
             #   @param parameters [::Google::Protobuf::Value, ::Hash]
             #     The parameters that govern the prediction. The schema of the parameters may
-            #     be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
+            #     be specified via Endpoint's DeployedModels' [Model's
+            #     ][google.cloud.aiplatform.v1.DeployedModel.model]
             #     [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
             #     {::Google::Cloud::AIPlatform::V1::PredictSchemata#parameters_schema_uri parameters_schema_uri}.
             #   @param explanation_spec_override [::Google::Cloud::AIPlatform::V1::ExplanationSpecOverride, ::Hash]
             #     If specified, overrides the
-            #     {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec} of the DeployedModel.
-            #     Can be used for explaining prediction results with different
-            #     configurations, such as:
+            #     {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
+            #     of the DeployedModel. Can be used for explaining prediction results with
+            #     different configurations, such as:
             #      - Explaining top-5 predictions results as opposed to top-1;
             #      - Increasing path count or step count of the attribution methods to reduce
             #        approximate errors;
             #      - Using different baselines for explaining the prediction results.
             #   @param deployed_model_id [::String]
             #     If specified, this ExplainRequest will be served by the chosen
-            #     DeployedModel, overriding {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split Endpoint.traffic_split}.
+            #     DeployedModel, overriding
+            #     {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split Endpoint.traffic_split}.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::AIPlatform::V1::ExplainResponse]

data/lib/google/cloud/ai_platform/v1/prediction_service.rb

@@ -33,7 +33,7 @@ module Google
         ##
         # A service for online predictions and explanations.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/ai_platform/v1/prediction_service"
         #     client = ::Google::Cloud::AIPlatform::V1::PredictionService::Client.new

data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb

@@ -398,9 +398,11 @@ module Google
             #     The standard list page size.
             #   @param page_token [::String]
             #     The standard list page token.
-            #     Typically obtained by {::Google::Cloud::AIPlatform::V1::ListSpecialistPoolsResponse#next_page_token ListSpecialistPoolsResponse.next_page_token} of
-            #     the previous {::Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client#list_specialist_pools SpecialistPoolService.ListSpecialistPools} call. Return
-            #     first page if empty.
+            #     Typically obtained by
+            #     {::Google::Cloud::AIPlatform::V1::ListSpecialistPoolsResponse#next_page_token ListSpecialistPoolsResponse.next_page_token}
+            #     of the previous
+            #     {::Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client#list_specialist_pools SpecialistPoolService.ListSpecialistPools}
+            #     call. Return first page if empty.
             #   @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Mask specifying which fields to read. FieldMask represents a set of
             #

data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb

@@ -39,7 +39,7 @@ module Google
         # then Managers will get email notifications to manage Specialists and tasks on
         # CrowdCompute console.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/ai_platform/v1/specialist_pool_service"
         #     client = ::Google::Cloud::AIPlatform::V1::SpecialistPoolService::Client.new