Method: 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.

HTTP request

POST https://{service-endpoint}/v1beta1/{entityType}:deleteFeatureValues

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
entityType

string

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:

JSON representation 
{

  // Union field DeleteOption can be only one of the following:
  "selectEntity": {
    object (SelectEntity)
  },
  "selectTimeRangeAndFeature": {
    object (SelectTimeRangeAndFeature)
  }
  // End of list of possible types for union field DeleteOption.
}
Fields
Union field DeleteOption. Defines options to select feature values to be deleted. DeleteOption can be only one of the following:
selectEntity

object (SelectEntity)

Select feature values to be deleted by specifying entities.
selectTimeRangeAndFeature

object (SelectTimeRangeAndFeature)

Select feature values to be deleted by specifying time range and features.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the entityType resource:

  • aiplatform.entityTypes.deleteFeatureValues

For more information, see the IAM documentation.

SelectEntity

message to select entity. If an entity id is selected, all the feature values corresponding to the entity id will be deleted, including the entityId.

JSON representation 
{
  "entityIdSelector": {
    object (EntityIdSelector)
  }
}
Fields
entityIdSelector

object (EntityIdSelector)

Required. Selectors choosing feature values of which entity id to be deleted from the EntityType.

EntityIdSelector

Selector for entityId. Getting ids from the given source.

JSON representation 
{
  "entityIdField": string,

  // Union field EntityIdsSource can be only one of the following:
  "csvSource": {
    object (CsvSource)
  }
  // End of list of possible types for union field EntityIdsSource.
}
Fields
entityIdField

string

Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.
Union field EntityIdsSource. Details about the source data, including the location of the storage and the format. EntityIdsSource can be only one of the following:
csvSource

object (CsvSource)

Source of Csv

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.

JSON representation 
{
  "timeRange": {
    object (Interval)
  },
  "featureSelector": {
    object (FeatureSelector)
  },
  "skipOnlineStorageDelete": boolean
}
Fields
timeRange

object (Interval)

Required. Select feature generated within a half-inclusive time range. The time range is lower inclusive and upper exclusive.
featureSelector

object (FeatureSelector)

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.