pub struct RecallArgs {Show 13 fields
pub query: String,
pub k: usize,
pub type: Option<MemoryType>,
pub namespace: Option<String>,
pub no_graph: bool,
pub precise: bool,
pub max_hops: u32,
pub min_weight: f64,
pub max_graph_results: Option<usize>,
pub max_distance: f32,
pub format: JsonOutputFormat,
pub db: Option<String>,
pub json: bool,
}Fields§
§query: String§k: usizeMaximum number of direct vector matches to return.
Note: this flag controls only direct_matches. Graph traversal results
(graph_matches) are unbounded by default; use --max-graph-results to
cap them independently. The results field aggregates both lists.
type: Option<MemoryType>§namespace: Option<String>§no_graph: bool§precise: bool§max_hops: u32§min_weight: f64§max_graph_results: Option<usize>Cap the size of graph_matches to at most N entries.
Defaults to unbounded (None) so existing pipelines see the same shape
as in v1.0.22 and earlier. Set this when a query touches a dense graph
neighbourhood and the caller only needs a top-N preview. Added in v1.0.23.
max_distance: f32Filter results by maximum distance. Results with distance greater than this value
are excluded. If all matches exceed this threshold, the command exits with code 4
(not found) per the documented public contract.
Default 1.0 disables the filter and preserves the top-k behavior.
format: JsonOutputFormat§db: Option<String>§json: boolAccept --json as a no-op because output is already JSON by default.
Trait Implementations§
Source§impl Args for RecallArgs
impl Args for RecallArgs
Source§fn augment_args<'b>(__clap_app: Command) -> Command
fn augment_args<'b>(__clap_app: Command) -> Command
Source§fn augment_args_for_update<'b>(__clap_app: Command) -> Command
fn augment_args_for_update<'b>(__clap_app: Command) -> Command
Command so it can instantiate self via
FromArgMatches::update_from_arg_matches_mut Read moreSource§impl FromArgMatches for RecallArgs
impl FromArgMatches for RecallArgs
Source§fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
Source§fn from_arg_matches_mut(
__clap_arg_matches: &mut ArgMatches,
) -> Result<Self, Error>
fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>
Source§fn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches,
) -> Result<(), Error>
fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>
ArgMatches to self.Source§fn update_from_arg_matches_mut(
&mut self,
__clap_arg_matches: &mut ArgMatches,
) -> Result<(), Error>
fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>
ArgMatches to self.Auto Trait Implementations§
impl Freeze for RecallArgs
impl RefUnwindSafe for RecallArgs
impl Send for RecallArgs
impl Sync for RecallArgs
impl Unpin for RecallArgs
impl UnsafeUnpin for RecallArgs
impl UnwindSafe for RecallArgs
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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