google-cloud-ai_platform-v1 0.15.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +164 -4
  4. data/lib/google/cloud/ai_platform/v1/dataset_service/paths.rb +21 -0
  5. data/lib/google/cloud/ai_platform/v1/dataset_service.rb +1 -1
  6. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +28 -21
  7. data/lib/google/cloud/ai_platform/v1/endpoint_service.rb +1 -1
  8. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +109 -5
  9. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb +1 -1
  10. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +53 -50
  11. data/lib/google/cloud/ai_platform/v1/featurestore_service.rb +1 -1
  12. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +18 -14
  13. data/lib/google/cloud/ai_platform/v1/index_endpoint_service.rb +1 -1
  14. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +8 -4
  15. data/lib/google/cloud/ai_platform/v1/index_service.rb +1 -1
  16. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +53 -36
  17. data/lib/google/cloud/ai_platform/v1/job_service.rb +1 -1
  18. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +33 -36
  19. data/lib/google/cloud/ai_platform/v1/metadata_service.rb +1 -1
  20. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +3 -4
  21. data/lib/google/cloud/ai_platform/v1/migration_service.rb +1 -1
  22. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +53 -23
  23. data/lib/google/cloud/ai_platform/v1/model_service.rb +1 -1
  24. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +28 -17
  25. data/lib/google/cloud/ai_platform/v1/pipeline_service.rb +1 -1
  26. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +28 -19
  27. data/lib/google/cloud/ai_platform/v1/prediction_service.rb +1 -1
  28. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +5 -3
  29. data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb +1 -1
  30. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +165 -71
  31. data/lib/google/cloud/ai_platform/v1/tensorboard_service.rb +1 -1
  32. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  33. data/lib/google/cloud/ai_platform/v1/vizier_service.rb +1 -1
  34. data/lib/google/cloud/ai_platform/v1.rb +2 -2
  35. data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +8 -0
  36. data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +3 -0
  37. data/lib/google/cloud/aiplatform/v1/dataset_service_pb.rb +34 -0
  38. data/lib/google/cloud/aiplatform/v1/dataset_service_services_pb.rb +2 -0
  39. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_pb.rb +13 -0
  40. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_services_pb.rb +6 -0
  41. data/lib/google/cloud/aiplatform/v1/featurestore_service_pb.rb +1 -0
  42. data/lib/google/cloud/aiplatform/v1/index_service_services_pb.rb +2 -1
  43. data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +24 -14
  44. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +2 -0
  45. data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +10 -5
  46. data/lib/google/cloud/aiplatform/v1/pipeline_service_services_pb.rb +16 -9
  47. data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb +10 -6
  48. data/lib/google/cloud/aiplatform/v1/study_pb.rb +1 -0
  49. data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +17 -0
  50. data/lib/google/cloud/aiplatform/v1/tensorboard_service_services_pb.rb +8 -8
  51. data/proto_docs/google/cloud/aiplatform/v1/annotation.rb +9 -6
  52. data/proto_docs/google/cloud/aiplatform/v1/annotation_spec.rb +3 -3
  53. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +185 -52
  54. data/proto_docs/google/cloud/aiplatform/v1/completion_stats.rb +8 -7
  55. data/proto_docs/google/cloud/aiplatform/v1/context.rb +2 -2
  56. data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +23 -18
  57. data/proto_docs/google/cloud/aiplatform/v1/data_item.rb +6 -5
  58. data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +17 -17
  59. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +38 -17
  60. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +180 -24
  61. data/proto_docs/google/cloud/aiplatform/v1/encryption_spec.rb +2 -2
  62. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +39 -24
  63. data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +57 -35
  64. data/proto_docs/google/cloud/aiplatform/v1/entity_type.rb +8 -6
  65. data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +111 -75
  66. data/proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb +58 -38
  67. data/proto_docs/google/cloud/aiplatform/v1/feature.rb +9 -6
  68. data/proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb +2 -1
  69. data/proto_docs/google/cloud/aiplatform/v1/featurestore.rb +12 -11
  70. data/proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb +6 -2
  71. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +65 -10
  72. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +141 -99
  73. data/proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb +10 -8
  74. data/proto_docs/google/cloud/aiplatform/v1/index.rb +19 -18
  75. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +36 -24
  76. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb +49 -29
  77. data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +35 -17
  78. data/proto_docs/google/cloud/aiplatform/v1/io.rb +2 -1
  79. data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +94 -57
  80. data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb +53 -43
  81. data/proto_docs/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.rb +5 -5
  82. data/proto_docs/google/cloud/aiplatform/v1/metadata_schema.rb +3 -3
  83. data/proto_docs/google/cloud/aiplatform/v1/metadata_service.rb +141 -91
  84. data/proto_docs/google/cloud/aiplatform/v1/migratable_resource.rb +3 -3
  85. data/proto_docs/google/cloud/aiplatform/v1/migration_service.rb +18 -15
  86. data/proto_docs/google/cloud/aiplatform/v1/model.rb +180 -133
  87. data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +22 -18
  88. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +7 -6
  89. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +11 -7
  90. data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +4 -2
  91. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +119 -54
  92. data/proto_docs/google/cloud/aiplatform/v1/operation.rb +1 -1
  93. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +59 -45
  94. data/proto_docs/google/cloud/aiplatform/v1/pipeline_service.rb +42 -22
  95. data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +42 -28
  96. data/proto_docs/google/cloud/aiplatform/v1/saved_query.rb +2 -2
  97. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool.rb +1 -1
  98. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool_service.rb +19 -11
  99. data/proto_docs/google/cloud/aiplatform/v1/study.rb +42 -25
  100. data/proto_docs/google/cloud/aiplatform/v1/tensorboard.rb +3 -3
  101. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb +8 -7
  102. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb +2 -1
  103. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb +203 -109
  104. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_time_series.rb +8 -6
  105. data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +84 -59
  106. data/proto_docs/google/cloud/aiplatform/v1/unmanaged_container_model.rb +2 -2
  107. data/proto_docs/google/cloud/aiplatform/v1/vizier_service.rb +40 -20
  108. data/proto_docs/google/rpc/status.rb +4 -2
  109. metadata +5 -5
@@ -30,7 +30,7 @@ module Google
30
30
  # @!attribute [rw] display_name
31
31
  # @return [::String]
32
32
  # Required. The user-defined name of the ModelDeploymentMonitoringJob.
33
- # The name can be up to 128 characters long and can be consist of any UTF-8
33
+ # The name can be up to 128 characters long and can consist of any UTF-8
34
34
  # characters.
35
35
  # Display name of a ModelDeploymentMonitoringJob.
36
36
  # @!attribute [rw] endpoint
@@ -52,8 +52,8 @@ module Google
52
52
  # Output only. Latest triggered monitoring pipeline metadata.
53
53
  # @!attribute [rw] model_deployment_monitoring_objective_configs
54
54
  # @return [::Array<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringObjectiveConfig>]
55
- # Required. The config for monitoring objectives. This is a per DeployedModel config.
56
- # Each DeployedModel needs to be configured separately.
55
+ # Required. The config for monitoring objectives. This is a per DeployedModel
56
+ # config. Each DeployedModel needs to be configured separately.
57
57
  # @!attribute [rw] model_deployment_monitoring_schedule_config
58
58
  # @return [::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringScheduleConfig]
59
59
  # Required. Schedule config for running the monitoring job.
@@ -71,10 +71,12 @@ module Google
71
71
  # requests.
72
72
  # @!attribute [rw] sample_predict_instance
73
73
  # @return [::Google::Protobuf::Value]
74
- # Sample Predict instance, same format as {::Google::Cloud::AIPlatform::V1::PredictRequest#instances PredictRequest.instances},
74
+ # Sample Predict instance, same format as
75
+ # {::Google::Cloud::AIPlatform::V1::PredictRequest#instances PredictRequest.instances},
75
76
  # this can be set as a replacement of
76
- # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob#predict_instance_schema_uri ModelDeploymentMonitoringJob.predict_instance_schema_uri}. If not set,
77
- # we will generate predict schema from collected predict requests.
77
+ # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob#predict_instance_schema_uri ModelDeploymentMonitoringJob.predict_instance_schema_uri}.
78
+ # If not set, we will generate predict schema from collected predict
79
+ # requests.
78
80
  # @!attribute [rw] analysis_instance_schema_uri
79
81
  # @return [::String]
80
82
  # YAML schema file uri describing the format of a single instance that you
@@ -90,9 +92,9 @@ module Google
90
92
  # fields in predict instance formatted as string.
91
93
  # @!attribute [r] bigquery_tables
92
94
  # @return [::Array<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringBigQueryTable>]
93
- # Output only. The created bigquery tables for the job under customer project. Customer
94
- # could do their own query & analysis. There could be 4 log tables in
95
- # maximum:
95
+ # Output only. The created bigquery tables for the job under customer
96
+ # project. Customer could do their own query & analysis. There could be 4 log
97
+ # tables in maximum:
96
98
  # 1. Training data logging predict request/response
97
99
  # 2. Serving data logging predict request/response
98
100
  # @!attribute [rw] log_ttl
@@ -115,11 +117,12 @@ module Google
115
117
  # Output only. Timestamp when this ModelDeploymentMonitoringJob was created.
116
118
  # @!attribute [r] update_time
117
119
  # @return [::Google::Protobuf::Timestamp]
118
- # Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.
120
+ # Output only. Timestamp when this ModelDeploymentMonitoringJob was updated
121
+ # most recently.
119
122
  # @!attribute [r] next_schedule_time
120
123
  # @return [::Google::Protobuf::Timestamp]
121
- # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the
122
- # next round.
124
+ # Output only. Timestamp when this monitoring pipeline will be scheduled to
125
+ # run for the next round.
123
126
  # @!attribute [rw] stats_anomalies_base_directory
124
127
  # @return [::Google::Cloud::AIPlatform::V1::GcsDestination]
125
128
  # Stats anomalies base folder path.
@@ -238,17 +241,18 @@ module Google
238
241
  # The config for scheduling monitoring job.
239
242
  # @!attribute [rw] monitor_interval
240
243
  # @return [::Google::Protobuf::Duration]
241
- # Required. The model monitoring job scheduling interval. It will be rounded up to next
242
- # full hour. This defines how often the monitoring jobs are triggered.
244
+ # Required. The model monitoring job scheduling interval. It will be rounded
245
+ # up to next full hour. This defines how often the monitoring jobs are
246
+ # triggered.
243
247
  # @!attribute [rw] monitor_window
244
248
  # @return [::Google::Protobuf::Duration]
245
249
  # The time window of the prediction data being included in each prediction
246
250
  # dataset. This window specifies how long the data should be collected from
247
251
  # historical model results for each run. If not set,
248
- # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringScheduleConfig#monitor_interval ModelDeploymentMonitoringScheduleConfig.monitor_interval} will be used.
249
- # e.g. If currently the cutoff time is 2022-01-08 14:30:00 and the
250
- # monitor_window is set to be 3600, then data from 2022-01-08 13:30:00
251
- # to 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the
252
+ # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringScheduleConfig#monitor_interval ModelDeploymentMonitoringScheduleConfig.monitor_interval}
253
+ # will be used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and
254
+ # the monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 to
255
+ # 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the
252
256
  # monitoring statistics.
253
257
  class ModelDeploymentMonitoringScheduleConfig
254
258
  include ::Google::Protobuf::MessageExts
@@ -32,8 +32,8 @@ module Google
32
32
  # @!attribute [rw] metrics_schema_uri
33
33
  # @return [::String]
34
34
  # Points to a YAML file stored on Google Cloud Storage describing the
35
- # {::Google::Cloud::AIPlatform::V1::ModelEvaluation#metrics metrics} of this ModelEvaluation. The schema is
36
- # defined as an OpenAPI 3.0.2 [Schema
35
+ # {::Google::Cloud::AIPlatform::V1::ModelEvaluation#metrics metrics} of this
36
+ # ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema
37
37
  # Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
38
38
  # @!attribute [rw] metrics
39
39
  # @return [::Google::Protobuf::Value]
@@ -46,8 +46,8 @@ module Google
46
46
  # @return [::Array<::String>]
47
47
  # All possible [dimensions][ModelEvaluationSlice.slice.dimension] of
48
48
  # ModelEvaluationSlices. The dimensions can be used as the filter of the
49
- # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluation_slices ModelService.ListModelEvaluationSlices} request, in the form of
50
- # `slice.dimension = <dimension>`.
49
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluation_slices ModelService.ListModelEvaluationSlices}
50
+ # request, in the form of `slice.dimension = <dimension>`.
51
51
  # @!attribute [rw] data_item_schema_uri
52
52
  # @return [::String]
53
53
  # Points to a YAML file stored on Google Cloud Storage describing
@@ -77,8 +77,9 @@ module Google
77
77
  # is evaluated with explanations, and only for AutoML tabular Models.
78
78
  # @!attribute [rw] explanation_specs
79
79
  # @return [::Array<::Google::Cloud::AIPlatform::V1::ModelEvaluation::ModelEvaluationExplanationSpec>]
80
- # Describes the values of {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} that are used for explaining
81
- # the predicted values on the evaluated data.
80
+ # Describes the values of
81
+ # {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} that are used
82
+ # for explaining the predicted values on the evaluated data.
82
83
  # @!attribute [rw] metadata
83
84
  # @return [::Google::Protobuf::Value]
84
85
  # The metadata of the ModelEvaluation.
@@ -31,14 +31,16 @@ module Google
31
31
  # Output only. The slice of the test data that is used to evaluate the Model.
32
32
  # @!attribute [r] metrics_schema_uri
33
33
  # @return [::String]
34
- # Output only. Points to a YAML file stored on Google Cloud Storage describing the
35
- # {::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice#metrics metrics} of this ModelEvaluationSlice. The
36
- # schema is defined as an OpenAPI 3.0.2 [Schema
34
+ # Output only. Points to a YAML file stored on Google Cloud Storage
35
+ # describing the
36
+ # {::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice#metrics metrics} of this
37
+ # ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 [Schema
37
38
  # Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
38
39
  # @!attribute [r] metrics
39
40
  # @return [::Google::Protobuf::Value]
40
- # Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored
41
- # in {::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice#metrics_schema_uri metrics_schema_uri}
41
+ # Output only. Sliced evaluation metrics of the Model. The schema of the
42
+ # metrics is stored in
43
+ # {::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice#metrics_schema_uri metrics_schema_uri}
42
44
  # @!attribute [r] create_time
43
45
  # @return [::Google::Protobuf::Timestamp]
44
46
  # Output only. Timestamp when this ModelEvaluationSlice was created.
@@ -52,8 +54,10 @@ module Google
52
54
  # Output only. The dimension of the slice.
53
55
  # Well-known dimensions are:
54
56
  # * `annotationSpec`: This slice is on the test data that has either
55
- # ground truth or prediction with {::Google::Cloud::AIPlatform::V1::AnnotationSpec#display_name AnnotationSpec.display_name}
56
- # equals to {::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice#value value}.
57
+ # ground truth or prediction with
58
+ # {::Google::Cloud::AIPlatform::V1::AnnotationSpec#display_name AnnotationSpec.display_name}
59
+ # equals to
60
+ # {::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice#value value}.
57
61
  # @!attribute [r] value
58
62
  # @return [::String]
59
63
  # Output only. The value of the dimension in this slice.
@@ -173,8 +173,10 @@ module Google
173
173
  include ::Google::Protobuf::MessageExts
174
174
  extend ::Google::Protobuf::MessageExts::ClassMethods
175
175
 
176
- # Output from {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob} for Model Monitoring baseline dataset,
177
- # which can be used to generate baseline attribution scores.
176
+ # Output from
177
+ # {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob} for
178
+ # Model Monitoring baseline dataset, which can be used to generate baseline
179
+ # attribution scores.
178
180
  # @!attribute [rw] gcs
179
181
  # @return [::Google::Cloud::AIPlatform::V1::GcsDestination]
180
182
  # Cloud Storage location for BatchExplain output.
@@ -21,15 +21,16 @@ module Google
21
21
  module Cloud
22
22
  module AIPlatform
23
23
  module V1
24
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#upload_model ModelService.UploadModel}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#upload_model ModelService.UploadModel}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The resource name of the Location into which to upload the Model.
28
29
  # Format: `projects/{project}/locations/{location}`
29
30
  # @!attribute [rw] parent_model
30
31
  # @return [::String]
31
- # Optional. The resource name of the model into which to upload the version. Only
32
- # specify this field when uploading a new version.
32
+ # Optional. The resource name of the model into which to upload the version.
33
+ # Only specify this field when uploading a new version.
33
34
  # @!attribute [rw] model_id
34
35
  # @return [::String]
35
36
  # Optional. The ID to use for the uploaded Model, which will become the final
@@ -40,12 +41,23 @@ module Google
40
41
  # @!attribute [rw] model
41
42
  # @return [::Google::Cloud::AIPlatform::V1::Model]
42
43
  # Required. The Model to create.
44
+ # @!attribute [rw] service_account
45
+ # @return [::String]
46
+ # Optional. The user-provided custom service account to use to do the model
47
+ # upload. If empty, [Vertex AI Service
48
+ # Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
49
+ # will be used. Users uploading the Model must have the
50
+ # `iam.serviceAccounts.actAs` permission on this service account. Also, this
51
+ # account must belong to the project specified in the `parent` field and have
52
+ # all necessary read permissions.
43
53
  class UploadModelRequest
44
54
  include ::Google::Protobuf::MessageExts
45
55
  extend ::Google::Protobuf::MessageExts::ClassMethods
46
56
  end
47
57
 
48
- # Details of {::Google::Cloud::AIPlatform::V1::ModelService::Client#upload_model ModelService.UploadModel} operation.
58
+ # Details of
59
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#upload_model ModelService.UploadModel}
60
+ # operation.
49
61
  # @!attribute [rw] generic_metadata
50
62
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
51
63
  # The common part of the operation metadata.
@@ -54,7 +66,9 @@ module Google
54
66
  extend ::Google::Protobuf::MessageExts::ClassMethods
55
67
  end
56
68
 
57
- # Response message of {::Google::Cloud::AIPlatform::V1::ModelService::Client#upload_model ModelService.UploadModel} operation.
69
+ # Response message of
70
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#upload_model ModelService.UploadModel}
71
+ # operation.
58
72
  # @!attribute [rw] model
59
73
  # @return [::String]
60
74
  # The name of the uploaded Model resource.
@@ -67,7 +81,8 @@ module Google
67
81
  extend ::Google::Protobuf::MessageExts::ClassMethods
68
82
  end
69
83
 
70
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#get_model ModelService.GetModel}.
84
+ # Request message for
85
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#get_model ModelService.GetModel}.
71
86
  # @!attribute [rw] name
72
87
  # @return [::String]
73
88
  # Required. The name of the Model resource.
@@ -87,7 +102,8 @@ module Google
87
102
  extend ::Google::Protobuf::MessageExts::ClassMethods
88
103
  end
89
104
 
90
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_models ModelService.ListModels}.
105
+ # Request message for
106
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_models ModelService.ListModels}.
91
107
  # @!attribute [rw] parent
92
108
  # @return [::String]
93
109
  # Required. The resource name of the Location to list the Models from.
@@ -98,7 +114,8 @@ module Google
98
114
  # both snake_case and camelCase are supported.
99
115
  #
100
116
  # * `model` supports = and !=. `model` represents the Model ID,
101
- # i.e. the last segment of the Model's {::Google::Cloud::AIPlatform::V1::Model#name resource name}.
117
+ # i.e. the last segment of the Model's [resource
118
+ # name][google.cloud.aiplatform.v1.Model.name].
102
119
  # * `display_name` supports = and !=
103
120
  # * `labels` supports general map functions that is:
104
121
  # * `labels.key=value` - key:value equality
@@ -117,8 +134,10 @@ module Google
117
134
  # @return [::String]
118
135
  # The standard list page token.
119
136
  # Typically obtained via
120
- # {::Google::Cloud::AIPlatform::V1::ListModelsResponse#next_page_token ListModelsResponse.next_page_token} of the previous
121
- # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_models ModelService.ListModels} call.
137
+ # {::Google::Cloud::AIPlatform::V1::ListModelsResponse#next_page_token ListModelsResponse.next_page_token}
138
+ # of the previous
139
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_models ModelService.ListModels}
140
+ # call.
122
141
  # @!attribute [rw] read_mask
123
142
  # @return [::Google::Protobuf::FieldMask]
124
143
  # Mask specifying which fields to read.
@@ -138,20 +157,24 @@ module Google
138
157
  extend ::Google::Protobuf::MessageExts::ClassMethods
139
158
  end
140
159
 
141
- # Response message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_models ModelService.ListModels}
160
+ # Response message for
161
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_models ModelService.ListModels}
142
162
  # @!attribute [rw] models
143
163
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Model>]
144
164
  # List of Models in the requested page.
145
165
  # @!attribute [rw] next_page_token
146
166
  # @return [::String]
147
167
  # A token to retrieve next page of results.
148
- # Pass to {::Google::Cloud::AIPlatform::V1::ListModelsRequest#page_token ListModelsRequest.page_token} to obtain that page.
168
+ # Pass to
169
+ # {::Google::Cloud::AIPlatform::V1::ListModelsRequest#page_token ListModelsRequest.page_token}
170
+ # to obtain that page.
149
171
  class ListModelsResponse
150
172
  include ::Google::Protobuf::MessageExts
151
173
  extend ::Google::Protobuf::MessageExts::ClassMethods
152
174
  end
153
175
 
154
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_versions ModelService.ListModelVersions}.
176
+ # Request message for
177
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_versions ModelService.ListModelVersions}.
155
178
  # @!attribute [rw] name
156
179
  # @return [::String]
157
180
  # Required. The name of the model to list versions for.
@@ -162,8 +185,8 @@ module Google
162
185
  # @return [::String]
163
186
  # The standard list page token.
164
187
  # Typically obtained via
165
- # {::Google::Cloud::AIPlatform::V1::ListModelVersionsResponse#next_page_token ListModelVersionsResponse.next_page_token} of the previous
166
- # [ModelService.ListModelversions][] call.
188
+ # {::Google::Cloud::AIPlatform::V1::ListModelVersionsResponse#next_page_token ListModelVersionsResponse.next_page_token}
189
+ # of the previous [ModelService.ListModelversions][] call.
167
190
  # @!attribute [rw] filter
168
191
  # @return [::String]
169
192
  # An expression for filtering the results of the request. For field names
@@ -180,12 +203,23 @@ module Google
180
203
  # @!attribute [rw] read_mask
181
204
  # @return [::Google::Protobuf::FieldMask]
182
205
  # Mask specifying which fields to read.
206
+ # @!attribute [rw] order_by
207
+ # @return [::String]
208
+ # A comma-separated list of fields to order by, sorted in ascending order.
209
+ # Use "desc" after a field name for descending.
210
+ # Supported fields:
211
+ #
212
+ # * `create_time`
213
+ # * `update_time`
214
+ #
215
+ # Example: `update_time asc, create_time desc`.
183
216
  class ListModelVersionsRequest
184
217
  include ::Google::Protobuf::MessageExts
185
218
  extend ::Google::Protobuf::MessageExts::ClassMethods
186
219
  end
187
220
 
188
- # Response message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_versions ModelService.ListModelVersions}
221
+ # Response message for
222
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_versions ModelService.ListModelVersions}
189
223
  # @!attribute [rw] models
190
224
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Model>]
191
225
  # List of Model versions in the requested page.
@@ -194,13 +228,16 @@ module Google
194
228
  # @!attribute [rw] next_page_token
195
229
  # @return [::String]
196
230
  # A token to retrieve the next page of results.
197
- # Pass to {::Google::Cloud::AIPlatform::V1::ListModelVersionsRequest#page_token ListModelVersionsRequest.page_token} to obtain that page.
231
+ # Pass to
232
+ # {::Google::Cloud::AIPlatform::V1::ListModelVersionsRequest#page_token ListModelVersionsRequest.page_token}
233
+ # to obtain that page.
198
234
  class ListModelVersionsResponse
199
235
  include ::Google::Protobuf::MessageExts
200
236
  extend ::Google::Protobuf::MessageExts::ClassMethods
201
237
  end
202
238
 
203
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#update_model ModelService.UpdateModel}.
239
+ # Request message for
240
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#update_model ModelService.UpdateModel}.
204
241
  # @!attribute [rw] model
205
242
  # @return [::Google::Cloud::AIPlatform::V1::Model]
206
243
  # Required. The Model which replaces the resource on the server.
@@ -224,13 +261,15 @@ module Google
224
261
  # @!attribute [rw] update_mask
225
262
  # @return [::Google::Protobuf::FieldMask]
226
263
  # Required. The update mask applies to the resource.
227
- # For the `FieldMask` definition, see {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
264
+ # For the `FieldMask` definition, see
265
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
228
266
  class UpdateModelRequest
229
267
  include ::Google::Protobuf::MessageExts
230
268
  extend ::Google::Protobuf::MessageExts::ClassMethods
231
269
  end
232
270
 
233
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#delete_model ModelService.DeleteModel}.
271
+ # Request message for
272
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#delete_model ModelService.DeleteModel}.
234
273
  # @!attribute [rw] name
235
274
  # @return [::String]
236
275
  # Required. The name of the Model resource to be deleted.
@@ -240,11 +279,12 @@ module Google
240
279
  extend ::Google::Protobuf::MessageExts::ClassMethods
241
280
  end
242
281
 
243
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#delete_model_version ModelService.DeleteModelVersion}.
282
+ # Request message for
283
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#delete_model_version ModelService.DeleteModelVersion}.
244
284
  # @!attribute [rw] name
245
285
  # @return [::String]
246
- # Required. The name of the model version to be deleted, with a version ID explicitly
247
- # included.
286
+ # Required. The name of the model version to be deleted, with a version ID
287
+ # explicitly included.
248
288
  #
249
289
  # Example: `projects/{project}/locations/{location}/models/{model}@1234`
250
290
  class DeleteModelVersionRequest
@@ -252,7 +292,8 @@ module Google
252
292
  extend ::Google::Protobuf::MessageExts::ClassMethods
253
293
  end
254
294
 
255
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#merge_version_aliases ModelService.MergeVersionAliases}.
295
+ # Request message for
296
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#merge_version_aliases ModelService.MergeVersionAliases}.
256
297
  # @!attribute [rw] name
257
298
  # @return [::String]
258
299
  # Required. The name of the model version to merge aliases, with a version ID
@@ -278,7 +319,8 @@ module Google
278
319
  extend ::Google::Protobuf::MessageExts::ClassMethods
279
320
  end
280
321
 
281
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#export_model ModelService.ExportModel}.
322
+ # Request message for
323
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#export_model ModelService.ExportModel}.
282
324
  # @!attribute [rw] name
283
325
  # @return [::String]
284
326
  # Required. The resource name of the Model to export.
@@ -295,8 +337,9 @@ module Google
295
337
  # @!attribute [rw] export_format_id
296
338
  # @return [::String]
297
339
  # The ID of the format in which the Model must be exported. Each Model
298
- # lists the {::Google::Cloud::AIPlatform::V1::Model#supported_export_formats export formats it supports}.
299
- # If no value is provided here, then the first from the list of the Model's
340
+ # lists the [export formats it
341
+ # supports][google.cloud.aiplatform.v1.Model.supported_export_formats]. If
342
+ # no value is provided here, then the first from the list of the Model's
300
343
  # supported formats is used by default.
301
344
  # @!attribute [rw] artifact_destination
302
345
  # @return [::Google::Cloud::AIPlatform::V1::GcsDestination]
@@ -320,13 +363,16 @@ module Google
320
363
  end
321
364
  end
322
365
 
323
- # Details of {::Google::Cloud::AIPlatform::V1::ModelService::Client#export_model ModelService.ExportModel} operation.
366
+ # Details of
367
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#export_model ModelService.ExportModel}
368
+ # operation.
324
369
  # @!attribute [rw] generic_metadata
325
370
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
326
371
  # The common part of the operation metadata.
327
372
  # @!attribute [r] output_info
328
373
  # @return [::Google::Cloud::AIPlatform::V1::ExportModelOperationMetadata::OutputInfo]
329
- # Output only. Information further describing the output of this Model export.
374
+ # Output only. Information further describing the output of this Model
375
+ # export.
330
376
  class ExportModelOperationMetadata
331
377
  include ::Google::Protobuf::MessageExts
332
378
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -335,26 +381,29 @@ module Google
335
381
  # {::Google::Cloud::AIPlatform::V1::ExportModelRequest::OutputConfig ExportModelRequest.OutputConfig}.
336
382
  # @!attribute [r] artifact_output_uri
337
383
  # @return [::String]
338
- # Output only. If the Model artifact is being exported to Google Cloud Storage this is
339
- # the full path of the directory created, into which the Model files are
340
- # being written to.
384
+ # Output only. If the Model artifact is being exported to Google Cloud
385
+ # Storage this is the full path of the directory created, into which the
386
+ # Model files are being written to.
341
387
  # @!attribute [r] image_output_uri
342
388
  # @return [::String]
343
- # Output only. If the Model image is being exported to Google Container Registry or
344
- # Artifact Registry this is the full path of the image created.
389
+ # Output only. If the Model image is being exported to Google Container
390
+ # Registry or Artifact Registry this is the full path of the image created.
345
391
  class OutputInfo
346
392
  include ::Google::Protobuf::MessageExts
347
393
  extend ::Google::Protobuf::MessageExts::ClassMethods
348
394
  end
349
395
  end
350
396
 
351
- # Response message of {::Google::Cloud::AIPlatform::V1::ModelService::Client#export_model ModelService.ExportModel} operation.
397
+ # Response message of
398
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#export_model ModelService.ExportModel}
399
+ # operation.
352
400
  class ExportModelResponse
353
401
  include ::Google::Protobuf::MessageExts
354
402
  extend ::Google::Protobuf::MessageExts::ClassMethods
355
403
  end
356
404
 
357
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#import_model_evaluation ModelService.ImportModelEvaluation}
405
+ # Request message for
406
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#import_model_evaluation ModelService.ImportModelEvaluation}
358
407
  # @!attribute [rw] parent
359
408
  # @return [::String]
360
409
  # Required. The name of the parent model resource.
@@ -367,7 +416,8 @@ module Google
367
416
  extend ::Google::Protobuf::MessageExts::ClassMethods
368
417
  end
369
418
 
370
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#batch_import_model_evaluation_slices ModelService.BatchImportModelEvaluationSlices}
419
+ # Request message for
420
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#batch_import_model_evaluation_slices ModelService.BatchImportModelEvaluationSlices}
371
421
  # @!attribute [rw] parent
372
422
  # @return [::String]
373
423
  # Required. The name of the parent ModelEvaluation resource.
@@ -381,16 +431,19 @@ module Google
381
431
  extend ::Google::Protobuf::MessageExts::ClassMethods
382
432
  end
383
433
 
384
- # Response message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#batch_import_model_evaluation_slices ModelService.BatchImportModelEvaluationSlices}
434
+ # Response message for
435
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#batch_import_model_evaluation_slices ModelService.BatchImportModelEvaluationSlices}
385
436
  # @!attribute [r] imported_model_evaluation_slices
386
437
  # @return [::Array<::String>]
387
- # Output only. List of imported {::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice#name ModelEvaluationSlice.name}.
438
+ # Output only. List of imported
439
+ # {::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice#name ModelEvaluationSlice.name}.
388
440
  class BatchImportModelEvaluationSlicesResponse
389
441
  include ::Google::Protobuf::MessageExts
390
442
  extend ::Google::Protobuf::MessageExts::ClassMethods
391
443
  end
392
444
 
393
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#get_model_evaluation ModelService.GetModelEvaluation}.
445
+ # Request message for
446
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#get_model_evaluation ModelService.GetModelEvaluation}.
394
447
  # @!attribute [rw] name
395
448
  # @return [::String]
396
449
  # Required. The name of the ModelEvaluation resource.
@@ -401,7 +454,8 @@ module Google
401
454
  extend ::Google::Protobuf::MessageExts::ClassMethods
402
455
  end
403
456
 
404
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluations ModelService.ListModelEvaluations}.
457
+ # Request message for
458
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluations ModelService.ListModelEvaluations}.
405
459
  # @!attribute [rw] parent
406
460
  # @return [::String]
407
461
  # Required. The resource name of the Model to list the ModelEvaluations from.
@@ -416,8 +470,10 @@ module Google
416
470
  # @return [::String]
417
471
  # The standard list page token.
418
472
  # Typically obtained via
419
- # {::Google::Cloud::AIPlatform::V1::ListModelEvaluationsResponse#next_page_token ListModelEvaluationsResponse.next_page_token} of the previous
420
- # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluations ModelService.ListModelEvaluations} call.
473
+ # {::Google::Cloud::AIPlatform::V1::ListModelEvaluationsResponse#next_page_token ListModelEvaluationsResponse.next_page_token}
474
+ # of the previous
475
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluations ModelService.ListModelEvaluations}
476
+ # call.
421
477
  # @!attribute [rw] read_mask
422
478
  # @return [::Google::Protobuf::FieldMask]
423
479
  # Mask specifying which fields to read.
@@ -426,20 +482,24 @@ module Google
426
482
  extend ::Google::Protobuf::MessageExts::ClassMethods
427
483
  end
428
484
 
429
- # Response message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluations ModelService.ListModelEvaluations}.
485
+ # Response message for
486
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluations ModelService.ListModelEvaluations}.
430
487
  # @!attribute [rw] model_evaluations
431
488
  # @return [::Array<::Google::Cloud::AIPlatform::V1::ModelEvaluation>]
432
489
  # List of ModelEvaluations in the requested page.
433
490
  # @!attribute [rw] next_page_token
434
491
  # @return [::String]
435
492
  # A token to retrieve next page of results.
436
- # Pass to {::Google::Cloud::AIPlatform::V1::ListModelEvaluationsRequest#page_token ListModelEvaluationsRequest.page_token} to obtain that page.
493
+ # Pass to
494
+ # {::Google::Cloud::AIPlatform::V1::ListModelEvaluationsRequest#page_token ListModelEvaluationsRequest.page_token}
495
+ # to obtain that page.
437
496
  class ListModelEvaluationsResponse
438
497
  include ::Google::Protobuf::MessageExts
439
498
  extend ::Google::Protobuf::MessageExts::ClassMethods
440
499
  end
441
500
 
442
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#get_model_evaluation_slice ModelService.GetModelEvaluationSlice}.
501
+ # Request message for
502
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#get_model_evaluation_slice ModelService.GetModelEvaluationSlice}.
443
503
  # @!attribute [rw] name
444
504
  # @return [::String]
445
505
  # Required. The name of the ModelEvaluationSlice resource.
@@ -450,11 +510,12 @@ module Google
450
510
  extend ::Google::Protobuf::MessageExts::ClassMethods
451
511
  end
452
512
 
453
- # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluation_slices ModelService.ListModelEvaluationSlices}.
513
+ # Request message for
514
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluation_slices ModelService.ListModelEvaluationSlices}.
454
515
  # @!attribute [rw] parent
455
516
  # @return [::String]
456
- # Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices
457
- # from. Format:
517
+ # Required. The resource name of the ModelEvaluation to list the
518
+ # ModelEvaluationSlices from. Format:
458
519
  # `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
459
520
  # @!attribute [rw] filter
460
521
  # @return [::String]
@@ -468,8 +529,10 @@ module Google
468
529
  # @return [::String]
469
530
  # The standard list page token.
470
531
  # Typically obtained via
471
- # {::Google::Cloud::AIPlatform::V1::ListModelEvaluationSlicesResponse#next_page_token ListModelEvaluationSlicesResponse.next_page_token} of the previous
472
- # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluation_slices ModelService.ListModelEvaluationSlices} call.
532
+ # {::Google::Cloud::AIPlatform::V1::ListModelEvaluationSlicesResponse#next_page_token ListModelEvaluationSlicesResponse.next_page_token}
533
+ # of the previous
534
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluation_slices ModelService.ListModelEvaluationSlices}
535
+ # call.
473
536
  # @!attribute [rw] read_mask
474
537
  # @return [::Google::Protobuf::FieldMask]
475
538
  # Mask specifying which fields to read.
@@ -478,15 +541,17 @@ module Google
478
541
  extend ::Google::Protobuf::MessageExts::ClassMethods
479
542
  end
480
543
 
481
- # Response message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluation_slices ModelService.ListModelEvaluationSlices}.
544
+ # Response message for
545
+ # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_evaluation_slices ModelService.ListModelEvaluationSlices}.
482
546
  # @!attribute [rw] model_evaluation_slices
483
547
  # @return [::Array<::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice>]
484
548
  # List of ModelEvaluations in the requested page.
485
549
  # @!attribute [rw] next_page_token
486
550
  # @return [::String]
487
551
  # A token to retrieve next page of results.
488
- # Pass to {::Google::Cloud::AIPlatform::V1::ListModelEvaluationSlicesRequest#page_token ListModelEvaluationSlicesRequest.page_token} to obtain that
489
- # page.
552
+ # Pass to
553
+ # {::Google::Cloud::AIPlatform::V1::ListModelEvaluationSlicesRequest#page_token ListModelEvaluationSlicesRequest.page_token}
554
+ # to obtain that page.
490
555
  class ListModelEvaluationSlicesResponse
491
556
  include ::Google::Protobuf::MessageExts
492
557
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -27,7 +27,7 @@ module Google
27
27
  # Output only. Partial failures encountered.
28
28
  # E.g. single files that couldn't be read.
29
29
  # This field should never exceed 20 entries.
30
- # Status details field will contain standard GCP error details.
30
+ # Status details field will contain standard Google Cloud error details.
31
31
  # @!attribute [r] create_time
32
32
  # @return [::Google::Protobuf::Timestamp]
33
33
  # Output only. Time when the operation was created.