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
@@ -24,17 +24,18 @@ module Google
24
24
  # Metadata describing the Model's input and output for explanation.
25
25
  # @!attribute [rw] inputs
26
26
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata}]
27
- # Required. Map from feature names to feature input metadata. Keys are the name of the
28
- # features. Values are the specification of the feature.
27
+ # Required. Map from feature names to feature input metadata. Keys are the
28
+ # name of the features. Values are the specification of the feature.
29
29
  #
30
30
  # An empty InputMetadata is valid. It describes a text feature which has the
31
- # name specified as the key in {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs ExplanationMetadata.inputs}. The baseline
32
- # of the empty feature is chosen by Vertex AI.
31
+ # name specified as the key in
32
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs ExplanationMetadata.inputs}.
33
+ # The baseline of the empty feature is chosen by Vertex AI.
33
34
  #
34
35
  # For Vertex AI-provided Tensorflow images, the key can be any friendly
35
36
  # name of the feature. Once specified,
36
- # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions featureAttributions} are keyed by
37
- # this key (if not grouped with another feature).
37
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions featureAttributions}
38
+ # are keyed by this key (if not grouped with another feature).
38
39
  #
39
40
  # For custom images, the key must match with the key in
40
41
  # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}.
@@ -52,7 +53,8 @@ module Google
52
53
  # @!attribute [rw] feature_attributions_schema_uri
53
54
  # @return [::String]
54
55
  # Points to a YAML file stored on Google Cloud Storage describing the format
55
- # of the {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions feature attributions}.
56
+ # of the [feature
57
+ # attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
56
58
  # The schema is defined as an OpenAPI 3.0.2 [Schema
57
59
  # Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
58
60
  # AutoML tabular Models always have this field populated by Vertex AI.
@@ -68,15 +70,18 @@ module Google
68
70
 
69
71
  # Metadata of the input of a feature.
70
72
  #
71
- # Fields other than {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#input_baselines InputMetadata.input_baselines} are applicable only
72
- # for Models that are using Vertex AI-provided images for Tensorflow.
73
+ # Fields other than
74
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#input_baselines InputMetadata.input_baselines}
75
+ # are applicable only for Models that are using Vertex AI-provided images for
76
+ # Tensorflow.
73
77
  # @!attribute [rw] input_baselines
74
78
  # @return [::Array<::Google::Protobuf::Value>]
75
79
  # Baseline inputs for this feature.
76
80
  #
77
81
  # If no baseline is specified, Vertex AI chooses the baseline for this
78
82
  # feature. If multiple baselines are specified, Vertex AI returns the
79
- # average attributions across them in {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions Attribution.feature_attributions}.
83
+ # average attributions across them in
84
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions Attribution.feature_attributions}.
80
85
  #
81
86
  # For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape
82
87
  # of each baseline must match the shape of the input tensor. If a scalar is
@@ -84,9 +89,9 @@ module Google
84
89
  #
85
90
  # For custom images, the element of the baselines must be in the same
86
91
  # format as the feature's input in the
87
- # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}[]. The schema of any single instance
88
- # may be specified via Endpoint's DeployedModels'
89
- # [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
92
+ # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}[]. The
93
+ # schema of any single instance may be specified via Endpoint's
94
+ # DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
90
95
  # [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
91
96
  # {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri instance_schema_uri}.
92
97
  # @!attribute [rw] input_tensor_name
@@ -119,15 +124,18 @@ module Google
119
124
  # @!attribute [rw] index_feature_mapping
120
125
  # @return [::Array<::String>]
121
126
  # A list of feature names for each index in the input tensor.
122
- # Required when the input {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoding InputMetadata.encoding} is BAG_OF_FEATURES,
123
- # BAG_OF_FEATURES_SPARSE, INDICATOR.
127
+ # Required when the input
128
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoding InputMetadata.encoding}
129
+ # is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
124
130
  # @!attribute [rw] encoded_tensor_name
125
131
  # @return [::String]
126
132
  # Encoded tensor is a transformation of the input tensor. Must be provided
127
133
  # if choosing
128
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution Integrated Gradients attribution}
129
- # or {::Google::Cloud::AIPlatform::V1::ExplanationParameters#xrai_attribution XRAI attribution} and the
130
- # input tensor is not differentiable.
134
+ # [Integrated Gradients
135
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]
136
+ # or [XRAI
137
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution]
138
+ # and the input tensor is not differentiable.
131
139
  #
132
140
  # An encoded tensor is generated if the input tensor is encoded by a lookup
133
141
  # table.
@@ -147,7 +155,8 @@ module Google
147
155
  # name will be treated as one feature when computing attributions. Features
148
156
  # grouped together can have different shapes in value. If provided, there
149
157
  # will be one single attribution generated in
150
- # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions Attribution.feature_attributions}, keyed by the group name.
158
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions Attribution.feature_attributions},
159
+ # keyed by the group name.
151
160
  class InputMetadata
152
161
  include ::Google::Protobuf::MessageExts
153
162
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -185,7 +194,8 @@ module Google
185
194
  # @!attribute [rw] type
186
195
  # @return [::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata::Visualization::Type]
187
196
  # Type of the image visualization. Only applicable to
188
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution Integrated Gradients attribution}.
197
+ # [Integrated Gradients
198
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
189
199
  # OUTLINES shows regions of attribution, while PIXELS shows per-pixel
190
200
  # attribution. Defaults to OUTLINES.
191
201
  # @!attribute [rw] polarity
@@ -197,12 +207,14 @@ module Google
197
207
  # The color scheme used for the highlighted areas.
198
208
  #
199
209
  # Defaults to PINK_GREEN for
200
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution Integrated Gradients attribution},
210
+ # [Integrated Gradients
211
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
201
212
  # which shows positive attributions in green and negative in pink.
202
213
  #
203
214
  # Defaults to VIRIDIS for
204
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#xrai_attribution XRAI attribution}, which
205
- # highlights the most influential regions in yellow and the least
215
+ # [XRAI
216
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
217
+ # which highlights the most influential regions in yellow and the least
206
218
  # influential in blue.
207
219
  # @!attribute [rw] clip_percent_upperbound
208
220
  # @return [::Float]
@@ -225,7 +237,8 @@ module Google
225
237
  extend ::Google::Protobuf::MessageExts::ClassMethods
226
238
 
227
239
  # Type of the image visualization. Only applicable to
228
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution Integrated Gradients attribution}.
240
+ # [Integrated Gradients
241
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
229
242
  module Type
230
243
  # Should not be used.
231
244
  TYPE_UNSPECIFIED = 0
@@ -312,8 +325,9 @@ module Google
312
325
  IDENTITY = 1
313
326
 
314
327
  # The tensor represents a bag of features where each index maps to
315
- # a feature. {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping} must be provided for
316
- # this encoding. For example:
328
+ # a feature.
329
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping}
330
+ # must be provided for this encoding. For example:
317
331
  # ```
318
332
  # input = [27, 6.0, 150]
319
333
  # index_feature_mapping = ["age", "height", "weight"]
@@ -322,8 +336,9 @@ module Google
322
336
 
323
337
  # The tensor represents a bag of features where each index maps to a
324
338
  # feature. Zero values in the tensor indicates feature being
325
- # non-existent. {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping} must be provided
326
- # for this encoding. For example:
339
+ # non-existent.
340
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping}
341
+ # must be provided for this encoding. For example:
327
342
  # ```
328
343
  # input = [2, 0, 5, 0, 1]
329
344
  # index_feature_mapping = ["a", "b", "c", "d", "e"]
@@ -331,7 +346,8 @@ module Google
331
346
  BAG_OF_FEATURES_SPARSE = 3
332
347
 
333
348
  # The tensor is a list of binaries representing whether a feature exists
334
- # or not (1 indicates existence). {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping}
349
+ # or not (1 indicates existence).
350
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping}
335
351
  # must be provided for this encoding. For example:
336
352
  # ```
337
353
  # input = [1, 0, 1, 0, 1]
@@ -340,8 +356,9 @@ module Google
340
356
  INDICATOR = 4
341
357
 
342
358
  # The tensor is encoded into a 1-dimensional array represented by an
343
- # encoded tensor. {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoded_tensor_name InputMetadata.encoded_tensor_name} must be provided
344
- # for this encoding. For example:
359
+ # encoded tensor.
360
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoded_tensor_name InputMetadata.encoded_tensor_name}
361
+ # must be provided for this encoding. For example:
345
362
  # ```
346
363
  # input = ["This", "is", "a", "test", "."]
347
364
  # encoded = [0.1, 0.2, 0.3, 0.4, 0.5]
@@ -350,9 +367,9 @@ module Google
350
367
 
351
368
  # Select this encoding when the input tensor is encoded into a
352
369
  # 2-dimensional array represented by an encoded tensor.
353
- # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoded_tensor_name InputMetadata.encoded_tensor_name} must be provided for this
354
- # encoding. The first dimension of the encoded tensor's shape is the same
355
- # as the input tensor's shape. For example:
370
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoded_tensor_name InputMetadata.encoded_tensor_name}
371
+ # must be provided for this encoding. The first dimension of the encoded
372
+ # tensor's shape is the same as the input tensor's shape. For example:
356
373
  # ```
357
374
  # input = ["This", "is", "a", "test", "."]
358
375
  # encoded = [[0.1, 0.2, 0.3, 0.4, 0.5],
@@ -378,8 +395,10 @@ module Google
378
395
  #
379
396
  # The shape of the value must be an n-dimensional array of strings. The
380
397
  # number of dimensions must match that of the outputs to be explained.
381
- # The {::Google::Cloud::AIPlatform::V1::Attribution#output_display_name Attribution.output_display_name} is populated by locating in the
382
- # mapping with {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}.
398
+ # The
399
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_display_name Attribution.output_display_name}
400
+ # is populated by locating in the mapping with
401
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}.
383
402
  # @!attribute [rw] display_name_mapping_key
384
403
  # @return [::String]
385
404
  # Specify a field name in the prediction to look for the display name.
@@ -387,8 +406,9 @@ module Google
387
406
  # Use this if the prediction contains the display names for the outputs.
388
407
  #
389
408
  # The display names in the prediction must have the same shape of the
390
- # outputs, so that it can be located by {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} for
391
- # a specific output.
409
+ # outputs, so that it can be located by
410
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}
411
+ # for a specific output.
392
412
  # @!attribute [rw] output_tensor_name
393
413
  # @return [::String]
394
414
  # Name of the output tensor. Required and is only applicable to Vertex
@@ -65,16 +65,17 @@ module Google
65
65
  # "overwrite" update happens.
66
66
  # @!attribute [rw] disable_monitoring
67
67
  # @return [::Boolean]
68
- # Optional. If not set, use the monitoring_config defined for the EntityType this
69
- # Feature belongs to.
70
- # Only Features with type ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL, STRING, DOUBLE or
71
- # INT64 can enable monitoring.
68
+ # Optional. If not set, use the monitoring_config defined for the EntityType
69
+ # this Feature belongs to. Only Features with type
70
+ # ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL,
71
+ # STRING, DOUBLE or INT64 can enable monitoring.
72
72
  #
73
73
  # If set to true, all types of data monitoring are disabled despite the
74
74
  # config on EntityType.
75
75
  # @!attribute [r] monitoring_stats_anomalies
76
76
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Feature::MonitoringStatsAnomaly>]
77
- # Output only. The list of historical stats and anomalies with specified objectives.
77
+ # Output only. The list of historical stats and anomalies with specified
78
+ # objectives.
78
79
  class Feature
79
80
  include ::Google::Protobuf::MessageExts
80
81
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -82,7 +83,9 @@ module Google
82
83
  # A list of historical [Snapshot
83
84
  # Analysis][FeaturestoreMonitoringConfig.SnapshotAnalysis] or [Import Feature
84
85
  # Analysis] [FeaturestoreMonitoringConfig.ImportFeatureAnalysis] stats
85
- # requested by user, sorted by {::Google::Cloud::AIPlatform::V1::FeatureStatsAnomaly#start_time FeatureStatsAnomaly.start_time} descending.
86
+ # requested by user, sorted by
87
+ # {::Google::Cloud::AIPlatform::V1::FeatureStatsAnomaly#start_time FeatureStatsAnomaly.start_time}
88
+ # descending.
86
89
  # @!attribute [r] objective
87
90
  # @return [::Google::Cloud::AIPlatform::V1::Feature::MonitoringStatsAnomaly::Objective]
88
91
  # Output only. The objective for each stats.
@@ -35,7 +35,8 @@ module Google
35
35
  # Feature importance score, only populated when cross-feature monitoring is
36
36
  # enabled. For now only used to represent feature attribution score within
37
37
  # range [0, 1] for
38
- # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringObjectiveType::FEATURE_ATTRIBUTION_SKEW ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW} and
38
+ # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringObjectiveType::FEATURE_ATTRIBUTION_SKEW ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW}
39
+ # and
39
40
  # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringObjectiveType::FEATURE_ATTRIBUTION_DRIFT ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT}.
40
41
  # @!attribute [rw] stats_uri
41
42
  # @return [::String]
@@ -36,11 +36,12 @@ module Google
36
36
  # Output only. Timestamp when this Featurestore was last updated.
37
37
  # @!attribute [rw] etag
38
38
  # @return [::String]
39
- # Optional. Used to perform consistent read-modify-write updates. If not set, a blind
40
- # "overwrite" update happens.
39
+ # Optional. Used to perform consistent read-modify-write updates. If not set,
40
+ # a blind "overwrite" update happens.
41
41
  # @!attribute [rw] labels
42
42
  # @return [::Google::Protobuf::Map{::String => ::String}]
43
- # Optional. The labels with user-defined metadata to organize your Featurestore.
43
+ # Optional. The labels with user-defined metadata to organize your
44
+ # Featurestore.
44
45
  #
45
46
  # Label keys and values can be no longer than 64 characters
46
47
  # (Unicode codepoints), can only contain lowercase letters, numeric
@@ -53,17 +54,17 @@ module Google
53
54
  # and are immutable.
54
55
  # @!attribute [rw] online_serving_config
55
56
  # @return [::Google::Cloud::AIPlatform::V1::Featurestore::OnlineServingConfig]
56
- # Optional. Config for online storage resources. The field should not co-exist with the
57
- # field of `OnlineStoreReplicationConfig`. If both of it and
58
- # OnlineStoreReplicationConfig are unset, the feature store will not have an
59
- # online store and cannot be used for online serving.
57
+ # Optional. Config for online storage resources. The field should not
58
+ # co-exist with the field of `OnlineStoreReplicationConfig`. If both of it
59
+ # and OnlineStoreReplicationConfig are unset, the feature store will not have
60
+ # an online store and cannot be used for online serving.
60
61
  # @!attribute [r] state
61
62
  # @return [::Google::Cloud::AIPlatform::V1::Featurestore::State]
62
63
  # Output only. State of the featurestore.
63
64
  # @!attribute [rw] encryption_spec
64
65
  # @return [::Google::Cloud::AIPlatform::V1::EncryptionSpec]
65
- # Optional. Customer-managed encryption key spec for data storage. If set, both of the
66
- # online and offline data storage will be secured by this key.
66
+ # Optional. Customer-managed encryption key spec for data storage. If set,
67
+ # both of the online and offline data storage will be secured by this key.
67
68
  class Featurestore
68
69
  include ::Google::Protobuf::MessageExts
69
70
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -90,8 +91,8 @@ module Google
90
91
  # with the fixed number of node (no auto-scaling).
91
92
  # @!attribute [rw] min_node_count
92
93
  # @return [::Integer]
93
- # Required. The minimum number of nodes to scale down to. Must be greater than or
94
- # equal to 1.
94
+ # Required. The minimum number of nodes to scale down to. Must be greater
95
+ # than or equal to 1.
95
96
  # @!attribute [rw] max_node_count
96
97
  # @return [::Integer]
97
98
  # The maximum number of nodes to scale up to. Must be greater than
@@ -32,12 +32,16 @@ module Google
32
32
  # @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::ThresholdConfig]
33
33
  # Threshold for numerical features of anomaly detection.
34
34
  # This is shared by all objectives of Featurestore Monitoring for numerical
35
- # features (i.e. Features with type ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) DOUBLE or INT64).
35
+ # features (i.e. Features with type
36
+ # ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) DOUBLE
37
+ # or INT64).
36
38
  # @!attribute [rw] categorical_threshold_config
37
39
  # @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::ThresholdConfig]
38
40
  # Threshold for categorical features of anomaly detection.
39
41
  # This is shared by all types of Featurestore Monitoring for categorical
40
- # features (i.e. Features with type ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL or STRING).
42
+ # features (i.e. Features with type
43
+ # ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL or
44
+ # STRING).
41
45
  class FeaturestoreMonitoringConfig
42
46
  include ::Google::Protobuf::MessageExts
43
47
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -21,7 +21,58 @@ module Google
21
21
  module Cloud
22
22
  module AIPlatform
23
23
  module V1
24
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client#read_feature_values FeaturestoreOnlineServingService.ReadFeatureValues}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client#write_feature_values FeaturestoreOnlineServingService.WriteFeatureValues}.
26
+ # @!attribute [rw] entity_type
27
+ # @return [::String]
28
+ # Required. The resource name of the EntityType for the entities being
29
+ # written. Value format:
30
+ # `projects/{project}/locations/{location}/featurestores/
31
+ # \\{featurestore}/entityTypes/\\{entityType}`. For example,
32
+ # for a machine learning model predicting user clicks on a website, an
33
+ # EntityType ID could be `user`.
34
+ # @!attribute [rw] payloads
35
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::WriteFeatureValuesPayload>]
36
+ # Required. The entities to be written. Up to 100,000 feature values can be
37
+ # written across all `payloads`.
38
+ class WriteFeatureValuesRequest
39
+ include ::Google::Protobuf::MessageExts
40
+ extend ::Google::Protobuf::MessageExts::ClassMethods
41
+ end
42
+
43
+ # Contains Feature values to be written for a specific entity.
44
+ # @!attribute [rw] entity_id
45
+ # @return [::String]
46
+ # Required. The ID of the entity.
47
+ # @!attribute [rw] feature_values
48
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::FeatureValue}]
49
+ # Required. Feature values to be written, mapping from Feature ID to value.
50
+ # Up to 100,000 `feature_values` entries may be written across all payloads.
51
+ # The feature generation time, aligned by days, must be no older than five
52
+ # years (1825 days) and no later than one year (366 days) in the future.
53
+ class WriteFeatureValuesPayload
54
+ include ::Google::Protobuf::MessageExts
55
+ extend ::Google::Protobuf::MessageExts::ClassMethods
56
+
57
+ # @!attribute [rw] key
58
+ # @return [::String]
59
+ # @!attribute [rw] value
60
+ # @return [::Google::Cloud::AIPlatform::V1::FeatureValue]
61
+ class FeatureValuesEntry
62
+ include ::Google::Protobuf::MessageExts
63
+ extend ::Google::Protobuf::MessageExts::ClassMethods
64
+ end
65
+ end
66
+
67
+ # Response message for
68
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client#write_feature_values FeaturestoreOnlineServingService.WriteFeatureValues}.
69
+ class WriteFeatureValuesResponse
70
+ include ::Google::Protobuf::MessageExts
71
+ extend ::Google::Protobuf::MessageExts::ClassMethods
72
+ end
73
+
74
+ # Request message for
75
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client#read_feature_values FeaturestoreOnlineServingService.ReadFeatureValues}.
25
76
  # @!attribute [rw] entity_type
26
77
  # @return [::String]
27
78
  # Required. The resource name of the EntityType for the entity being read.
@@ -42,7 +93,8 @@ module Google
42
93
  extend ::Google::Protobuf::MessageExts::ClassMethods
43
94
  end
44
95
 
45
- # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client#read_feature_values FeaturestoreOnlineServingService.ReadFeatureValues}.
96
+ # Response message for
97
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client#read_feature_values FeaturestoreOnlineServingService.ReadFeatureValues}.
46
98
  # @!attribute [rw] header
47
99
  # @return [::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse::Header]
48
100
  # Response header.
@@ -66,11 +118,13 @@ module Google
66
118
  end
67
119
 
68
120
  # Response header with metadata for the requested
69
- # {::Google::Cloud::AIPlatform::V1::ReadFeatureValuesRequest#entity_type ReadFeatureValuesRequest.entity_type} and Features.
121
+ # {::Google::Cloud::AIPlatform::V1::ReadFeatureValuesRequest#entity_type ReadFeatureValuesRequest.entity_type}
122
+ # and Features.
70
123
  # @!attribute [rw] entity_type
71
124
  # @return [::String]
72
125
  # The resource name of the EntityType from the
73
- # {::Google::Cloud::AIPlatform::V1::ReadFeatureValuesRequest ReadFeatureValuesRequest}. Value format:
126
+ # {::Google::Cloud::AIPlatform::V1::ReadFeatureValuesRequest ReadFeatureValuesRequest}.
127
+ # Value format:
74
128
  # `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
75
129
  # @!attribute [rw] feature_descriptors
76
130
  # @return [::Array<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse::FeatureDescriptor>]
@@ -91,7 +145,8 @@ module Google
91
145
  # requested values for one requested Feature. If no values
92
146
  # for the requested Feature exist, the corresponding cell will be empty.
93
147
  # This has the same size and is in the same order as the features from the
94
- # header {::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse#header ReadFeatureValuesResponse.header}.
148
+ # header
149
+ # {::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse#header ReadFeatureValuesResponse.header}.
95
150
  class EntityView
96
151
  include ::Google::Protobuf::MessageExts
97
152
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -126,13 +181,13 @@ module Google
126
181
  # EntityType ID could be `user`.
127
182
  # @!attribute [rw] entity_ids
128
183
  # @return [::Array<::String>]
129
- # Required. IDs of entities to read Feature values of. The maximum number of IDs is
130
- # 100. For example, for a machine learning model predicting user clicks on a
131
- # website, an entity ID could be `user_123`.
184
+ # Required. IDs of entities to read Feature values of. The maximum number of
185
+ # IDs is 100. For example, for a machine learning model predicting user
186
+ # clicks on a website, an entity ID could be `user_123`.
132
187
  # @!attribute [rw] feature_selector
133
188
  # @return [::Google::Cloud::AIPlatform::V1::FeatureSelector]
134
- # Required. Selector choosing Features of the target EntityType. Feature IDs will be
135
- # deduplicated.
189
+ # Required. Selector choosing Features of the target EntityType. Feature IDs
190
+ # will be deduplicated.
136
191
  class StreamingReadFeatureValuesRequest
137
192
  include ::Google::Protobuf::MessageExts
138
193
  extend ::Google::Protobuf::MessageExts::ClassMethods