Delete - Upstash Documentation

The delete method allows you to delete vectors from your index using various criteria. You can delete vectors by their IDs, by ID prefix, or using metadata filters.

Arguments

IDsstring[] | number[] | string | numberrequired

One or more vector IDs to delete.

DeletePayloadobjectrequired

You can only use one of the ids, prefix, or filter fields.

idsstring[] | number[] | string | number

One or more vector IDs to delete.

prefixstring

A string prefix to match vector IDs for deletion. All vectors with IDs starting with this prefix will be deleted.

filterstring

A metadata filter for vector deletion. See Metadata Filtering for more information.

Deleting vectors with metadata filter is a O(N) operation that performs a full scan. Therefore, it might be slow for large indexes.

OptionsDeleteCommandOptions

namespacestring

Namespace to delete from. If not set, default namespace is used.

Response

ResponseDeleteResultrequired

deletednumberrequired

The number of vectors that were successfully deleted.

Delete by IDs Array

const response = await index.delete(["2", "3"]);// { deleted: 2 }

Delete Single ID

const response = await index.delete("2");// { deleted: 1 }

Delete by Prefix

const response = await index.delete({  prefix: "article_",});// { deleted: 3 }

Delete by Filter

const response = await index.delete({  filter: "age > 30",});// { deleted: 3 }