Skip to content

Commit bbdd153

Browse files
Explain return values from vector functions (#1104)
1 parent 7056849 commit bbdd153

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

modules/ROOT/pages/functions/vector.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ For more details, see the {link-vector-indexes}#similarity-functions[vector inde
3434
| Both vectors must be of the same dimension.
3535
| Both vectors must be {link-vector-indexes}#indexes-vector-similarity-cosine[*valid*] with respect to cosine similarity.
3636
| The implementation is identical to that of the latest available vector index provider (`vector-2.0`).
37+
| `vector.similarity.cosine()` returns the neighborhood of nodes along with their respective cosine similarity scores, sorted in descending order of similarity.
38+
The similarity score range from `0` and `1`, with scores closer to `1` indicating a higher degree of similarity between the indexed vector and the query vector.
3739

3840
|===
3941

@@ -62,6 +64,8 @@ For more details, see the {link-vector-indexes}#similarity-functions[vector inde
6264
| Both vectors must be of the same dimension.
6365
| Both vectors must be {link-vector-indexes}#indexes-vector-similarity-euclidean[*valid*] with respect to Euclidean similarity.
6466
| The implementation is identical to that of the latest available vector index provider (`vector-2.0`).
67+
| `vector.similarity.euclidean()` returns the neighborhood of nodes along with their respective Euclidean similarity scores, sorted in descending order of similarity.
68+
The similarity score range from `0` and `1`, with scores closer to `1` indicating a higher degree of similarity between the indexed vector and the query vector.
6569

6670
|===
6771

0 commit comments

Comments
 (0)