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
@@ -28,18 +28,17 @@ module Google
28
28
  # @!attribute [rw] display_name
29
29
  # @return [::String]
30
30
  # Required. The user-defined name of the Dataset.
31
- # The name can be up to 128 characters long and can be consist of any UTF-8
31
+ # The name can be up to 128 characters long and can consist of any UTF-8
32
32
  # characters.
33
33
  # @!attribute [rw] description
34
34
  # @return [::String]
35
- # Optional. The description of the Dataset.
35
+ # The description of the Dataset.
36
36
  # @!attribute [rw] metadata_schema_uri
37
37
  # @return [::String]
38
- # Required. Points to a YAML file stored on Google Cloud Storage describing additional
39
- # information about the Dataset.
40
- # The schema is defined as an OpenAPI 3.0.2 Schema Object.
41
- # The schema files that can be used here are found in
42
- # gs://google-cloud-aiplatform/schema/dataset/metadata/.
38
+ # Required. Points to a YAML file stored on Google Cloud Storage describing
39
+ # additional information about the Dataset. The schema is defined as an
40
+ # OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
41
+ # found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
43
42
  # @!attribute [rw] metadata
44
43
  # @return [::Google::Protobuf::Value]
45
44
  # Required. Additional information about the Dataset.
@@ -68,11 +67,28 @@ module Google
68
67
  # and are immutable. Following system labels exist for each Dataset:
69
68
  #
70
69
  # * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
71
- # value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.
70
+ # value is the
71
+ # [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
72
+ # title.
73
+ # @!attribute [rw] saved_queries
74
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>]
75
+ # All SavedQueries belong to the Dataset will be returned in List/Get
76
+ # Dataset response. The [annotation_specs][SavedQuery.annotation_specs] field
77
+ # will not be populated except for UI cases which will only use
78
+ # {::Google::Cloud::AIPlatform::V1::SavedQuery#annotation_spec_count annotation_spec_count}.
79
+ # In CreateDataset request, a SavedQuery is created together if
80
+ # this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
81
+ # The SavedQuery should not contain any AnnotationSpec.
72
82
  # @!attribute [rw] encryption_spec
73
83
  # @return [::Google::Cloud::AIPlatform::V1::EncryptionSpec]
74
84
  # Customer-managed encryption key spec for a Dataset. If set, this Dataset
75
85
  # and all sub-resources of this Dataset will be secured by this key.
86
+ # @!attribute [r] metadata_artifact
87
+ # @return [::String]
88
+ # Output only. The resource name of the Artifact that was created in
89
+ # MetadataStore when creating the Dataset. The Artifact resource name pattern
90
+ # is
91
+ # `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
76
92
  class Dataset
77
93
  include ::Google::Protobuf::MessageExts
78
94
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -104,21 +120,26 @@ module Google
104
120
  # considered identical if their content bytes are identical (e.g. image bytes
105
121
  # or pdf bytes).
106
122
  # These labels will be overridden by Annotation labels specified inside index
107
- # file referenced by {::Google::Cloud::AIPlatform::V1::ImportDataConfig#import_schema_uri import_schema_uri}, e.g. jsonl file.
123
+ # file referenced by
124
+ # {::Google::Cloud::AIPlatform::V1::ImportDataConfig#import_schema_uri import_schema_uri},
125
+ # e.g. jsonl file.
108
126
  # @!attribute [rw] annotation_labels
109
127
  # @return [::Google::Protobuf::Map{::String => ::String}]
110
128
  # Labels that will be applied to newly imported Annotations. If two
111
129
  # Annotations are identical, one of them will be deduped. Two Annotations are
112
- # considered identical if their {::Google::Cloud::AIPlatform::V1::Annotation#payload payload},
113
- # {::Google::Cloud::AIPlatform::V1::Annotation#payload_schema_uri payload_schema_uri} and all of their
114
- # {::Google::Cloud::AIPlatform::V1::Annotation#labels labels} are the same.
115
- # These labels will be overridden by Annotation labels specified inside index
116
- # file referenced by {::Google::Cloud::AIPlatform::V1::ImportDataConfig#import_schema_uri import_schema_uri}, e.g. jsonl file.
130
+ # considered identical if their
131
+ # {::Google::Cloud::AIPlatform::V1::Annotation#payload payload},
132
+ # {::Google::Cloud::AIPlatform::V1::Annotation#payload_schema_uri payload_schema_uri}
133
+ # and all of their {::Google::Cloud::AIPlatform::V1::Annotation#labels labels} are
134
+ # the same. These labels will be overridden by Annotation labels specified
135
+ # inside index file referenced by
136
+ # {::Google::Cloud::AIPlatform::V1::ImportDataConfig#import_schema_uri import_schema_uri},
137
+ # e.g. jsonl file.
117
138
  # @!attribute [rw] import_schema_uri
118
139
  # @return [::String]
119
- # Required. Points to a YAML file stored on Google Cloud Storage describing the import
120
- # format. Validation will be done against the schema. The schema is defined
121
- # as an [OpenAPI 3.0.2 Schema
140
+ # Required. Points to a YAML file stored on Google Cloud Storage describing
141
+ # the import format. Validation will be done against the schema. The schema
142
+ # is defined as an [OpenAPI 3.0.2 Schema
122
143
  # Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
123
144
  class ImportDataConfig
124
145
  include ::Google::Protobuf::MessageExts
@@ -21,7 +21,8 @@ module Google
21
21
  module Cloud
22
22
  module AIPlatform
23
23
  module V1
24
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#create_dataset DatasetService.CreateDataset}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#create_dataset DatasetService.CreateDataset}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The resource name of the Location to create the Dataset in.
@@ -34,7 +35,8 @@ module Google
34
35
  extend ::Google::Protobuf::MessageExts::ClassMethods
35
36
  end
36
37
 
37
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#create_dataset DatasetService.CreateDataset}.
38
+ # Runtime operation information for
39
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#create_dataset DatasetService.CreateDataset}.
38
40
  # @!attribute [rw] generic_metadata
39
41
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
40
42
  # The operation generic information.
@@ -43,7 +45,8 @@ module Google
43
45
  extend ::Google::Protobuf::MessageExts::ClassMethods
44
46
  end
45
47
 
46
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#get_dataset DatasetService.GetDataset}.
48
+ # Request message for
49
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#get_dataset DatasetService.GetDataset}.
47
50
  # @!attribute [rw] name
48
51
  # @return [::String]
49
52
  # Required. The name of the Dataset resource.
@@ -55,15 +58,16 @@ module Google
55
58
  extend ::Google::Protobuf::MessageExts::ClassMethods
56
59
  end
57
60
 
58
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#update_dataset DatasetService.UpdateDataset}.
61
+ # Request message for
62
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#update_dataset DatasetService.UpdateDataset}.
59
63
  # @!attribute [rw] dataset
60
64
  # @return [::Google::Cloud::AIPlatform::V1::Dataset]
61
65
  # Required. The Dataset which replaces the resource on the server.
62
66
  # @!attribute [rw] update_mask
63
67
  # @return [::Google::Protobuf::FieldMask]
64
68
  # Required. The update mask applies to the resource.
65
- # For the `FieldMask` definition, see {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
66
- # Updatable fields:
69
+ # For the `FieldMask` definition, see
70
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}. Updatable fields:
67
71
  #
68
72
  # * `display_name`
69
73
  # * `description`
@@ -73,7 +77,8 @@ module Google
73
77
  extend ::Google::Protobuf::MessageExts::ClassMethods
74
78
  end
75
79
 
76
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_datasets DatasetService.ListDatasets}.
80
+ # Request message for
81
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_datasets DatasetService.ListDatasets}.
77
82
  # @!attribute [rw] parent
78
83
  # @return [::String]
79
84
  # Required. The name of the Dataset's parent resource.
@@ -117,7 +122,8 @@ module Google
117
122
  extend ::Google::Protobuf::MessageExts::ClassMethods
118
123
  end
119
124
 
120
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_datasets DatasetService.ListDatasets}.
125
+ # Response message for
126
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_datasets DatasetService.ListDatasets}.
121
127
  # @!attribute [rw] datasets
122
128
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Dataset>]
123
129
  # A list of Datasets that matches the specified filter in the request.
@@ -129,7 +135,8 @@ module Google
129
135
  extend ::Google::Protobuf::MessageExts::ClassMethods
130
136
  end
131
137
 
132
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#delete_dataset DatasetService.DeleteDataset}.
138
+ # Request message for
139
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#delete_dataset DatasetService.DeleteDataset}.
133
140
  # @!attribute [rw] name
134
141
  # @return [::String]
135
142
  # Required. The resource name of the Dataset to delete.
@@ -140,7 +147,8 @@ module Google
140
147
  extend ::Google::Protobuf::MessageExts::ClassMethods
141
148
  end
142
149
 
143
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
150
+ # Request message for
151
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
144
152
  # @!attribute [rw] name
145
153
  # @return [::String]
146
154
  # Required. The name of the Dataset resource.
@@ -148,20 +156,22 @@ module Google
148
156
  # `projects/{project}/locations/{location}/datasets/{dataset}`
149
157
  # @!attribute [rw] import_configs
150
158
  # @return [::Array<::Google::Cloud::AIPlatform::V1::ImportDataConfig>]
151
- # Required. The desired input locations. The contents of all input locations will be
152
- # imported in one batch.
159
+ # Required. The desired input locations. The contents of all input locations
160
+ # will be imported in one batch.
153
161
  class ImportDataRequest
154
162
  include ::Google::Protobuf::MessageExts
155
163
  extend ::Google::Protobuf::MessageExts::ClassMethods
156
164
  end
157
165
 
158
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
166
+ # Response message for
167
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
159
168
  class ImportDataResponse
160
169
  include ::Google::Protobuf::MessageExts
161
170
  extend ::Google::Protobuf::MessageExts::ClassMethods
162
171
  end
163
172
 
164
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
173
+ # Runtime operation information for
174
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
165
175
  # @!attribute [rw] generic_metadata
166
176
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
167
177
  # The common part of the operation metadata.
@@ -170,7 +180,8 @@ module Google
170
180
  extend ::Google::Protobuf::MessageExts::ClassMethods
171
181
  end
172
182
 
173
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
183
+ # Request message for
184
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
174
185
  # @!attribute [rw] name
175
186
  # @return [::String]
176
187
  # Required. The name of the Dataset resource.
@@ -184,7 +195,8 @@ module Google
184
195
  extend ::Google::Protobuf::MessageExts::ClassMethods
185
196
  end
186
197
 
187
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
198
+ # Response message for
199
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
188
200
  # @!attribute [rw] exported_files
189
201
  # @return [::Array<::String>]
190
202
  # All of the files that are exported in this export operation.
@@ -193,7 +205,8 @@ module Google
193
205
  extend ::Google::Protobuf::MessageExts::ClassMethods
194
206
  end
195
207
 
196
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
208
+ # Runtime operation information for
209
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
197
210
  # @!attribute [rw] generic_metadata
198
211
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
199
212
  # The common part of the operation metadata.
@@ -206,7 +219,8 @@ module Google
206
219
  extend ::Google::Protobuf::MessageExts::ClassMethods
207
220
  end
208
221
 
209
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_data_items DatasetService.ListDataItems}.
222
+ # Request message for
223
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_data_items DatasetService.ListDataItems}.
210
224
  # @!attribute [rw] parent
211
225
  # @return [::String]
212
226
  # Required. The resource name of the Dataset to list DataItems from.
@@ -233,7 +247,8 @@ module Google
233
247
  extend ::Google::Protobuf::MessageExts::ClassMethods
234
248
  end
235
249
 
236
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_data_items DatasetService.ListDataItems}.
250
+ # Response message for
251
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_data_items DatasetService.ListDataItems}.
237
252
  # @!attribute [rw] data_items
238
253
  # @return [::Array<::Google::Cloud::AIPlatform::V1::DataItem>]
239
254
  # A list of DataItems that matches the specified filter in the request.
@@ -245,7 +260,144 @@ module Google
245
260
  extend ::Google::Protobuf::MessageExts::ClassMethods
246
261
  end
247
262
 
248
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_saved_queries DatasetService.ListSavedQueries}.
263
+ # Request message for
264
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}.
265
+ # @!attribute [rw] order_by_data_item
266
+ # @return [::String]
267
+ # A comma-separated list of data item fields to order by, sorted in
268
+ # ascending order. Use "desc" after a field name for descending.
269
+ # @!attribute [rw] order_by_annotation
270
+ # @return [::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation]
271
+ # Expression that allows ranking results based on annotation's property.
272
+ # @!attribute [rw] dataset
273
+ # @return [::String]
274
+ # Required. The resource name of the Dataset from which to search DataItems.
275
+ # Format:
276
+ # `projects/{project}/locations/{location}/datasets/{dataset}`
277
+ # @!attribute [rw] saved_query
278
+ # @return [::String]
279
+ # The resource name of a SavedQuery(annotation set in UI).
280
+ # Format:
281
+ # `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
282
+ # All of the search will be done in the context of this SavedQuery.
283
+ # @!attribute [rw] data_labeling_job
284
+ # @return [::String]
285
+ # The resource name of a DataLabelingJob.
286
+ # Format:
287
+ # `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
288
+ # If this field is set, all of the search will be done in the context of
289
+ # this DataLabelingJob.
290
+ # @!attribute [rw] data_item_filter
291
+ # @return [::String]
292
+ # An expression for filtering the DataItem that will be returned.
293
+ #
294
+ # * `data_item_id` - for = or !=.
295
+ # * `labeled` - for = or !=.
296
+ # * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that
297
+ # have at least one annotation with annotation_spec_id =
298
+ # `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob.
299
+ #
300
+ # For example:
301
+ #
302
+ # * `data_item=1`
303
+ # * `has_annotation(5)`
304
+ # @!attribute [rw] annotations_filter
305
+ # @return [::String]
306
+ # An expression for filtering the Annotations that will be returned per
307
+ # DataItem.
308
+ # * `annotation_spec_id` - for = or !=.
309
+ # @!attribute [rw] annotation_filters
310
+ # @return [::Array<::String>]
311
+ # An expression that specifies what Annotations will be returned per
312
+ # DataItem. Annotations satisfied either of the conditions will be returned.
313
+ # * `annotation_spec_id` - for = or !=.
314
+ # Must specify `saved_query_id=` - saved query id that annotations should
315
+ # belong to.
316
+ # @!attribute [rw] field_mask
317
+ # @return [::Google::Protobuf::FieldMask]
318
+ # Mask specifying which fields of
319
+ # {::Google::Cloud::AIPlatform::V1::DataItemView DataItemView} to read.
320
+ # @!attribute [rw] annotations_limit
321
+ # @return [::Integer]
322
+ # If set, only up to this many of Annotations will be returned per
323
+ # DataItemView. The maximum value is 1000. If not set, the maximum value will
324
+ # be used.
325
+ # @!attribute [rw] page_size
326
+ # @return [::Integer]
327
+ # Requested page size. Server may return fewer results than requested.
328
+ # Default and maximum page size is 100.
329
+ # @!attribute [rw] order_by
330
+ # @return [::String]
331
+ # A comma-separated list of fields to order by, sorted in ascending order.
332
+ # Use "desc" after a field name for descending.
333
+ # @!attribute [rw] page_token
334
+ # @return [::String]
335
+ # A token identifying a page of results for the server to return
336
+ # Typically obtained via
337
+ # {::Google::Cloud::AIPlatform::V1::SearchDataItemsResponse#next_page_token SearchDataItemsResponse.next_page_token}
338
+ # of the previous
339
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}
340
+ # call.
341
+ class SearchDataItemsRequest
342
+ include ::Google::Protobuf::MessageExts
343
+ extend ::Google::Protobuf::MessageExts::ClassMethods
344
+
345
+ # Expression that allows ranking results based on annotation's property.
346
+ # @!attribute [rw] saved_query
347
+ # @return [::String]
348
+ # Required. Saved query of the Annotation. Only Annotations belong to this
349
+ # saved query will be considered for ordering.
350
+ # @!attribute [rw] order_by
351
+ # @return [::String]
352
+ # A comma-separated list of annotation fields to order by, sorted in
353
+ # ascending order. Use "desc" after a field name for descending. Must also
354
+ # specify saved_query.
355
+ class OrderByAnnotation
356
+ include ::Google::Protobuf::MessageExts
357
+ extend ::Google::Protobuf::MessageExts::ClassMethods
358
+ end
359
+ end
360
+
361
+ # Response message for
362
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}.
363
+ # @!attribute [rw] data_item_views
364
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::DataItemView>]
365
+ # The DataItemViews read.
366
+ # @!attribute [rw] next_page_token
367
+ # @return [::String]
368
+ # A token to retrieve next page of results.
369
+ # Pass to
370
+ # {::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest#page_token SearchDataItemsRequest.page_token}
371
+ # to obtain that page.
372
+ class SearchDataItemsResponse
373
+ include ::Google::Protobuf::MessageExts
374
+ extend ::Google::Protobuf::MessageExts::ClassMethods
375
+ end
376
+
377
+ # A container for a single DataItem and Annotations on it.
378
+ # @!attribute [rw] data_item
379
+ # @return [::Google::Cloud::AIPlatform::V1::DataItem]
380
+ # The DataItem.
381
+ # @!attribute [rw] annotations
382
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::Annotation>]
383
+ # The Annotations on the DataItem. If too many Annotations should be returned
384
+ # for the DataItem, this field will be truncated per annotations_limit in
385
+ # request. If it was, then the has_truncated_annotations will be set to true.
386
+ # @!attribute [rw] has_truncated_annotations
387
+ # @return [::Boolean]
388
+ # True if and only if the Annotations field has been truncated. It happens if
389
+ # more Annotations for this DataItem met the request's annotation_filter than
390
+ # are allowed to be returned by annotations_limit.
391
+ # Note that if Annotations field is not being returned due to field mask,
392
+ # then this field will not be set to true no matter how many Annotations are
393
+ # there.
394
+ class DataItemView
395
+ include ::Google::Protobuf::MessageExts
396
+ extend ::Google::Protobuf::MessageExts::ClassMethods
397
+ end
398
+
399
+ # Request message for
400
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_saved_queries DatasetService.ListSavedQueries}.
249
401
  # @!attribute [rw] parent
250
402
  # @return [::String]
251
403
  # Required. The resource name of the Dataset to list SavedQueries from.
@@ -272,7 +424,8 @@ module Google
272
424
  extend ::Google::Protobuf::MessageExts::ClassMethods
273
425
  end
274
426
 
275
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_saved_queries DatasetService.ListSavedQueries}.
427
+ # Response message for
428
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_saved_queries DatasetService.ListSavedQueries}.
276
429
  # @!attribute [rw] saved_queries
277
430
  # @return [::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>]
278
431
  # A list of SavedQueries that match the specified filter in the request.
@@ -284,7 +437,8 @@ module Google
284
437
  extend ::Google::Protobuf::MessageExts::ClassMethods
285
438
  end
286
439
 
287
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#get_annotation_spec DatasetService.GetAnnotationSpec}.
440
+ # Request message for
441
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#get_annotation_spec DatasetService.GetAnnotationSpec}.
288
442
  # @!attribute [rw] name
289
443
  # @return [::String]
290
444
  # Required. The name of the AnnotationSpec resource.
@@ -298,7 +452,8 @@ module Google
298
452
  extend ::Google::Protobuf::MessageExts::ClassMethods
299
453
  end
300
454
 
301
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_annotations DatasetService.ListAnnotations}.
455
+ # Request message for
456
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_annotations DatasetService.ListAnnotations}.
302
457
  # @!attribute [rw] parent
303
458
  # @return [::String]
304
459
  # Required. The resource name of the DataItem to list Annotations from.
@@ -325,7 +480,8 @@ module Google
325
480
  extend ::Google::Protobuf::MessageExts::ClassMethods
326
481
  end
327
482
 
328
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_annotations DatasetService.ListAnnotations}.
483
+ # Response message for
484
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_annotations DatasetService.ListAnnotations}.
329
485
  # @!attribute [rw] annotations
330
486
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Annotation>]
331
487
  # A list of Annotations that matches the specified filter in the request.
@@ -25,8 +25,8 @@ module Google
25
25
  # a top-level resource.
26
26
  # @!attribute [rw] kms_key_name
27
27
  # @return [::String]
28
- # Required. The Cloud KMS resource identifier of the customer managed encryption key
29
- # used to protect a resource. Has the form:
28
+ # Required. The Cloud KMS resource identifier of the customer managed
29
+ # encryption key used to protect a resource. Has the form:
30
30
  # `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`.
31
31
  # The key needs to be in the same region as where the compute resource is
32
32
  # created.
@@ -29,7 +29,7 @@ module Google
29
29
  # @!attribute [rw] display_name
30
30
  # @return [::String]
31
31
  # Required. The display name of the Endpoint.
32
- # The name can be up to 128 characters long and can be consist of any UTF-8
32
+ # The name can be up to 128 characters long and can consist of any UTF-8
33
33
  # characters.
34
34
  # @!attribute [rw] description
35
35
  # @return [::String]
@@ -37,8 +37,11 @@ module Google
37
37
  # @!attribute [r] deployed_models
38
38
  # @return [::Array<::Google::Cloud::AIPlatform::V1::DeployedModel>]
39
39
  # Output only. The models deployed in this Endpoint.
40
- # To add or remove DeployedModels use {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel} and
41
- # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel} respectively.
40
+ # To add or remove DeployedModels use
41
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}
42
+ # and
43
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}
44
+ # respectively.
42
45
  # @!attribute [rw] traffic_split
43
46
  # @return [::Google::Protobuf::Map{::String => ::Integer}]
44
47
  # A map from a DeployedModel's ID to the percentage of this Endpoint's
@@ -82,7 +85,8 @@ module Google
82
85
  # Private services access must already be configured for the network. If left
83
86
  # unspecified, the Endpoint is not peered with any network.
84
87
  #
85
- # Only one of the fields, {::Google::Cloud::AIPlatform::V1::Endpoint#network network} or
88
+ # Only one of the fields,
89
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#network network} or
86
90
  # {::Google::Cloud::AIPlatform::V1::Endpoint#enable_private_service_connect enable_private_service_connect},
87
91
  # can be set.
88
92
  #
@@ -94,14 +98,15 @@ module Google
94
98
  # @return [::Boolean]
95
99
  # Deprecated: If true, expose the Endpoint via private service connect.
96
100
  #
97
- # Only one of the fields, {::Google::Cloud::AIPlatform::V1::Endpoint#network network} or
101
+ # Only one of the fields,
102
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#network network} or
98
103
  # {::Google::Cloud::AIPlatform::V1::Endpoint#enable_private_service_connect enable_private_service_connect},
99
104
  # can be set.
100
105
  # @!attribute [r] model_deployment_monitoring_job
101
106
  # @return [::String]
102
- # Output only. Resource name of the Model Monitoring job associated with this Endpoint
103
- # if monitoring is enabled by [CreateModelDeploymentMonitoringJob][].
104
- # Format:
107
+ # Output only. Resource name of the Model Monitoring job associated with this
108
+ # Endpoint if monitoring is enabled by
109
+ # [CreateModelDeploymentMonitoringJob][]. Format:
105
110
  # `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
106
111
  # @!attribute [rw] predict_request_response_logging_config
107
112
  # @return [::Google::Cloud::AIPlatform::V1::PredictRequestResponseLoggingConfig]
@@ -140,14 +145,15 @@ module Google
140
145
  # AI, and require only a modest additional configuration.
141
146
  # @!attribute [rw] id
142
147
  # @return [::String]
143
- # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI
144
- # will generate a value for this ID.
148
+ # Immutable. The ID of the DeployedModel. If not provided upon deployment,
149
+ # Vertex AI will generate a value for this ID.
145
150
  #
146
151
  # This value should be 1-10 characters, and valid characters are /[0-9]/.
147
152
  # @!attribute [rw] model
148
153
  # @return [::String]
149
- # Required. The resource name of the Model that this is the deployment of. Note that
150
- # the Model may be in a different location than the DeployedModel's Endpoint.
154
+ # Required. The resource name of the Model that this is the deployment of.
155
+ # Note that the Model may be in a different location than the DeployedModel's
156
+ # Endpoint.
151
157
  #
152
158
  # The resource name may contain version id or version alias to specify the
153
159
  # version, if no version is specified, the default version will be deployed.
@@ -165,13 +171,21 @@ module Google
165
171
  # @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
166
172
  # Explanation configuration for this DeployedModel.
167
173
  #
168
- # When deploying a Model using {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}, this value
169
- # overrides the value of {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}. All fields of
170
- # {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec} are optional in the request. If a field of
171
- # {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec} is not populated, the value of the same field of
172
- # {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec} is inherited. If the corresponding
173
- # {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec} is not populated, all fields of the
174
- # {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec} will be used for the explanation configuration.
174
+ # When deploying a Model using
175
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel},
176
+ # this value overrides the value of
177
+ # {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}.
178
+ # All fields of
179
+ # {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
180
+ # are optional in the request. If a field of
181
+ # {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
182
+ # is not populated, the value of the same field of
183
+ # {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}
184
+ # is inherited. If the corresponding
185
+ # {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}
186
+ # is not populated, all fields of the
187
+ # {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
188
+ # will be used for the explanation configuration.
175
189
  # @!attribute [rw] service_account
176
190
  # @return [::String]
177
191
  # The service account that the DeployedModel's container runs as. Specify the
@@ -200,9 +214,10 @@ module Google
200
214
  # Estimate your costs before enabling this option.
201
215
  # @!attribute [r] private_endpoints
202
216
  # @return [::Google::Cloud::AIPlatform::V1::PrivateEndpoints]
203
- # Output only. Provide paths for users to send predict/explain/health requests directly to
204
- # the deployed model services running on Cloud via private services access.
205
- # This field is populated if {::Google::Cloud::AIPlatform::V1::Endpoint#network network} is configured.
217
+ # Output only. Provide paths for users to send predict/explain/health
218
+ # requests directly to the deployed model services running on Cloud via
219
+ # private services access. This field is populated if
220
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#network network} is configured.
206
221
  class DeployedModel
207
222
  include ::Google::Protobuf::MessageExts
208
223
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -224,8 +239,8 @@ module Google
224
239
  # Output only. Http(s) path to send health check requests.
225
240
  # @!attribute [r] service_attachment
226
241
  # @return [::String]
227
- # Output only. The name of the service attachment resource. Populated if private service
228
- # connect is enabled.
242
+ # Output only. The name of the service attachment resource. Populated if
243
+ # private service connect is enabled.
229
244
  class PrivateEndpoints
230
245
  include ::Google::Protobuf::MessageExts
231
246
  extend ::Google::Protobuf::MessageExts::ClassMethods