Added epsilon property to the vsim command (#3723)

* added epsilon property to the vsim command

* fixed linter errors

* added async client test

* modified test to use async

Author: htemelski-redis

redis/commands/vectorset/commands.py

@@ -129,6 +129,7 @@ def vsim(
         filter_ef: Optional[str] = None,
         truth: Optional[bool] = False,
         no_thread: Optional[bool] = False,
+        epsilon: Optional[Number] = None,
     ) -> Union[
         Awaitable[Optional[List[Union[List[EncodableT], Dict[EncodableT, Number]]]]],
         Optional[List[Union[List[EncodableT], Dict[EncodableT, Number]]]],
@@ -152,6 +153,9 @@ def vsim(
         ``no_thread`` when enabled forces the command to execute the search
                 on the data structure in the main thread.
 
+        ``epsilon`` floating point between 0 and 1, if specified will return
+                only elements with distance no further than the specified one.
+
         For more information see https://redis.io/commands/vsim
         """
 
@@ -176,6 +180,9 @@ def vsim(
         if count:
             pieces.extend(["COUNT", count])
 
+        if epsilon:
+            pieces.extend(["EPSILON", epsilon])
+
         if ef:
             pieces.extend(["EF", ef])
 

tests/test_asyncio/test_vsets.py

@@ -423,6 +423,21 @@ async def test_vsim_truth_no_thread_enabled(d_client):
     assert isinstance(sim_no_thread, dict)
 
 
+@skip_if_server_version_lt("8.2.0")
+async def test_vsim_epsilon(d_client):
+    await d_client.vset().vadd("myset", [2, 1, 1], "a")
+    await d_client.vset().vadd("myset", [2, 0, 1], "b")
+    await d_client.vset().vadd("myset", [2, 0, 0], "c")
+    await d_client.vset().vadd("myset", [2, 0, -1], "d")
+    await d_client.vset().vadd("myset", [2, -1, -1], "e")
+
+    res1 = await d_client.vset().vsim("myset", [2, 1, 1])
+    assert 5 == len(res1)
+
+    res2 = await d_client.vset().vsim("myset", [2, 1, 1], epsilon=0.5)
+    assert 3 == len(res2)
+
+
 @skip_if_server_version_lt("7.9.0")
 async def test_vdim(d_client):
     float_array = [1, 4.32, 0.11, 0.5, 0.9, 0.1, 0.2]

tests/test_vsets.py

@@ -425,6 +425,21 @@ def test_vsim_truth_no_thread_enabled(d_client):
     assert isinstance(sim_no_thread, dict)
 
 
+@skip_if_server_version_lt("8.2.0")
+def test_vsim_epsilon(d_client):
+    d_client.vset().vadd("myset", [2, 1, 1], "a")
+    d_client.vset().vadd("myset", [2, 0, 1], "b")
+    d_client.vset().vadd("myset", [2, 0, 0], "c")
+    d_client.vset().vadd("myset", [2, 0, -1], "d")
+    d_client.vset().vadd("myset", [2, -1, -1], "e")
+
+    res1 = d_client.vset().vsim("myset", [2, 1, 1])
+    assert 5 == len(res1)
+
+    res2 = d_client.vset().vsim("myset", [2, 1, 1], epsilon=0.5)
+    assert 3 == len(res2)
+
+
 @skip_if_server_version_lt("7.9.0")
 def test_vdim(d_client):
     float_array = [1, 4.32, 0.11, 0.5, 0.9, 0.1, 0.2]