REST Resource: projects.locations.featureGroups.features

Resource: Feature

feature metadata information. For example, color is a feature that describes an apple.

Fields
name string

Immutable. name of the feature. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}/features/{feature} projects/{project}/locations/{location}/featureGroups/{featureGroup}/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.

description string

description of the feature.

valueType enum (ValueType)

Immutable. Only applicable for Vertex AI feature Store (Legacy). type of feature value.

createTime string (Timestamp format)

Output only. Only applicable for Vertex AI feature Store (Legacy). timestamp when this EntityType was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Output only. Only applicable for Vertex AI feature Store (Legacy). timestamp when this EntityType was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels map (key: string, value: string)

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)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

etag string

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

monitoringConfig
(deprecated) object (FeaturestoreMonitoringConfig)

Optional. Only applicable for Vertex AI feature Store (Legacy). Deprecated: The custom monitoring configuration for this feature, if not set, use the monitoringConfig defined for the EntityType this feature belongs to. Only Features with type (feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring.

If this is populated with [FeaturestoreMonitoringConfig.disabled][] = true, snapshot analysis monitoring is disabled; if [FeaturestoreMonitoringConfig.monitoring_interval][] specified, snapshot analysis monitoring is enabled. Otherwise, snapshot analysis monitoring config is same as the EntityType's this feature belongs to.

disableMonitoring boolean

Optional. Only applicable for Vertex AI feature Store (Legacy). If not set, use the monitoringConfig 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.

monitoringStats[] object (FeatureStatsAnomaly)

Output only. Only applicable for Vertex AI feature Store (Legacy). A list of historical SnapshotAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.

monitoringStatsAnomalies[] object (MonitoringStatsAnomaly)

Output only. Only applicable for Vertex AI feature Store (Legacy). The list of historical stats and anomalies with specified objectives.

featureStatsAndAnomaly[] object (FeatureStatsAndAnomaly)

Output only. Only applicable for Vertex AI feature Store. The list of historical stats and anomalies.

versionColumnName string

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 featureId.

pointOfContact string

Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.

JSON representation 
{
  "name": string,
  "description": string,
  "valueType": enum (ValueType),
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "etag": string,
  "monitoringConfig": {
    object (FeaturestoreMonitoringConfig)
  },
  "disableMonitoring": boolean,
  "monitoringStats": [
    {
      object (FeatureStatsAnomaly)
    }
  ],
  "monitoringStatsAnomalies": [
    {
      object (MonitoringStatsAnomaly)
    }
  ],
  "featureStatsAndAnomaly": [
    {
      object (FeatureStatsAndAnomaly)
    }
  ],
  "versionColumnName": string,
  "pointOfContact": string
}

ValueType

Only applicable for Vertex AI Legacy feature Store. An enum representing the value type of a feature.

Enums
VALUE_TYPE_UNSPECIFIED The value type is unspecified.
BOOL Used for feature that is a boolean.
BOOL_ARRAY Used for feature that is a list of boolean.
DOUBLE Used for feature that is double.
DOUBLE_ARRAY Used for feature that is a list of double.
INT64 Used for feature that is INT64.
INT64_ARRAY Used for feature that is a list of INT64.
STRING Used for feature that is string.
STRING_ARRAY Used for feature that is a list of String.
BYTES Used for feature that is bytes.
STRUCT Used for feature that is struct.

MonitoringStatsAnomaly

A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.

Fields
objective enum (Objective)

Output only. The objective for each stats.

featureStatsAnomaly object (FeatureStatsAnomaly)

Output only. The stats and anomalies generated at specific timestamp.

JSON representation 
{
  "objective": enum (Objective),
  "featureStatsAnomaly": {
    object (FeatureStatsAnomaly)
  }
}

Objective

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.

Enums
OBJECTIVE_UNSPECIFIED If it's OBJECTIVE_UNSPECIFIED, monitoringStats will be empty.
IMPORT_FEATURE_ANALYSIS Stats are generated by Import feature Analysis.
SNAPSHOT_ANALYSIS Stats are generated by Snapshot Analysis.

FeatureStatsAndAnomaly

Stats and Anomaly generated by FeatureMonitorJobs. Anomaly only includes Drift.

Fields
featureId string

feature id.

featureStats value (Value format)

feature stats. e.g. histogram buckets. In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.

distributionDeviation number

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.

driftDetectionThreshold number

This is the threshold used when detecting drifts, which is set in FeatureMonitor.FeatureSelectionConfig.FeatureConfig.drift_threshold

driftDetected boolean

If set to true, indicates current stats is detected as and comparing with baseline stats.

statsTime string (Timestamp format)

The timestamp we take snapshot for feature values to generate stats.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

featureMonitorJobId string (int64 format)

The id of the FeatureMonitorJob that generated this FeatureStatsAndAnomaly.

featureMonitorId string

The id of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.

JSON representation 
{
  "featureId": string,
  "featureStats": value,
  "distributionDeviation": number,
  "driftDetectionThreshold": number,
  "driftDetected": boolean,
  "statsTime": string,
  "featureMonitorJobId": string,
  "featureMonitorId": string
}

Methods

batchCreate

 Creates a batch of Features in a given FeatureGroup.

create

 Creates a new Feature in a given FeatureGroup.

delete

 Deletes a single Feature.

get

 Gets details of a single Feature.

list

 Lists Features in a given FeatureGroup.

patch

 Updates the parameters of a single Feature.