Added inner_hits option to kNN search (#1777)

Author: miguelgrinberg

elasticsearch_dsl/search_base.py

@@ -514,6 +514,7 @@ def knn(
         boost=None,
         filter=None,
         similarity=None,
+        inner_hits=None,
     ):
         """
         Add a k-nearest neighbor (kNN) search.
@@ -526,6 +527,7 @@ def knn(
         :arg boost: A floating-point boost factor for kNN scores
         :arg filter: query to filter the documents that can match
         :arg similarity: the minimum similarity required for a document to be considered a match, as a float value
+        :arg inner_hits: retrieve hits from nested field
 
         Example::
 
@@ -560,6 +562,8 @@ def knn(
                 s._knn[-1]["filter"] = filter
         if similarity is not None:
             s._knn[-1]["similarity"] = similarity
+        if inner_hits is not None:
+            s._knn[-1]["inner_hits"] = inner_hits
         return s
 
     def rank(self, rrf=None):

tests/_async/test_search.py

@@ -266,6 +266,7 @@ def test_knn():
         query_vector_builder={
             "text_embedding": {"model_id": "foo", "model_text": "search text"}
         },
+        inner_hits={"size": 1},
     )
     assert {
         "knn": [
@@ -283,6 +284,7 @@ def test_knn():
                     "text_embedding": {"model_id": "foo", "model_text": "search text"}
                 },
                 "boost": 0.8,
+                "inner_hits": {"size": 1},
             },
         ]
     } == s.to_dict()

tests/_sync/test_search.py

@@ -266,6 +266,7 @@ def test_knn():
         query_vector_builder={
             "text_embedding": {"model_id": "foo", "model_text": "search text"}
         },
+        inner_hits={"size": 1},
     )
     assert {
         "knn": [
@@ -283,6 +284,7 @@ def test_knn():
                     "text_embedding": {"model_id": "foo", "model_text": "search text"}
                 },
                 "boost": 0.8,
+                "inner_hits": {"size": 1},
             },
         ]
     } == s.to_dict()