Trait EmbeddingModel 

pub trait EmbeddingModel: ModelInfo {
    // Required methods
    fn embed<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        texts: &'life1 [&'life2 str],
    ) -> Pin<Box<dyn Future<Output = Result<EmbedResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn dimensions(&self) -> u32;

    // Provided method
    fn warmup<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: Sync + 'async_trait,
             'life0: 'async_trait { ... }
}

A model that produces dense vector embeddings from text.

Required Methods

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

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Embed a batch of text strings into dense vectors.

Returns an EmbedResult whose vectors holds one Vec<f32> per input text, each with dimensions() elements.

fn dimensions(&self) -> u32

The dimensionality of the embedding vectors produced by this model.

Provided Methods

fn warmup<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Optional warmup hook (e.g. load weights into memory on first access). The default is a no-op.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl EmbeddingModel for CandleEmbeddingModel

impl EmbeddingModel for GeminiEmbeddingModel

impl EmbeddingModel for InstrumentedEmbeddingModel

impl EmbeddingModel for LlamaCppEmbeddingModel

impl EmbeddingModel for OpenAIEmbeddingModel

impl EmbeddingModel for VertexAiEmbeddingModel