Skip to main content

features

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

Overview​

Namefeatures
TypeResource
Idgoogle.aiplatform.features

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringImmutable. 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.
createTimestring (google-datetime)Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
descriptionstringDescription of the Feature.
disableMonitoringbooleanOptional. 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.
etagstringUsed to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labelsobjectOptional. 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.
monitoringStatsAnomaliesarrayOutput only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
pointOfContactstringEntity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
updateTimestring (google-datetime)Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
valueTypestringImmutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
versionColumnNamestringOnly 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​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, featureGroupsId, featuresIdGets details of a single Feature.
listselectprojectsId, locationsId, featureGroupsIdfilter, pageSize, pageToken, orderBy, readMask, latestStatsCountLists Features in a given FeatureGroup.
createinsertprojectsId, locationsId, featureGroupsIdfeatureIdCreates a new Feature in a given FeatureGroup.
batch_createinsertprojectsId, locationsId, featureGroupsIdCreates a batch of Features in a given FeatureGroup.
patchupdateprojectsId, locationsId, featureGroupsId, featuresIdupdateMaskUpdates the parameters of a single Feature.
deletedeleteprojectsId, locationsId, featureGroupsId, featuresIdDeletes a single Feature.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
featureGroupsIdstring
featuresIdstring
locationsIdstring
projectsIdstring
featureIdstring
filterstring
latestStatsCountinteger (int32)
orderBystring
pageSizeinteger (int32)
pageTokenstring
readMaskstring (google-fieldmask)
updateMaskstring (google-fieldmask)

SELECT examples​

Gets details of a single Feature.

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

INSERT examples​

Creates a new Feature in a given FeatureGroup.

INSERT INTO google.aiplatform.features (
data__name,
data__description,
data__valueType,
data__labels,
data__etag,
data__disableMonitoring,
data__versionColumnName,
data__pointOfContact,
projectsId,
locationsId,
featureGroupsId,
featureId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ valueType }}',
'{{ labels }}',
'{{ etag }}',
{{ disableMonitoring }},
'{{ versionColumnName }}',
'{{ pointOfContact }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ featureGroupsId }}',
'{{ featureId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates the parameters of a single Feature.

UPDATE google.aiplatform.features
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__valueType = '{{ valueType }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__disableMonitoring = {{ disableMonitoring }},
data__versionColumnName = '{{ versionColumnName }}',
data__pointOfContact = '{{ pointOfContact }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND featureGroupsId = '{{ featureGroupsId }}' --required
AND featuresId = '{{ featuresId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes a single Feature.

DELETE FROM google.aiplatform.features
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND featureGroupsId = '{{ featureGroupsId }}' --required
AND featuresId = '{{ featuresId }}' --required;