Skip to main content

EmbeddingsSession

Struct EmbeddingsSession 

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

An embeddings-oriented Session producing dense vectors for text input.

Dereferences to Session.

Implementations§

Source§

impl EmbeddingsSession

Source

pub async fn new(model: &Model) -> Result<EmbeddingsSession, FoundryLocalError>

Open an embeddings session on a loaded model.

Returns FoundryLocalError::Validation if the model’s task is not "embeddings".

Source

pub async fn embed( &self, input: impl Into<String>, ) -> Result<Vec<f32>, FoundryLocalError>

Embed a single text input, returning its dense vector.

Source

pub async fn embed_batch( &self, inputs: Vec<String>, ) -> Result<Vec<Vec<f32>>, FoundryLocalError>

Embed a batch of text inputs, returning one dense vector per input (in order).

Source

pub fn into_session(self) -> Session

Consume this handle, yielding the underlying base Session.

Methods from Deref<Target = Session>§

Source

pub async fn process_request( &self, request: Request, ) -> Result<Response, FoundryLocalError>

Process a request and return the complete response.

Runs on a blocking worker thread; the returned future resolves when generation finishes.

§Cancellation

The returned future is cancel-on-drop: if it is dropped before it resolves — for example via tokio::time::timeout, tokio::select!, or aborting the task — the in-flight native request is cancelled and generation stops as soon as possible rather than running to completion on the detached worker. This mirrors the drop-cancels-generation behaviour of process_streaming_request.

Source

pub fn process_streaming_request(&self, request: Request) -> ItemStream

Process a request, streaming each output Item as it is produced.

The returned ItemStream yields items until generation completes; dropping it cancels generation.

Source

pub async fn set_options( &self, options: RequestOptions, ) -> Result<(), FoundryLocalError>

Apply session-scoped options that persist across subsequent requests.

Source

pub fn create_input_queue(&self) -> Result<ItemQueue, FoundryLocalError>

Create an ItemQueue for streaming incremental input into a request.

Attach the returned queue to a Request via Request::with_input_queue, then push items as they become available.

Trait Implementations§

Source§

impl Clone for EmbeddingsSession

Source§

fn clone(&self) -> EmbeddingsSession

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Deref for EmbeddingsSession

Source§

type Target = Session

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Session

Dereferences the value.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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