Struct Config 

pub struct Config {
    pub database_path: PathBuf,
    pub embedding_model: String,
    pub similarity_threshold: f64,
    pub recency_weight: f64,
    pub hybrid: bool,
    pub decay_refresh_days: f64,
    pub promotion_threshold: i64,
    pub prune_retrieval_limit: i64,
    pub prune_min_age_days: f64,
}

Configuration values with priority: defaults < config file < env vars.

Provides configuration options for the memory store, including database paths, embedding model selection, and search parameters.

Example

use vipune::Config;

let config = Config::default();
println!("Database path: {:?}", config.database_path);

Fields

database_path: PathBuf

Path to the SQLite database file (e.g., ~/.vipune/memories.db).

embedding_model: String

HuggingFace embedding model identifier (e.g., BAAI/bge-small-en-v1.5).

similarity_threshold: f64

Minimum similarity score (0.0-1.0) required for search results to be returned.

recency_weight: f64

Weight applied to recency in search ranking (0.0 = ignore time, 1.0 = prioritize recent).

hybrid: bool

Whether to use hybrid search (semantic + BM25) by default.

decay_refresh_days: f64

Cap (in days) on the recency refresh used in decay scoring.

promotion_threshold: i64

Retrieval-count threshold (>=) for promoting a candidate to active.

prune_retrieval_limit: i64

Prune eligibility: a candidate with retrieval_count < N is prunable.

prune_min_age_days: f64

Prune eligibility: a candidate older than T days is prunable.

Implementations

impl Config

pub fn load() -> Result<Self, Error>

Load configuration with defaults, file values, and environment overrides.

pub fn ensure_directories(&self) -> Result<(), Error>

Ensure the parent directory of the database path exists.

Model files are cached in the HuggingFace Hub cache (~/.cache/huggingface/hub/ by default), which hf-hub creates on demand — vipune does not pre-create any model directory.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.