Struct RuvectorQuery 

pub struct RuvectorQuery {
    pub vector: Option<Vec<f32>>,
    pub text: Option<String>,
    pub node_id: Option<u64>,
    pub mode: QueryMode,
    pub k: usize,
    pub ef: usize,
    pub gnn_depth: usize,
    pub temperature: f32,
    pub return_attention: bool,
}

Query configuration for RuVector searches

Fields

vector: Option<Vec<f32>>

Query vector for similarity search

text: Option<String>

Text query (requires embedding model)

node_id: Option<u64>

Node ID for subgraph extraction

mode: QueryMode

Search mode

k: usize

Number of results to return

ef: usize

HNSW search parameter (exploration factor)

gnn_depth: usize

GNN depth for neural search

temperature: f32

Temperature for differentiable search (higher = softer)

return_attention: bool

Whether to return attention weights

Implementations

impl RuvectorQuery

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

Create a basic vector search query

Arguments

• vector - Query vector
• k - Number of results to return

Example

use ruvector_gnn::query::RuvectorQuery;

let query = RuvectorQuery::vector_search(vec![0.1, 0.2, 0.3], 10);
assert_eq!(query.k, 10);

pub fn neural_search(vector: Vec<f32>, k: usize, gnn_depth: usize) -> Self

Create a GNN-enhanced neural search query

Arguments

• vector - Query vector
• k - Number of results to return
• gnn_depth - Number of GNN layers to apply

Example

use ruvector_gnn::query::RuvectorQuery;

let query = RuvectorQuery::neural_search(vec![0.1, 0.2, 0.3], 10, 3);
assert_eq!(query.gnn_depth, 3);

pub fn subgraph_search(vector: Vec<f32>, k: usize) -> Self

Create a subgraph extraction query

Arguments

• vector - Query vector
• k - Number of nodes in subgraph

Example

use ruvector_gnn::query::RuvectorQuery;

let query = RuvectorQuery::subgraph_search(vec![0.1, 0.2, 0.3], 20);
assert_eq!(query.k, 20);

pub fn differentiable_search( vector: Vec<f32>, k: usize, temperature: f32, ) -> Self

Create a differentiable search query with temperature

Arguments

• vector - Query vector
• k - Number of results
• temperature - Softmax temperature (higher = softer distribution)

pub fn with_text(self, text: String) -> Self

Set text query (requires embedding model)

pub fn with_node(self, node_id: u64) -> Self

Set node ID for centered queries

pub fn with_ef(self, ef: usize) -> Self

Set EF parameter for HNSW search

pub fn with_attention(self) -> Self

Enable attention weight return

Trait Implementations

impl Clone for RuvectorQuery

fn clone(&self) -> RuvectorQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuvectorQuery

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

Formats the value using the given formatter.

impl Default for RuvectorQuery

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RuvectorQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RuvectorQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.