Module org.nasdanika.ai

Package org.nasdanika.ai

Interface SimilaritySearch<T,D extends Comparable<D>>

Type Parameters:

T - Search result and query type, e.g. String

D - Distance type, e.g. Float

public interface SimilaritySearch<T,D extends Comparable<D>>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	SimilaritySearch.EmbeddingsItem	Vector index item
static final record	SimilaritySearch.IndexId	Index id - item URI and embedding vector index for URIs with multiple vectors/chunks.

Method Summary

Modifier and Type	Method	Description
default <U> SimilaritySearch<U,D>	adapt(Function<U,T> mapper, Function<U,reactor.core.publisher.Mono<T>> asyncMapper)
static <D extends Comparable<D>> SimilaritySearch<List<List<Float>>,D>	adapt(SimilaritySearch<List<Float>,D> vectorSearch)	Adapts a single vector search to multi-vector search
static <D extends Comparable<D>> SimilaritySearch<String,D>	embeddingsSearch(SimilaritySearch<List<List<Float>>,D> multiVectorSearch, Embeddings embeddings)	Computes embeddings and uses them for similarity search in a multi-vector search.
List<SearchResult<D>>	find(T query, int numberOfItems)	Finds items closest to the query
reactor.core.publisher.Mono<List<SearchResult<D>>>	findAsync(T query, int numberOfItems)	Finds items closest to the query
static SimilaritySearch<List<Float>,Float>	from(com.github.jelmerk.hnswlib.core.Index<SimilaritySearch.IndexId,float[],SimilaritySearch.EmbeddingsItem,Float> index)
static SimilaritySearch<List<Float>,Float>	from(com.github.jelmerk.hnswlib.core.Index<SimilaritySearch.IndexId,float[],SimilaritySearch.EmbeddingsItem,Float> index, Function<float[],float[]> normalizer)

Method Details

find

List<SearchResult<D>> find(T query,
 int numberOfItems)

Finds items closest to the query

Parameters:

query -

numberOfItems - Number of items to return

Returns:

findAsync

reactor.core.publisher.Mono<List<SearchResult<D>>> findAsync(T query,
 int numberOfItems)

Finds items closest to the query

Parameters:

query -

numberOfItems - Number of items to return

Returns:

adapt

default <U> SimilaritySearch<U,D> adapt(Function<U,T> mapper,
 Function<U,reactor.core.publisher.Mono<T>> asyncMapper)

embeddingsSearch

static <D extends Comparable<D>>
SimilaritySearch<String,D> embeddingsSearch(SimilaritySearch<List<List<Float>>,D> multiVectorSearch,
 Embeddings embeddings)

Computes embeddings and uses them for similarity search in a multi-vector search.

Type Parameters:

D -

Parameters:

multiVectorSearch -

embeddings -

Returns:

adapt

static <D extends Comparable<D>>
SimilaritySearch<List<List<Float>>,D> adapt(SimilaritySearch<List<Float>,D> vectorSearch)

Adapts a single vector search to multi-vector search

from

static SimilaritySearch<List<Float>,Float> from(com.github.jelmerk.hnswlib.core.Index<SimilaritySearch.IndexId,float[],SimilaritySearch.EmbeddingsItem,Float> index)

from

static SimilaritySearch<List<Float>,Float> from(com.github.jelmerk.hnswlib.core.Index<SimilaritySearch.IndexId,float[],SimilaritySearch.EmbeddingsItem,Float> index,
 Function<float[],float[]> normalizer)