Trait EmbeddingModel

pub trait EmbeddingModel:
    Clone
    + Sync
    + Send {
    const MAX_DOCUMENTS: usize;

    // Required methods
    fn ndims(&self) -> usize;
    fn embed_documents(
        &self,
        documents: impl IntoIterator<Item = String> + Send,
    ) -> impl Future<Output = Result<Vec<Embedding>, EmbeddingError>> + Send;

    // Provided method
    fn embed_document(
        &self,
        document: &str,
    ) -> impl Future<Output = Result<Embedding, EmbeddingError>> + Send
       where Self: Sync { ... }
}

Trait for embedding models that can generate embeddings for documents.

Required Associated Constants

const MAX_DOCUMENTS: usize

The maximum number of documents that can be embedded in a single request.

Required Methods

fn ndims(&self) -> usize

The number of dimensions in the embedding vector.

fn embed_documents( &self, documents: impl IntoIterator<Item = String> + Send, ) -> impl Future<Output = Result<Vec<Embedding>, EmbeddingError>> + Send

Embed multiple documents in a single request

Provided Methods

fn embed_document( &self, document: &str, ) -> impl Future<Output = Result<Embedding, EmbeddingError>> + Send

where Self: Sync,

Embed a single document

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl EmbeddingModel for rig::providers::cohere::EmbeddingModel

const MAX_DOCUMENTS: usize = 96usize

impl EmbeddingModel for rig::providers::openai::EmbeddingModel

const MAX_DOCUMENTS: usize = 1_024usize