Skip to main content

FastEmbedder

Struct FastEmbedder 

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

A local FastEmbed text model, available with the fastembed feature.

The model is downloaded on first initialization and cached for offline use. Ordinary git-vdb builds do not include FastEmbed or an ONNX runtime.

Implementations§

Source§

impl FastEmbedder

Source

pub fn try_new() -> Result<Self>

Initializes FastEmbed’s default English model.

Examples found in repository?
examples/text_fastembed.rs (line 8)
5fn main() -> git_vdb::Result<()> {
6    let temporary = tempfile::TempDir::new()?;
7    let db = open(temporary.path().join("documents.git"))?;
8    let docs = db.text_collection("docs", FastEmbedder::try_new()?)?;
9    docs.upsert_documents([
10        Document::new("git", "Git-native vector search"),
11        Document::new("fruit", "Fresh fruit at the market"),
12    ])?;
13    let hits = docs.search_text("versioned database search", 1)?;
14    println!("{}", hits[0].id);
15    Ok(())
16}
Source

pub fn try_with_model(model: FastEmbedModel) -> Result<Self>

Initializes one of FastEmbed’s supported text models.

Source

pub fn try_from_options(options: FastEmbedInitOptions) -> Result<Self>

Initializes a model with explicit FastEmbed cache, runtime, and length options.

Trait Implementations§

Source§

impl Embedder for FastEmbedder

Available on crate feature fastembed only.
Source§

fn model_id(&self) -> &str

Returns a stable identity such as a provider, model, and revision.
Source§

fn embed(&self, input: &[String]) -> Result<Vec<Vec<f32>>>

Embeds every input string in the same order.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

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

Source§

fn vzip(self) -> V