Skip to main content

EmbeddingEngine

Struct EmbeddingEngine 

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

Embedding engine for converting text to vectors.

Wraps different embedding providers with a unified interface.

Implementations§

Source§

impl EmbeddingEngine

Source

pub fn new(dimensions: usize) -> Self

Create a new embedding engine with hash-based embeddings.

Use this for development, testing, or offline scenarios. Hash embeddings are fast and free but lower quality.

Source

pub fn from_env() -> Self

Create from environment variables.

Reads OPENAI_API_KEY. Falls back to hash embeddings if not set.

Source

pub fn from_env_required() -> Result<Self>

Create from environment, returning error if not configured.

Source

pub fn with_openai(api_key: impl Into<String>, model: Option<String>) -> Self

Create with OpenAI embeddings.

Source

pub fn with_openai_config( api_key: impl Into<String>, config: OpenAIConfig, ) -> Self

Create with OpenAI using custom configuration.

Source

pub fn with_provider(provider: Box<dyn EmbeddingProvider>) -> Self

Create with a custom provider.

Source

pub fn dimensions(&self) -> usize

Get the embedding dimensions.

Source

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

Generate an embedding for the given text (sync wrapper).

Source

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

Generate an embedding asynchronously.

Source

pub async fn embed_batch(&self, texts: &[&str]) -> Result<Vec<Vec<f32>>>

Generate embeddings for multiple texts.

Source

pub fn similarity(&self, a: &[f32], b: &[f32]) -> f32

Compute similarity between two embeddings.

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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> 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 = 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