Struct EmbedOptions 

pub struct EmbedOptions {
    pub model_name: Option<String>,
    pub cache_dir: Option<PathBuf>,
    pub max_batch_size: Option<usize>,
    pub show_download_progress: Option<bool>,
}

Options for constructing a FastEmbedModel.

All fields are optional; defaults produce a working model using BAAI/bge-small-en-v1.5 on CPU with fastembed’s built-in cache.

Fields

model_name: Option<String>

Fastembed model variant name (e.g. "BGESmallENV15").

Parsed via fastembed::EmbeddingModel::from_str. When None, defaults to fastembed::EmbeddingModel::BGESmallENV15.

cache_dir: Option<PathBuf>

Model cache directory. When None, fastembed uses its built-in cache (controlled by FASTEMBED_CACHE_DIR / HF_HOME env vars).

max_batch_size: Option<usize>

Maximum batch size for embedding. When None, fastembed uses its default (256).

show_download_progress: Option<bool>

Whether to display download progress when fetching models from HuggingFace. Defaults to true.

Trait Implementations

impl Clone for FastEmbedOptions

fn clone(&self) -> FastEmbedOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FastEmbedOptions

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

Formats the value using the given formatter.

impl Default for FastEmbedOptions

fn default() -> FastEmbedOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FastEmbedOptions

fn deserialize<__D>( __deserializer: __D, ) -> Result<FastEmbedOptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FastEmbedOptions

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.