Skip to main content

RecallPolicy

Struct RecallPolicy 

Source
pub struct RecallPolicy {
    pub enabled: bool,
    pub max_k_total: usize,
    pub max_tokens_injection: usize,
    pub min_score_threshold: f64,
    pub budgets: RecallBudgets,
    pub allowed_uses: Vec<RecallUse>,
    pub prior_weight: f64,
}
Expand description

Policy controlling recall behavior.

This is the declarative configuration for recall operations. It controls what is allowed, not how it is implemented.

Fields§

§enabled: bool

Whether recall is enabled

§max_k_total: usize

Maximum number of candidates to return total

§max_tokens_injection: usize

Maximum tokens to inject from recall context

§min_score_threshold: f64

Minimum similarity score threshold

§budgets: RecallBudgets

Budget constraints

§allowed_uses: Vec<RecallUse>

Allowed recall uses (runtime, training, etc.)

Defaults to [RuntimeAugmentation] only - training use must be explicitly enabled. This preserves “Recall ≠ Training” boundary.

§prior_weight: f64

How strongly recall results weight planning priors when consumed by PlanningPriorAgent. 1.0 means full weight; 0.0 disables prior adjustment without disabling recall itself. Capped to [0.0, 1.0] by consumers.

Implementations§

Source§

impl RecallPolicy

Source

pub fn enabled() -> RecallPolicy

Create an enabled recall policy with default settings.

Source

pub fn disabled() -> RecallPolicy

Create a disabled recall policy.

Source

pub fn is_use_allowed(&self, purpose: RecallUse) -> bool

Check if a specific recall use is allowed by this policy.

Returns true if the policy allows the given use, false otherwise. This is the primary enforcement point for “Recall ≠ Training” boundary.

Source

pub fn snapshot_hash(&self) -> String

Compute a deterministic hash of this policy for provenance tracking.

This enables replay verification: same policy hash → same behavior. Note: Includes allowed_uses in the hash for full provenance.

Trait Implementations§

Source§

impl Clone for RecallPolicy

Source§

fn clone(&self) -> RecallPolicy

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RecallPolicy

Source§

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

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

impl Default for RecallPolicy

Source§

fn default() -> RecallPolicy

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

impl<'de> Deserialize<'de> for RecallPolicy

Source§

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

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

impl Serialize for RecallPolicy

Source§

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

Serialize this value into the given Serde serializer. Read more

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<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
Source§

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