CachedEmbeddings

Struct CachedEmbeddings 

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

A caching wrapper for embedding providers.

This wrapper adds a caching layer on top of any embedding provider to avoid regenerating embeddings for the same text. This is especially useful when:

  • The same queries or texts are embedded multiple times
  • Embeddings are expensive to compute (API calls, local models)
  • You want to reduce API costs and latency

§Cache Strategy

  • Uses a simple in-memory HashMap with RwLock for thread-safety
  • Cache key is the exact text string
  • No cache eviction (unbounded cache - use with caution for large datasets)
  • Thread-safe for concurrent access

§Example

use ceylon_next::memory::vector::{EmbeddingProvider, CachedEmbeddings};
use std::sync::Arc;

#[tokio::main]
async fn main() {
    // Wrap any embedding provider with caching
    // let base_provider = OpenAIEmbeddings::new("api-key");
    // let cached = CachedEmbeddings::new(Arc::new(base_provider));

    // First call - computes embedding
    // let embedding1 = cached.embed("hello world").await.unwrap();

    // Second call - returns cached result
    // let embedding2 = cached.embed("hello world").await.unwrap();
}

Implementations§

Source§

impl CachedEmbeddings

Source

pub fn new(provider: Arc<dyn EmbeddingProvider>) -> Self

Creates a new cached embedding provider.

§Arguments
  • provider - The underlying embedding provider to wrap
Source

pub fn with_capacity( provider: Arc<dyn EmbeddingProvider>, capacity: usize, ) -> Self

Creates a new cached embedding provider with pre-allocated cache capacity.

§Arguments
  • provider - The underlying embedding provider to wrap
  • capacity - Initial capacity for the cache
Source

pub async fn cache_size(&self) -> usize

Returns the number of cached embeddings.

Source

pub async fn clear_cache(&self)

Clears all cached embeddings.

Source

pub async fn is_cached(&self, text: &str) -> bool

Checks if a text is in the cache.

Source

pub async fn preload(&self, texts: &[String]) -> Result<(), String>

Preloads embeddings into the cache.

This can be useful for warming up the cache with known queries.

§Arguments
  • texts - Texts to preload into cache

Trait Implementations§

Source§

impl EmbeddingProvider for CachedEmbeddings

Source§

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

Generates an embedding vector for the given text. Read more
Source§

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

Generates embeddings for multiple texts in batch. Read more
Source§

fn dimension(&self) -> usize

Returns the dimensionality of the embeddings produced by this provider.
Source§

fn model_name(&self) -> &str

Returns the model name or identifier.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,