Struct InitOptions

#[non_exhaustive]
pub struct InitOptions {
    pub model_name: EmbeddingModel,
    pub execution_providers: Vec<ExecutionProviderDispatch>,
    pub max_length: usize,
    pub cache_dir: PathBuf,
    pub show_download_progress: bool,
}

Options for initializing the TextEmbedding model

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

model_name: EmbeddingModel

execution_providers: Vec<ExecutionProviderDispatch>

max_length: usize

cache_dir: PathBuf

show_download_progress: bool

Implementations

impl InitOptions

pub fn new(model_name: EmbeddingModel) -> Self

Create a new InitOptions with the given model name

pub fn with_max_length(self, max_length: usize) -> Self

Set the maximum length of the input text

pub fn with_cache_dir(self, cache_dir: PathBuf) -> Self

Set the cache directory for the model files

pub fn with_execution_providers( self, execution_providers: Vec<ExecutionProviderDispatch>, ) -> Self

Set the execution providers for the model

pub fn with_show_download_progress(self, show_download_progress: bool) -> Self

Set whether to show download progress

Trait Implementations

impl Clone for InitOptions

fn clone(&self) -> InitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitOptions

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

Formats the value using the given formatter.

impl Default for InitOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<InitOptions> for InitOptionsUserDefined

Convert InitOptions to InitOptionsUserDefined

This is useful for when the user wants to use the same options for both the default and user-defined models

fn from(options: InitOptions) -> Self

Converts to this type from the input type.