Skip to main content

VectorJoinOp

Struct VectorJoinOp 

Source
pub struct VectorJoinOp {
Show 13 fields pub input: Box<LogicalOperator>, pub left_vector_variable: Option<String>, pub left_property: Option<String>, pub query_vector: LogicalExpression, pub right_variable: String, pub right_property: String, pub right_label: Option<String>, pub index_name: Option<String>, pub k: usize, pub metric: Option<VectorMetric>, pub min_similarity: Option<f32>, pub max_distance: Option<f32>, pub score_variable: Option<String>,
}
Expand description

Join graph patterns with vector similarity search.

This operator takes entities from the left input and computes vector similarity against a query vector, outputting (entity, distance) pairs.

§Use Cases

  1. Hybrid graph + vector queries: Find similar nodes after graph traversal
  2. Aggregated embeddings: Use AVG(embeddings) as query vector
  3. Filtering by similarity: Join with threshold-based filtering

§Example

// Find movies similar to what the user liked
MATCH (u:User {id: $user_id})-[:LIKED]->(liked:Movie)
WITH avg(liked.embedding) AS user_taste
VECTOR JOIN (m:Movie) ON m.embedding
WHERE vector_similarity(m.embedding, user_taste) > 0.7
RETURN m.title

Fields§

§input: Box<LogicalOperator>

Input operator providing entities to match against.

§left_vector_variable: Option<String>

Variable from input to extract vectors from (for entity-to-entity similarity). If None, uses query_vector directly.

§left_property: Option<String>

Property containing the left vector (used with left_vector_variable).

§query_vector: LogicalExpression

The query vector expression (constant or computed).

§right_variable: String

Variable name to bind the right-side matching entities.

§right_property: String

Property containing the right-side vector embeddings.

§right_label: Option<String>

Optional label filter for right-side entities.

§index_name: Option<String>

Name of vector index on right side (None = brute-force).

§k: usize

Number of nearest neighbors per left-side entity.

§metric: Option<VectorMetric>

Distance metric.

§min_similarity: Option<f32>

Minimum similarity threshold.

§max_distance: Option<f32>

Maximum distance threshold.

§score_variable: Option<String>

Variable to bind the distance/similarity score.

Trait Implementations§

Source§

impl Clone for VectorJoinOp

Source§

fn clone(&self) -> VectorJoinOp

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VectorJoinOp

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more