Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.featurestores.entityTypes.deleteFeatureValues
Delete feature values from Featurestore.
The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.
If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.
Endpoint
post
https://{service-endpoint}/v1/{entityType}:deleteFeatureValues
Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}
Request body
The request body contains data with the following structure:
Fields
DeleteOption
Union type
Defines options to select feature values to be deleted. DeleteOption can be only one of the following:
{"entityIdField": string,// EntityIdsSource"csvSource": {object (CsvSource)}// Union type}
SelectTimeRangeAndFeature
message to select time range and feature. Values of the selected feature generated within an inclusive time range will be deleted. Using this option permanently deletes the feature values from the specified feature IDs within the specified time range. This might include data from the online storage. If you want to retain any deleted historical data in the online storage, you must re-ingest it.
Required. Selectors choosing which feature values to be deleted from the EntityType.
skipOnlineStorageDelete
boolean
If set, data will not be deleted from online storage. When time range is older than the data in online storage, setting this to be true will make the deletion have no impact on online serving.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: entityTypes.deleteFeatureValues\n\n**Full name**: projects.locations.featurestores.entityTypes.deleteFeatureValues\n\nDelete feature values from Featurestore.\n\nThe progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.\n\nIf a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done. \n\n### Endpoint\n\npost `https:``/``/{service-endpoint}``/v1``/{entityType}:deleteFeatureValues` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`entityType` `string` \nRequired. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`\n\n### Request body\n\nThe request body contains data with the following structure:\nFields \n`DeleteOption` `Union type` \nDefines options to select feature values to be deleted. `DeleteOption` can be only one of the following:\n`selectEntity` `object (`[SelectEntity](/vertex-ai/docs/reference/rest/v1/projects.locations.featurestores.entityTypes/deleteFeatureValues#SelectEntity)`)` \nSelect feature values to be deleted by specifying entities.\n`selectTimeRangeAndFeature` `object (`[SelectTimeRangeAndFeature](/vertex-ai/docs/reference/rest/v1/projects.locations.featurestores.entityTypes/deleteFeatureValues#SelectTimeRangeAndFeature)`)` \nSelect feature values to be deleted by specifying time range and features. \n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/vertex-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\nSelectEntity\n------------\n\nmessage to select entity. If an entity id is selected, all the feature values corresponding to the entity id will be deleted, including the entityId.\nFields `entityIdSelector` `object (`[EntityIdSelector](/vertex-ai/docs/reference/rest/v1/projects.locations.featurestores.entityTypes/deleteFeatureValues#EntityIdSelector)`)` \nRequired. Selectors choosing feature values of which entity id to be deleted from the EntityType. \n\nEntityIdSelector\n----------------\n\nSelector for entityId. Getting ids from the given source.\nFields `entityIdField` `string` \nSource column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id. \n`EntityIdsSource` `Union type` \nDetails about the source data, including the location of the storage and the format. `EntityIdsSource` can be only one of the following:\n`csvSource` `object (`[CsvSource](/vertex-ai/docs/reference/rest/v1/CsvSource)`)` \nSource of Csv \n\nSelectTimeRangeAndFeature\n-------------------------\n\nmessage to select time range and feature. Values of the selected feature generated within an inclusive time range will be deleted. Using this option permanently deletes the feature values from the specified feature IDs within the specified time range. This might include data from the online storage. If you want to retain any deleted historical data in the online storage, you must re-ingest it.\nFields `timeRange` `object (`[Interval](/vertex-ai/docs/reference/rest/Shared.Types/Interval)`)` \nRequired. Select feature generated within a half-inclusive time range. The time range is lower inclusive and upper exclusive.\n`featureSelector` `object (`[FeatureSelector](/vertex-ai/docs/reference/rest/v1/FeatureSelector)`)` \nRequired. Selectors choosing which feature values to be deleted from the EntityType.\n`skipOnlineStorageDelete` `boolean` \nIf set, data will not be deleted from online storage. When time range is older than the data in online storage, setting this to be true will make the deletion have no impact on online serving."]]