Struct vec_embed_store::SimilaritySearch

pub struct SimilaritySearch<'a> { /* private fields */ }

A builder-style struct for performing similarity searches on the embeddings.

Implementations

impl<'a> SimilaritySearch<'a>

pub fn new(embed_db: &'a EmbeddingsDb, similar_text: &str) -> Self

Creates a new SimilaritySearch instance.

Example

use vec_embed_store::{EmbeddingsDb, EmbeddingEngineOptions, TextChunk, SimilaritySearch};

let embed_db = EmbeddingsDb::new("path/to/db", EmbeddingEngineOptions::default()).await?;
let embed_text = "Example text";
let search = SimilaritySearch::new(&embed_db, embed_text);

pub fn threshold(self, threshold: f32) -> Self

Sets the similarity threshold for the search.

Example

use vec_embed_store::{EmbeddingsDb, EmbeddingEngineOptions, TextChunk, SimilaritySearch};

let search = SimilaritySearch::new(&embed_db, embed_text)
    .threshold(0.8);

pub fn limit(self, limit: usize) -> Self

Sets the maximum number of results to return.

Example

use vec_embed_store::{EmbeddingsDb, EmbeddingEngineOptions, TextChunk, SimilaritySearch};

let search = SimilaritySearch::new(&embed_db, embed_text)
    .limit(10);

pub async fn execute(self) -> Result<Vec<ComparedTextBlock>, EmbedDbError>

Executes the similarity search and returns the results.

Example

use vec_embed_store::{EmbeddingsDb, EmbeddingEngineOptions, TextChunk, SimilaritySearch};

let results = SimilaritySearch::new(&embed_db, embed_text)
    .threshold(0.8)
    .limit(10)
    .execute()
    .await?;

let results = SimilaritySearch::new(&embed_db, embed_text) .threshold(0.8) .limit(10) .execute() .await?;