Struct EmbeddingModelRequest 

pub struct EmbeddingModelRequest<M: EmbeddingModel> {
    pub model: M,
    /* private fields */
}

Options for embedding generation requests to be used by embed.

Fields

model: M

The embedding model to use for generating embeddings.

Implementations

impl<M: EmbeddingModel> EmbeddingModelRequest<M>

pub fn builder() -> EmbeddingModelRequestBuilder<M>

Creates a new builder for constructing an EmbeddingModelRequest.

This method initiates the type-state builder pattern, starting with the ModelStage where you must specify the embedding model.

pub async fn embed(&self) -> Result<EmbeddingModelResponse>

Generates embeddings for the input text.

Returns

A Result containing a vector of embedding vectors, where each embedding is a vector of floats, or an error if the embedding request fails.

Trait Implementations

impl<M: Clone + EmbeddingModel> Clone for EmbeddingModelRequest<M>

fn clone(&self) -> EmbeddingModelRequest<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug + EmbeddingModel> Debug for EmbeddingModelRequest<M>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<M: EmbeddingModel> Deref for EmbeddingModelRequest<M>

type Target = EmbeddingModelOptions

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<M: EmbeddingModel> DerefMut for EmbeddingModelRequest<M>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.