Skip to main content

QueryExpansionEngine

Struct QueryExpansionEngine 

Source
pub struct QueryExpansionEngine {
    pub config: ExpansionConfig,
    pub synonym_db: HashMap<String, SynonymEntry>,
    pub context_terms: HashMap<String, Vec<String>>,
    pub expansions_performed: u64,
    pub total_terms_added: u64,
}
Expand description

Production-grade query expansion engine.

§Thread Safety

The engine holds no shared state — callers that need concurrent access should wrap it in a Mutex / RwLock (write lock only for expand_query because it mutates the counters).

Fields§

§config: ExpansionConfig

User-supplied configuration.

§synonym_db: HashMap<String, SynonymEntry>

Synonym / hypernym / hyponym registry, keyed by lowercased term.

§context_terms: HashMap<String, Vec<String>>

Context-term map: trigger word → list of related terms.

§expansions_performed: u64

Total number of expand_query calls.

§total_terms_added: u64

Cumulative count of expansion terms added across all calls.

Implementations§

Source§

impl QueryExpansionEngine

Source

pub fn new(config: ExpansionConfig) -> Self

Create a new engine with the given configuration.

Source

pub fn add_synonym_entry(&mut self, entry: SynonymEntry)

Insert or replace a SynonymEntry in the synonym database.

The entry.term is lowercased before use as the map key so that lookups are case-insensitive.

Source

pub fn add_context_terms(&mut self, trigger: String, related: Vec<String>)

Register a list of related terms that fire when trigger appears in a query.

If an entry for trigger already exists the new terms are appended (deduplication is left to the caller).

Source

pub fn expand_term(&self, term: &str) -> Vec<QeExpansionTerm>

Return expansion terms for a single term, respecting the current ExpansionConfig.

The returned list is sorted by weight descending and capped at config.max_expansions_per_term. Terms below config.min_weight are excluded.

Source

pub fn expand_query( &mut self, query: &str, embedding: Option<Vec<f64>>, ) -> QeExpandedQuery

Tokenise query, expand every token, and return a QeExpandedQuery.

Tokenisation splits on ASCII whitespace and the punctuation characters ., ,, !, ?, ;, :. Empty tokens are discarded.

The embedding argument, if provided, is stored verbatim in the result (e.g. a pre-computed dense vector for the full query string).

Source

pub fn build_search_string(&self, expanded: &QeExpandedQuery) -> String

Build a space-separated search string from all terms whose weight is at or above config.min_weight.

The original tokens (source = ContextualExpansion) are placed first, followed by expansion terms, both groups sorted by weight descending.

Source

pub fn weighted_terms<'a>( &self, expanded: &'a QeExpandedQuery, ) -> Vec<(&'a str, f64)>

Return (term, weight) pairs sorted by weight descending.

Source

pub fn coverage_stats(&self, expanded: &QeExpandedQuery) -> ExpansionStats

Compute expansion statistics for a QeExpandedQuery.

Source

pub fn engine_stats(&self) -> (u64, u64)

Return (expansions_performed, total_terms_added).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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