Struct QueryExplainRequest 

pub struct QueryExplainRequest {
    pub query_type: ExplainQueryType,
    pub vector: Option<Vec<f32>>,
    pub top_k: usize,
    pub filter: Option<Value>,
    pub text_query: Option<String>,
    pub distance_metric: String,
    pub execute: bool,
    pub verbose: bool,
}

Query explain request

Fields

query_type: ExplainQueryType

Type of query to explain

vector: Option<Vec<f32>>

Query vector (for vector searches)

top_k: usize

Number of results to return

filter: Option<Value>

Optional metadata filter

text_query: Option<String>

Optional text query for hybrid/fulltext search

distance_metric: String

Distance metric

execute: bool

Whether to actually execute the query for actual stats

verbose: bool

Include verbose output

Implementations

impl QueryExplainRequest

pub fn vector_search(vector: Vec<f32>, top_k: usize) -> Self

Create a new explain request for a vector search

pub fn fulltext_search(text_query: impl Into<String>, top_k: usize) -> Self

Create a new explain request for a full-text search

pub fn hybrid_search( vector: Vec<f32>, text_query: impl Into<String>, top_k: usize, ) -> Self

Create a new explain request for a hybrid search

pub fn with_filter(self, filter: Value) -> Self

Add a filter to the explain request

pub fn with_distance_metric(self, metric: impl Into<String>) -> Self

Set the distance metric

pub fn with_execution(self) -> Self

Execute the query to get actual stats

pub fn with_verbose(self) -> Self

Enable verbose output

Trait Implementations

impl Clone for QueryExplainRequest

fn clone(&self) -> QueryExplainRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryExplainRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryExplainRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QueryExplainRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.