1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.cloud.aiplatform.v1beta1; 18 19import "google/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21import "google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto"; 22import "google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto"; 23import "google/protobuf/timestamp.proto"; 24 25option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1"; 26option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb"; 27option java_multiple_files = true; 28option java_outer_classname = "FeatureProto"; 29option java_package = "com.google.cloud.aiplatform.v1beta1"; 30option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1"; 31option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; 32 33// Feature Metadata information. 34// For example, color is a feature that describes an apple. 35message Feature { 36 option (google.api.resource) = { 37 type: "aiplatform.googleapis.com/Feature" 38 pattern: "projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}" 39 pattern: "projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}" 40 plural: "features" 41 singular: "feature" 42 }; 43 44 // A list of historical 45 // [SnapshotAnalysis][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis] 46 // or 47 // [ImportFeaturesAnalysis][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis] 48 // stats requested by user, sorted by 49 // [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time] 50 // descending. 51 message MonitoringStatsAnomaly { 52 // If the objective in the request is both 53 // Import Feature Analysis and Snapshot Analysis, this objective could be 54 // one of them. Otherwise, this objective should be the same as the 55 // objective in the request. 56 enum Objective { 57 // If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty. 58 OBJECTIVE_UNSPECIFIED = 0; 59 60 // Stats are generated by Import Feature Analysis. 61 IMPORT_FEATURE_ANALYSIS = 1; 62 63 // Stats are generated by Snapshot Analysis. 64 SNAPSHOT_ANALYSIS = 2; 65 } 66 67 // Output only. The objective for each stats. 68 Objective objective = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 69 70 // Output only. The stats and anomalies generated at specific timestamp. 71 FeatureStatsAnomaly feature_stats_anomaly = 2 72 [(google.api.field_behavior) = OUTPUT_ONLY]; 73 } 74 75 // Only applicable for Vertex AI Legacy Feature Store. 76 // An enum representing the value type of a feature. 77 enum ValueType { 78 // The value type is unspecified. 79 VALUE_TYPE_UNSPECIFIED = 0; 80 81 // Used for Feature that is a boolean. 82 BOOL = 1; 83 84 // Used for Feature that is a list of boolean. 85 BOOL_ARRAY = 2; 86 87 // Used for Feature that is double. 88 DOUBLE = 3; 89 90 // Used for Feature that is a list of double. 91 DOUBLE_ARRAY = 4; 92 93 // Used for Feature that is INT64. 94 INT64 = 9; 95 96 // Used for Feature that is a list of INT64. 97 INT64_ARRAY = 10; 98 99 // Used for Feature that is string. 100 STRING = 11; 101 102 // Used for Feature that is a list of String. 103 STRING_ARRAY = 12; 104 105 // Used for Feature that is bytes. 106 BYTES = 13; 107 } 108 109 // Immutable. Name of the Feature. 110 // Format: 111 // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` 112 // `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` 113 // 114 // The last part feature is assigned by the client. The feature can be up to 115 // 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, 116 // underscore(_), and ASCII digits 0-9 starting with a letter. The value will 117 // be unique given an entity type. 118 string name = 1 [(google.api.field_behavior) = IMMUTABLE]; 119 120 // Description of the Feature. 121 string description = 2; 122 123 // Immutable. Only applicable for Vertex AI Feature Store (Legacy). 124 // Type of Feature value. 125 ValueType value_type = 3 [(google.api.field_behavior) = IMMUTABLE]; 126 127 // Output only. Only applicable for Vertex AI Feature Store (Legacy). 128 // Timestamp when this EntityType was created. 129 google.protobuf.Timestamp create_time = 4 130 [(google.api.field_behavior) = OUTPUT_ONLY]; 131 132 // Output only. Only applicable for Vertex AI Feature Store (Legacy). 133 // Timestamp when this EntityType was most recently updated. 134 google.protobuf.Timestamp update_time = 5 135 [(google.api.field_behavior) = OUTPUT_ONLY]; 136 137 // Optional. The labels with user-defined metadata to organize your Features. 138 // 139 // Label keys and values can be no longer than 64 characters 140 // (Unicode codepoints), can only contain lowercase letters, numeric 141 // characters, underscores and dashes. International characters are allowed. 142 // 143 // See https://goo.gl/xmQnxf for more information on and examples of labels. 144 // No more than 64 user labels can be associated with one Feature (System 145 // labels are excluded)." 146 // System reserved label keys are prefixed with "aiplatform.googleapis.com/" 147 // and are immutable. 148 map<string, string> labels = 6 [(google.api.field_behavior) = OPTIONAL]; 149 150 // Used to perform a consistent read-modify-write updates. If not set, a blind 151 // "overwrite" update happens. 152 string etag = 7; 153 154 // Optional. Only applicable for Vertex AI Feature Store (Legacy). 155 // Deprecated: The custom monitoring configuration for this Feature, if not 156 // set, use the monitoring_config defined for the EntityType this Feature 157 // belongs to. 158 // Only Features with type 159 // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) 160 // BOOL, STRING, DOUBLE or INT64 can enable monitoring. 161 // 162 // If this is populated with 163 // [FeaturestoreMonitoringConfig.disabled][] = true, snapshot analysis 164 // monitoring is disabled; if 165 // [FeaturestoreMonitoringConfig.monitoring_interval][] specified, snapshot 166 // analysis monitoring is enabled. Otherwise, snapshot analysis monitoring 167 // config is same as the EntityType's this Feature belongs to. 168 FeaturestoreMonitoringConfig monitoring_config = 9 169 [deprecated = true, (google.api.field_behavior) = OPTIONAL]; 170 171 // Optional. Only applicable for Vertex AI Feature Store (Legacy). 172 // If not set, use the monitoring_config defined for the EntityType this 173 // Feature belongs to. 174 // Only Features with type 175 // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) 176 // BOOL, STRING, DOUBLE or INT64 can enable monitoring. 177 // 178 // If set to true, all types of data monitoring are disabled despite the 179 // config on EntityType. 180 bool disable_monitoring = 12 [(google.api.field_behavior) = OPTIONAL]; 181 182 // Output only. Only applicable for Vertex AI Feature Store (Legacy). 183 // A list of historical 184 // [SnapshotAnalysis][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis] 185 // stats requested by user, sorted by 186 // [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time] 187 // descending. 188 repeated FeatureStatsAnomaly monitoring_stats = 10 189 [(google.api.field_behavior) = OUTPUT_ONLY]; 190 191 // Output only. Only applicable for Vertex AI Feature Store (Legacy). 192 // The list of historical stats and anomalies with specified objectives. 193 repeated MonitoringStatsAnomaly monitoring_stats_anomalies = 11 194 [(google.api.field_behavior) = OUTPUT_ONLY]; 195 196 // Only applicable for Vertex AI Feature Store. 197 // The name of the BigQuery Table/View column hosting data for this version. 198 // If no value is provided, will use feature_id. 199 string version_column_name = 106; 200 201 // Entity responsible for maintaining this feature. Can be comma separated 202 // list of email addresses or URIs. 203 string point_of_contact = 107; 204} 205