features

Creates, updates, deletes, gets or lists a features resource.

Overview

Name	features
Type	Resource
Id	google.aiplatform.features

Fields

Name	Datatype	Description
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.
description	string	Description of the Feature.
createTime	string	Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
disableMonitoring	boolean	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.
etag	string	Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	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.
monitoringStatsAnomalies	array	Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
pointOfContact	string	Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
updateTime	string	Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
valueType	string	Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
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 feature_id.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	featureGroupsId, featuresId, locationsId, projectsId	Gets details of a single Feature.
list	SELECT	featureGroupsId, locationsId, projectsId	Lists Features in a given FeatureGroup.
batch_create	INSERT	entityTypesId, featurestoresId, locationsId, projectsId	Creates a batch of Features in a given EntityType.
create	INSERT	featureGroupsId, locationsId, projectsId	Creates a new Feature in a given FeatureGroup.
delete	DELETE	featureGroupsId, featuresId, locationsId, projectsId	Deletes a single Feature.
patch	UPDATE	featureGroupsId, featuresId, locationsId, projectsId	Updates the parameters of a single Feature.

SELECT examples

Lists Features in a given FeatureGroup.

SELECT
name,
description,
createTime,
disableMonitoring,
etag,
labels,
monitoringStatsAnomalies,
pointOfContact,
updateTime,
valueType,
versionColumnName
FROM google.aiplatform.features
WHERE featureGroupsId = '{{ featureGroupsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new features resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.features (
featureGroupsId,
locationsId,
projectsId,
versionColumnName,
disableMonitoring,
description,
name,
etag,
valueType,
labels,
pointOfContact
)
SELECT 
'{{ featureGroupsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ versionColumnName }}',
{{ disableMonitoring }},
'{{ description }}',
'{{ name }}',
'{{ etag }}',
'{{ valueType }}',
'{{ labels }}',
'{{ pointOfContact }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: versionColumnName
      value: string
    - name: updateTime
      value: string
    - name: disableMonitoring
      value: boolean
    - name: createTime
      value: string
    - name: description
      value: string
    - name: monitoringStatsAnomalies
      value:
        - - name: featureStatsAnomaly
            value:
              - name: statsUri
                value: string
              - name: anomalyUri
                value: string
              - name: anomalyDetectionThreshold
                value: number
              - name: endTime
                value: string
              - name: distributionDeviation
                value: number
              - name: startTime
                value: string
              - name: score
                value: number
          - name: objective
            value: string
    - name: name
      value: string
    - name: etag
      value: string
    - name: valueType
      value: string
    - name: labels
      value: object
    - name: pointOfContact
      value: string

UPDATE example

Updates a features resource.

/*+ update */
UPDATE google.aiplatform.features
SET 
versionColumnName = '{{ versionColumnName }}',
disableMonitoring = true|false,
description = '{{ description }}',
name = '{{ name }}',
etag = '{{ etag }}',
valueType = '{{ valueType }}',
labels = '{{ labels }}',
pointOfContact = '{{ pointOfContact }}'
WHERE 
featureGroupsId = '{{ featureGroupsId }}'
AND featuresId = '{{ featuresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified features resource.

/*+ delete */
DELETE FROM google.aiplatform.features
WHERE featureGroupsId = '{{ featureGroupsId }}'
AND featuresId = '{{ featuresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';