ft.profile query_params

Author: dvora-h

redis/commands/search/commands.py

@@ -506,7 +506,7 @@ def _get_aggregate_result(self, raw, query, has_cursor):
 
         return AggregateResult(rows, cursor, schema)
 
-    def profile(self, query, limited=False):
+    def profile(self, query, query_params=None, limited=False):
         """
         Performs a search or aggregate command and collects performance
         information.
@@ -530,6 +530,8 @@ def profile(self, query, limited=False):
         elif isinstance(query, Query):
             cmd[2] = "SEARCH"
             cmd += query.get_args()
+            if query_params is not None:
+                cmd += self.get_params_args(query_params)
         else:
             raise ValueError("Must provide AggregateRequest object or " "Query object.")
 

tests/test_search.py

@@ -1557,6 +1557,30 @@ def test_profile_limited(client):
     assert len(res.docs) == 3  # check also the search result
 
 
+@pytest.mark.redismod
+@skip_ifmodversion_lt("2.4.3", "search")
+def test_profile_query_params(modclient: redis.Redis):
+    modclient.flushdb()
+    modclient.ft().create_index(
+        (
+            VectorField(
+                "v", "HNSW", {"TYPE": "FLOAT32", "DIM": 2, "DISTANCE_METRIC": "L2"}
+            ),
+        )
+    )
+    modclient.hset("a", "v", "aaaaaaaa")
+    modclient.hset("b", "v", "aaaabaaa")
+    modclient.hset("c", "v", "aaaaabaa")
+    query = "*=>[KNN 2 @v $vec]"
+    q = Query(query).return_field("__v_score").sort_by("__v_score", True).dialect(2)
+    res, det = modclient.ft().profile(q, query_params={"vec": "aaaaaaaa"})
+    assert det["Iterators profile"]["Counter"] == 2.0
+    assert det["Iterators profile"]["Type"] == "VECTOR"
+    assert res.total == 2
+    assert "a" == res.docs[0].id
+    assert "0" == res.docs[0].__getattribute__("__v_score")
+
+
 @pytest.mark.redismod
 @skip_ifmodversion_lt("2.4.3", "search")
 def test_vector_field(modclient):