Trait EmbeddingService

Source

pub trait EmbeddingService: Send + Sync {
    // Required methods
    fn embed(&self, text: &str) -> Result<Embedding>;
    fn embed_batch(&self, texts: &[&str]) -> Result<Vec<Embedding>>;
    fn dimension(&self) -> usize;

    // Provided method
    fn validate_embedding(&self, embedding: &Embedding) -> Result<()> { ... }
}

Expand description

Embedding service trait for generating vector representations of text.

This trait defines the contract for any embedding provider. Implementations must be thread-safe (Send + Sync) to allow concurrent embedding operations.

§Implementing a Custom Provider

use pulsedb::embedding::EmbeddingService;
use pulsedb::{Embedding, Result};

struct MyEmbeddingService {
    client: MyApiClient,
    dimension: usize,
}

impl EmbeddingService for MyEmbeddingService {
    fn embed(&self, text: &str) -> Result<Embedding> {
        Ok(self.client.get_embedding(text)?)
    }

    fn embed_batch(&self, texts: &[&str]) -> Result<Vec<Embedding>> {
        Ok(self.client.get_embeddings(texts)?)
    }

    fn dimension(&self) -> usize {
        self.dimension
    }
}