Skip to main content

WithOption

Enum WithOption 

Source
pub enum WithOption {
Show 30 variants Superseded, ScoreBreakdown, Explanation, Provenance, ContradictionDetection, Diversity { lambda: Option<f64>, }, Dedup { field: Option<String>, }, ProgressiveDisclosure { level: Option<String>, }, Consistency { level: Option<String>, }, Locale { tag: String, }, Cache { ttl_seconds: u64, }, Rerank { model: Option<String>, }, LlmRerank { model: Option<String>, }, QueryExpansion, QueryDecompose, Hyde, ConflictResolution, IncludeSources, AnnotateRelativeTime, RecencyWeight { weight: f64, }, MinScore { score: f64, }, MultiHop { hops: u64, }, SessionAffinity { boost: f64, }, SubjectAffinity { boost: f64, }, SessionCoverage { min_per_ns: u64, }, MaxNamespaces { max: u64, }, Exhaustive { max_rounds: Option<u64>, }, SessionCensus { min_per_session: Option<u64>, min_score: Option<f64>, }, AggregationIntent, PreferenceEnrichment,
}
Expand description

A WITH option modifying query behaviour.

Variants§

§

Superseded

Include superseded (historical) grains in results.

§

ScoreBreakdown

Include relevance score breakdown per result.

§

Explanation

Include a human-readable explanation of ranking.

§

Provenance

Include provenance chain in results.

§

ContradictionDetection

Enable contradiction detection on the result set.

§

Diversity

Apply MMR diversity to the result set.

Fields

§lambda: Option<f64>
§

Dedup

Deduplicate results, optionally keyed by a specific field name. EBNF: "dedup" , "(" , field_name , ")".

Fields

§

ProgressiveDisclosure

Progressive disclosure level (OMS §4 progressive_disclosure(level)). level is summary | headlines | full. Bare form (no parens) maps to None and lets the assembler pick a default.

Fields

§

Consistency

Consistency level (OMS §4 consistency(level) where level = "eventual" | "bounded" | "linearizable").

Fields

§

Locale

Locale hint for humanization / collation (OMS §4 locale("en-US")).

Fields

§

Cache

Cache directive (OMS §4 cache(ttl=300)).

Fields

§ttl_seconds: u64
§

Rerank

Enable cross-encoder reranking (requires rerank feature). Optional model name selects a specific reranker from the registry.

Fields

§

LlmRerank

Enable LLM listwise reranking (requires llm-rerank feature). Optional model name selects a specific LLM reranker from the registry.

Fields

§

QueryExpansion

Enable rule-based query expansion (stemming + synonyms).

§

QueryDecompose

ADR-023: Enable rule-based query decomposition (2-4 sub-queries per strategy).

§

Hyde

Enable hypothetical document embeddings.

§

ConflictResolution

Keep only newest grain per (subject, relation).

§

IncludeSources

Include derived_from source grains in results.

§

AnnotateRelativeTime

Annotate results with relative time labels (e.g. “2 weeks ago”).

§

RecencyWeight

Set recency weight for temporal freshness scoring.

Fields

§weight: f64
§

MinScore

Set minimum relevance score threshold.

Fields

§score: f64
§

MultiHop

Enable entity-graph multi-hop retrieval (1-3 hops).

Fields

§hops: u64
§

SessionAffinity

Set session affinity boost factor [0.0–1.0].

Fields

§boost: f64
§

SubjectAffinity

Set subject affinity boost factor [0.0–1.0].

Fields

§boost: f64
§

SessionCoverage

FR-005: Minimum grains per namespace for cross-session coverage.

Fields

§min_per_ns: u64
§

MaxNamespaces

FR-005: Maximum unique namespaces in results.

Fields

§max: u64
§

Exhaustive

WI-EXHAUST: Enable exhaustive entity-class recall. Optional rounds parameter.

Fields

§max_rounds: Option<u64>
§

SessionCensus

RF-3: Session-census retrieval. Optional parameters: min_per_session, min_score.

Fields

§min_per_session: Option<u64>
§min_score: Option<f64>
§

AggregationIntent

RQ-3: Keep superseded grains at natural scores for aggregation queries.

§

PreferenceEnrichment

Enrich preference queries with co-occurring session grains.

Trait Implementations§

Source§

impl Clone for WithOption

Source§

fn clone(&self) -> WithOption

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WithOption

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for WithOption

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for WithOption

Source§

fn eq(&self, other: &WithOption) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for WithOption

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for WithOption

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> ErasedDestructor for T
where T: 'static,

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> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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