Struct SearchRequest

pub struct SearchRequest {
    pub index_name: String,
    pub query: SearchQuery,
    pub top_k: usize,
    pub filter: Option<FilterCondition>,
    pub include_vectors: bool,
    pub include_metadata: bool,
    pub options: HashMap<String, MetadataValue>,
}

Search request for querying vectors

Fields

index_name: String

Index name to search

query: SearchQuery

Query vector or text

top_k: usize

Number of results to return

filter: Option<FilterCondition>

Optional filter conditions

include_vectors: bool

Whether to include vectors in results

include_metadata: bool

Whether to include metadata in results

options: HashMap<String, MetadataValue>

Search options

Implementations

impl SearchRequest

pub fn new(index_name: impl Into<String>, vector: Vec<f32>) -> SearchRequest

Create a new search request with a vector query

pub fn new_text( index_name: impl Into<String>, text: impl Into<String>, ) -> SearchRequest

Create a new search request with a text query

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

Set the number of results to return

pub fn with_filter(self, filter: FilterCondition) -> SearchRequest

Set the filter condition

pub fn with_include_vectors(self, include: bool) -> SearchRequest

Set whether to include vectors in results

pub fn with_include_metadata(self, include: bool) -> SearchRequest

Set whether to include metadata in results

pub fn with_option( self, key: impl Into<String>, value: MetadataValue, ) -> SearchRequest

Add a search option

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 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.