Skip to main content

EmbeddingProvider

engram::embedding

Trait EmbeddingProvider 

Source 
pub trait EmbeddingProvider: Send + Sync {
    // Required methods
    fn embed<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        texts: &'life1 [&'life2 str],
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, MemoryError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn dimensions(&self) -> usize;
}
Expand description

Pluggable text-embedding provider.

Implementations MUST be Send + Sync so that Arc<dyn EmbeddingProvider> can be shared across async task boundaries.

Required Methods§

Source

fn embed<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, texts: &'life1 [&'life2 str], ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, MemoryError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Embed a batch of texts.

Returns one vector per input text, in the same order. Each returned vector has length self.dimensions().

Source

fn dimensions(&self) -> usize

The dimensionality of all vectors produced by this provider.

Implementors§