Struct RetrieveOptions 

pub struct RetrieveOptions {

    pub top_k: usize,
    pub beam_width: usize,
    pub max_iterations: usize,
    pub include_content: bool,
    pub include_summaries: bool,
    pub min_score: f32,
    pub strategy: StrategyPreference,
    pub sufficiency_check: bool,
    pub max_tokens: usize,
    pub enable_cache: bool,
    pub pruning_strategy: PruningStrategy,
    pub token_estimation: TokenEstimation,
    pub use_async_context: bool,
}

Options for retrieval operations.

Fields

top_k: usize

Maximum number of results to return.

beam_width: usize

Beam width for multi-path search.

max_iterations: usize

Maximum search iterations.

include_content: bool

Whether to include node content in results.

include_summaries: bool

Whether to include node summaries in results.

min_score: f32

Minimum relevance score (0.0 - 1.0).

strategy: StrategyPreference

Strategy preference.

sufficiency_check: bool

Enable sufficiency checking for incremental retrieval.

max_tokens: usize

Maximum tokens for sufficiency threshold.

enable_cache: bool

Enable result caching.

pruning_strategy: PruningStrategy

Pruning strategy for context building.

token_estimation: TokenEstimation

Token estimation mode.

use_async_context: bool

Whether to use async context building for large documents.

Implementations

impl RetrieveOptions

pub fn new() -> Self

Create new retrieve options with defaults.

pub fn with_top_k(self, top_k: usize) -> Self

Set the maximum number of results to return.

pub fn with_beam_width(self, beam_width: usize) -> Self

Set the beam width for multi-path search.

pub fn with_max_iterations(self, max_iterations: usize) -> Self

Set the maximum search iterations.

pub fn with_include_content(self, include: bool) -> Self

Set whether to include node content in results.

pub fn with_include_summaries(self, include: bool) -> Self

Set whether to include node summaries in results.

pub fn with_min_score(self, min_score: f32) -> Self

Set the minimum relevance score.

pub fn with_strategy(self, strategy: StrategyPreference) -> Self

Set the strategy preference.

pub fn with_sufficiency_check(self, enable: bool) -> Self

Set whether to enable sufficiency checking.

pub fn with_max_tokens(self, max_tokens: usize) -> Self

Set the maximum tokens for sufficiency threshold.

pub fn with_enable_cache(self, enable: bool) -> Self

Set whether to enable result caching.

pub fn with_pruning_strategy(self, strategy: PruningStrategy) -> Self

Set pruning strategy for context building.

pub fn with_token_estimation(self, mode: TokenEstimation) -> Self

Set token estimation mode.

pub fn with_async_context(self, enable: bool) -> Self

Enable async context building for large documents.

Trait Implementations

impl Clone for RetrieveOptions

fn clone(&self) -> RetrieveOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrieveOptions

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

Formats the value using the given formatter.

impl Default for RetrieveOptions

fn default() -> Self

Returns the “default value” for a type.