Trait fastembed::EmbeddingBase

pub trait EmbeddingBase<S: AsRef<str>> {
    // Required methods
    fn embed(
        &self,
        texts: Vec<S>,
        batch_size: Option<usize>
    ) -> Result<Vec<Embedding>>;
    fn passage_embed(
        &self,
        texts: Vec<S>,
        batch_size: Option<usize>
    ) -> Result<Vec<Embedding>>;
    fn query_embed(&self, query: S) -> Result<Embedding>;
}

Base class for implemnting an embedding model

Required Methods

fn embed( &self, texts: Vec<S>, batch_size: Option<usize> ) -> Result<Vec<Embedding>>

The base embedding method for generating senytence embeddings

fn passage_embed( &self, texts: Vec<S>, batch_size: Option<usize> ) -> Result<Vec<Embedding>>

Generate sentence embeddings for passages, prefixed with “passage”

fn query_embed(&self, query: S) -> Result<Embedding>

Generate embeddings for user queries pre-fixed with “query”

Implementors

impl<S: AsRef<str> + Send + Sync> EmbeddingBase<S> for FlagEmbedding

EmbeddingBase implementation for FlagEmbedding Generic type to accept String, &str, OsString, &OsStr