Skip to content

Explain return values from vector functions #1104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 11, 2024
Merged

Explain return values from vector functions #1104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1d4a51
add explanation
JPryce-Aklundh Nov 11, 2024
7cb502c
add backticks
JPryce-Aklundh Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions modules/ROOT/pages/functions/vector.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ For more details, see the {link-vector-indexes}#similarity-functions[vector inde
| Both vectors must be of the same dimension.
| Both vectors must be {link-vector-indexes}#indexes-vector-similarity-cosine[*valid*] with respect to cosine similarity.
| The implementation is identical to that of the latest available vector index provider (`vector-2.0`).
| `vector.similarity.cosine()` returns the neighborhood of nodes along with their respective cosine similarity scores, sorted in descending order of similarity.
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.

|===

Expand Down Expand Up @@ -63,6 +65,8 @@ For more details, see the {link-vector-indexes}#similarity-functions[vector inde
| Both vectors must be of the same dimension.
| Both vectors must be {link-vector-indexes}#indexes-vector-similarity-euclidean[*valid*] with respect to Euclidean similarity.
| The implementation is identical to that of the latest available vector index provider (`vector-2.0`).
| `vector.similarity.euclidean()` returns the neighborhood of nodes along with their respective Euclidean similarity scores, sorted in descending order of similarity.
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.

|===

Expand Down
Loading