google-cloud-ai_platform-v1 0.16.0 → 0.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +10 -7
- data/lib/google/cloud/ai_platform/v1/dataset_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +28 -21
- data/lib/google/cloud/ai_platform/v1/endpoint_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +10 -9
- data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +53 -50
- data/lib/google/cloud/ai_platform/v1/featurestore_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +18 -14
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/index_service/client.rb +8 -4
- data/lib/google/cloud/ai_platform/v1/index_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/job_service/client.rb +53 -36
- data/lib/google/cloud/ai_platform/v1/job_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +33 -36
- data/lib/google/cloud/ai_platform/v1/metadata_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +3 -4
- data/lib/google/cloud/ai_platform/v1/migration_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/model_service/client.rb +44 -22
- data/lib/google/cloud/ai_platform/v1/model_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +28 -17
- data/lib/google/cloud/ai_platform/v1/pipeline_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +28 -19
- data/lib/google/cloud/ai_platform/v1/prediction_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +5 -3
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +165 -71
- data/lib/google/cloud/ai_platform/v1/tensorboard_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/vizier_service.rb +1 -1
- data/lib/google/cloud/ai_platform/v1.rb +2 -2
- data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +8 -0
- data/lib/google/cloud/aiplatform/v1/custom_job_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +2 -0
- data/lib/google/cloud/aiplatform/v1/index_service_services_pb.rb +2 -1
- data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +24 -14
- data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +10 -5
- data/lib/google/cloud/aiplatform/v1/pipeline_service_services_pb.rb +16 -9
- data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb +10 -6
- data/lib/google/cloud/aiplatform/v1/study_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +17 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_service_services_pb.rb +8 -8
- data/proto_docs/google/cloud/aiplatform/v1/annotation.rb +9 -6
- data/proto_docs/google/cloud/aiplatform/v1/annotation_spec.rb +2 -2
- data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +183 -50
- data/proto_docs/google/cloud/aiplatform/v1/completion_stats.rb +8 -7
- data/proto_docs/google/cloud/aiplatform/v1/context.rb +2 -2
- data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +34 -17
- data/proto_docs/google/cloud/aiplatform/v1/data_item.rb +6 -5
- data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +16 -16
- data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +33 -17
- data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +59 -32
- data/proto_docs/google/cloud/aiplatform/v1/encryption_spec.rb +2 -2
- data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +38 -23
- data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +57 -35
- data/proto_docs/google/cloud/aiplatform/v1/entity_type.rb +8 -6
- data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +111 -75
- data/proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb +58 -38
- data/proto_docs/google/cloud/aiplatform/v1/feature.rb +9 -6
- data/proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb +2 -1
- data/proto_docs/google/cloud/aiplatform/v1/featurestore.rb +12 -11
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb +6 -2
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +27 -19
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +138 -99
- data/proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb +9 -7
- data/proto_docs/google/cloud/aiplatform/v1/index.rb +18 -17
- data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +36 -24
- data/proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb +49 -29
- data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +35 -17
- data/proto_docs/google/cloud/aiplatform/v1/io.rb +2 -1
- data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +94 -57
- data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb +53 -43
- data/proto_docs/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.rb +5 -5
- data/proto_docs/google/cloud/aiplatform/v1/metadata_schema.rb +3 -3
- data/proto_docs/google/cloud/aiplatform/v1/metadata_service.rb +141 -91
- data/proto_docs/google/cloud/aiplatform/v1/migratable_resource.rb +3 -3
- data/proto_docs/google/cloud/aiplatform/v1/migration_service.rb +18 -15
- data/proto_docs/google/cloud/aiplatform/v1/model.rb +179 -132
- data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +21 -17
- data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +7 -6
- data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +11 -7
- data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +4 -2
- data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +110 -54
- data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +56 -42
- data/proto_docs/google/cloud/aiplatform/v1/pipeline_service.rb +42 -22
- data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +42 -28
- data/proto_docs/google/cloud/aiplatform/v1/saved_query.rb +2 -2
- data/proto_docs/google/cloud/aiplatform/v1/specialist_pool_service.rb +19 -11
- data/proto_docs/google/cloud/aiplatform/v1/study.rb +42 -25
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard.rb +2 -2
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb +8 -7
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb +2 -1
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb +203 -109
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_time_series.rb +8 -6
- data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +84 -59
- data/proto_docs/google/cloud/aiplatform/v1/unmanaged_container_model.rb +2 -2
- data/proto_docs/google/cloud/aiplatform/v1/vizier_service.rb +40 -20
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +9 -9
@@ -408,8 +408,10 @@ module Google
|
|
408
408
|
# @param page_token [::String]
|
409
409
|
# The standard list page token.
|
410
410
|
# Typically obtained via
|
411
|
-
# {::Google::Cloud::AIPlatform::V1::ListCustomJobsResponse#next_page_token ListCustomJobsResponse.next_page_token}
|
412
|
-
#
|
411
|
+
# {::Google::Cloud::AIPlatform::V1::ListCustomJobsResponse#next_page_token ListCustomJobsResponse.next_page_token}
|
412
|
+
# of the previous
|
413
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#list_custom_jobs JobService.ListCustomJobs}
|
414
|
+
# call.
|
413
415
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
414
416
|
# Mask specifying which fields to read.
|
415
417
|
#
|
@@ -583,12 +585,15 @@ module Google
|
|
583
585
|
# Cancels a CustomJob.
|
584
586
|
# Starts asynchronous cancellation on the CustomJob. The server
|
585
587
|
# makes a best effort to cancel the job, but success is not
|
586
|
-
# guaranteed. Clients can use
|
587
|
-
#
|
588
|
+
# guaranteed. Clients can use
|
589
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#get_custom_job JobService.GetCustomJob}
|
590
|
+
# or other methods to check whether the cancellation succeeded or whether the
|
588
591
|
# job completed despite cancellation. On successful cancellation,
|
589
592
|
# the CustomJob is not deleted; instead it becomes a job with
|
590
|
-
# a {::Google::Cloud::AIPlatform::V1::CustomJob#error CustomJob.error} value with
|
591
|
-
#
|
593
|
+
# a {::Google::Cloud::AIPlatform::V1::CustomJob#error CustomJob.error} value with
|
594
|
+
# a {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
|
595
|
+
# `Code.CANCELLED`, and
|
596
|
+
# {::Google::Cloud::AIPlatform::V1::CustomJob#state CustomJob.state} is set to
|
592
597
|
# `CANCELLED`.
|
593
598
|
#
|
594
599
|
# @overload cancel_custom_job(request, options = nil)
|
@@ -1178,8 +1183,9 @@ module Google
|
|
1178
1183
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1179
1184
|
#
|
1180
1185
|
# @param parent [::String]
|
1181
|
-
# Required. The resource name of the Location to create the
|
1182
|
-
# Format:
|
1186
|
+
# Required. The resource name of the Location to create the
|
1187
|
+
# HyperparameterTuningJob in. Format:
|
1188
|
+
# `projects/{project}/locations/{location}`
|
1183
1189
|
# @param hyperparameter_tuning_job [::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob, ::Hash]
|
1184
1190
|
# Required. The HyperparameterTuningJob to create.
|
1185
1191
|
#
|
@@ -1353,8 +1359,9 @@ module Google
|
|
1353
1359
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1354
1360
|
#
|
1355
1361
|
# @param parent [::String]
|
1356
|
-
# Required. The resource name of the Location to list the
|
1357
|
-
# from. Format:
|
1362
|
+
# Required. The resource name of the Location to list the
|
1363
|
+
# HyperparameterTuningJobs from. Format:
|
1364
|
+
# `projects/{project}/locations/{location}`
|
1358
1365
|
# @param filter [::String]
|
1359
1366
|
# The standard list filter.
|
1360
1367
|
#
|
@@ -1381,8 +1388,10 @@ module Google
|
|
1381
1388
|
# @param page_token [::String]
|
1382
1389
|
# The standard list page token.
|
1383
1390
|
# Typically obtained via
|
1384
|
-
# {::Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsResponse#next_page_token ListHyperparameterTuningJobsResponse.next_page_token}
|
1385
|
-
#
|
1391
|
+
# {::Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsResponse#next_page_token ListHyperparameterTuningJobsResponse.next_page_token}
|
1392
|
+
# of the previous
|
1393
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#list_hyperparameter_tuning_jobs JobService.ListHyperparameterTuningJobs}
|
1394
|
+
# call.
|
1386
1395
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1387
1396
|
# Mask specifying which fields to read.
|
1388
1397
|
#
|
@@ -1556,13 +1565,17 @@ module Google
|
|
1556
1565
|
# Cancels a HyperparameterTuningJob.
|
1557
1566
|
# Starts asynchronous cancellation on the HyperparameterTuningJob. The server
|
1558
1567
|
# makes a best effort to cancel the job, but success is not
|
1559
|
-
# guaranteed. Clients can use
|
1560
|
-
#
|
1568
|
+
# guaranteed. Clients can use
|
1569
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#get_hyperparameter_tuning_job JobService.GetHyperparameterTuningJob}
|
1570
|
+
# or other methods to check whether the cancellation succeeded or whether the
|
1561
1571
|
# job completed despite cancellation. On successful cancellation,
|
1562
1572
|
# the HyperparameterTuningJob is not deleted; instead it becomes a job with
|
1563
|
-
# a
|
1564
|
-
#
|
1565
|
-
# {::Google::
|
1573
|
+
# a
|
1574
|
+
# {::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob#error HyperparameterTuningJob.error}
|
1575
|
+
# value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
|
1576
|
+
# corresponding to `Code.CANCELLED`, and
|
1577
|
+
# {::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob#state HyperparameterTuningJob.state}
|
1578
|
+
# is set to `CANCELLED`.
|
1566
1579
|
#
|
1567
1580
|
# @overload cancel_hyperparameter_tuning_job(request, options = nil)
|
1568
1581
|
# Pass arguments to `cancel_hyperparameter_tuning_job` via a request object, either of type
|
@@ -1668,8 +1681,8 @@ module Google
|
|
1668
1681
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1669
1682
|
#
|
1670
1683
|
# @param parent [::String]
|
1671
|
-
# Required. The resource name of the Location to create the
|
1672
|
-
# Format: `projects/{project}/locations/{location}`
|
1684
|
+
# Required. The resource name of the Location to create the
|
1685
|
+
# BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
|
1673
1686
|
# @param batch_prediction_job [::Google::Cloud::AIPlatform::V1::BatchPredictionJob, ::Hash]
|
1674
1687
|
# Required. The BatchPredictionJob to create.
|
1675
1688
|
#
|
@@ -1872,8 +1885,10 @@ module Google
|
|
1872
1885
|
# @param page_token [::String]
|
1873
1886
|
# The standard list page token.
|
1874
1887
|
# Typically obtained via
|
1875
|
-
# {::Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsResponse#next_page_token ListBatchPredictionJobsResponse.next_page_token}
|
1876
|
-
#
|
1888
|
+
# {::Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsResponse#next_page_token ListBatchPredictionJobsResponse.next_page_token}
|
1889
|
+
# of the previous
|
1890
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#list_batch_prediction_jobs JobService.ListBatchPredictionJobs}
|
1891
|
+
# call.
|
1877
1892
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1878
1893
|
# Mask specifying which fields to read.
|
1879
1894
|
#
|
@@ -2049,12 +2064,14 @@ module Google
|
|
2049
2064
|
#
|
2050
2065
|
# Starts asynchronous cancellation on the BatchPredictionJob. The server
|
2051
2066
|
# makes the best effort to cancel the job, but success is not
|
2052
|
-
# guaranteed. Clients can use
|
2053
|
-
#
|
2067
|
+
# guaranteed. Clients can use
|
2068
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#get_batch_prediction_job JobService.GetBatchPredictionJob}
|
2069
|
+
# or other methods to check whether the cancellation succeeded or whether the
|
2054
2070
|
# job completed despite cancellation. On a successful cancellation,
|
2055
2071
|
# the BatchPredictionJob is not deleted;instead its
|
2056
|
-
# {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#state BatchPredictionJob.state}
|
2057
|
-
# outputted by the job are not
|
2072
|
+
# {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#state BatchPredictionJob.state}
|
2073
|
+
# is set to `CANCELLED`. Any files already outputted by the job are not
|
2074
|
+
# deleted.
|
2058
2075
|
#
|
2059
2076
|
# @overload cancel_batch_prediction_job(request, options = nil)
|
2060
2077
|
# Pass arguments to `cancel_batch_prediction_job` via a request object, either of type
|
@@ -2571,17 +2588,16 @@ module Google
|
|
2571
2588
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2572
2589
|
#
|
2573
2590
|
# @param model_deployment_monitoring_job [::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob, ::Hash]
|
2574
|
-
# Required. The model monitoring configuration which replaces the resource on
|
2575
|
-
# server.
|
2591
|
+
# Required. The model monitoring configuration which replaces the resource on
|
2592
|
+
# the server.
|
2576
2593
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2577
|
-
# Required. The update mask is used to specify the fields to be overwritten
|
2578
|
-
# ModelDeploymentMonitoringJob resource by the update.
|
2579
|
-
#
|
2580
|
-
#
|
2581
|
-
#
|
2582
|
-
#
|
2583
|
-
#
|
2584
|
-
# For the objective config, the user can either provide the update mask for
|
2594
|
+
# Required. The update mask is used to specify the fields to be overwritten
|
2595
|
+
# in the ModelDeploymentMonitoringJob resource by the update. The fields
|
2596
|
+
# specified in the update_mask are relative to the resource, not the full
|
2597
|
+
# request. A field will be overwritten if it is in the mask. If the user does
|
2598
|
+
# not provide a mask then only the non-empty fields present in the request
|
2599
|
+
# will be overwritten. Set the update_mask to `*` to override all fields. For
|
2600
|
+
# the objective config, the user can either provide the update mask for
|
2585
2601
|
# model_deployment_monitoring_objective_configs or any combination of its
|
2586
2602
|
# nested fields, such as:
|
2587
2603
|
# model_deployment_monitoring_objective_configs.objective_config.training_dataset.
|
@@ -2772,7 +2788,8 @@ module Google
|
|
2772
2788
|
##
|
2773
2789
|
# Pauses a ModelDeploymentMonitoringJob. If the job is running, the server
|
2774
2790
|
# makes a best effort to cancel the job. Will mark
|
2775
|
-
# {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob#state ModelDeploymentMonitoringJob.state}
|
2791
|
+
# {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob#state ModelDeploymentMonitoringJob.state}
|
2792
|
+
# to 'PAUSED'.
|
2776
2793
|
#
|
2777
2794
|
# @overload pause_model_deployment_monitoring_job(request, options = nil)
|
2778
2795
|
# Pass arguments to `pause_model_deployment_monitoring_job` via a request object, either of type
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
##
|
35
35
|
# A service for creating and managing Vertex AI's jobs.
|
36
36
|
#
|
37
|
-
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
38
|
#
|
39
39
|
# require "google/cloud/ai_platform/v1/job_service"
|
40
40
|
# client = ::Google::Cloud::AIPlatform::V1::JobService::Client.new
|
@@ -406,8 +406,8 @@ module Google
|
|
406
406
|
# Must be in range 1-1000, inclusive. Defaults to 100.
|
407
407
|
# @param page_token [::String]
|
408
408
|
# A page token, received from a previous
|
409
|
-
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_metadata_stores MetadataService.ListMetadataStores}
|
410
|
-
# subsequent page.
|
409
|
+
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_metadata_stores MetadataService.ListMetadataStores}
|
410
|
+
# call. Provide this to retrieve the subsequent page.
|
411
411
|
#
|
412
412
|
# When paginating, all other provided parameters must match the call that
|
413
413
|
# provided the page token. (Otherwise the request will fail with
|
@@ -793,7 +793,8 @@ module Google
|
|
793
793
|
# The maximum number of Artifacts to return. The service may return fewer.
|
794
794
|
# Must be in range 1-1000, inclusive. Defaults to 100.
|
795
795
|
# @param page_token [::String]
|
796
|
-
# A page token, received from a previous
|
796
|
+
# A page token, received from a previous
|
797
|
+
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_artifacts MetadataService.ListArtifacts}
|
797
798
|
# call. Provide this to retrieve the subsequent page.
|
798
799
|
#
|
799
800
|
# When paginating, all other provided parameters must match the call that
|
@@ -927,15 +928,15 @@ module Google
|
|
927
928
|
#
|
928
929
|
# @param artifact [::Google::Cloud::AIPlatform::V1::Artifact, ::Hash]
|
929
930
|
# Required. The Artifact containing updates.
|
930
|
-
# The Artifact's {::Google::Cloud::AIPlatform::V1::Artifact#name Artifact.name}
|
931
|
-
# be updated.
|
932
|
-
# Format:
|
931
|
+
# The Artifact's {::Google::Cloud::AIPlatform::V1::Artifact#name Artifact.name}
|
932
|
+
# field is used to identify the Artifact to be updated. Format:
|
933
933
|
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
|
934
934
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
935
935
|
# Optional. A FieldMask indicating which fields should be updated.
|
936
936
|
# Functionality of this field is not yet supported.
|
937
937
|
# @param allow_missing [::Boolean]
|
938
|
-
# If set to true, and the {::Google::Cloud::AIPlatform::V1::Artifact Artifact} is
|
938
|
+
# If set to true, and the {::Google::Cloud::AIPlatform::V1::Artifact Artifact} is
|
939
|
+
# not found, a new {::Google::Cloud::AIPlatform::V1::Artifact Artifact} is
|
939
940
|
# created.
|
940
941
|
#
|
941
942
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -1222,9 +1223,8 @@ module Google
|
|
1222
1223
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1223
1224
|
#
|
1224
1225
|
# @param parent [::String]
|
1225
|
-
# Required. The resource name of the MetadataStore where the Context should
|
1226
|
-
# created.
|
1227
|
-
# Format:
|
1226
|
+
# Required. The resource name of the MetadataStore where the Context should
|
1227
|
+
# be created. Format:
|
1228
1228
|
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
1229
1229
|
# @param context [::Google::Cloud::AIPlatform::V1::Context, ::Hash]
|
1230
1230
|
# Required. The Context to create.
|
@@ -1414,7 +1414,8 @@ module Google
|
|
1414
1414
|
# The maximum number of Contexts to return. The service may return fewer.
|
1415
1415
|
# Must be in range 1-1000, inclusive. Defaults to 100.
|
1416
1416
|
# @param page_token [::String]
|
1417
|
-
# A page token, received from a previous
|
1417
|
+
# A page token, received from a previous
|
1418
|
+
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_contexts MetadataService.ListContexts}
|
1418
1419
|
# call. Provide this to retrieve the subsequent page.
|
1419
1420
|
#
|
1420
1421
|
# When paginating, all other provided parameters must match the call that
|
@@ -1552,16 +1553,15 @@ module Google
|
|
1552
1553
|
#
|
1553
1554
|
# @param context [::Google::Cloud::AIPlatform::V1::Context, ::Hash]
|
1554
1555
|
# Required. The Context containing updates.
|
1555
|
-
# The Context's {::Google::Cloud::AIPlatform::V1::Context#name Context.name} field
|
1556
|
-
# updated.
|
1557
|
-
# Format:
|
1556
|
+
# The Context's {::Google::Cloud::AIPlatform::V1::Context#name Context.name} field
|
1557
|
+
# is used to identify the Context to be updated. Format:
|
1558
1558
|
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
|
1559
1559
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1560
1560
|
# Optional. A FieldMask indicating which fields should be updated.
|
1561
1561
|
# Functionality of this field is not yet supported.
|
1562
1562
|
# @param allow_missing [::Boolean]
|
1563
|
-
# If set to true, and the {::Google::Cloud::AIPlatform::V1::Context Context} is
|
1564
|
-
# created.
|
1563
|
+
# If set to true, and the {::Google::Cloud::AIPlatform::V1::Context Context} is
|
1564
|
+
# not found, a new {::Google::Cloud::AIPlatform::V1::Context Context} is created.
|
1565
1565
|
#
|
1566
1566
|
# @yield [response, operation] Access the result along with the RPC operation
|
1567
1567
|
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Context]
|
@@ -1852,9 +1852,8 @@ module Google
|
|
1852
1852
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1853
1853
|
#
|
1854
1854
|
# @param context [::String]
|
1855
|
-
# Required. The resource name of the Context that the Artifacts and
|
1856
|
-
# belong to.
|
1857
|
-
# Format:
|
1855
|
+
# Required. The resource name of the Context that the Artifacts and
|
1856
|
+
# Executions belong to. Format:
|
1858
1857
|
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
|
1859
1858
|
# @param artifacts [::Array<::String>]
|
1860
1859
|
# The resource names of the Artifacts to attribute to the Context.
|
@@ -2423,7 +2422,8 @@ module Google
|
|
2423
2422
|
# The maximum number of Executions to return. The service may return fewer.
|
2424
2423
|
# Must be in range 1-1000, inclusive. Defaults to 100.
|
2425
2424
|
# @param page_token [::String]
|
2426
|
-
# A page token, received from a previous
|
2425
|
+
# A page token, received from a previous
|
2426
|
+
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_executions MetadataService.ListExecutions}
|
2427
2427
|
# call. Provide this to retrieve the subsequent page.
|
2428
2428
|
#
|
2429
2429
|
# When paginating, all other provided parameters must match the call that
|
@@ -2557,16 +2557,16 @@ module Google
|
|
2557
2557
|
#
|
2558
2558
|
# @param execution [::Google::Cloud::AIPlatform::V1::Execution, ::Hash]
|
2559
2559
|
# Required. The Execution containing updates.
|
2560
|
-
# The Execution's {::Google::Cloud::AIPlatform::V1::Execution#name Execution.name}
|
2561
|
-
# to be updated.
|
2562
|
-
# Format:
|
2560
|
+
# The Execution's {::Google::Cloud::AIPlatform::V1::Execution#name Execution.name}
|
2561
|
+
# field is used to identify the Execution to be updated. Format:
|
2563
2562
|
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
|
2564
2563
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2565
2564
|
# Optional. A FieldMask indicating which fields should be updated.
|
2566
2565
|
# Functionality of this field is not yet supported.
|
2567
2566
|
# @param allow_missing [::Boolean]
|
2568
|
-
# If set to true, and the {::Google::Cloud::AIPlatform::V1::Execution Execution}
|
2569
|
-
# is
|
2567
|
+
# If set to true, and the {::Google::Cloud::AIPlatform::V1::Execution Execution}
|
2568
|
+
# is not found, a new {::Google::Cloud::AIPlatform::V1::Execution Execution} is
|
2569
|
+
# created.
|
2570
2570
|
#
|
2571
2571
|
# @yield [response, operation] Access the result along with the RPC operation
|
2572
2572
|
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Execution]
|
@@ -2947,9 +2947,8 @@ module Google
|
|
2947
2947
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2948
2948
|
#
|
2949
2949
|
# @param execution [::String]
|
2950
|
-
# Required. The resource name of the Execution whose input and output
|
2951
|
-
# be retrieved as a LineageSubgraph.
|
2952
|
-
# Format:
|
2950
|
+
# Required. The resource name of the Execution whose input and output
|
2951
|
+
# Artifacts should be retrieved as a LineageSubgraph. Format:
|
2953
2952
|
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
|
2954
2953
|
#
|
2955
2954
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -3035,9 +3034,8 @@ module Google
|
|
3035
3034
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
3036
3035
|
#
|
3037
3036
|
# @param parent [::String]
|
3038
|
-
# Required. The resource name of the MetadataStore where the MetadataSchema
|
3039
|
-
# be created.
|
3040
|
-
# Format:
|
3037
|
+
# Required. The resource name of the MetadataStore where the MetadataSchema
|
3038
|
+
# should be created. Format:
|
3041
3039
|
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
3042
3040
|
# @param metadata_schema [::Google::Cloud::AIPlatform::V1::MetadataSchema, ::Hash]
|
3043
3041
|
# Required. The MetadataSchema to create.
|
@@ -3230,8 +3228,8 @@ module Google
|
|
3230
3228
|
# Must be in range 1-1000, inclusive. Defaults to 100.
|
3231
3229
|
# @param page_token [::String]
|
3232
3230
|
# A page token, received from a previous
|
3233
|
-
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_metadata_schemas MetadataService.ListMetadataSchemas}
|
3234
|
-
# next page.
|
3231
|
+
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_metadata_schemas MetadataService.ListMetadataSchemas}
|
3232
|
+
# call. Provide this to retrieve the next page.
|
3235
3233
|
#
|
3236
3234
|
# When paginating, all other provided parameters must match the call that
|
3237
3235
|
# provided the page token. (Otherwise the request will fail with
|
@@ -3330,9 +3328,8 @@ module Google
|
|
3330
3328
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
3331
3329
|
#
|
3332
3330
|
# @param artifact [::String]
|
3333
|
-
# Required. The resource name of the Artifact whose Lineage needs to be
|
3334
|
-
# LineageSubgraph.
|
3335
|
-
# Format:
|
3331
|
+
# Required. The resource name of the Artifact whose Lineage needs to be
|
3332
|
+
# retrieved as a LineageSubgraph. Format:
|
3336
3333
|
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
|
3337
3334
|
#
|
3338
3335
|
# The request may error with FAILED_PRECONDITION if the number of Artifacts,
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
##
|
35
35
|
# Service for reading and writing metadata entries.
|
36
36
|
#
|
37
|
-
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
38
|
#
|
39
39
|
# require "google/cloud/ai_platform/v1/metadata_service"
|
40
40
|
# client = ::Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
@@ -207,10 +207,9 @@ module Google
|
|
207
207
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
208
208
|
#
|
209
209
|
# @param parent [::String]
|
210
|
-
# Required. The location that the migratable resources should be searched
|
211
|
-
# It's the Vertex AI location that the resources can be migrated to,
|
212
|
-
# the resources' original location.
|
213
|
-
# Format:
|
210
|
+
# Required. The location that the migratable resources should be searched
|
211
|
+
# from. It's the Vertex AI location that the resources can be migrated to,
|
212
|
+
# not the resources' original location. Format:
|
214
213
|
# `projects/{project}/locations/{location}`
|
215
214
|
# @param page_size [::Integer]
|
216
215
|
# The standard page size.
|
@@ -35,7 +35,7 @@ module Google
|
|
35
35
|
# A service that migrates resources from automl.googleapis.com,
|
36
36
|
# datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
|
37
37
|
#
|
38
|
-
#
|
38
|
+
# @example Load this service and instantiate a gRPC client
|
39
39
|
#
|
40
40
|
# require "google/cloud/ai_platform/v1/migration_service"
|
41
41
|
# client = ::Google::Cloud::AIPlatform::V1::MigrationService::Client.new
|
@@ -207,8 +207,8 @@ module Google
|
|
207
207
|
# Required. The resource name of the Location into which to upload the Model.
|
208
208
|
# Format: `projects/{project}/locations/{location}`
|
209
209
|
# @param parent_model [::String]
|
210
|
-
# Optional. The resource name of the model into which to upload the version.
|
211
|
-
# specify this field when uploading a new version.
|
210
|
+
# Optional. The resource name of the model into which to upload the version.
|
211
|
+
# Only specify this field when uploading a new version.
|
212
212
|
# @param model_id [::String]
|
213
213
|
# Optional. The ID to use for the uploaded Model, which will become the final
|
214
214
|
# component of the model resource name.
|
@@ -420,7 +420,8 @@ module Google
|
|
420
420
|
# both snake_case and camelCase are supported.
|
421
421
|
#
|
422
422
|
# * `model` supports = and !=. `model` represents the Model ID,
|
423
|
-
# i.e. the last segment of the Model's
|
423
|
+
# i.e. the last segment of the Model's [resource
|
424
|
+
# name][google.cloud.aiplatform.v1.Model.name].
|
424
425
|
# * `display_name` supports = and !=
|
425
426
|
# * `labels` supports general map functions that is:
|
426
427
|
# * `labels.key=value` - key:value equality
|
@@ -437,8 +438,10 @@ module Google
|
|
437
438
|
# @param page_token [::String]
|
438
439
|
# The standard list page token.
|
439
440
|
# Typically obtained via
|
440
|
-
# {::Google::Cloud::AIPlatform::V1::ListModelsResponse#next_page_token ListModelsResponse.next_page_token}
|
441
|
-
#
|
441
|
+
# {::Google::Cloud::AIPlatform::V1::ListModelsResponse#next_page_token ListModelsResponse.next_page_token}
|
442
|
+
# of the previous
|
443
|
+
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_models ModelService.ListModels}
|
444
|
+
# call.
|
442
445
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
443
446
|
# Mask specifying which fields to read.
|
444
447
|
# @param order_by [::String]
|
@@ -536,7 +539,7 @@ module Google
|
|
536
539
|
# @param options [::Gapic::CallOptions, ::Hash]
|
537
540
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
538
541
|
#
|
539
|
-
# @overload list_model_versions(name: nil, page_size: nil, page_token: nil, filter: nil, read_mask: nil)
|
542
|
+
# @overload list_model_versions(name: nil, page_size: nil, page_token: nil, filter: nil, read_mask: nil, order_by: nil)
|
540
543
|
# Pass arguments to `list_model_versions` via keyword arguments. Note that at
|
541
544
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
542
545
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -548,8 +551,8 @@ module Google
|
|
548
551
|
# @param page_token [::String]
|
549
552
|
# The standard list page token.
|
550
553
|
# Typically obtained via
|
551
|
-
# {::Google::Cloud::AIPlatform::V1::ListModelVersionsResponse#next_page_token ListModelVersionsResponse.next_page_token}
|
552
|
-
# [ModelService.ListModelversions][] call.
|
554
|
+
# {::Google::Cloud::AIPlatform::V1::ListModelVersionsResponse#next_page_token ListModelVersionsResponse.next_page_token}
|
555
|
+
# of the previous [ModelService.ListModelversions][] call.
|
553
556
|
# @param filter [::String]
|
554
557
|
# An expression for filtering the results of the request. For field names
|
555
558
|
# both snake_case and camelCase are supported.
|
@@ -564,6 +567,15 @@ module Google
|
|
564
567
|
# * `labels.myKey="myValue"`
|
565
568
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
566
569
|
# Mask specifying which fields to read.
|
570
|
+
# @param order_by [::String]
|
571
|
+
# A comma-separated list of fields to order by, sorted in ascending order.
|
572
|
+
# Use "desc" after a field name for descending.
|
573
|
+
# Supported fields:
|
574
|
+
#
|
575
|
+
# * `create_time`
|
576
|
+
# * `update_time`
|
577
|
+
#
|
578
|
+
# Example: `update_time asc, create_time desc`.
|
567
579
|
#
|
568
580
|
# @yield [response, operation] Access the result along with the RPC operation
|
569
581
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Model>]
|
@@ -675,7 +687,8 @@ module Google
|
|
675
687
|
# must update them separately.
|
676
688
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
677
689
|
# Required. The update mask applies to the resource.
|
678
|
-
# For the `FieldMask` definition, see
|
690
|
+
# For the `FieldMask` definition, see
|
691
|
+
# {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
|
679
692
|
#
|
680
693
|
# @yield [response, operation] Access the result along with the RPC operation
|
681
694
|
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Model]
|
@@ -744,9 +757,12 @@ module Google
|
|
744
757
|
##
|
745
758
|
# Deletes a Model.
|
746
759
|
#
|
747
|
-
# A model cannot be deleted if any
|
748
|
-
# {::Google::Cloud::AIPlatform::V1::
|
749
|
-
# {::Google::Cloud::AIPlatform::V1::
|
760
|
+
# A model cannot be deleted if any
|
761
|
+
# {::Google::Cloud::AIPlatform::V1::Endpoint Endpoint} resource has a
|
762
|
+
# {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel} based on the
|
763
|
+
# model in its
|
764
|
+
# {::Google::Cloud::AIPlatform::V1::Endpoint#deployed_models deployed_models}
|
765
|
+
# field.
|
750
766
|
#
|
751
767
|
# @overload delete_model(request, options = nil)
|
752
768
|
# Pass arguments to `delete_model` via a request object, either of type
|
@@ -844,7 +860,8 @@ module Google
|
|
844
860
|
#
|
845
861
|
# Model version can only be deleted if there are no [DeployedModels][]
|
846
862
|
# created from it. Deleting the only version in the Model is not allowed. Use
|
847
|
-
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#delete_model DeleteModel} for
|
863
|
+
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#delete_model DeleteModel} for
|
864
|
+
# deleting the Model instead.
|
848
865
|
#
|
849
866
|
# @overload delete_model_version(request, options = nil)
|
850
867
|
# Pass arguments to `delete_model_version` via a request object, either of type
|
@@ -862,8 +879,8 @@ module Google
|
|
862
879
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
863
880
|
#
|
864
881
|
# @param name [::String]
|
865
|
-
# Required. The name of the model version to be deleted, with a version ID
|
866
|
-
# included.
|
882
|
+
# Required. The name of the model version to be deleted, with a version ID
|
883
|
+
# explicitly included.
|
867
884
|
#
|
868
885
|
# Example: `projects/{project}/locations/{location}/models/{model}@1234`
|
869
886
|
#
|
@@ -1043,7 +1060,8 @@ module Google
|
|
1043
1060
|
##
|
1044
1061
|
# Exports a trained, exportable Model to a location specified by the
|
1045
1062
|
# user. A Model is considered to be exportable if it has at least one
|
1046
|
-
#
|
1063
|
+
# [supported export
|
1064
|
+
# format][google.cloud.aiplatform.v1.Model.supported_export_formats].
|
1047
1065
|
#
|
1048
1066
|
# @overload export_model(request, options = nil)
|
1049
1067
|
# Pass arguments to `export_model` via a request object, either of type
|
@@ -1431,8 +1449,10 @@ module Google
|
|
1431
1449
|
# @param page_token [::String]
|
1432
1450
|
# The standard list page token.
|
1433
1451
|
# Typically obtained via
|
1434
|
-
# {::Google::Cloud::AIPlatform::V1::ListModelEvaluationsResponse#next_page_token ListModelEvaluationsResponse.next_page_token}
|
1435
|
-
#
|
1452
|
+
# {::Google::Cloud::AIPlatform::V1::ListModelEvaluationsResponse#next_page_token ListModelEvaluationsResponse.next_page_token}
|
1453
|
+
# of the previous
|
1454
|
+
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluations ModelService.ListModelEvaluations}
|
1455
|
+
# call.
|
1436
1456
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1437
1457
|
# Mask specifying which fields to read.
|
1438
1458
|
#
|
@@ -1613,8 +1633,8 @@ module Google
|
|
1613
1633
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1614
1634
|
#
|
1615
1635
|
# @param parent [::String]
|
1616
|
-
# Required. The resource name of the ModelEvaluation to list the
|
1617
|
-
# from. Format:
|
1636
|
+
# Required. The resource name of the ModelEvaluation to list the
|
1637
|
+
# ModelEvaluationSlices from. Format:
|
1618
1638
|
# `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
|
1619
1639
|
# @param filter [::String]
|
1620
1640
|
# The standard list filter.
|
@@ -1625,8 +1645,10 @@ module Google
|
|
1625
1645
|
# @param page_token [::String]
|
1626
1646
|
# The standard list page token.
|
1627
1647
|
# Typically obtained via
|
1628
|
-
# {::Google::Cloud::AIPlatform::V1::ListModelEvaluationSlicesResponse#next_page_token ListModelEvaluationSlicesResponse.next_page_token}
|
1629
|
-
#
|
1648
|
+
# {::Google::Cloud::AIPlatform::V1::ListModelEvaluationSlicesResponse#next_page_token ListModelEvaluationSlicesResponse.next_page_token}
|
1649
|
+
# of the previous
|
1650
|
+
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluation_slices ModelService.ListModelEvaluationSlices}
|
1651
|
+
# call.
|
1630
1652
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1631
1653
|
# Mask specifying which fields to read.
|
1632
1654
|
#
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
##
|
35
35
|
# A service for managing Vertex AI's machine learning Models.
|
36
36
|
#
|
37
|
-
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
38
|
#
|
39
39
|
# require "google/cloud/ai_platform/v1/model_service"
|
40
40
|
# client = ::Google::Cloud::AIPlatform::V1::ModelService::Client.new
|