Skip to main content

EmbeddingModel

Struct EmbeddingModel 

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

A loaded embedding model: tokenizer + encoder + the checkpoint’s own pooling rule.

Implementations§

Source§

impl EmbeddingModel

Source

pub fn from_gguf_path(path: impl AsRef<Path>) -> Result<Self, EmbedError>

Opens path and builds whichever embedding stack its general.architecture names, or refuses naming what is missing.

Source

pub fn architecture(&self) -> &str

Source

pub fn name(&self) -> &str

The checkpoint’s general.name, or its architecture when the file carries none. What /v1/embeddings reports as model.

Source

pub fn n_embd(&self) -> usize

Source

pub fn n_ctx_train(&self) -> usize

Source

pub fn pooling_type(&self) -> PoolingType

Source

pub fn token_ids(&self, text: &str) -> Vec<u32>

The exact ids the encoder will see for text: the tokenizer’s pieces wrapped in the model’s own special tokens. Public because /v1/embeddings has to report usage.prompt_tokens, and that number is this length — llama.cpp counts the specials too.

Source

pub fn embed(&self, text: &str, normalize: bool) -> Result<Vec<f32>, EmbedError>

Pooled embedding for text. normalize applies L2 normalization, which is what an OpenAI-compatible /v1/embeddings response is expected to carry and what llama.cpp’s server does by default; the raw pooled vector is what the graph produced.

Source

pub fn hidden_states(&self, text: &str) -> Result<Vec<f32>, EmbedError>

Un-pooled n_tokens × n_embd hidden states, for a caller that wants to pool differently (or not at all).

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.