Trait rig::embeddings::EmbeddingModel

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

    // Required method
    fn embed_documents(
        &self,
        documents: Vec<String>,
    ) -> 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 embed_documents( &self, documents: Vec<String>, ) -> 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

Object Safety

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