Interface IVectorStore

Namespace

Mythosia.VectorDb

Assembly

Mythosia.VectorDb.Abstractions.dll

public interface IVectorStore

Methods

CountAsync(VectorFilter?, CancellationToken)

Task<long> CountAsync(VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

filter VectorFilter

cancellationToken CancellationToken

Returns

Task<long>

DeleteAsync(string, VectorFilter?, CancellationToken)

Task DeleteAsync(string id, VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

id string

filter VectorFilter

cancellationToken CancellationToken

Returns

Task

DeleteByFilterAsync(VectorFilter, CancellationToken)

Task DeleteByFilterAsync(VectorFilter filter, CancellationToken cancellationToken = default)

Parameters

filter VectorFilter

cancellationToken CancellationToken

Returns

Task

GetAsync(string, VectorFilter?, CancellationToken)

Task<VectorRecord?> GetAsync(string id, VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

id string

filter VectorFilter

cancellationToken CancellationToken

Returns

Task<VectorRecord>

GetBatchAsync(IEnumerable<string>, VectorFilter?, CancellationToken)

Task<IReadOnlyList<VectorRecord>> GetBatchAsync(IEnumerable<string> ids, VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

ids IEnumerable<string>

filter VectorFilter

cancellationToken CancellationToken

Returns

Task<IReadOnlyList<VectorRecord>>

HybridSearchAsync(float[], string, int, VectorFilter?, CancellationToken)

Task<IReadOnlyList<VectorSearchResult>> HybridSearchAsync(float[] denseVector, string query, int topK = 5, VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

denseVector float[]

query string

topK int

filter VectorFilter

cancellationToken CancellationToken

Returns

Task<IReadOnlyList<VectorSearchResult>>

ReplaceByFilterAsync(VectorFilter, IReadOnlyList<VectorRecord>, CancellationToken)

Task ReplaceByFilterAsync(VectorFilter filter, IReadOnlyList<VectorRecord> records, CancellationToken cancellationToken = default)

Parameters

filter VectorFilter

records IReadOnlyList<VectorRecord>

cancellationToken CancellationToken

Returns

Task

SearchAsync(float[], int, VectorFilter?, CancellationToken)

Task<IReadOnlyList<VectorSearchResult>> SearchAsync(float[] queryVector, int topK = 5, VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

queryVector float[]

topK int

filter VectorFilter

cancellationToken CancellationToken

Returns

Task<IReadOnlyList<VectorSearchResult>>

UpsertAsync(VectorRecord, CancellationToken)

Task UpsertAsync(VectorRecord record, CancellationToken cancellationToken = default)

Parameters

record VectorRecord

cancellationToken CancellationToken

Returns

Task

UpsertBatchAsync(IEnumerable<VectorRecord>, CancellationToken)

Task UpsertBatchAsync(IEnumerable<VectorRecord> records, CancellationToken cancellationToken = default)

Parameters

records IEnumerable<VectorRecord>

cancellationToken CancellationToken

Returns

Task

VerifyConnectionAsync(CancellationToken)

Task VerifyConnectionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task