Merge pull request #15 from FalkorDB/euclidean-distance-func

document vector distance function
FalkorDB · Dec 5, 2023 · b4f254a · b4f254a
2 parents 6ea52e2 + 62713e0
commit b4f254a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -240,6 +240,9 @@ whitespace
 xyxel
 yaml
 uri
+vec
+euclideanDistance
+vecf
 Dani
 Dovizioso
 Pedrosa

diff --git a/commands/graph.query.md b/commands/graph.query.md
@@ -1018,6 +1018,7 @@ This section contains information on all supported functions from the Cypher que
 * [Type conversion functions](#type-conversion-functions)
 * [Node functions](#node-functions)
 * [Path functions](#path-functions)
+* [Vector functions](#vector-functions)
 
 ## Predicate functions
 
@@ -1202,6 +1203,14 @@ This section contains information on all supported functions from the Cypher que
 
 &#42; FalkorDB-specific extensions to Cypher
 
+
+## Vector functions
+
+| Function                                  | Description|
+| ----------------------------------------- | :----------|
+| vecf32(_array_)                           | Creates a new float 32 vector <br> all elements of input array must be of type float |
+| vec.euclideanDistance(_vector_, _vector_) | Returns the Euclidean distance between the two input vectors |
+
 ### List comprehensions
 
 List comprehensions are a syntactical construct that accepts an array and produces another based on the provided map and filter directives.
-Original file line number
+Diff line change
@@ Expand Up / @@ -240,6 +240,9 @@ whitespace @@
     xyxel
     yaml
     uri
+    vec
+    euclideanDistance
+    vecf
     Dani
     Dovizioso
     Pedrosa
@@ Expand Down @@