ExtensionsVectorData lodestarvectorstorecollection deleteasync - CyrilB1531/lodestar GitHub Wiki

Home › ExtensionsVectorData › Vector store

LodestarVectorStoreCollection.DeleteAsync

Removes records by key.

public Task DeleteAsync(TKey key, CancellationToken cancellationToken = default)
public Task DeleteAsync(IEnumerable<TKey> keys, CancellationToken cancellationToken = default)

Parameters — key is one record's key. keys is several. cancellationToken is accepted for the abstraction's sake and not observed.

Returns — a completed Task.

Exceptions — ArgumentNullException when key or keys is null, or when keys holds a null key. The batch overload reads and checks every key before it removes any, so a refused batch removes nothing.

Example — a deleted record is gone from reads and from searches alike.

using Lodestar.Extensions.VectorData;
using Microsoft.Extensions.VectorData;

static async Task<string> RemoveAsync()
{
    using var notes = new LodestarVectorStoreCollection<string, Note>("notes");
    await notes.UpsertAsync([
        new Note { Id = "a", Text = "the cat", Embedding = new float[] { 1f, 0f, 0f } },
        new Note { Id = "b", Text = "the dog", Embedding = new float[] { 0f, 1f, 0f } },
        new Note { Id = "c", Text = "the elephant", Embedding = new float[] { 0f, 0f, 1f } },
    ]);

    await notes.DeleteAsync("a");
    await notes.DeleteAsync(["c", "never-written"]);

    List<VectorSearchResult<Note>> left = await notes
        .SearchAsync(new float[] { 1f, 0f, 0f }, 3)
        .ToListAsync();

    return string.Join(",", left.Select(hit => hit.Record.Id));
}

string remaining = RemoveAsync().GetAwaiter().GetResult();  // => b

Remarks — a key that is not held is not an error, in either overload. A delete that removed nothing leaves the indexes as they were, so it costs no rebuild; one that removed anything marks them stale, and the next search rebuilds them without the deleted records. The positions of the records that remain are recomputed with them, so no result ever maps back to the wrong key.

Deleting the last record does not delete the collection: LodestarVectorStoreCollection.CollectionExistsAsync still answers true. LodestarVectorStoreCollection.EnsureCollectionDeletedAsync is the member that does.

Applies to — net10.0, netstandard2.0.

See also — LodestarVectorStoreCollection.UpsertAsync, LodestarVectorStoreCollection.

⚠️ **GitHub.com Fallback** ⚠️