Delete - Upstash Documentation

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

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

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

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

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

string[] | number[] | string | number

required

One or more vector IDs to delete.

object

required

Hide child attributes

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

string[] | number[] | string | number

One or more vector IDs to delete.

string

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

string

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.

DeleteCommandOptions

Hide child attributes

string

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

Response

DeleteResult

required

Hide child attributes

number

required

The number of vectors that were successfully deleted.

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

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

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

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

​Arguments

​Response

Arguments

Response