Skip to main content

ContextForgeBuilder

Struct ContextForgeBuilder 

Source
pub struct ContextForgeBuilder { /* private fields */ }
Expand description

Builder for ContextForge.

Lexicon scoring is opt-in. By default the engine ranks on relevance (BM25, plus semantic when an embedding model is set) with no lexicon layer. Lexicon scoring applies a query-independent importance boost, which suits persona/importance use cases but degrades pure relevance retrieval — so it must be requested explicitly:

When both are set they compose additively via CompositeLexiconScorer.

§Example

use context_forge::{Config, ContextForge, ConfigLexiconScorer};
use std::path::PathBuf;

#[tokio::main]
async fn main() -> Result<(), context_forge::Error> {
    let mut config = Config::default();
    config.db_path = PathBuf::from("memory.db");

    // Relevance only, no lexicon (default):
    let cf = ContextForge::builder(config.clone()).build().await?;

    // Opt into the English importance scorer:
    let cf = ContextForge::builder(config.clone())
        .with_default_english_scorer()
        .build()
        .await?;

    // English + a persona scorer loaded from a TOML string:
    let toml = "[affirmations]\npatterns = [\"for the emperor\"]";
    let persona: ConfigLexiconScorer = toml.parse()?;
    let cf = ContextForge::builder(config)
        .with_default_english_scorer()
        .with_persona_scorer(persona)
        .build()
        .await?;

    Ok(())
}

Implementations§

Source§

impl ContextForgeBuilder

Source

pub fn new(config: Config) -> Self

Create a new builder with the given config.

Prefer ContextForge::builder over calling this directly.

Source

pub fn with_default_english_scorer(self) -> Self

Enable the built-in DefaultEnglishScorer (opt-in).

Applies a query-independent importance boost to entries containing plain-English commitment/confirmation/decision/correction markers (“i’ll fix it”, “confirmed”, “we decided”, “never mind”). This is the right signal for persona/importance use cases (surfacing what matters to a user) but hurts pure relevance retrieval — a factual-QA benchmark showed it lowering recall by burying evidence under important-sounding distractors. Off by default for that reason; enable it when importance, not just relevance, is what you want to rank on.

Source

pub fn with_persona_scorer(self, scorer: impl LexiconScorer + 'static) -> Self

Add a persona scorer (opt-in).

Typically a crate::ConfigLexiconScorer loaded from a domain-specific TOML file. If with_default_english_scorer was also called, the two compose additively via CompositeLexiconScorer and the engine applies a -1.0 floor after fusion; otherwise the persona scorer is used alone.

Source

pub async fn build(self) -> Result<ContextForge>

Open the database and build a ContextForge with the configured scorers.

Lexicon scoring is applied only if with_default_english_scorer and/or with_persona_scorer were called; with both, they compose via CompositeLexiconScorer. With neither, the engine ranks on relevance (BM25 + semantic) only.

§Errors

Returns an error if the database cannot be opened or migrations fail.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Fruit for T
where T: Send + Downcast,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more