LocalEmbeddingProvider

Struct LocalEmbeddingProvider 

Source
pub struct LocalEmbeddingProvider { /* private fields */ }
Expand description

Local embedding provider for offline and privacy-focused deployments

Supports local inference with Hugging Face models or custom implementations. Ideal for:

  • Privacy-sensitive applications
  • High-volume processing without API costs
  • Offline or air-gapped environments
  • Custom fine-tuned models
  • sentence-transformers/all-MiniLM-L6-v2: 384 dims, fast and lightweight
  • sentence-transformers/all-mpnet-base-v2: 768 dims, high quality
  • sentence-transformers/all-distilroberta-v1: 768 dims, balanced

§Example

use rrag::prelude::*;
use std::sync::Arc;

let provider = Arc::new(LocalEmbeddingProvider::new(
    "sentence-transformers/all-MiniLM-L6-v2",
    384
));

let service = EmbeddingService::new(provider);
let embeddings = service.embed_documents(&[
    Document::new("First document"),
    Document::new("Second document")
]).await?;

assert_eq!(embeddings.len(), 2);

§Performance Notes

  • Uses parallel processing for batch operations
  • Smaller batch sizes recommended (16-32) for memory efficiency
  • CPU-intensive; consider GPU acceleration for large workloads

Implementations§

Source§

impl LocalEmbeddingProvider

Source

pub fn new(model_path: impl Into<String>, dimensions: usize) -> Self

Create a new local embedding provider

Trait Implementations§

Source§

impl EmbeddingProvider for LocalEmbeddingProvider

Source§

fn name(&self) -> &str

Provider name (e.g., “openai”, “huggingface”)
Source§

fn supported_models(&self) -> Vec<&str>

Supported models for this provider
Source§

fn max_batch_size(&self) -> usize

Maximum batch size supported
Source§

fn embedding_dimensions(&self) -> usize

Embedding dimensions for the current model
Source§

fn embed_text<'life0, 'life1, 'async_trait>( &'life0 self, text: &'life1 str, ) -> Pin<Box<dyn Future<Output = RragResult<Embedding>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generate embedding for a single text
Source§

fn embed_batch<'life0, 'async_trait>( &'life0 self, requests: Vec<EmbeddingRequest>, ) -> Pin<Box<dyn Future<Output = RragResult<EmbeddingBatch>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Generate embeddings for multiple texts (more efficient)
Source§

fn health_check<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = RragResult<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Health check for the provider

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,