Struct SearchQuery 

pub struct SearchQuery {
    pub collection: String,
    pub vector: Vec<f32>,
    pub top_k: usize,
    pub filter: Option<MetadataFilter>,
    pub include_vectors: bool,
    pub include_metadata: bool,
    pub ef_search: Option<usize>,
    pub reranker: Option<RerankerConfig>,
}

A nearest-neighbour search query.

Fields

collection: String

Target collection name.

vector: Vec<f32>

Query vector.

top_k: usize

Maximum number of results to return.

filter: Option<MetadataFilter>

Optional metadata filter applied after ANN retrieval.

include_vectors: bool

If true, each SearchResult will include the raw vector.

include_metadata: bool

If true, each SearchResult will include the JSON metadata.

ef_search: Option<usize>

Override the HNSW ef_search parameter for this query.

reranker: Option<RerankerConfig>

Optional post-retrieval reranking strategy.

Implementations

impl SearchQuery

pub fn validate(&self) -> VectorResult<()>

Validate the query fields, returning an error for invalid configurations.

Trait Implementations

impl Clone for SearchQuery

fn clone(&self) -> SearchQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchQuery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchQuery

fn eq(&self, other: &SearchQuery) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchQuery