Struct Client 

pub struct Client;

The rig-fastembed client.

Use this as your main entrypoint for any rig-fastembed functionality.

Implementations

impl Client

pub fn new() -> Self

Create a new rig-fastembed client.

pub fn embedding_model(&self, model: &FastembedModel) -> EmbeddingModel

Create an embedding model with the given name. Note: default embedding dimension of 0 will be used if model is not known. If this is the case, it’s better to use function embedding_model_with_ndims

Example

use rig_fastembed::{Client, FastembedModel};

// Initialize the `rig-fastembed` client
let fastembed_client = rig_fastembed::Client::new();

let embedding_model = fastembed_client.embedding_model(&FastembedModel::AllMiniLML6V2Q);

pub fn embeddings<D: Embed>( &self, model: &EmbeddingModel, ) -> EmbeddingsBuilder<EmbeddingModel, D>

Create an embedding builder with the given embedding model.

Example

use rig_fastembed::{Client, FastembedModel};

// Initialize the Fastembed client
let fastembed_client = Client::new();

let embeddings = fastembed_client.embeddings(FastembedModel::AllMiniLML6V2Q)
    .simple_document("doc0", "Hello, world!")
    .simple_document("doc1", "Goodbye, world!")
    .build()
    .await
    .expect("Failed to embed documents");

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.