google-cloud-ai_platform-v1 0.5.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +28 -0
  3. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +28 -0
  4. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +28 -0
  5. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +29 -0
  6. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +28 -0
  7. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +28 -0
  8. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +28 -0
  9. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +28 -0
  10. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +28 -0
  11. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +384 -1
  12. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +28 -0
  13. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +28 -0
  14. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +28 -0
  15. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +28 -0
  16. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  17. data/lib/google/cloud/ai_platform/v1/vizier_service/client.rb +28 -0
  18. data/lib/google/cloud/aiplatform/v1/completion_stats_pb.rb +1 -0
  19. data/lib/google/cloud/aiplatform/v1/explanation_pb.rb +27 -0
  20. data/lib/google/cloud/aiplatform/v1/model_deployment_monitoring_job_pb.rb +1 -0
  21. data/lib/google/cloud/aiplatform/v1/model_pb.rb +5 -0
  22. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +24 -0
  23. data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +10 -0
  24. data/lib/google/cloud/aiplatform/v1/training_pipeline_pb.rb +2 -0
  25. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +3 -0
  26. data/proto_docs/google/cloud/aiplatform/v1/completion_stats.rb +4 -0
  27. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +3 -0
  28. data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +69 -0
  29. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +0 -1
  30. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +1 -0
  31. data/proto_docs/google/cloud/aiplatform/v1/model.rb +26 -0
  32. data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +10 -0
  33. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +109 -0
  34. data/proto_docs/google/cloud/aiplatform/v1/pipeline_failure_policy.rb +1 -1
  35. data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +11 -0
  36. data/proto_docs/google/type/expr.rb +75 -0
  37. metadata +43 -2
@@ -18,6 +18,8 @@
18
18
 
19
19
  require "google/cloud/errors"
20
20
  require "google/cloud/aiplatform/v1/vizier_service_pb"
21
+ require "google/cloud/location"
22
+ require "google/iam/v1/iam_policy"
21
23
 
22
24
  module Google
23
25
  module Cloud
@@ -143,6 +145,18 @@ module Google
143
145
  config.endpoint = @config.endpoint
144
146
  end
145
147
 
148
+ @location_client = Google::Cloud::Location::Locations::Client.new do |config|
149
+ config.credentials = credentials
150
+ config.quota_project = @quota_project_id
151
+ config.endpoint = @config.endpoint
152
+ end
153
+
154
+ @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
155
+ config.credentials = credentials
156
+ config.quota_project = @quota_project_id
157
+ config.endpoint = @config.endpoint
158
+ end
159
+
146
160
  @vizier_service_stub = ::Gapic::ServiceStub.new(
147
161
  ::Google::Cloud::AIPlatform::V1::VizierService::Stub,
148
162
  credentials: credentials,
@@ -159,6 +173,20 @@ module Google
159
173
  #
160
174
  attr_reader :operations_client
161
175
 
176
+ ##
177
+ # Get the associated client for mix-in of the Locations.
178
+ #
179
+ # @return [Google::Cloud::Location::Locations::Client]
180
+ #
181
+ attr_reader :location_client
182
+
183
+ ##
184
+ # Get the associated client for mix-in of the IAMPolicy.
185
+ #
186
+ # @return [Google::Iam::V1::IAMPolicy::Client]
187
+ #
188
+ attr_reader :iam_policy_client
189
+
162
190
  # Service calls
163
191
 
164
192
  ##
@@ -11,6 +11,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
11
11
  optional :successful_count, :int64, 1
12
12
  optional :failed_count, :int64, 2
13
13
  optional :incomplete_count, :int64, 3
14
+ optional :successful_forecast_point_count, :int64, 5
14
15
  end
15
16
  end
16
17
  end
@@ -11,6 +11,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
11
11
  add_file("google/cloud/aiplatform/v1/explanation.proto", :syntax => :proto3) do
12
12
  add_message "google.cloud.aiplatform.v1.Explanation" do
13
13
  repeated :attributions, :message, 1, "google.cloud.aiplatform.v1.Attribution"
14
+ repeated :neighbors, :message, 2, "google.cloud.aiplatform.v1.Neighbor"
14
15
  end
15
16
  add_message "google.cloud.aiplatform.v1.ModelExplanation" do
16
17
  repeated :mean_attributions, :message, 1, "google.cloud.aiplatform.v1.Attribution"
@@ -24,6 +25,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
24
25
  optional :approximation_error, :double, 6
25
26
  optional :output_name, :string, 7
26
27
  end
28
+ add_message "google.cloud.aiplatform.v1.Neighbor" do
29
+ optional :neighbor_id, :string, 1
30
+ optional :neighbor_distance, :double, 2
31
+ end
27
32
  add_message "google.cloud.aiplatform.v1.ExplanationSpec" do
28
33
  optional :parameters, :message, 1, "google.cloud.aiplatform.v1.ExplanationParameters"
29
34
  optional :metadata, :message, 2, "google.cloud.aiplatform.v1.ExplanationMetadata"
@@ -70,6 +75,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
70
75
  add_message "google.cloud.aiplatform.v1.ExplanationSpecOverride" do
71
76
  optional :parameters, :message, 1, "google.cloud.aiplatform.v1.ExplanationParameters"
72
77
  optional :metadata, :message, 2, "google.cloud.aiplatform.v1.ExplanationMetadataOverride"
78
+ optional :examples_override, :message, 3, "google.cloud.aiplatform.v1.ExamplesOverride"
73
79
  end
74
80
  add_message "google.cloud.aiplatform.v1.ExplanationMetadataOverride" do
75
81
  map :inputs, :string, :message, 1, "google.cloud.aiplatform.v1.ExplanationMetadataOverride.InputMetadataOverride"
@@ -77,6 +83,23 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
77
83
  add_message "google.cloud.aiplatform.v1.ExplanationMetadataOverride.InputMetadataOverride" do
78
84
  repeated :input_baselines, :message, 1, "google.protobuf.Value"
79
85
  end
86
+ add_message "google.cloud.aiplatform.v1.ExamplesOverride" do
87
+ optional :neighbor_count, :int32, 1
88
+ optional :crowding_count, :int32, 2
89
+ repeated :restrictions, :message, 3, "google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace"
90
+ optional :return_embeddings, :bool, 4
91
+ optional :data_format, :enum, 5, "google.cloud.aiplatform.v1.ExamplesOverride.DataFormat"
92
+ end
93
+ add_enum "google.cloud.aiplatform.v1.ExamplesOverride.DataFormat" do
94
+ value :DATA_FORMAT_UNSPECIFIED, 0
95
+ value :INSTANCES, 1
96
+ value :EMBEDDINGS, 2
97
+ end
98
+ add_message "google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace" do
99
+ optional :namespace_name, :string, 1
100
+ repeated :allow, :string, 2
101
+ repeated :deny, :string, 3
102
+ end
80
103
  end
81
104
  end
82
105
 
@@ -87,6 +110,7 @@ module Google
87
110
  Explanation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.Explanation").msgclass
88
111
  ModelExplanation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ModelExplanation").msgclass
89
112
  Attribution = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.Attribution").msgclass
113
+ Neighbor = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.Neighbor").msgclass
90
114
  ExplanationSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExplanationSpec").msgclass
91
115
  ExplanationParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExplanationParameters").msgclass
92
116
  SampledShapleyAttribution = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.SampledShapleyAttribution").msgclass
@@ -99,6 +123,9 @@ module Google
99
123
  ExplanationSpecOverride = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExplanationSpecOverride").msgclass
100
124
  ExplanationMetadataOverride = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExplanationMetadataOverride").msgclass
101
125
  ExplanationMetadataOverride::InputMetadataOverride = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExplanationMetadataOverride.InputMetadataOverride").msgclass
126
+ ExamplesOverride = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExamplesOverride").msgclass
127
+ ExamplesOverride::DataFormat = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExamplesOverride.DataFormat").enummodule
128
+ ExamplesRestrictionsNamespace = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace").msgclass
102
129
  end
103
130
  end
104
131
  end
@@ -73,6 +73,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
73
73
  end
74
74
  add_message "google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig" do
75
75
  optional :monitor_interval, :message, 1, "google.protobuf.Duration"
76
+ optional :monitor_window, :message, 2, "google.protobuf.Duration"
76
77
  end
77
78
  add_message "google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies" do
78
79
  optional :objective, :enum, 1, "google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType"
@@ -16,8 +16,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
16
16
  add_file("google/cloud/aiplatform/v1/model.proto", :syntax => :proto3) do
17
17
  add_message "google.cloud.aiplatform.v1.Model" do
18
18
  optional :name, :string, 1
19
+ optional :version_id, :string, 28
20
+ repeated :version_aliases, :string, 29
21
+ optional :version_create_time, :message, 31, "google.protobuf.Timestamp"
22
+ optional :version_update_time, :message, 32, "google.protobuf.Timestamp"
19
23
  optional :display_name, :string, 2
20
24
  optional :description, :string, 3
25
+ optional :version_description, :string, 30
21
26
  optional :predict_schemata, :message, 4, "google.cloud.aiplatform.v1.PredictSchemata"
22
27
  optional :metadata_schema_uri, :string, 5
23
28
  optional :metadata, :message, 6, "google.protobuf.Value"
@@ -19,6 +19,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
19
19
  add_file("google/cloud/aiplatform/v1/model_service.proto", :syntax => :proto3) do
20
20
  add_message "google.cloud.aiplatform.v1.UploadModelRequest" do
21
21
  optional :parent, :string, 1
22
+ optional :parent_model, :string, 4
23
+ optional :model_id, :string, 5
22
24
  optional :model, :message, 2, "google.cloud.aiplatform.v1.Model"
23
25
  end
24
26
  add_message "google.cloud.aiplatform.v1.UploadModelOperationMetadata" do
@@ -42,6 +44,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
42
44
  repeated :models, :message, 1, "google.cloud.aiplatform.v1.Model"
43
45
  optional :next_page_token, :string, 2
44
46
  end
47
+ add_message "google.cloud.aiplatform.v1.ListModelVersionsRequest" do
48
+ optional :name, :string, 1
49
+ optional :page_size, :int32, 2
50
+ optional :page_token, :string, 3
51
+ optional :filter, :string, 4
52
+ optional :read_mask, :message, 5, "google.protobuf.FieldMask"
53
+ end
54
+ add_message "google.cloud.aiplatform.v1.ListModelVersionsResponse" do
55
+ repeated :models, :message, 1, "google.cloud.aiplatform.v1.Model"
56
+ optional :next_page_token, :string, 2
57
+ end
45
58
  add_message "google.cloud.aiplatform.v1.UpdateModelRequest" do
46
59
  optional :model, :message, 1, "google.cloud.aiplatform.v1.Model"
47
60
  optional :update_mask, :message, 2, "google.protobuf.FieldMask"
@@ -49,6 +62,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
49
62
  add_message "google.cloud.aiplatform.v1.DeleteModelRequest" do
50
63
  optional :name, :string, 1
51
64
  end
65
+ add_message "google.cloud.aiplatform.v1.DeleteModelVersionRequest" do
66
+ optional :name, :string, 1
67
+ end
68
+ add_message "google.cloud.aiplatform.v1.MergeVersionAliasesRequest" do
69
+ optional :name, :string, 1
70
+ repeated :version_aliases, :string, 2
71
+ end
52
72
  add_message "google.cloud.aiplatform.v1.ExportModelRequest" do
53
73
  optional :name, :string, 1
54
74
  optional :output_config, :message, 2, "google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig"
@@ -113,8 +133,12 @@ module Google
113
133
  GetModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.GetModelRequest").msgclass
114
134
  ListModelsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ListModelsRequest").msgclass
115
135
  ListModelsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ListModelsResponse").msgclass
136
+ ListModelVersionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ListModelVersionsRequest").msgclass
137
+ ListModelVersionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ListModelVersionsResponse").msgclass
116
138
  UpdateModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.UpdateModelRequest").msgclass
117
139
  DeleteModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.DeleteModelRequest").msgclass
140
+ DeleteModelVersionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.DeleteModelVersionRequest").msgclass
141
+ MergeVersionAliasesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.MergeVersionAliasesRequest").msgclass
118
142
  ExportModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExportModelRequest").msgclass
119
143
  ExportModelRequest::OutputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig").msgclass
120
144
  ExportModelOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExportModelOperationMetadata").msgclass
@@ -39,6 +39,8 @@ module Google
39
39
  rpc :GetModel, ::Google::Cloud::AIPlatform::V1::GetModelRequest, ::Google::Cloud::AIPlatform::V1::Model
40
40
  # Lists Models in a Location.
41
41
  rpc :ListModels, ::Google::Cloud::AIPlatform::V1::ListModelsRequest, ::Google::Cloud::AIPlatform::V1::ListModelsResponse
42
+ # Lists versions of the specified model.
43
+ rpc :ListModelVersions, ::Google::Cloud::AIPlatform::V1::ListModelVersionsRequest, ::Google::Cloud::AIPlatform::V1::ListModelVersionsResponse
42
44
  # Updates a Model.
43
45
  rpc :UpdateModel, ::Google::Cloud::AIPlatform::V1::UpdateModelRequest, ::Google::Cloud::AIPlatform::V1::Model
44
46
  # Deletes a Model.
@@ -47,6 +49,14 @@ module Google
47
49
  # [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its
48
50
  # [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
49
51
  rpc :DeleteModel, ::Google::Cloud::AIPlatform::V1::DeleteModelRequest, ::Google::Longrunning::Operation
52
+ # Deletes a Model version.
53
+ #
54
+ # Model version can only be deleted if there are no [DeployedModels][]
55
+ # created from it. Deleting the only version in the Model is not allowed. Use
56
+ # [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
57
+ rpc :DeleteModelVersion, ::Google::Cloud::AIPlatform::V1::DeleteModelVersionRequest, ::Google::Longrunning::Operation
58
+ # Merges a set of aliases for a Model version.
59
+ rpc :MergeVersionAliases, ::Google::Cloud::AIPlatform::V1::MergeVersionAliasesRequest, ::Google::Cloud::AIPlatform::V1::Model
50
60
  # Exports a trained, exportable Model to a location specified by the
51
61
  # user. A Model is considered to be exportable if it has at least one
52
62
  # [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].
@@ -23,6 +23,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
23
23
  optional :training_task_inputs, :message, 5, "google.protobuf.Value"
24
24
  optional :training_task_metadata, :message, 6, "google.protobuf.Value"
25
25
  optional :model_to_upload, :message, 7, "google.cloud.aiplatform.v1.Model"
26
+ optional :model_id, :string, 22
27
+ optional :parent_model, :string, 21
26
28
  optional :state, :enum, 9, "google.cloud.aiplatform.v1.PipelineState"
27
29
  optional :error, :message, 10, "google.rpc.Status"
28
30
  optional :create_time, :message, 11, "google.protobuf.Timestamp"
@@ -38,6 +38,9 @@ module Google
38
38
  # Starting this job has no impact on any existing deployments of the Model
39
39
  # and their resources.
40
40
  # Exactly one of model and unmanaged_container_model must be set.
41
+ #
42
+ # The model resource name may contain version id or version alias to specify
43
+ # the version, if no version is specified, the default version will be used.
41
44
  # @!attribute [rw] unmanaged_container_model
42
45
  # @return [::Google::Cloud::AIPlatform::V1::UnmanagedContainerModel]
43
46
  # Contains model information necessary to perform batch prediction without
@@ -36,6 +36,10 @@ module Google
36
36
  # processing had not been finished (either in successful or failed state).
37
37
  # Set to -1 if the number is unknown (for example, the operation failed
38
38
  # before the total entity number could be collected).
39
+ # @!attribute [r] successful_forecast_point_count
40
+ # @return [::Integer]
41
+ # Output only. The number of the successful forecast points that are generated by the
42
+ # forecasting model. This is ONLY used by the forecasting batch prediction.
39
43
  class CompletionStats
40
44
  include ::Google::Protobuf::MessageExts
41
45
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -148,6 +148,9 @@ module Google
148
148
  # @return [::String]
149
149
  # Required. The resource name of the Model that this is the deployment of. Note that
150
150
  # the Model may be in a different location than the DeployedModel's Endpoint.
151
+ #
152
+ # The resource name may contain version id or version alias to specify the
153
+ # version, if no version is specified, the default version will be deployed.
151
154
  # @!attribute [rw] display_name
152
155
  # @return [::String]
153
156
  # The display name of the DeployedModel. If not provided upon creation,
@@ -39,6 +39,12 @@ module Google
39
39
  # descending order. If {::Google::Cloud::AIPlatform::V1::ExplanationParameters#output_indices ExplanationParameters.output_indices} is specified,
40
40
  # the attributions are stored by {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} in the same
41
41
  # order as they appear in the output_indices.
42
+ # @!attribute [r] neighbors
43
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::Neighbor>]
44
+ # Output only. List of the nearest neighbors for example-based explanations.
45
+ #
46
+ # For models deployed with the examples explanations feature enabled, the
47
+ # attributions field is empty and instead the neighbors field is populated.
42
48
  class Explanation
43
49
  include ::Google::Protobuf::MessageExts
44
50
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -164,6 +170,18 @@ module Google
164
170
  extend ::Google::Protobuf::MessageExts::ClassMethods
165
171
  end
166
172
 
173
+ # Neighbors for example-based explanations.
174
+ # @!attribute [r] neighbor_id
175
+ # @return [::String]
176
+ # Output only. The neighbor id.
177
+ # @!attribute [r] neighbor_distance
178
+ # @return [::Float]
179
+ # Output only. The neighbor distance.
180
+ class Neighbor
181
+ include ::Google::Protobuf::MessageExts
182
+ extend ::Google::Protobuf::MessageExts::ClassMethods
183
+ end
184
+
167
185
  # Specification of Model explanation.
168
186
  # @!attribute [rw] parameters
169
187
  # @return [::Google::Cloud::AIPlatform::V1::ExplanationParameters]
@@ -397,6 +415,9 @@ module Google
397
415
  # @!attribute [rw] metadata
398
416
  # @return [::Google::Cloud::AIPlatform::V1::ExplanationMetadataOverride]
399
417
  # The metadata to be overridden. If not specified, no metadata is overridden.
418
+ # @!attribute [rw] examples_override
419
+ # @return [::Google::Cloud::AIPlatform::V1::ExamplesOverride]
420
+ # The example-based explanations parameter overrides.
400
421
  class ExplanationSpecOverride
401
422
  include ::Google::Protobuf::MessageExts
402
423
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -439,6 +460,54 @@ module Google
439
460
  extend ::Google::Protobuf::MessageExts::ClassMethods
440
461
  end
441
462
  end
463
+
464
+ # Overrides for example-based explanations.
465
+ # @!attribute [rw] neighbor_count
466
+ # @return [::Integer]
467
+ # The number of neighbors to return.
468
+ # @!attribute [rw] crowding_count
469
+ # @return [::Integer]
470
+ # The number of neighbors to return that have the same crowding tag.
471
+ # @!attribute [rw] restrictions
472
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ExamplesRestrictionsNamespace>]
473
+ # Restrict the resulting nearest neighbors to respect these constraints.
474
+ # @!attribute [rw] return_embeddings
475
+ # @return [::Boolean]
476
+ # If true, return the embeddings instead of neighbors.
477
+ # @!attribute [rw] data_format
478
+ # @return [::Google::Cloud::AIPlatform::V1::ExamplesOverride::DataFormat]
479
+ # The format of the data being provided with each call.
480
+ class ExamplesOverride
481
+ include ::Google::Protobuf::MessageExts
482
+ extend ::Google::Protobuf::MessageExts::ClassMethods
483
+
484
+ # Data format enum.
485
+ module DataFormat
486
+ # Unspecified format. Must not be used.
487
+ DATA_FORMAT_UNSPECIFIED = 0
488
+
489
+ # Provided data is a set of model inputs.
490
+ INSTANCES = 1
491
+
492
+ # Provided data is a set of embeddings.
493
+ EMBEDDINGS = 2
494
+ end
495
+ end
496
+
497
+ # Restrictions namespace for example-based explanations overrides.
498
+ # @!attribute [rw] namespace_name
499
+ # @return [::String]
500
+ # The namespace name.
501
+ # @!attribute [rw] allow
502
+ # @return [::Array<::String>]
503
+ # The list of allowed tags.
504
+ # @!attribute [rw] deny
505
+ # @return [::Array<::String>]
506
+ # The list of deny tags.
507
+ class ExamplesRestrictionsNamespace
508
+ include ::Google::Protobuf::MessageExts
509
+ extend ::Google::Protobuf::MessageExts::ClassMethods
510
+ end
442
511
  end
443
512
  end
444
513
  end
@@ -139,7 +139,6 @@ module Google
139
139
  end
140
140
 
141
141
  # Value for a feature.
142
- # (-- NEXT ID: 15 --)
143
142
  # @!attribute [rw] bool_value
144
143
  # @return [::Boolean]
145
144
  # Bool type feature value.
@@ -147,6 +147,7 @@ module Google
147
147
  #
148
148
  # * `labels`
149
149
  # * `online_serving_config.fixed_node_count`
150
+ # * `online_serving_config.scaling`
150
151
  class UpdateFeaturestoreRequest
151
152
  include ::Google::Protobuf::MessageExts
152
153
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -25,6 +25,29 @@ module Google
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
27
  # The resource name of the Model.
28
+ # @!attribute [r] version_id
29
+ # @return [::String]
30
+ # Output only. Immutable. The version ID of the model.
31
+ # A new version is committed when a new model version is uploaded or
32
+ # trained under an existing model id. It is an auto-incrementing decimal
33
+ # number in string representation.
34
+ # @!attribute [rw] version_aliases
35
+ # @return [::Array<::String>]
36
+ # User provided version aliases so that a model version can be referenced via
37
+ # alias (i.e.
38
+ # projects/\\{project}/locations/\\{location}/models/\\{model_id}@\\{version_alias}
39
+ # instead of auto-generated version id (i.e.
40
+ # projects/\\{project}/locations/\\{location}/models/\\{model_id}@\\{version_id}).
41
+ # The format is [a-z][a-zA-Z0-9-]\\{0,126}[a-z0-9] to distinguish from
42
+ # version_id. A default version alias will be created for the first version
43
+ # of the model, and there must be exactly one default version alias for a
44
+ # model.
45
+ # @!attribute [r] version_create_time
46
+ # @return [::Google::Protobuf::Timestamp]
47
+ # Output only. Timestamp when this version was created.
48
+ # @!attribute [r] version_update_time
49
+ # @return [::Google::Protobuf::Timestamp]
50
+ # Output only. Timestamp when this version was most recently updated.
28
51
  # @!attribute [rw] display_name
29
52
  # @return [::String]
30
53
  # Required. The display name of the Model.
@@ -33,6 +56,9 @@ module Google
33
56
  # @!attribute [rw] description
34
57
  # @return [::String]
35
58
  # The description of the Model.
59
+ # @!attribute [rw] version_description
60
+ # @return [::String]
61
+ # The description of this version.
36
62
  # @!attribute [rw] predict_schemata
37
63
  # @return [::Google::Cloud::AIPlatform::V1::PredictSchemata]
38
64
  # The schemata that describe formats of the Model's predictions and
@@ -240,6 +240,16 @@ module Google
240
240
  # @return [::Google::Protobuf::Duration]
241
241
  # Required. The model monitoring job scheduling interval. It will be rounded up to next
242
242
  # full hour. This defines how often the monitoring jobs are triggered.
243
+ # @!attribute [rw] monitor_window
244
+ # @return [::Google::Protobuf::Duration]
245
+ # The time window of the prediction data being included in each prediction
246
+ # dataset. This window specifies how long the data should be collected from
247
+ # historical model results for each run. If not set,
248
+ # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringScheduleConfig#monitor_interval ModelDeploymentMonitoringScheduleConfig.monitor_interval} will be used.
249
+ # e.g. If currently the cutoff time is 2022-01-08 14:30:00 and the
250
+ # monitor_window is set to be 3600, then data from 2022-01-08 13:30:00
251
+ # to 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the
252
+ # monitoring statistics.
243
253
  class ModelDeploymentMonitoringScheduleConfig
244
254
  include ::Google::Protobuf::MessageExts
245
255
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -26,6 +26,17 @@ module Google
26
26
  # @return [::String]
27
27
  # Required. The resource name of the Location into which to upload the Model.
28
28
  # Format: `projects/{project}/locations/{location}`
29
+ # @!attribute [rw] parent_model
30
+ # @return [::String]
31
+ # Optional. The resource name of the model into which to upload the version. Only
32
+ # specify this field when uploading a new version.
33
+ # @!attribute [rw] model_id
34
+ # @return [::String]
35
+ # Optional. The ID to use for the uploaded Model, which will become the final
36
+ # component of the model resource name.
37
+ #
38
+ # This value may be up to 63 characters, and valid characters are
39
+ # `[a-z0-9_-]`. The first character cannot be a number or hyphen.
29
40
  # @!attribute [rw] model
30
41
  # @return [::Google::Cloud::AIPlatform::V1::Model]
31
42
  # Required. The Model to create.
@@ -58,6 +69,16 @@ module Google
58
69
  # @return [::String]
59
70
  # Required. The name of the Model resource.
60
71
  # Format: `projects/{project}/locations/{location}/models/{model}`
72
+ #
73
+ # In order to retrieve a specific version of the model, also provide
74
+ # the version ID or version alias.
75
+ # Example: `projects/{project}/locations/{location}/models/{model}@2`
76
+ # or
77
+ # `projects/{project}/locations/{location}/models/{model}@golden`
78
+ # If no version ID or alias is specified, the "default" version will be
79
+ # returned. The "default" version alias is created for the first version of
80
+ # the model, and can be moved to other versions later on. There will be
81
+ # exactly one default version.
61
82
  class GetModelRequest
62
83
  include ::Google::Protobuf::MessageExts
63
84
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -125,6 +146,54 @@ module Google
125
146
  extend ::Google::Protobuf::MessageExts::ClassMethods
126
147
  end
127
148
 
149
+ # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_versions ModelService.ListModelVersions}.
150
+ # @!attribute [rw] name
151
+ # @return [::String]
152
+ # Required. The name of the model to list versions for.
153
+ # @!attribute [rw] page_size
154
+ # @return [::Integer]
155
+ # The standard list page size.
156
+ # @!attribute [rw] page_token
157
+ # @return [::String]
158
+ # The standard list page token.
159
+ # Typically obtained via
160
+ # {::Google::Cloud::AIPlatform::V1::ListModelVersionsResponse#next_page_token ListModelVersionsResponse.next_page_token} of the previous
161
+ # [ModelService.ListModelversions][] call.
162
+ # @!attribute [rw] filter
163
+ # @return [::String]
164
+ # An expression for filtering the results of the request. For field names
165
+ # both snake_case and camelCase are supported.
166
+ #
167
+ # * `labels` supports general map functions that is:
168
+ # * `labels.key=value` - key:value equality
169
+ # * `labels.key:* or labels:key - key existence
170
+ # * A key including a space must be quoted. `labels."a key"`.
171
+ #
172
+ # Some examples:
173
+ # * `labels.myKey="myValue"`
174
+ # @!attribute [rw] read_mask
175
+ # @return [::Google::Protobuf::FieldMask]
176
+ # Mask specifying which fields to read.
177
+ class ListModelVersionsRequest
178
+ include ::Google::Protobuf::MessageExts
179
+ extend ::Google::Protobuf::MessageExts::ClassMethods
180
+ end
181
+
182
+ # Response message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_versions ModelService.ListModelVersions}
183
+ # @!attribute [rw] models
184
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::Model>]
185
+ # List of Model versions in the requested page.
186
+ # In the returned Model name field, version ID instead of regvision tag will
187
+ # be included.
188
+ # @!attribute [rw] next_page_token
189
+ # @return [::String]
190
+ # A token to retrieve the next page of results.
191
+ # Pass to {::Google::Cloud::AIPlatform::V1::ListModelVersionsRequest#page_token ListModelVersionsRequest.page_token} to obtain that page.
192
+ class ListModelVersionsResponse
193
+ include ::Google::Protobuf::MessageExts
194
+ extend ::Google::Protobuf::MessageExts::ClassMethods
195
+ end
196
+
128
197
  # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#update_model ModelService.UpdateModel}.
129
198
  # @!attribute [rw] model
130
199
  # @return [::Google::Cloud::AIPlatform::V1::Model]
@@ -165,10 +234,50 @@ module Google
165
234
  extend ::Google::Protobuf::MessageExts::ClassMethods
166
235
  end
167
236
 
237
+ # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#delete_model_version ModelService.DeleteModelVersion}.
238
+ # @!attribute [rw] name
239
+ # @return [::String]
240
+ # Required. The name of the model version to be deleted, with a version ID explicitly
241
+ # included.
242
+ #
243
+ # Example: `projects/{project}/locations/{location}/models/{model}@1234`
244
+ class DeleteModelVersionRequest
245
+ include ::Google::Protobuf::MessageExts
246
+ extend ::Google::Protobuf::MessageExts::ClassMethods
247
+ end
248
+
249
+ # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#merge_version_aliases ModelService.MergeVersionAliases}.
250
+ # @!attribute [rw] name
251
+ # @return [::String]
252
+ # Required. The name of the model version to merge aliases, with a version ID
253
+ # explicitly included.
254
+ #
255
+ # Example: `projects/{project}/locations/{location}/models/{model}@1234`
256
+ # @!attribute [rw] version_aliases
257
+ # @return [::Array<::String>]
258
+ # Required. The set of version aliases to merge.
259
+ # The alias should be at most 128 characters, and match
260
+ # `[a-z][a-z0-9-]{0,126}[a-z-0-9]`.
261
+ # Add the `-` prefix to an alias means removing that alias from the version.
262
+ # `-` is NOT counted in the 128 characters. Example: `-golden` means removing
263
+ # the `golden` alias from the version.
264
+ #
265
+ # There is NO ordering in aliases, which means
266
+ # 1) The aliases returned from GetModel API might not have the exactly same
267
+ # order from this MergeVersionAliases API. 2) Adding and deleting the same
268
+ # alias in the request is not recommended, and the 2 operations will be
269
+ # cancelled out.
270
+ class MergeVersionAliasesRequest
271
+ include ::Google::Protobuf::MessageExts
272
+ extend ::Google::Protobuf::MessageExts::ClassMethods
273
+ end
274
+
168
275
  # Request message for {::Google::Cloud::AIPlatform::V1::ModelService::Client#export_model ModelService.ExportModel}.
169
276
  # @!attribute [rw] name
170
277
  # @return [::String]
171
278
  # Required. The resource name of the Model to export.
279
+ # The resource name may contain version id or version alias to specify the
280
+ # version, if no version is specified, the default version will be exported.
172
281
  # @!attribute [rw] output_config
173
282
  # @return [::Google::Cloud::AIPlatform::V1::ExportModelRequest::OutputConfig]
174
283
  # Required. The desired output location and configuration.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module AIPlatform
23
23
  module V1
24
- # Represents the failure policy of a pipeline. Currently, the default of a
24
+ # Reperesents the failure policy of a pipeline. Currently, the default of a
25
25
  # pipeline is that the pipeline will continue to run until no more tasks can be
26
26
  # executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a
27
27
  # pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling
@@ -77,6 +77,17 @@ module Google
77
77
  # model_to_upload's resource {::Google::Cloud::AIPlatform::V1::Model#name name} is populated. The Model
78
78
  # is always uploaded into the Project and Location in which this pipeline
79
79
  # is.
80
+ # @!attribute [rw] model_id
81
+ # @return [::String]
82
+ # Optional. The ID to use for the uploaded Model, which will become the final
83
+ # component of the model resource name.
84
+ #
85
+ # This value may be up to 63 characters, and valid characters are
86
+ # `[a-z0-9_-]`. The first character cannot be a number or hyphen.
87
+ # @!attribute [rw] parent_model
88
+ # @return [::String]
89
+ # Optional. When specify this field, the `model_to_upload` will not be uploaded as a
90
+ # new model, instead, it will become a new version of this `parent_model`.
80
91
  # @!attribute [r] state
81
92
  # @return [::Google::Cloud::AIPlatform::V1::PipelineState]
82
93
  # Output only. The detailed state of the pipeline.