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 methods
    fn embed_text(
        &self,
        text: &str,
    ) -> impl Future<Output = Result<Embedding, EmbeddingError>> + WasmCompatSend { ... }
    fn embed_texts_with_usage(
        &self,
        texts: impl IntoIterator<Item = String> + WasmCompatSend,
    ) -> impl Future<Output = Result<EmbeddingResponse, EmbeddingError>> + WasmCompatSend { ... }
    fn embed_text_with_usage(
        &self,
        text: &str,
    ) -> impl Future<Output = Result<EmbeddingResponse, 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

Provider client type used to construct this embedding model.

Required Methods

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

Construct a model handle from a provider client, model identifier, and optional dimensions.

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.

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

Embed multiple text documents in a single request and return token usage.

The default implementation delegates to EmbeddingModel::embed_texts and returns zero-valued usage. Providers that expose usage information from their embedding API should override this method.

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

Embed a single text document and return token usage.

The default implementation delegates to EmbeddingModel::embed_texts_with_usage.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl EmbeddingModel for MockEmbeddingModel

Available on crate feature test-utils only.

const MAX_DOCUMENTS: usize = 5

type Client = Nothing

impl<H> EmbeddingModel for rig_core::providers::copilot::EmbeddingModel<H>

where Client<H>: HttpClientExt + Clone + Debug + WasmCompatSend + WasmCompatSync + 'static, H: Clone + Default + Debug + WasmCompatSend + WasmCompatSync + 'static,

const MAX_DOCUMENTS: usize = 1024

type Client = Client<CopilotExt, H>

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

where T: Clone + HttpClientExt + 'static,

const MAX_DOCUMENTS: usize = 1024

type Client = Client<GeminiExt, T>

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

where T: HttpClientExt + Clone + 'static,

const MAX_DOCUMENTS: usize = MAX_DOCUMENTS

type Client = Client<MistralExt, T>

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

where T: HttpClientExt + Clone + 'static,

const MAX_DOCUMENTS: usize = 1024

type Client = Client<OllamaExt, T>

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

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

const MAX_DOCUMENTS: usize = 1024

type Client = Client<VoyageExt, T>

impl<T> EmbeddingModel for rig_core::providers::llamafile::EmbeddingModel<T>

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

const MAX_DOCUMENTS: usize = 1024

type Client = Client<LlamafileExt, T>

impl<T> EmbeddingModel for rig_core::providers::openrouter::embedding::EmbeddingModel<T>

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

const MAX_DOCUMENTS: usize = 1024

type Client = Client<OpenRouterExt, T>

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

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

const MAX_DOCUMENTS: usize = 96

type Client = Client<CohereExt, T>

impl<T> EmbeddingModel for rig_core::providers::azure::EmbeddingModel<T>

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

const MAX_DOCUMENTS: usize = 1024

type Client = Client<AzureExt, T>

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

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

const MAX_DOCUMENTS: usize = 1024

type Client = Client<TogetherExt, T>