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