Struct OpenAICompatibleEmbeddingModelBuilder

pub struct OpenAICompatibleEmbeddingModelBuilder<const WITH_NAME: bool> { /* private fields */ }

A builder for an openai compatible embedding model.

Implementations

impl OpenAICompatibleEmbeddingModelBuilder<false>

pub fn new() -> Self

Creates a new builder

impl<const WITH_NAME: bool> OpenAICompatibleEmbeddingModelBuilder<WITH_NAME>

pub fn with_model( self, model: impl ToString, ) -> OpenAICompatibleEmbeddingModelBuilder<true>

Set the name of the model to use.

pub fn with_text_embedding_3_small( self, ) -> OpenAICompatibleEmbeddingModelBuilder<true>

Set the model to text-embedding-3-small. This is the smallest model available with a score of 62.3% on mteb and a max sequence length of 8191

pub fn with_text_embedding_3_large( self, ) -> OpenAICompatibleEmbeddingModelBuilder<true>

Set the model to text-embedding-3-large. This is the smallest model available with a score of 64.6% on mteb and a max sequence length of 8191

pub fn with_client(self, client: OpenAICompatibleClient) -> Self

Set the client used to make requests to the OpenAI API.

impl OpenAICompatibleEmbeddingModelBuilder<true>

pub fn build(self) -> OpenAICompatibleEmbeddingModel

Build the model.

Trait Implementations

impl<const WITH_NAME: bool> Debug for OpenAICompatibleEmbeddingModelBuilder<WITH_NAME>

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

Formats the value using the given formatter.

impl<const WITH_NAME: bool> Default for OpenAICompatibleEmbeddingModelBuilder<WITH_NAME>

fn default() -> OpenAICompatibleEmbeddingModelBuilder<WITH_NAME>

Returns the “default value” for a type.

impl ModelBuilder for OpenAICompatibleEmbeddingModelBuilder<true>

type Model = OpenAICompatibleEmbeddingModel

The model that this trait creates.

type Error = Infallible

An error that can occur when creating the model.

async fn start_with_loading_handler( self, _: impl FnMut(ModelLoadingProgress) + Send + Sync + 'static, ) -> Result<Self::Model, Self::Error>

Start the model with a loading handler.

fn requires_download(&self) -> bool

Check if the model will need to be downloaded before use (default: false)

fn start(self) -> impl Future<Output = Result<Self::Model, Self::Error>>

where Self: Sized,

Start the model.