Skip to main content

RerankSpec

Struct RerankSpec 

Source
pub struct RerankSpec {
    pub enabled: bool,
    pub rerank_k: u32,
    pub model: String,
    pub passage_field: String,
    pub signal_blend: f32,
    pub query_text: String,
    pub validate_only: bool,
}
Expand description

─── Second-stage reranking (optional) ───────────────────────────────────────

First-class, optional second-stage reranker over an over-fetched candidate window for plain VectorSearch / HybridSearch. Mirrors Weaviate reranker modules, Pinecone’s rerank API, Vespa global-phase rank-profiles, and Cohere/Qdrant rerank: a stateless, bounded, post-merge stage run once globally after shard fan-in. Additive & wire-compatible — old clients omit this message ⇒ rerank off, behavior identical to today.

Fields§

§enabled: bool

master switch (false / message-absent ⇒ no rerank)

§rerank_k: u32

over-fetch pool size; 0 ⇒ default max(k*4, 24) clamped to the mode’s hard cap (48 for cross-encoder; 200 for the cheaper maxsim late-interaction path, sized for the issue’s “top-K ~100-200” fused window).

§model: String

“cross-encoder” | “maxsim” | “learned” | “score-fusion” | “custom”; “” ⇒ “score-fusion”.

  • “maxsim” — token-level ColBERT-style MaxSim late interaction: the query and each hydrated passage are encoded into per-token L2-normalized matrices and scored Σ_q max_d q·d ÷ query-token-count. LLM-free; needs the embedding model loaded + query_text + passage_field, else it degrades to score-fusion (never errors).
  • “learned” — (#768 LongMemEval Phase 7) non-generative GBDT reranker over the funnel feature vector [dense, BM25, MaxSim, recency, graph-distance, granularity], trained on LongMemEval dev relevance labels. Applied as the FINAL rerank over the fused+reranked candidate set. Needs a model loaded (STATELET_LEARNED_RERANKER_MODEL); else degrades to score-fusion. LLM-free.
§passage_field: String

KV-key template for passage hydration (cross-encoder / maxsim). Tokens: {id} → candidate vector/result id (decimal) {index} → index_name e.g. “doc:{index}:{id}:text”. Empty ⇒ hydration disabled ⇒ fall back to score-fusion.

§signal_blend: f32

score-fusion only: blend = blend*norm_distance + (1-blend)*aux_signal. 0 ⇒ default 1.0 (pure full-precision/coarse distance re-rank). Range [0,1].

§query_text: String

Raw query text for the text-based rerankers (both RPCs query by vector, not text). Required for model=“cross-encoder” and model=“maxsim”; empty ⇒ auto-downgrade to score-fusion.

§validate_only: bool

Dry-run pre-flight validation. When true the RPC validates the rerank spec (passage_field template via validate_passage_field, plus reranker availability for model=“cross-encoder”) and returns an empty successful response if valid, or an InvalidArgument/FailedPrecondition Status if not — without executing the search. SDKs expose it as rerank_validate(…). Additive & wire-compatible: old clients omit it ⇒ false ⇒ unchanged.

Trait Implementations§

Source§

impl Clone for RerankSpec

Source§

fn clone(&self) -> RerankSpec

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 RerankSpec

Source§

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

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

impl Default for RerankSpec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Message for RerankSpec

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
Source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
Source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
Source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
Source§

impl PartialEq for RerankSpec

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RerankSpec

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

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

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 = 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