Skip to content

Commit ca332fa

Browse files
committed
Added EPSILON info
1 parent ae6eccb commit ca332fa

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

content/commands/vsim.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ history:
1919
linkTitle: VSIM
2020
since: 8.0.0
2121
summary: Return elements by vector similarity.
22-
syntax_fmt: "VSIM key (ELE | FP32 | VALUES num) (vector | element) [WITHSCORES] [WITHATTRIBS] [COUNT num]\n [EF search-exploration-factor] [FILTER expression] [FILTER-EF max-filtering-effort] [TRUTH] [NOTHREAD] [EPSILON]"
22+
syntax_fmt: "VSIM key (ELE | FP32 | VALUES num) (vector | element) [WITHSCORES] [WITHATTRIBS] [COUNT num]\n [EPSILON delta] [EF search-exploration-factor] [FILTER expression] [FILTER-EF max-filtering-effort]\n [TRUTH] [NOTHREAD]"
2323
title: VSIM
2424
bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
2525
---
@@ -99,6 +99,12 @@ returns, for each element, the JSON attribute associated with the element or NUL
9999
limits the number of returned results to `num`.
100100
</details>
101101

102+
<details open>
103+
<summary><code>EPSILON delta</code></summary>
104+
105+
is a floating point number between 0 and 1. It is used to retrieve elements that have a distance that is no further than the specified `delta`. In vector sets, returned elements have a similarity score (when compared to the query vector) that is between 1 and 0, where 1 means identical and 0 means opposite vectors. For example, if the `EPSILON` option is specified with an argument of `0.2`, it means only elements that have a similarity of 0.8 or better (a distance < 0.2) are returned. This is useful when a large `COUNT` is specified, but you don't want elements that are too far away the query vector.
106+
</details>
107+
102108
<details open>
103109
<summary><code>EF search-exploration-factor</code></summary>
104110

0 commit comments

Comments
 (0)