Trait EmbeddingModel 

pub trait EmbeddingModel: WasmCompatSend + WasmCompatSync {
    type Client;

    const MAX_DOCUMENTS: usize;

    // Required methods
    fn make(
        client: &Self::Client,
        model: impl Into<String>,
        dims: Option<usize>,
    ) -> Self;
    fn ndims(&self) -> usize;
    fn embed_texts(
        &self,
        texts: impl IntoIterator<Item = String> + WasmCompatSend,
    ) -> impl Future<Output = Result<Vec<Embedding>, EmbeddingError>> + WasmCompatSend;

    // Provided method
    fn embed_text(
        &self,
        text: &str,
    ) -> impl Future<Output = Result<Embedding, EmbeddingError>> + WasmCompatSend { ... }
}

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 Associated Types

type Client

Required Methods

fn make( client: &Self::Client, model: impl Into<String>, dims: Option<usize>, ) -> Self

fn ndims(&self) -> usize

The number of dimensions in the embedding vector.

fn embed_texts( &self, texts: impl IntoIterator<Item = String> + WasmCompatSend, ) -> impl Future<Output = Result<Vec<Embedding>, EmbeddingError>> + WasmCompatSend

Embed multiple text documents in a single request

Provided Methods

fn embed_text( &self, text: &str, ) -> impl Future<Output = Result<Embedding, EmbeddingError>> + WasmCompatSend

Embed a single text 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<T> EmbeddingModel for rig::providers::azure::EmbeddingModel<T>

where T: HttpClientExt + Default + Clone,

const MAX_DOCUMENTS: usize = 1_024usize

type Client = Client<AzureExt, T>

impl<T> EmbeddingModel for rig::providers::cohere::embeddings::EmbeddingModel<T>

where T: HttpClientExt + Clone + WasmCompatSend + WasmCompatSync + 'static,

const MAX_DOCUMENTS: usize = 96usize

type Client = Client<CohereExt, T>

impl<T> EmbeddingModel for rig::providers::gemini::embedding::EmbeddingModel<T>

where T: Clone + HttpClientExt,

const MAX_DOCUMENTS: usize = 1_024usize

type Client = Client<GeminiExt, T>

impl<T> EmbeddingModel for rig::providers::mistral::embedding::EmbeddingModel<T>

where T: HttpClientExt + Clone,

const MAX_DOCUMENTS: usize = 1_024usize

type Client = Client<MistralExt, T>

impl<T> EmbeddingModel for rig::providers::ollama::EmbeddingModel<T>

where T: HttpClientExt + Clone + 'static,

const MAX_DOCUMENTS: usize = 1_024usize

type Client = Client<OllamaExt, T>

impl<T> EmbeddingModel for rig::providers::openai::embedding::EmbeddingModel<T>

where T: HttpClientExt + Clone + Debug + Default + Send + 'static,

const MAX_DOCUMENTS: usize = 1_024usize

type Client = Client<OpenAIResponsesExt, T>

impl<T> EmbeddingModel for rig::providers::together::embedding::EmbeddingModel<T>

where T: HttpClientExt + Default + Clone + Send + 'static,

const MAX_DOCUMENTS: usize = 1_024usize

type Client = Client<TogetherExt, T>

impl<T> EmbeddingModel for rig::providers::voyageai::EmbeddingModel<T>

where T: HttpClientExt + Clone + Debug + Default + 'static,

const MAX_DOCUMENTS: usize = 1_024usize

type Client = Client<VoyageExt, T>