Skip to main content

EmbeddingClient

Struct EmbeddingClient 

Source
pub struct EmbeddingClient { /* private fields */ }
Expand description

The llama.cpp embedding client.

EmbeddingClient loads a GGUF embedding model on a dedicated worker thread and exposes it through Rig’s rig::embeddings::EmbeddingModel trait. Create one with EmbeddingClient::from_gguf.

use rig::embeddings::EmbeddingModel;

let client = rig_llama_cpp::EmbeddingClient::from_gguf(
    "path/to/embedding-model.gguf",
    99,   // n_gpu_layers
    8192, // n_ctx
)?;
let model = client.embedding_model("local");
let embedding = model.embed_text("Hello, world!").await?;
println!("dims: {}", embedding.vec.len());

Implementations§

Source§

impl EmbeddingClient

Source

pub fn from_gguf( model_path: impl Into<String>, n_gpu_layers: u32, n_ctx: u32, ) -> Result<Self, LoadError>

Load a GGUF embedding model and start the embedding worker thread.

§Arguments
  • model_path — Path to a .gguf embedding model file.
  • n_gpu_layers — Number of layers to offload to the GPU (u32::MAX for all).
  • n_ctx — Context window size in tokens.
§Errors

Returns a LoadError if the backend fails to initialise or the model cannot be loaded.

Source

pub fn embedding_model(&self, model: impl Into<String>) -> EmbeddingModelHandle

Create an embedding model handle from this client.

Source

pub fn embedding_model_with_ndims( &self, model: impl Into<String>, ndims: usize, ) -> EmbeddingModelHandle

Create an embedding model handle with explicit dimensions.

Trait Implementations§

Source§

impl Drop for EmbeddingClient

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,