Struct VectorSearch 

pub struct VectorSearch<T>
where
    T: SurrealRecord,
{ /* private fields */ }

A vector K-nearest-neighbour SELECT, reached from Table::nearest. Renders SELECT … FROM <table> WHERE field <|k,ef|> [vector], optionally projecting / ordering by the computed vector::distance::knn(). By default it uses the field’s HNSW index with ef = k; call distance for a brute-force scan or ef to tune recall.

Doc::table()
    .nearest("embedding", vec![0.1, 0.2, 0.3])
    .k(5)
    .distance_as("dist")      // SELECT *, vector::distance::knn() AS dist
    .order_by_distance()      // ORDER BY dist
    .to_surrealql();
// SELECT *, vector::distance::knn() AS dist FROM doc
//   WHERE embedding <|5,5|> [0.1, 0.2, 0.3] ORDER BY dist

Implementations

impl<T> VectorSearch<T>

where T: SurrealRecord,

pub fn k(self, k: u32) -> VectorSearch<T>

Number of neighbours k to return (default 10).

pub fn distance(self, metric: impl Into<String>) -> VectorSearch<T>

Brute-force KNN with an explicit distance metric (<|k,METRIC|>), e.g. "EUCLIDEAN", "COSINE", "MANHATTAN".

pub fn ef(self, ef: u32) -> VectorSearch<T>

HNSW KNN with explicit candidate-list size ef (<|k,ef|>); larger ef trades latency for recall. Defaults to ef = k when unset.

pub fn filter(self, expr: impl DynExpr + 'static) -> VectorSearch<T>

AND an additional predicate onto the WHERE clause.

pub fn distance_as(self, alias: impl Into<String>) -> VectorSearch<T>

Project the computed distance as vector::distance::knn() AS <alias>.

pub fn order_by_distance(self) -> VectorSearch<T>

ORDER BY <distance> — nearest first. Projects the computed distance (default alias distance), since ORDER BY sorts on the projected alias rather than the vector::distance::knn() call directly.

pub fn limit(self, n: u32) -> VectorSearch<T>

LIMIT n.

pub fn to_surrealql(&self) -> String

Render to a SurrealQL string with the query vector inlined.

pub fn to_surrealql_with_params(&self) -> (String, BTreeMap<String, Value>)

Render with $param placeholders (the query vector becomes a bound param).

Trait Implementations

impl<T> Display for VectorSearch<T>

where T: SurrealRecord,

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

Formats the value using the given formatter.