Skip to main content

RecallArgs

Struct RecallArgs 

Source
pub struct RecallArgs {
Show 19 fields pub context: String, pub namespace: Option<String>, pub limit: usize, pub tags: Option<String>, pub since: Option<String>, pub until: Option<String>, pub tier: Option<String>, pub as_agent: Option<String>, pub budget_tokens: Option<usize>, pub context_tokens: Option<Vec<String>>, pub session_default: bool, pub include_archived: bool, pub has_citations: bool, pub source_uri_prefix: Option<String>, pub kind: Option<String>, pub confidence_tier: Option<String>, pub verbose_provenance: bool, pub format: String, pub session_id: Option<String>,
}
Expand description

Clap-derived arg shape for the recall subcommand. Definition moved from main.rs verbatim in W5b — fields and attrs unchanged.

Fields§

§context: String§namespace: Option<String>§limit: usize§tags: Option<String>§since: Option<String>§until: Option<String>§tier: Option<String>

Feature tier for recall: keyword, semantic, smart, autonomous

§as_agent: Option<String>

Task 1.5: querying agent’s namespace position. Enables scope-based visibility filtering (private/team/unit/org/collective).

§budget_tokens: Option<usize>

Task 1.11: context-budget-aware recall. Return the top-ranked memories whose cumulative estimated tokens fit within N. Omit for unlimited (limit-based only).

§context_tokens: Option<Vec<String>>

v0.6.0.0 contextual recall. Comma-separated list of recent conversation tokens used to bias the query embedding at 70/30 (primary/context). Shifts the recall towards memories that match both the explicit query and the conversation’s nearby topics.

§session_default: bool

v0.7.0 (issue #518) — when set, splice defaults from [agents.defaults.recall_scope] in config.toml for any filter field not explicitly passed on the command line. Resolution: explicit args > recall_scope defaults > compiled defaults. Default false preserves v0.6.x recall semantics.

§include_archived: bool

v0.7.0 WT-1-E — when set, recall returns archived sources (those replaced by their atoms after WT-1-B atomisation) alongside the atoms. Default false surfaces atoms only, which is the canonical post-atomisation recall unit.

§has_citations: bool

v0.7.0 Form 4 (issue #757) — restrict results to memories whose citations array is non-empty. Composes with the other filters; default false (no provenance filter).

§source_uri_prefix: Option<String>

v0.7.0 Form 4 (issue #757) — restrict results to memories whose source_uri starts with this prefix. Matches the substring exactly (no glob/regex). Typical use: --source-uri-prefix doc: to surface every atom or memory pointing at a substrate doc; --source-uri-prefix uri:https:// to surface every memory citing an HTTP source.

§kind: Option<String>

v0.7.x Form 6 (issue #759) — Batman-taxonomy memory-kind filter. Comma-separated. Examples: –kind concept –kind concept,entity,claim –kinds concept,entity,claim (plural alias for MCP parity) Recognised values: observation, reflection, persona, concept, entity, claim, relation, event, conversation, decision. OR-of-kinds within the flag; AND with the other filters. Pass ‘all’ or omit for no filter.

Cluster E audit API-3 (issue #767): the MCP tool param is kinds (plural), so the CLI accepts both spellings via an alias for cross-interface ergonomics.

§confidence_tier: Option<String>

v0.7.0 #1098 — restrict to memories whose confidence tier matches one of {high, medium, low}. Wired through to crate::models::RecallRequest::confidence_tier via RecallRequest::from_cli_args; the MCP / HTTP surfaces have accepted this filter since RC, the CLI surface closes the three-surface parity gap.

§verbose_provenance: bool

v0.7.0 #1098 — when set, emit per-row provenance decoration (Gap-7 #890): citations, source_uri, source_span, confidence_source, confidence_signals. The flag flows through the DTO so MCP / HTTP / CLI agree on the verbose envelope shape; the JSON renderer downstream owns the actual expansion (today’s CLI emits the full Memory row already, so the flag is preserved for cross-surface parity).

§format: String

v0.7.0 #1098 — response format selector: human (default pretty text), json (the same envelope --json produces), or toon (TOON compact format, ~79% smaller than JSON; see crate::toon). The MCP / HTTP surfaces accept the same vocabulary via RecallRequest::format. Default human preserves v0.6.x CLI semantics.

§session_id: Option<String>

v0.7.0 #1257 — session-id parity flag (DTO C2 #967, +0.05 rerank boost under #518). Pre-#1257 this was hard-coded to None in RecallRequest::from_cli_args, so a CLI caller could not reach the in-session ring boost even though MCP ({"session_id": "…"} param) and HTTP (?session_id=… or JSON body) callers could. Optional; omit to preserve v0.6.x recall semantics.

Trait Implementations§

Source§

impl Args for RecallArgs

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl FromArgMatches for RecallArgs

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, 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