Struct SearchRequest 

pub struct SearchRequest {

    pub query_text: String,
    pub search_type: SearchType,
    pub top_k: Option<usize>,
    pub datasets: Option<Vec<String>>,
    pub dataset_ids: Option<Vec<Uuid>>,
    pub system_prompt: Option<String>,
    pub system_prompt_path: Option<String>,
    pub only_context: Option<bool>,
    pub use_combined_context: Option<bool>,
    pub session_id: Option<String>,
    pub node_type: Option<String>,
    pub node_name: Option<Vec<String>>,
    pub node_name_filter_operator: Option<String>,
    pub wide_search_top_k: Option<usize>,
    pub triplet_distance_penalty: Option<f32>,
    pub save_interaction: Option<bool>,
    pub user_id: Option<Uuid>,
    pub verbose: Option<bool>,
    pub feedback_influence: Option<f32>,
    pub retriever_specific_config: Option<HashMap<String, Value>>,
    pub response_schema: Option<Value>,
    pub custom_search_type: Option<String>,
    pub auto_feedback_detection: Option<bool>,
    pub neighborhood_depth: Option<usize>,
    pub neighborhood_seed_top_k: Option<usize>,
    pub summarize_context: Option<bool>,
}

Fields

query_text: String

search_type: SearchType

top_k: Option<usize>

datasets: Option<Vec<String>>

dataset_ids: Option<Vec<Uuid>>

system_prompt: Option<String>

system_prompt_path: Option<String>

only_context: Option<bool>

use_combined_context: Option<bool>

session_id: Option<String>

node_type: Option<String>

node_name: Option<Vec<String>>

node_name_filter_operator: Option<String>

Controls how multiple node_name filters combine: "OR" = match any (default), "AND" = match all.

wide_search_top_k: Option<usize>

triplet_distance_penalty: Option<f32>

save_interaction: Option<bool>

Whether to persist this query and its result to the search history database. Defaults to true when omitted, matching the Python SDK behavior where every search is logged unconditionally. Set to Some(false) to opt out of logging.

user_id: Option<Uuid>

verbose: Option<bool>

feedback_influence: Option<f32>

retriever_specific_config: Option<HashMap<String, Value>>

Arbitrary retriever-specific configuration passed through from the caller. Keys and values are retriever-defined; unknown keys are silently ignored.

response_schema: Option<Value>

Optional JSON schema for structured LLM output. When present, completion-generating retrievers return structured JSON matching this schema instead of plain text.

custom_search_type: Option<String>

When set, routes to a community/custom retriever registered by this name, ignoring search_type.

auto_feedback_detection: Option<bool>

When true and a session is active, automatically detect if the query contains feedback about the previous response before executing the search.

neighborhood_depth: Option<usize>

Number of hops from query result nodes to include in the graph context. Controls context breadth.

neighborhood_seed_top_k: Option<usize>

Number of initial seed nodes for neighborhood expansion. Controls starting point density.

summarize_context: Option<bool>

When true, store a JSON summary of the retrieved context alongside the Q&A entry. When false (default), store an empty string — matching the Python SDK behavior where context_to_store = "" unless summarize_context=True.

Implementations

impl SearchRequest

pub fn only_context(&self) -> bool

pub fn use_combined_context(&self) -> bool

pub fn top_k_or_default(&self, default_value: usize) -> usize

pub fn verbose(&self) -> bool

pub fn feedback_influence_or_default(&self) -> f32

pub fn retriever_config(&self) -> Option<&HashMap<String, Value>>

Return the retriever-specific config map.

pub fn retriever_config_str<'a>( &'a self, key: &str, default: &'a str, ) -> &'a str

Get a string value from retriever_specific_config, with a fallback.

pub fn retriever_config_usize(&self, key: &str, default: usize) -> usize

Get a usize value from retriever_specific_config, with a fallback.

Trait Implementations

impl Clone for SearchRequest

fn clone(&self) -> SearchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SearchRequest> for SearchParams

fn from(req: &SearchRequest) -> SearchParams

Converts to this type from the input type.

impl Serialize for SearchRequest

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.