Debian Codegraph @

docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.features.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="aiplatform_v1.html">Agent Platform API</a> . <a href="aiplatform_v1.projects.html">projects</a> . <a href="aiplatform_v1.projects.locations.html">locations</a> . <a href="aiplatform_v1.projects.locations.featurestores.html">featurestores</a> . <a href="aiplatform_v1.projects.locations.featurestores.entityTypes.html">entityTypes</a> . <a href="aiplatform_v1.projects.locations.featurestores.entityTypes.features.html">features</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="aiplatform_v1.projects.locations.featurestores.entityTypes.features.operations.html">operations()</a></code>
79 </p>
80 <p class="firstline">Returns the operations Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
84 <p class="firstline">Creates a batch of Features in a given EntityType.</p>
85 <p class="toc_element">
86 <code><a href="#close">close()</a></code></p>
87 <p class="firstline">Close httplib2 connections.</p>
88 <p class="toc_element">
89 <code><a href="#create">create(parent, body=None, featureId=None, x__xgafv=None)</a></code></p>
90 <p class="firstline">Creates a new Feature in a given EntityType.</p>
91 <p class="toc_element">
92 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
93 <p class="firstline">Deletes a single Feature.</p>
94 <p class="toc_element">
95 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
96 <p class="firstline">Gets details of a single Feature.</p>
97 <p class="toc_element">
98 <code><a href="#list">list(parent, filter=None, latestStatsCount=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p>
99 <p class="firstline">Lists Features in a given EntityType.</p>
100 <p class="toc_element">
101 <code><a href="#list_next">list_next()</a></code></p>
102 <p class="firstline">Retrieves the next page of results.</p>
103 <p class="toc_element">
104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
105 <p class="firstline">Updates the parameters of a single Feature.</p>
106 <h3>Method Details</h3>
107 <div class="method">
108 <code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
109 <pre>Creates a batch of Features in a given EntityType.
110
111 Args:
112 parent: string, Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}` (required)
113 body: object, The request body.
114 The object takes the form of:
115
116 { # Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures.
117 &quot;requests&quot;: [ # Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType / FeatureGroup. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message.
118 { # Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature.
119 &quot;feature&quot;: { # Feature Metadata information. For example, color is a feature that describes an apple. # Required. The Feature to create.
120 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
121 &quot;description&quot;: &quot;A String&quot;, # Description of the Feature.
122 &quot;disableMonitoring&quot;: True or False, # Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (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.
123 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
124 &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
125 &quot;a_key&quot;: &quot;A String&quot;,
126 },
127 &quot;monitoringStatsAnomalies&quot;: [ # Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
128 { # A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
129 &quot;featureStatsAnomaly&quot;: { # Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display. # Output only. The stats and anomalies generated at specific timestamp.
130 &quot;anomalyDetectionThreshold&quot;: 3.14, # This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.
131 &quot;anomalyUri&quot;: &quot;A String&quot;, # Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
132 &quot;distributionDeviation&quot;: 3.14, # Deviation from the current stats to baseline stats. 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.
133 &quot;endTime&quot;: &quot;A String&quot;, # The end timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).
134 &quot;score&quot;: 3.14, # Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.
135 &quot;startTime&quot;: &quot;A String&quot;, # The start timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).
136 &quot;statsUri&quot;: &quot;A String&quot;, # Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
137 },
138 &quot;objective&quot;: &quot;A String&quot;, # Output only. The objective for each stats.
139 },
140 ],
141 &quot;name&quot;: &quot;A String&quot;, # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
142 &quot;pointOfContact&quot;: &quot;A String&quot;, # Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
143 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
144 &quot;valueType&quot;: &quot;A String&quot;, # Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
145 &quot;versionColumnName&quot;: &quot;A String&quot;, # Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
146 },
147 &quot;featureId&quot;: &quot;A String&quot;, # Required. The ID to use for the Feature, which will become the final component of the Feature&#x27;s resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
148 &quot;parent&quot;: &quot;A String&quot;, # Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
149 },
150 ],
151 }
152
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158 Returns:
159 An object of the form:
160
161 { # This resource represents a long-running operation that is the result of a network API call.
162 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
163 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
164 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
165 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
166 {
167 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
168 },
169 ],
170 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
171 },
172 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
175 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
176 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
177 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
178 },
179 }</pre>
180 </div>
181
182 <div class="method">
183 <code class="details" id="close">close()</code>
184 <pre>Close httplib2 connections.</pre>
185 </div>
186
187 <div class="method">
188 <code class="details" id="create">create(parent, body=None, featureId=None, x__xgafv=None)</code>
189 <pre>Creates a new Feature in a given EntityType.
190
191 Args:
192 parent: string, Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}` (required)
193 body: object, The request body.
194 The object takes the form of:
195
196 { # Feature Metadata information. For example, color is a feature that describes an apple.
197 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
198 &quot;description&quot;: &quot;A String&quot;, # Description of the Feature.
199 &quot;disableMonitoring&quot;: True or False, # Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (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.
200 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
201 &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
202 &quot;a_key&quot;: &quot;A String&quot;,
203 },
204 &quot;monitoringStatsAnomalies&quot;: [ # Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
205 { # A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
206 &quot;featureStatsAnomaly&quot;: { # Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display. # Output only. The stats and anomalies generated at specific timestamp.
207 &quot;anomalyDetectionThreshold&quot;: 3.14, # This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.
208 &quot;anomalyUri&quot;: &quot;A String&quot;, # Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
209 &quot;distributionDeviation&quot;: 3.14, # Deviation from the current stats to baseline stats. 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.
210 &quot;endTime&quot;: &quot;A String&quot;, # The end timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).
211 &quot;score&quot;: 3.14, # Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.
212 &quot;startTime&quot;: &quot;A String&quot;, # The start timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).
213 &quot;statsUri&quot;: &quot;A String&quot;, # Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
214 },
215 &quot;objective&quot;: &quot;A String&quot;, # Output only. The objective for each stats.
216 },
217 ],
218 &quot;name&quot;: &quot;A String&quot;, # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
219 &quot;pointOfContact&quot;: &quot;A String&quot;, # Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
220 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
221 &quot;valueType&quot;: &quot;A String&quot;, # Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
222 &quot;versionColumnName&quot;: &quot;A String&quot;, # Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
223 }
224
225 featureId: string, Required. The ID to use for the Feature, which will become the final component of the Feature&#x27;s resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
226 x__xgafv: string, V1 error format.
227 Allowed values
228 1 - v1 error format
229 2 - v2 error format
230
231 Returns:
232 An object of the form:
233
234 { # This resource represents a long-running operation that is the result of a network API call.
235 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
236 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
237 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
238 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
239 {
240 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
241 },
242 ],
243 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
244 },
245 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
246 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
247 },
248 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
249 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
250 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
251 },
252 }</pre>
253 </div>
254
255 <div class="method">
256 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
257 <pre>Deletes a single Feature.
258
259 Args:
260 name: string, Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` (required)
261 x__xgafv: string, V1 error format.
262 Allowed values
263 1 - v1 error format
264 2 - v2 error format
265
266 Returns:
267 An object of the form:
268
269 { # This resource represents a long-running operation that is the result of a network API call.
270 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
271 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
272 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
273 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
274 {
275 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
276 },
277 ],
278 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
279 },
280 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
281 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
282 },
283 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
284 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
285 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
286 },
287 }</pre>
288 </div>
289
290 <div class="method">
291 <code class="details" id="get">get(name, x__xgafv=None)</code>
292 <pre>Gets details of a single Feature.
293
294 Args:
295 name: string, Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}` (required)
296 x__xgafv: string, V1 error format.
297 Allowed values
298 1 - v1 error format
299 2 - v2 error format
300
301 Returns:
302 An object of the form:
303
304 { # Feature Metadata information. For example, color is a feature that describes an apple.
305 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
306 &quot;description&quot;: &quot;A String&quot;, # Description of the Feature.
307 &quot;disableMonitoring&quot;: True or False, # Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (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.
308 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
309 &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
310 &quot;a_key&quot;: &quot;A String&quot;,
311 },
312 &quot;monitoringStatsAnomalies&quot;: [ # Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
313 { # A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
314 &quot;featureStatsAnomaly&quot;: { # Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display. # Output only. The stats and anomalies generated at specific timestamp.
315 &quot;anomalyDetectionThreshold&quot;: 3.14, # This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.
316 &quot;anomalyUri&quot;: &quot;A String&quot;, # Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
317 &quot;distributionDeviation&quot;: 3.14, # Deviation from the current stats to baseline stats. 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.
318 &quot;endTime&quot;: &quot;A String&quot;, # The end timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).
319 &quot;score&quot;: 3.14, # Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.
320 &quot;startTime&quot;: &quot;A String&quot;, # The start timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).
321 &quot;statsUri&quot;: &quot;A String&quot;, # Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
322 },
323 &quot;objective&quot;: &quot;A String&quot;, # Output only. The objective for each stats.
324 },
325 ],
326 &quot;name&quot;: &quot;A String&quot;, # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
327 &quot;pointOfContact&quot;: &quot;A String&quot;, # Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
328 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
329 &quot;valueType&quot;: &quot;A String&quot;, # Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
330 &quot;versionColumnName&quot;: &quot;A String&quot;, # Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
331 }</pre>
332 </div>
333
334 <div class="method">
335 <code class="details" id="list">list(parent, filter=None, latestStatsCount=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code>
336 <pre>Lists Features in a given EntityType.
337
338 Args:
339 parent: string, Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}` (required)
340 filter: string, Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, &lt;, &gt;, &gt;=, and &lt;= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, &lt;, &gt;, &gt;=, and &lt;= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --&gt; Features whose type is DOUBLE. * `create_time &gt; \&quot;2020-01-31T15:30:00.000000Z\&quot; OR update_time &gt; \&quot;2020-01-31T15:30:00.000000Z\&quot;` --&gt; EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --&gt; Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --&gt; Any Feature which has a label with &#x27;env&#x27; as the key.
341 latestStatsCount: integer, Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists &lt; ListFeaturesRequest.latest_stats_count, return all existing stats.
342 orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use &quot;desc&quot; after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`
343 pageSize: integer, The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
344 pageToken: string, A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.
345 readMask: string, Mask specifying which fields to read.
346 x__xgafv: string, V1 error format.
347 Allowed values
348 1 - v1 error format
349 2 - v2 error format
350
351 Returns:
352 An object of the form:
353
354 { # Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures.
355 &quot;features&quot;: [ # The Features matching the request.
356 { # Feature Metadata information. For example, color is a feature that describes an apple.
357 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
358 &quot;description&quot;: &quot;A String&quot;, # Description of the Feature.
359 &quot;disableMonitoring&quot;: True or False, # Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (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.
360 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
361 &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
362 &quot;a_key&quot;: &quot;A String&quot;,
363 },
364 &quot;monitoringStatsAnomalies&quot;: [ # Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
365 { # A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
366 &quot;featureStatsAnomaly&quot;: { # Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display. # Output only. The stats and anomalies generated at specific timestamp.
367 &quot;anomalyDetectionThreshold&quot;: 3.14, # This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.
368 &quot;anomalyUri&quot;: &quot;A String&quot;, # Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
369 &quot;distributionDeviation&quot;: 3.14, # Deviation from the current stats to baseline stats. 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.
370 &quot;endTime&quot;: &quot;A String&quot;, # The end timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).
371 &quot;score&quot;: 3.14, # Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.
372 &quot;startTime&quot;: &quot;A String&quot;, # The start timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).
373 &quot;statsUri&quot;: &quot;A String&quot;, # Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
374 },
375 &quot;objective&quot;: &quot;A String&quot;, # Output only. The objective for each stats.
376 },
377 ],
378 &quot;name&quot;: &quot;A String&quot;, # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
379 &quot;pointOfContact&quot;: &quot;A String&quot;, # Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
380 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
381 &quot;valueType&quot;: &quot;A String&quot;, # Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
382 &quot;versionColumnName&quot;: &quot;A String&quot;, # Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
383 },
384 ],
385 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as ListFeaturesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
386 }</pre>
387 </div>
388
389 <div class="method">
390 <code class="details" id="list_next">list_next()</code>
391 <pre>Retrieves the next page of results.
392
393 Args:
394 previous_request: The request for the previous page. (required)
395 previous_response: The response from the request for the previous page. (required)
396
397 Returns:
398 A request object that you can call &#x27;execute()&#x27; on to request the next
399 page. Returns None if there are no more items in the collection.
400 </pre>
401 </div>
402
403 <div class="method">
404 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
405 <pre>Updates the parameters of a single Feature.
406
407 Args:
408 name: string, Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. (required)
409 body: object, The request body.
410 The object takes the form of:
411
412 { # Feature Metadata information. For example, color is a feature that describes an apple.
413 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
414 &quot;description&quot;: &quot;A String&quot;, # Description of the Feature.
415 &quot;disableMonitoring&quot;: True or False, # Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (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.
416 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
417 &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
418 &quot;a_key&quot;: &quot;A String&quot;,
419 },
420 &quot;monitoringStatsAnomalies&quot;: [ # Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
421 { # A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
422 &quot;featureStatsAnomaly&quot;: { # Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display. # Output only. The stats and anomalies generated at specific timestamp.
423 &quot;anomalyDetectionThreshold&quot;: 3.14, # This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.
424 &quot;anomalyUri&quot;: &quot;A String&quot;, # Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
425 &quot;distributionDeviation&quot;: 3.14, # Deviation from the current stats to baseline stats. 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.
426 &quot;endTime&quot;: &quot;A String&quot;, # The end timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).
427 &quot;score&quot;: 3.14, # Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.
428 &quot;startTime&quot;: &quot;A String&quot;, # The start timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).
429 &quot;statsUri&quot;: &quot;A String&quot;, # Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
430 },
431 &quot;objective&quot;: &quot;A String&quot;, # Output only. The objective for each stats.
432 },
433 ],
434 &quot;name&quot;: &quot;A String&quot;, # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
435 &quot;pointOfContact&quot;: &quot;A String&quot;, # Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
436 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
437 &quot;valueType&quot;: &quot;A String&quot;, # Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
438 &quot;versionColumnName&quot;: &quot;A String&quot;, # Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
439 }
440
441 updateMask: string, Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)
442 x__xgafv: string, V1 error format.
443 Allowed values
444 1 - v1 error format
445 2 - v2 error format
446
447 Returns:
448 An object of the form:
449
450 { # Feature Metadata information. For example, color is a feature that describes an apple.
451 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
452 &quot;description&quot;: &quot;A String&quot;, # Description of the Feature.
453 &quot;disableMonitoring&quot;: True or False, # Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (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.
454 &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
455 &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
456 &quot;a_key&quot;: &quot;A String&quot;,
457 },
458 &quot;monitoringStatsAnomalies&quot;: [ # Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
459 { # A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
460 &quot;featureStatsAnomaly&quot;: { # Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display. # Output only. The stats and anomalies generated at specific timestamp.
461 &quot;anomalyDetectionThreshold&quot;: 3.14, # This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.
462 &quot;anomalyUri&quot;: &quot;A String&quot;, # Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
463 &quot;distributionDeviation&quot;: 3.14, # Deviation from the current stats to baseline stats. 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.
464 &quot;endTime&quot;: &quot;A String&quot;, # The end timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).
465 &quot;score&quot;: 3.14, # Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.
466 &quot;startTime&quot;: &quot;A String&quot;, # The start timestamp of window where stats were generated. For objectives where time window doesn&#x27;t make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).
467 &quot;statsUri&quot;: &quot;A String&quot;, # Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
468 },
469 &quot;objective&quot;: &quot;A String&quot;, # Output only. The objective for each stats.
470 },
471 ],
472 &quot;name&quot;: &quot;A String&quot;, # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
473 &quot;pointOfContact&quot;: &quot;A String&quot;, # Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
474 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
475 &quot;valueType&quot;: &quot;A String&quot;, # Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
476 &quot;versionColumnName&quot;: &quot;A String&quot;, # Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
477 }</pre>
478 </div>
479
480 </body></html>