google-cloud-ai_platform-v1 0.1.0 → 0.2.0

data/lib/google/cloud/aiplatform/v1/index_pb.rb

@@ -1,11 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/index.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/aiplatform/v1/deployed_index_ref_pb'
-require 'google/protobuf/duration_pb'
 require 'google/protobuf/struct_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf'

data/lib/google/cloud/aiplatform/v1/io_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/io.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/protobuf'
 

data/lib/google/cloud/aiplatform/v1/job_state_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/job_state.proto
 
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/aiplatform/v1/lineage_subgraph_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/lineage_subgraph.proto
 
-require 'google/api/annotations_pb'
 require 'google/cloud/aiplatform/v1/artifact_pb'
 require 'google/cloud/aiplatform/v1/event_pb'
 require 'google/cloud/aiplatform/v1/execution_pb'

data/lib/google/cloud/aiplatform/v1/machine_resources_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/machine_resources.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/cloud/aiplatform/v1/accelerator_type_pb'
 require 'google/protobuf'

data/lib/google/cloud/aiplatform/v1/manual_batch_tuning_parameters_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/protobuf'
 

data/lib/google/cloud/aiplatform/v1/metadata_schema_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/metadata_schema.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/timestamp_pb'

data/lib/google/cloud/aiplatform/v1/metadata_store_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/metadata_store.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/aiplatform/v1/encryption_spec_pb'

data/lib/google/cloud/aiplatform/v1/migratable_resource_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/migratable_resource.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/timestamp_pb'

data/lib/google/cloud/aiplatform/v1/migration_service_pb.rb

@@ -5,9 +5,7 @@ require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
-require 'google/cloud/aiplatform/v1/dataset_pb'
 require 'google/cloud/aiplatform/v1/migratable_resource_pb'
-require 'google/cloud/aiplatform/v1/model_pb'
 require 'google/cloud/aiplatform/v1/operation_pb'
 require 'google/longrunning/operations_pb'
 require 'google/rpc/status_pb'

data/lib/google/cloud/aiplatform/v1/model_deployment_monitoring_job_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/aiplatform/v1/encryption_spec_pb'

data/lib/google/cloud/aiplatform/v1/model_evaluation_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/model_evaluation.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/aiplatform/v1/explanation_pb'
@@ -17,7 +16,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :metrics, :message, 3, "google.protobuf.Value"
       optional :create_time, :message, 4, "google.protobuf.Timestamp"
       repeated :slice_dimensions, :string, 5
+      optional :data_item_schema_uri, :string, 6
+      optional :annotation_schema_uri, :string, 7
       optional :model_explanation, :message, 8, "google.cloud.aiplatform.v1.ModelExplanation"
+      repeated :explanation_specs, :message, 9, "google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec"
+    end
+    add_message "google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec" do
+      optional :explanation_type, :string, 1
+      optional :explanation_spec, :message, 2, "google.cloud.aiplatform.v1.ExplanationSpec"
     end
   end
 end
@@ -27,6 +33,7 @@ module Google
     module AIPlatform
       module V1
         ModelEvaluation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ModelEvaluation").msgclass
+        ModelEvaluation::ModelEvaluationExplanationSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec").msgclass
       end
     end
   end

data/lib/google/cloud/aiplatform/v1/model_evaluation_slice_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/model_evaluation_slice.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/struct_pb'

data/lib/google/cloud/aiplatform/v1/model_monitoring_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/model_monitoring.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/aiplatform/v1/io_pb'
 require 'google/protobuf'

data/lib/google/cloud/aiplatform/v1/model_pb.rb

@@ -1,10 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/model.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
-require 'google/cloud/aiplatform/v1/dataset_pb'
 require 'google/cloud/aiplatform/v1/deployed_model_ref_pb'
 require 'google/cloud/aiplatform/v1/encryption_spec_pb'
 require 'google/cloud/aiplatform/v1/env_var_pb'

data/lib/google/cloud/aiplatform/v1/model_service_pb.rb

@@ -5,8 +5,6 @@ require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
-require 'google/cloud/aiplatform/v1/encryption_spec_pb'
-require 'google/cloud/aiplatform/v1/explanation_pb'
 require 'google/cloud/aiplatform/v1/io_pb'
 require 'google/cloud/aiplatform/v1/model_pb'
 require 'google/cloud/aiplatform/v1/model_evaluation_pb'
@@ -69,6 +67,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.aiplatform.v1.ExportModelResponse" do
     end
+    add_message "google.cloud.aiplatform.v1.ImportModelEvaluationRequest" do
+      optional :parent, :string, 1
+      optional :model_evaluation, :message, 2, "google.cloud.aiplatform.v1.ModelEvaluation"
+    end
     add_message "google.cloud.aiplatform.v1.GetModelEvaluationRequest" do
       optional :name, :string, 1
     end
@@ -117,6 +119,7 @@ module Google
         ExportModelOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExportModelOperationMetadata").msgclass
         ExportModelOperationMetadata::OutputInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExportModelOperationMetadata.OutputInfo").msgclass
         ExportModelResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExportModelResponse").msgclass
+        ImportModelEvaluationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ImportModelEvaluationRequest").msgclass
         GetModelEvaluationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.GetModelEvaluationRequest").msgclass
         ListModelEvaluationsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ListModelEvaluationsRequest").msgclass
         ListModelEvaluationsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ListModelEvaluationsResponse").msgclass

data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb

@@ -51,6 +51,8 @@ module Google
             # user. A Model is considered to be exportable if it has at least one
             # [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].
             rpc :ExportModel, ::Google::Cloud::AIPlatform::V1::ExportModelRequest, ::Google::Longrunning::Operation
+            # Imports an externally generated ModelEvaluation.
+            rpc :ImportModelEvaluation, ::Google::Cloud::AIPlatform::V1::ImportModelEvaluationRequest, ::Google::Cloud::AIPlatform::V1::ModelEvaluation
             # Gets a ModelEvaluation.
             rpc :GetModelEvaluation, ::Google::Cloud::AIPlatform::V1::GetModelEvaluationRequest, ::Google::Cloud::AIPlatform::V1::ModelEvaluation
             # Lists ModelEvaluations in a Model.

data/lib/google/cloud/aiplatform/v1/operation_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/operation.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'

data/lib/google/cloud/aiplatform/v1/pipeline_job_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/pipeline_job.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/aiplatform/v1/artifact_pb'

data/lib/google/cloud/aiplatform/v1/pipeline_state_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/pipeline_state.proto
 
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/aiplatform/v1/specialist_pool_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/specialist_pool.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf'

data/lib/google/cloud/aiplatform/v1/study_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/study.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/duration_pb'

data/lib/google/cloud/aiplatform/v1/tensorboard_data_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/tensorboard_data.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/cloud/aiplatform/v1/tensorboard_time_series_pb'
 require 'google/protobuf/timestamp_pb'

data/lib/google/cloud/aiplatform/v1/tensorboard_experiment_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/tensorboard_experiment.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/timestamp_pb'

data/lib/google/cloud/aiplatform/v1/tensorboard_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/tensorboard.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/aiplatform/v1/encryption_spec_pb'

data/lib/google/cloud/aiplatform/v1/tensorboard_run_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/tensorboard_run.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/timestamp_pb'

data/lib/google/cloud/aiplatform/v1/tensorboard_time_series_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/tensorboard_time_series.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/timestamp_pb'

data/lib/google/cloud/aiplatform/v1/training_pipeline_pb.rb

@@ -1,13 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/training_pipeline.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/aiplatform/v1/encryption_spec_pb'
 require 'google/cloud/aiplatform/v1/io_pb'
-require 'google/cloud/aiplatform/v1/machine_resources_pb'
-require 'google/cloud/aiplatform/v1/manual_batch_tuning_parameters_pb'
 require 'google/cloud/aiplatform/v1/model_pb'
 require 'google/cloud/aiplatform/v1/pipeline_state_pb'
 require 'google/protobuf/struct_pb'

data/lib/google/cloud/aiplatform/v1/types_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/types.proto
 
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/aiplatform/v1/unmanaged_container_model_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/unmanaged_container_model.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/cloud/aiplatform/v1/model_pb'
 require 'google/protobuf'

data/lib/google/cloud/aiplatform/v1/user_action_reference_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/user_action_reference.proto
 
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/aiplatform/v1/value_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/aiplatform/v1/value.proto
 
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/proto_docs/google/cloud/aiplatform/v1/accelerator_type.rb

@@ -43,6 +43,12 @@ module Google
 
           # Nvidia Tesla A100 GPU.
           NVIDIA_TESLA_A100 = 8
+
+          # TPU v2.
+          TPU_V2 = 6
+
+          # TPU v3.
+          TPU_V3 = 7
         end
       end
     end

data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb

@@ -103,6 +103,9 @@ module Google
         #     if monitoring is enabled by [CreateModelDeploymentMonitoringJob][].
         #     Format:
         #     `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
+        # @!attribute [rw] predict_request_response_logging_config
+        #   @return [::Google::Cloud::AIPlatform::V1::PredictRequestResponseLoggingConfig]
+        #     Configures the request-response logging for online prediction.
         class Endpoint
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -221,6 +224,27 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Configuration for logging request-response to a BigQuery table.
+        # @!attribute [rw] enabled
+        #   @return [::Boolean]
+        #     If logging is enabled or not.
+        # @!attribute [rw] sampling_rate
+        #   @return [::Float]
+        #     Percentage of requests to be logged, expressed as a fraction in
+        #     range(0,1].
+        # @!attribute [rw] bigquery_destination
+        #   @return [::Google::Cloud::AIPlatform::V1::BigQueryDestination]
+        #     BigQuery table for logging.
+        #     If only given project, a new dataset will be created with name
+        #     `logging_<endpoint-display-name>_<endpoint-id>` where
+        #     <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g.
+        #     most special characters will become underscores). If no table name is
+        #     given, a new table will be created with name `request_response_logging`
+        class PredictRequestResponseLoggingConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/cloud/aiplatform/v1/entity_type.rb

@@ -60,6 +60,17 @@ module Google
         #   @return [::String]
         #     Optional. Used to perform a consistent read-modify-write updates. If not set, a blind
         #     "overwrite" update happens.
+        # @!attribute [rw] monitoring_config
+        #   @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig]
+        #     Optional. The default monitoring configuration for all Features with value
+        #     type
+        #     ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL,
+        #     STRING, DOUBLE or INT64 under this EntityType.
+        #
+        #     If this is populated with
+        #     [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
+        #     analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
+        #     disabled.
         class EntityType
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/aiplatform/v1/feature.rb

@@ -63,10 +63,55 @@ module Google
         #   @return [::String]
         #     Used to perform a consistent read-modify-write updates. If not set, a blind
         #     "overwrite" update happens.
+        # @!attribute [rw] disable_monitoring
+        #   @return [::Boolean]
+        #     Optional. If not set, use the monitoring_config defined for the EntityType
+        #     this Feature belongs to. Only Features with type
+        #     ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL,
+        #     STRING, DOUBLE or INT64 can enable monitoring.
+        #
+        #     If set to true, all types of data monitoring are disabled despite the
+        #     config on EntityType.
+        # @!attribute [r] monitoring_stats_anomalies
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Feature::MonitoringStatsAnomaly>]
+        #     Output only. The list of historical stats and anomalies with specified
+        #     objectives.
         class Feature
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
+          # A list of historical [Snapshot
+          # Analysis][FeaturestoreMonitoringConfig.SnapshotAnalysis] or [Import Feature
+          # Analysis] [FeaturestoreMonitoringConfig.ImportFeatureAnalysis] stats
+          # requested by user, sorted by
+          # {::Google::Cloud::AIPlatform::V1::FeatureStatsAnomaly#start_time FeatureStatsAnomaly.start_time}
+          # descending.
+          # @!attribute [r] objective
+          #   @return [::Google::Cloud::AIPlatform::V1::Feature::MonitoringStatsAnomaly::Objective]
+          #     Output only. The objective for each stats.
+          # @!attribute [r] feature_stats_anomaly
+          #   @return [::Google::Cloud::AIPlatform::V1::FeatureStatsAnomaly]
+          #     Output only. The stats and anomalies generated at specific timestamp.
+          class MonitoringStatsAnomaly
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # If the objective in the request is both
+            # Import Feature Analysis and Snapshot Analysis, this objective could be
+            # one of them. Otherwise, this objective should be the same as the
+            # objective in the request.
+            module Objective
+              # If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty.
+              OBJECTIVE_UNSPECIFIED = 0
+
+              # Stats are generated by Import Feature Analysis.
+              IMPORT_FEATURE_ANALYSIS = 1
+
+              # Stats are generated by Snapshot Analysis.
+              SNAPSHOT_ANALYSIS = 2
+            end
+          end
+
           # @!attribute [rw] key
           #   @return [::String]
           # @!attribute [rw] value

data/proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # Configuration of how features in Featurestore are monitored.
+        # @!attribute [rw] snapshot_analysis
+        #   @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::SnapshotAnalysis]
+        #     The config for Snapshot Analysis Based Feature Monitoring.
+        # @!attribute [rw] import_features_analysis
+        #   @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::ImportFeaturesAnalysis]
+        #     The config for ImportFeatures Analysis Based Feature Monitoring.
+        # @!attribute [rw] numerical_threshold_config
+        #   @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::ThresholdConfig]
+        #     Threshold for numerical features of anomaly detection.
+        #     This is shared by all objectives of Featurestore Monitoring for numerical
+        #     features (i.e. Features with type
+        #     ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) DOUBLE
+        #     or INT64).
+        # @!attribute [rw] categorical_threshold_config
+        #   @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::ThresholdConfig]
+        #     Threshold for categorical features of anomaly detection.
+        #     This is shared by all types of Featurestore Monitoring for categorical
+        #     features (i.e. Features with type
+        #     ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL or
+        #     STRING).
+        class FeaturestoreMonitoringConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration of the Featurestore's Snapshot Analysis Based Monitoring.
+          # This type of analysis generates statistics for each Feature based on a
+          # snapshot of the latest feature value of each entities every
+          # monitoring_interval.
+          # @!attribute [rw] disabled
+          #   @return [::Boolean]
+          #     The monitoring schedule for snapshot analysis.
+          #     For EntityType-level config:
+          #       unset / disabled = true indicates disabled by
+          #       default for Features under it; otherwise by default enable snapshot
+          #       analysis monitoring with monitoring_interval for Features under it.
+          #     Feature-level config:
+          #       disabled = true indicates disabled regardless of the EntityType-level
+          #       config; unset monitoring_interval indicates going with EntityType-level
+          #       config; otherwise run snapshot analysis monitoring with
+          #       monitoring_interval regardless of the EntityType-level config.
+          #     Explicitly Disable the snapshot analysis based monitoring.
+          # @!attribute [rw] monitoring_interval_days
+          #   @return [::Integer]
+          #     Configuration of the snapshot analysis based monitoring pipeline
+          #     running interval. The value indicates number of days.
+          #     If both
+          #     {::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::SnapshotAnalysis#monitoring_interval_days FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days}
+          #     and [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval][]
+          #     are set when creating/updating EntityTypes/Features,
+          #     {::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::SnapshotAnalysis#monitoring_interval_days FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days}
+          #     will be used.
+          # @!attribute [rw] staleness_days
+          #   @return [::Integer]
+          #     Customized export features time window for snapshot analysis. Unit is one
+          #     day. Default value is 3 weeks. Minimum value is 1 day. Maximum value is
+          #     4000 days.
+          class SnapshotAnalysis
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration of the Featurestore's ImportFeature Analysis Based
+          # Monitoring. This type of analysis generates statistics for values of each
+          # Feature imported by every [ImportFeatureValues][] operation.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::ImportFeaturesAnalysis::State]
+          #     Whether to enable / disable / inherite default hebavior for import
+          #     features analysis.
+          # @!attribute [rw] anomaly_detection_baseline
+          #   @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig::ImportFeaturesAnalysis::Baseline]
+          #     The baseline used to do anomaly detection for the statistics generated by
+          #     import features analysis.
+          class ImportFeaturesAnalysis
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The state defines whether to enable ImportFeature analysis.
+            module State
+              # Should not be used.
+              STATE_UNSPECIFIED = 0
+
+              # The default behavior of whether to enable the monitoring.
+              # EntityType-level config: disabled.
+              # Feature-level config: inherited from the configuration of EntityType
+              # this Feature belongs to.
+              DEFAULT = 1
+
+              # Explicitly enables import features analysis.
+              # EntityType-level config: by default enables import features analysis
+              # for all Features under it. Feature-level config: enables import
+              # features analysis regardless of the EntityType-level config.
+              ENABLED = 2
+
+              # Explicitly disables import features analysis.
+              # EntityType-level config: by default disables import features analysis
+              # for all Features under it. Feature-level config: disables import
+              # features analysis regardless of the EntityType-level config.
+              DISABLED = 3
+            end
+
+            # Defines the baseline to do anomaly detection for feature values imported
+            # by each [ImportFeatureValues][] operation.
+            module Baseline
+              # Should not be used.
+              BASELINE_UNSPECIFIED = 0
+
+              # Choose the later one statistics generated by either most recent
+              # snapshot analysis or previous import features analysis. If non of them
+              # exists, skip anomaly detection and only generate a statistics.
+              LATEST_STATS = 1
+
+              # Use the statistics generated by the most recent snapshot analysis if
+              # exists.
+              MOST_RECENT_SNAPSHOT_STATS = 2
+
+              # Use the statistics generated by the previous import features analysis
+              # if exists.
+              PREVIOUS_IMPORT_FEATURES_STATS = 3
+            end
+          end
+
+          # The config for Featurestore Monitoring threshold.
+          # @!attribute [rw] value
+          #   @return [::Float]
+          #     Specify a threshold value that can trigger the alert.
+          #     1. For categorical feature, the distribution distance is calculated by
+          #     L-inifinity norm.
+          #     2. For numerical feature, the distribution distance is calculated by
+          #     Jensen–Shannon divergence. Each feature must have a non-zero threshold
+          #     if they need to be monitored. Otherwise no alert will be triggered for
+          #     that feature.
+          class ThresholdConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end