Method SearchSimilarVectorsAsync

Namespace

LMKit.Data.Storage

Assembly

LM-Kit.NET.dll

SearchSimilarVectorsAsync(string, float[], uint, VectorRetrievalOptions, MetadataCollection, CancellationToken)

Asynchronously searches for vectors within the specified collection that are similar to a given query vector.

Task<List<(PointEntry Point, float Score)>> SearchSimilarVectorsAsync(string collectionIdentifier, float[] vector, uint limit, VectorRetrievalOptions options, MetadataCollection metadataFilter, CancellationToken cancellationToken = default)

Parameters

collectionIdentifier string

The name of the collection to search within.

vector float[]

The query vector used to compute similarity against stored vectors. The length of this vector should match the collection's defined vector size.

limit uint

The maximum number of similar vector entries to return.

options VectorRetrievalOptions

A combination of VectorRetrievalOptions flags indicating which parts of each matching entry (vector data, metadata, or both) are included in the results.

metadataFilter MetadataCollection

An optional collection of metadata key-value pairs to narrow the search scope. When specified, only vectors whose metadata matches all provided pairs are considered for similarity comparison.

cancellationToken CancellationToken

An optional token to cancel the asynchronous search operation.

Returns

Task<List<(PointEntry Point, float Score)>>

A task representing the asynchronous search operation. The task result is a list of tuples, where each tuple contains a PointEntry and a float similarity score. The similarity score is computed using the underlying vector similarity algorithm defined by the implementation.

SearchSimilarVectorsAsync(string, float[], uint, VectorRetrievalOptions, MetadataFilter, CancellationToken)

Asynchronously searches for vectors within the specified collection that are similar to a given query vector, restricted to entries whose metadata satisfies the given filter expression.

Task<List<(PointEntry Point, float Score)>> SearchSimilarVectorsAsync(string collectionIdentifier, float[] vector, uint limit, VectorRetrievalOptions options, MetadataFilter filter, CancellationToken cancellationToken = default)

Parameters

collectionIdentifier string

The name of the collection to search within.

vector float[]

The query vector used to compute similarity against stored vectors. The length of this vector should match the collection's defined vector size.

limit uint

The maximum number of similar vector entries to return.

options VectorRetrievalOptions

A combination of VectorRetrievalOptions flags indicating which parts of each matching entry (vector data, metadata, or both) are included in the results.

filter MetadataFilter

An optional filter expression to narrow the search scope. When specified, only vectors whose metadata satisfies the expression are considered for similarity comparison. Supports typed comparisons (eq, ne, gt, gte, lt, lte, in, nin, exists) combined with and/or; see MetadataFilter for the exact matching semantics. Pass null for no filtering.

cancellationToken CancellationToken

An optional token to cancel the asynchronous search operation.

Returns

Task<List<(PointEntry Point, float Score)>>

A task representing the asynchronous search operation. The task result is a list of tuples, where each tuple contains a PointEntry and a float similarity score.