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
@@ -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::EndpointService::Client#create_endpoint EndpointService.CreateEndpoint}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#create_endpoint EndpointService.CreateEndpoint}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The resource name of the Location to create the Endpoint in.
@@ -44,7 +45,8 @@ module Google
44
45
  extend ::Google::Protobuf::MessageExts::ClassMethods
45
46
  end
46
47
 
47
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#create_endpoint EndpointService.CreateEndpoint}.
48
+ # Runtime operation information for
49
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#create_endpoint EndpointService.CreateEndpoint}.
48
50
  # @!attribute [rw] generic_metadata
49
51
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
50
52
  # The operation generic information.
@@ -53,7 +55,8 @@ module Google
53
55
  extend ::Google::Protobuf::MessageExts::ClassMethods
54
56
  end
55
57
 
56
- # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#get_endpoint EndpointService.GetEndpoint}
58
+ # Request message for
59
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#get_endpoint EndpointService.GetEndpoint}
57
60
  # @!attribute [rw] name
58
61
  # @return [::String]
59
62
  # Required. The name of the Endpoint resource.
@@ -64,18 +67,20 @@ module Google
64
67
  extend ::Google::Protobuf::MessageExts::ClassMethods
65
68
  end
66
69
 
67
- # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}.
70
+ # Request message for
71
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}.
68
72
  # @!attribute [rw] parent
69
73
  # @return [::String]
70
- # Required. The resource name of the Location from which to list the Endpoints.
71
- # Format: `projects/{project}/locations/{location}`
74
+ # Required. The resource name of the Location from which to list the
75
+ # Endpoints. Format: `projects/{project}/locations/{location}`
72
76
  # @!attribute [rw] filter
73
77
  # @return [::String]
74
- # Optional. An expression for filtering the results of the request. For field names
75
- # both snake_case and camelCase are supported.
78
+ # Optional. An expression for filtering the results of the request. For field
79
+ # names both snake_case and camelCase are supported.
76
80
  #
77
81
  # * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID,
78
- # i.e. the last segment of the Endpoint's {::Google::Cloud::AIPlatform::V1::Endpoint#name resource name}.
82
+ # i.e. the last segment of the Endpoint's [resource
83
+ # name][google.cloud.aiplatform.v1.Endpoint.name].
79
84
  # * `display_name` supports = and, !=
80
85
  # * `labels` supports general map functions that is:
81
86
  # * `labels.key=value` - key:value equality
@@ -93,8 +98,10 @@ module Google
93
98
  # @return [::String]
94
99
  # Optional. The standard list page token.
95
100
  # Typically obtained via
96
- # {::Google::Cloud::AIPlatform::V1::ListEndpointsResponse#next_page_token ListEndpointsResponse.next_page_token} of the previous
97
- # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints} call.
101
+ # {::Google::Cloud::AIPlatform::V1::ListEndpointsResponse#next_page_token ListEndpointsResponse.next_page_token}
102
+ # of the previous
103
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}
104
+ # call.
98
105
  # @!attribute [rw] read_mask
99
106
  # @return [::Google::Protobuf::FieldMask]
100
107
  # Optional. Mask specifying which fields to read.
@@ -113,32 +120,38 @@ module Google
113
120
  extend ::Google::Protobuf::MessageExts::ClassMethods
114
121
  end
115
122
 
116
- # Response message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}.
123
+ # Response message for
124
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}.
117
125
  # @!attribute [rw] endpoints
118
126
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Endpoint>]
119
127
  # List of Endpoints in the requested page.
120
128
  # @!attribute [rw] next_page_token
121
129
  # @return [::String]
122
130
  # A token to retrieve the next page of results.
123
- # Pass to {::Google::Cloud::AIPlatform::V1::ListEndpointsRequest#page_token ListEndpointsRequest.page_token} to obtain that page.
131
+ # Pass to
132
+ # {::Google::Cloud::AIPlatform::V1::ListEndpointsRequest#page_token ListEndpointsRequest.page_token}
133
+ # to obtain that page.
124
134
  class ListEndpointsResponse
125
135
  include ::Google::Protobuf::MessageExts
126
136
  extend ::Google::Protobuf::MessageExts::ClassMethods
127
137
  end
128
138
 
129
- # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#update_endpoint EndpointService.UpdateEndpoint}.
139
+ # Request message for
140
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#update_endpoint EndpointService.UpdateEndpoint}.
130
141
  # @!attribute [rw] endpoint
131
142
  # @return [::Google::Cloud::AIPlatform::V1::Endpoint]
132
143
  # Required. The Endpoint which replaces the resource on the server.
133
144
  # @!attribute [rw] update_mask
134
145
  # @return [::Google::Protobuf::FieldMask]
135
- # Required. The update mask applies to the resource. See {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
146
+ # Required. The update mask applies to the resource. See
147
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
136
148
  class UpdateEndpointRequest
137
149
  include ::Google::Protobuf::MessageExts
138
150
  extend ::Google::Protobuf::MessageExts::ClassMethods
139
151
  end
140
152
 
141
- # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#delete_endpoint EndpointService.DeleteEndpoint}.
153
+ # Request message for
154
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#delete_endpoint EndpointService.DeleteEndpoint}.
142
155
  # @!attribute [rw] name
143
156
  # @return [::String]
144
157
  # Required. The name of the Endpoint resource to be deleted.
@@ -149,7 +162,8 @@ module Google
149
162
  extend ::Google::Protobuf::MessageExts::ClassMethods
150
163
  end
151
164
 
152
- # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
165
+ # Request message for
166
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
153
167
  # @!attribute [rw] endpoint
154
168
  # @return [::String]
155
169
  # Required. The name of the Endpoint resource into which to deploy a Model.
@@ -158,8 +172,9 @@ module Google
158
172
  # @!attribute [rw] deployed_model
159
173
  # @return [::Google::Cloud::AIPlatform::V1::DeployedModel]
160
174
  # Required. The DeployedModel to be created within the Endpoint. Note that
161
- # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split Endpoint.traffic_split} must be updated for the DeployedModel to start
162
- # receiving traffic, either as part of this call, or via
175
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split Endpoint.traffic_split}
176
+ # must be updated for the DeployedModel to start receiving traffic, either as
177
+ # part of this call, or via
163
178
  # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#update_endpoint EndpointService.UpdateEndpoint}.
164
179
  # @!attribute [rw] traffic_split
165
180
  # @return [::Google::Protobuf::Map{::String => ::Integer}]
@@ -167,13 +182,15 @@ module Google
167
182
  # traffic that should be forwarded to that DeployedModel.
168
183
  #
169
184
  # If this field is non-empty, then the Endpoint's
170
- # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be overwritten with it.
171
- # To refer to the ID of the just being deployed Model, a "0" should be used,
172
- # and the actual ID of the new DeployedModel will be filled in its place by
173
- # this method. The traffic percentage values must add up to 100.
185
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be
186
+ # overwritten with it. To refer to the ID of the just being deployed Model, a
187
+ # "0" should be used, and the actual ID of the new DeployedModel will be
188
+ # filled in its place by this method. The traffic percentage values must add
189
+ # up to 100.
174
190
  #
175
191
  # If this field is empty, then the Endpoint's
176
- # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} is not updated.
192
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} is not
193
+ # updated.
177
194
  class DeployModelRequest
178
195
  include ::Google::Protobuf::MessageExts
179
196
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -188,7 +205,8 @@ module Google
188
205
  end
189
206
  end
190
207
 
191
- # Response message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
208
+ # Response message for
209
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
192
210
  # @!attribute [rw] deployed_model
193
211
  # @return [::Google::Cloud::AIPlatform::V1::DeployedModel]
194
212
  # The DeployedModel that had been deployed in the Endpoint.
@@ -197,7 +215,8 @@ module Google
197
215
  extend ::Google::Protobuf::MessageExts::ClassMethods
198
216
  end
199
217
 
200
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
218
+ # Runtime operation information for
219
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
201
220
  # @!attribute [rw] generic_metadata
202
221
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
203
222
  # The operation generic information.
@@ -206,7 +225,8 @@ module Google
206
225
  extend ::Google::Protobuf::MessageExts::ClassMethods
207
226
  end
208
227
 
209
- # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
228
+ # Request message for
229
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
210
230
  # @!attribute [rw] endpoint
211
231
  # @return [::String]
212
232
  # Required. The name of the Endpoint resource from which to undeploy a Model.
@@ -218,12 +238,12 @@ module Google
218
238
  # @!attribute [rw] traffic_split
219
239
  # @return [::Google::Protobuf::Map{::String => ::Integer}]
220
240
  # If this field is provided, then the Endpoint's
221
- # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be overwritten with it. If
222
- # last DeployedModel is being undeployed from the Endpoint, the
223
- # [Endpoint.traffic_split] will always end up empty when this call returns.
224
- # A DeployedModel will be successfully undeployed only if it doesn't have
225
- # any traffic assigned to it when this method executes, or if this field
226
- # unassigns any traffic to it.
241
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be
242
+ # overwritten with it. If last DeployedModel is being undeployed from the
243
+ # Endpoint, the [Endpoint.traffic_split] will always end up empty when this
244
+ # call returns. A DeployedModel will be successfully undeployed only if it
245
+ # doesn't have any traffic assigned to it when this method executes, or if
246
+ # this field unassigns any traffic to it.
227
247
  class UndeployModelRequest
228
248
  include ::Google::Protobuf::MessageExts
229
249
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -238,13 +258,15 @@ module Google
238
258
  end
239
259
  end
240
260
 
241
- # Response message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
261
+ # Response message for
262
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
242
263
  class UndeployModelResponse
243
264
  include ::Google::Protobuf::MessageExts
244
265
  extend ::Google::Protobuf::MessageExts::ClassMethods
245
266
  end
246
267
 
247
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
268
+ # Runtime operation information for
269
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
248
270
  # @!attribute [rw] generic_metadata
249
271
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
250
272
  # The operation generic information.
@@ -45,7 +45,8 @@ module Google
45
45
  # Output only. Timestamp when this EntityType was most recently updated.
46
46
  # @!attribute [rw] labels
47
47
  # @return [::Google::Protobuf::Map{::String => ::String}]
48
- # Optional. The labels with user-defined metadata to organize your EntityTypes.
48
+ # Optional. The labels with user-defined metadata to organize your
49
+ # EntityTypes.
49
50
  #
50
51
  # Label keys and values can be no longer than 64 characters
51
52
  # (Unicode codepoints), can only contain lowercase letters, numeric
@@ -58,13 +59,14 @@ module Google
58
59
  # and are immutable.
59
60
  # @!attribute [rw] etag
60
61
  # @return [::String]
61
- # Optional. Used to perform a consistent read-modify-write updates. If not set, a blind
62
- # "overwrite" update happens.
62
+ # Optional. Used to perform a consistent read-modify-write updates. If not
63
+ # set, a blind "overwrite" update happens.
63
64
  # @!attribute [rw] monitoring_config
64
65
  # @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig]
65
- # Optional. The default monitoring configuration for all Features with value type
66
- # ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL, STRING, DOUBLE or INT64 under this
67
- # EntityType.
66
+ # Optional. The default monitoring configuration for all Features with value
67
+ # type
68
+ # ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL,
69
+ # STRING, DOUBLE or INT64 under this EntityType.
68
70
  #
69
71
  # If this is populated with
70
72
  # [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
@@ -21,8 +21,10 @@ module Google
21
21
  module Cloud
22
22
  module AIPlatform
23
23
  module V1
24
- # Explanation of a prediction (provided in {::Google::Cloud::AIPlatform::V1::PredictResponse#predictions PredictResponse.predictions})
25
- # produced by the Model on a given {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}.
24
+ # Explanation of a prediction (provided in
25
+ # {::Google::Cloud::AIPlatform::V1::PredictResponse#predictions PredictResponse.predictions})
26
+ # produced by the Model on a given
27
+ # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}.
26
28
  # @!attribute [r] attributions
27
29
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Attribution>]
28
30
  # Output only. Feature attributions grouped by predicted outputs.
@@ -31,14 +33,19 @@ module Google
31
33
  # predict only one score, there is only one attibution that explains the
32
34
  # predicted output. For Models that predict multiple outputs, such as
33
35
  # multiclass Models that predict multiple classes, each element explains one
34
- # specific item. {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} can be used to identify which
35
- # output this attribution is explaining.
36
- #
37
- # If users set {::Google::Cloud::AIPlatform::V1::ExplanationParameters#top_k ExplanationParameters.top_k}, the attributions are sorted
38
- # by [instance_output_value][Attributions.instance_output_value] in
39
- # descending order. If {::Google::Cloud::AIPlatform::V1::ExplanationParameters#output_indices ExplanationParameters.output_indices} is specified,
40
- # the attributions are stored by {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} in the same
41
- # order as they appear in the output_indices.
36
+ # specific item.
37
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}
38
+ # can be used to identify which output this attribution is explaining.
39
+ #
40
+ # If users set
41
+ # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#top_k ExplanationParameters.top_k},
42
+ # the attributions are sorted by
43
+ # [instance_output_value][Attributions.instance_output_value] in descending
44
+ # order. If
45
+ # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#output_indices ExplanationParameters.output_indices}
46
+ # is specified, the attributions are stored by
47
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}
48
+ # in the same order as they appear in the output_indices.
42
49
  # @!attribute [r] neighbors
43
50
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Neighbor>]
44
51
  # Output only. List of the nearest neighbors for example-based explanations.
@@ -53,24 +60,28 @@ module Google
53
60
  # Aggregated explanation metrics for a Model over a set of instances.
54
61
  # @!attribute [r] mean_attributions
55
62
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Attribution>]
56
- # Output only. Aggregated attributions explaining the Model's prediction outputs over the
57
- # set of instances. The attributions are grouped by outputs.
63
+ # Output only. Aggregated attributions explaining the Model's prediction
64
+ # outputs over the set of instances. The attributions are grouped by outputs.
58
65
  #
59
66
  # For Models that predict only one output, such as regression Models that
60
67
  # predict only one score, there is only one attibution that explains the
61
68
  # predicted output. For Models that predict multiple outputs, such as
62
69
  # multiclass Models that predict multiple classes, each element explains one
63
- # specific item. {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} can be used to identify which
64
- # output this attribution is explaining.
70
+ # specific item.
71
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}
72
+ # can be used to identify which output this attribution is explaining.
65
73
  #
66
- # The {::Google::Cloud::AIPlatform::V1::Attribution#baseline_output_value baselineOutputValue},
67
- # {::Google::Cloud::AIPlatform::V1::Attribution#instance_output_value instanceOutputValue} and
68
- # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions featureAttributions} fields are
69
- # averaged over the test data.
74
+ # The
75
+ # {::Google::Cloud::AIPlatform::V1::Attribution#baseline_output_value baselineOutputValue},
76
+ # {::Google::Cloud::AIPlatform::V1::Attribution#instance_output_value instanceOutputValue}
77
+ # and
78
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions featureAttributions}
79
+ # fields are averaged over the test data.
70
80
  #
71
81
  # NOTE: Currently AutoML tabular classification Models produce only one
72
82
  # attribution, which averages attributions over all the classes it predicts.
73
- # {::Google::Cloud::AIPlatform::V1::Attribution#approximation_error Attribution.approximation_error} is not populated.
83
+ # {::Google::Cloud::AIPlatform::V1::Attribution#approximation_error Attribution.approximation_error}
84
+ # is not populated.
74
85
  class ModelExplanation
75
86
  include ::Google::Protobuf::MessageExts
76
87
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -79,32 +90,39 @@ module Google
79
90
  # Attribution that explains a particular prediction output.
80
91
  # @!attribute [r] baseline_output_value
81
92
  # @return [::Float]
82
- # Output only. Model predicted output if the input instance is constructed from the
83
- # baselines of all the features defined in {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs ExplanationMetadata.inputs}.
93
+ # Output only. Model predicted output if the input instance is constructed
94
+ # from the baselines of all the features defined in
95
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs ExplanationMetadata.inputs}.
84
96
  # The field name of the output is determined by the key in
85
97
  # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#outputs ExplanationMetadata.outputs}.
86
98
  #
87
99
  # If the Model's predicted output has multiple dimensions (rank > 1), this is
88
- # the value in the output located by {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
100
+ # the value in the output located by
101
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
89
102
  #
90
103
  # If there are multiple baselines, their output values are averaged.
91
104
  # @!attribute [r] instance_output_value
92
105
  # @return [::Float]
93
106
  # Output only. Model predicted output on the corresponding [explanation
94
107
  # instance][ExplainRequest.instances]. The field name of the output is
95
- # determined by the key in {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#outputs ExplanationMetadata.outputs}.
108
+ # determined by the key in
109
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#outputs ExplanationMetadata.outputs}.
96
110
  #
97
111
  # If the Model predicted output has multiple dimensions, this is the value in
98
- # the output located by {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
112
+ # the output located by
113
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
99
114
  # @!attribute [r] feature_attributions
100
115
  # @return [::Google::Protobuf::Value]
101
- # Output only. Attributions of each explained feature. Features are extracted from
102
- # the {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances prediction instances} according to
103
- # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs explanation metadata for inputs}.
116
+ # Output only. Attributions of each explained feature. Features are extracted
117
+ # from the [prediction
118
+ # instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
119
+ # to [explanation metadata for
120
+ # inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
104
121
  #
105
122
  # The value is a struct, whose keys are the name of the feature. The values
106
- # are how much the feature in the {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}
107
- # contributed to the predicted result.
123
+ # are how much the feature in the
124
+ # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance} contributed
125
+ # to the predicted result.
108
126
  #
109
127
  # The format of the value is determined by the feature's input format:
110
128
  #
@@ -120,10 +138,13 @@ module Google
120
138
  # struct. The formats of the values in the attribution struct are
121
139
  # determined by the formats of the values in the feature struct.
122
140
  #
123
- # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#feature_attributions_schema_uri ExplanationMetadata.feature_attributions_schema_uri} field,
124
- # pointed to by the {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} field of the
125
- # {::Google::Cloud::AIPlatform::V1::Endpoint#deployed_models Endpoint.deployed_models} object, points to the schema file that
126
- # describes the features and their attribution values (if it is populated).
141
+ # The
142
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#feature_attributions_schema_uri ExplanationMetadata.feature_attributions_schema_uri}
143
+ # field, pointed to by the
144
+ # {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} field of the
145
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#deployed_models Endpoint.deployed_models}
146
+ # object, points to the schema file that describes the features and their
147
+ # attribution values (if it is populated).
127
148
  # @!attribute [r] output_index
128
149
  # @return [::Array<::Integer>]
129
150
  # Output only. The index that locates the explained prediction output.
@@ -135,8 +156,9 @@ module Google
135
156
  # of the output vector. Indices start from 0.
136
157
  # @!attribute [r] output_display_name
137
158
  # @return [::String]
138
- # Output only. The display name of the output identified by {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}. For example,
139
- # the predicted class name by a multi-classification Model.
159
+ # Output only. The display name of the output identified by
160
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}. For
161
+ # example, the predicted class name by a multi-classification Model.
140
162
  #
141
163
  # This field is only populated iff the Model predicts display names as a
142
164
  # separate field along with the explained output. The predicted display name
@@ -144,20 +166,26 @@ module Google
144
166
  # output_index.
145
167
  # @!attribute [r] approximation_error
146
168
  # @return [::Float]
147
- # Output only. Error of {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions feature_attributions} caused by approximation used in the
148
- # explanation method. Lower value means more precise attributions.
169
+ # Output only. Error of
170
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions feature_attributions}
171
+ # caused by approximation used in the explanation method. Lower value means
172
+ # more precise attributions.
149
173
  #
150
174
  # * For Sampled Shapley
151
175
  # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#sampled_shapley_attribution attribution},
152
- # increasing {::Google::Cloud::AIPlatform::V1::SampledShapleyAttribution#path_count path_count} might reduce
153
- # the error.
176
+ # increasing
177
+ # {::Google::Cloud::AIPlatform::V1::SampledShapleyAttribution#path_count path_count}
178
+ # might reduce the error.
154
179
  # * For Integrated Gradients
155
180
  # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution attribution},
156
- # increasing {::Google::Cloud::AIPlatform::V1::IntegratedGradientsAttribution#step_count step_count} might
157
- # reduce the error.
158
- # * For {::Google::Cloud::AIPlatform::V1::ExplanationParameters#xrai_attribution XRAI attribution},
159
181
  # increasing
160
- # {::Google::Cloud::AIPlatform::V1::XraiAttribution#step_count step_count} might reduce the error.
182
+ # {::Google::Cloud::AIPlatform::V1::IntegratedGradientsAttribution#step_count step_count}
183
+ # might reduce the error.
184
+ # * For [XRAI
185
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
186
+ # increasing
187
+ # {::Google::Cloud::AIPlatform::V1::XraiAttribution#step_count step_count} might
188
+ # reduce the error.
161
189
  #
162
190
  # See [this introduction](/vertex-ai/docs/explainable-ai/overview)
163
191
  # for more information.
@@ -226,13 +254,14 @@ module Google
226
254
  # @!attribute [rw] output_indices
227
255
  # @return [::Google::Protobuf::ListValue]
228
256
  # If populated, only returns attributions that have
229
- # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index} contained in output_indices. It
230
- # must be an ndarray of integers, with the same shape of the output it's
231
- # explaining.
257
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}
258
+ # contained in output_indices. It must be an ndarray of integers, with the
259
+ # same shape of the output it's explaining.
232
260
  #
233
- # If not populated, returns attributions for {::Google::Cloud::AIPlatform::V1::ExplanationParameters#top_k top_k} indices of outputs.
234
- # If neither top_k nor output_indices is populated, returns the argmax
235
- # index of the outputs.
261
+ # If not populated, returns attributions for
262
+ # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#top_k top_k} indices of
263
+ # outputs. If neither top_k nor output_indices is populated, returns the
264
+ # argmax index of the outputs.
236
265
  #
237
266
  # Only applicable to Models that predict multiple outputs (e,g, multi-class
238
267
  # Models that predict multiple classes).
@@ -246,8 +275,8 @@ module Google
246
275
  # approximate the value rather than considering all subsets of features.
247
276
  # @!attribute [rw] path_count
248
277
  # @return [::Integer]
249
- # Required. The number of feature permutations to consider when approximating the
250
- # Shapley values.
278
+ # Required. The number of feature permutations to consider when approximating
279
+ # the Shapley values.
251
280
  #
252
281
  # Valid range of its value is [1, 50], inclusively.
253
282
  class SampledShapleyAttribution
@@ -339,16 +368,18 @@ module Google
339
368
  # paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1.
340
369
  #
341
370
  # If the distribution is different per feature, set
342
- # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#feature_noise_sigma feature_noise_sigma} instead
343
- # for each feature.
371
+ # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#feature_noise_sigma feature_noise_sigma}
372
+ # instead for each feature.
344
373
  # @!attribute [rw] feature_noise_sigma
345
374
  # @return [::Google::Cloud::AIPlatform::V1::FeatureNoiseSigma]
346
- # This is similar to {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma}, but
347
- # provides additional flexibility. A separate noise sigma can be provided
348
- # for each feature, which is useful if their distributions are different.
349
- # No noise is added to features that are not set. If this field is unset,
350
- # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma} will be used for all
351
- # features.
375
+ # This is similar to
376
+ # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma},
377
+ # but provides additional flexibility. A separate noise sigma can be
378
+ # provided for each feature, which is useful if their distributions are
379
+ # different. No noise is added to features that are not set. If this field
380
+ # is unset,
381
+ # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma}
382
+ # will be used for all features.
352
383
  # @!attribute [rw] noisy_sample_count
353
384
  # @return [::Integer]
354
385
  # The number of gradient samples to use for
@@ -375,13 +406,14 @@ module Google
375
406
  # @return [::String]
376
407
  # The name of the input feature for which noise sigma is provided. The
377
408
  # features are defined in
378
- # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs explanation metadata inputs}.
409
+ # [explanation metadata
410
+ # inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
379
411
  # @!attribute [rw] sigma
380
412
  # @return [::Float]
381
413
  # This represents the standard deviation of the Gaussian kernel that will
382
414
  # be used to add noise to the feature prior to computing gradients. Similar
383
- # to {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma} but represents the
384
- # noise added to the current feature. Defaults to 0.1.
415
+ # to {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma}
416
+ # but represents the noise added to the current feature. Defaults to 0.1.
385
417
  class NoiseSigmaForFeature
386
418
  include ::Google::Protobuf::MessageExts
387
419
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -405,13 +437,14 @@ module Google
405
437
  extend ::Google::Protobuf::MessageExts::ClassMethods
406
438
  end
407
439
 
408
- # The {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} entries that can be overridden at
409
- # {::Google::Cloud::AIPlatform::V1::PredictionService::Client#explain online explanation} time.
440
+ # The {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} entries
441
+ # that can be overridden at [online
442
+ # explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
410
443
  # @!attribute [rw] parameters
411
444
  # @return [::Google::Cloud::AIPlatform::V1::ExplanationParameters]
412
445
  # The parameters to be overridden. Note that the
413
- # [method][google.cloud.aiplatform.v1.ExplanationParameters.method] cannot be changed. If not specified,
414
- # no parameter is overridden.
446
+ # [method][google.cloud.aiplatform.v1.ExplanationParameters.method] cannot be
447
+ # changed. If not specified, no parameter is overridden.
415
448
  # @!attribute [rw] metadata
416
449
  # @return [::Google::Cloud::AIPlatform::V1::ExplanationMetadataOverride]
417
450
  # The metadata to be overridden. If not specified, no metadata is overridden.
@@ -423,21 +456,24 @@ module Google
423
456
  extend ::Google::Protobuf::MessageExts::ClassMethods
424
457
  end
425
458
 
426
- # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata ExplanationMetadata} entries that can be overridden at
427
- # {::Google::Cloud::AIPlatform::V1::PredictionService::Client#explain online explanation} time.
459
+ # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata ExplanationMetadata}
460
+ # entries that can be overridden at [online
461
+ # explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
428
462
  # @!attribute [rw] inputs
429
463
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::ExplanationMetadataOverride::InputMetadataOverride}]
430
- # Required. Overrides the {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs input metadata} of the features.
431
- # The key is the name of the feature to be overridden. The keys specified
432
- # here must exist in the input metadata to be overridden. If a feature is
433
- # not specified here, the corresponding feature's input metadata is not
434
- # overridden.
464
+ # Required. Overrides the [input
465
+ # metadata][google.cloud.aiplatform.v1.ExplanationMetadata.inputs] of the
466
+ # features. The key is the name of the feature to be overridden. The keys
467
+ # specified here must exist in the input metadata to be overridden. If a
468
+ # feature is not specified here, the corresponding feature's input metadata
469
+ # is not overridden.
435
470
  class ExplanationMetadataOverride
436
471
  include ::Google::Protobuf::MessageExts
437
472
  extend ::Google::Protobuf::MessageExts::ClassMethods
438
473
 
439
- # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata input metadata} entries to be
440
- # overridden.
474
+ # The [input
475
+ # metadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata]
476
+ # entries to be overridden.
441
477
  # @!attribute [rw] input_baselines
442
478
  # @return [::Array<::Google::Protobuf::Value>]
443
479
  # Baseline inputs for this feature.