Struct RetrieveRequest 

pub struct RetrieveRequest {
    pub query: String,
    pub channels: Vec<ChannelConfig>,
    pub global_filters: Vec<StructuredFilter>,
    pub top_k: usize,
    pub namespace: Option<String>,
    pub include_embeddings: bool,
    pub query_preprocessing: Option<QueryPreprocessing>,
}

Multi-channel retrieval request.

Fields

query: String

Search query string.

channels: Vec<ChannelConfig>

Channel configurations for this request.

global_filters: Vec<StructuredFilter>

Global filters applied across all channels.

Note on channel support: StructuredFilter values are currently only applied by the metadata channel. The semantic, bm25, and graph channels silently ignore global_filters in their current implementation.

top_k: usize

Maximum number of results after fusion.

namespace: Option<String>

Optional namespace for scoping.

include_embeddings: bool

Whether to include embedding vectors in results.

query_preprocessing: Option<QueryPreprocessing>

Optional query preprocessing strategy.

Implementations

impl RetrieveRequest

pub fn builder(query: impl Into<String>) -> RetrieveRequestBuilder

Create a new builder for RetrieveRequest.

Trait Implementations

impl Clone for RetrieveRequest

fn clone(&self) -> RetrieveRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrieveRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RetrieveRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RetrieveRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.