Interface DeleteOptions

Options for a vector store delete operation.

DeleteOptions

interface DeleteOptions {
    filter?: MetadataFilter;
    deleteAll?: boolean;
    customParams?: Record<string, any>;
}

Properties

filter? deleteAll? customParams?

Properties

Optional filter

filter?: MetadataFilter

Optional: Delete documents matching this metadata filter. If ids are also provided, the behavior (AND/OR) might be store-specific or could be an error. Typically, deletion is by IDs OR by filter.

Optional deleteAll

deleteAll?: boolean

If true (and ids and filter are empty), attempt to delete all documents in the specified collection. This is a destructive operation and should be used with extreme caution.

Optional customParams

customParams?: Record<string, any>

Provider-specific parameters for the delete operation.

Settings

Member Visibility

Theme

On This Page

filterdeleteAllcustomParams