Add query highlighting to synthesis response

materialsproject · Apr 25, 2021 · 8856979 · 8856979
1 parent 228e0e5
commit 8856979
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/src/mp_api/synthesis/models.py b/src/mp_api/synthesis/models.py
@@ -1,5 +1,5 @@
 from pydantic import BaseModel, Field
-
+from typing import List, Dict
 
 class SynthesisDoc(BaseModel):
     """
@@ -20,3 +20,8 @@ class SynthesisDoc(BaseModel):
         None,
         description="Synthesis description.",
     )
+
+    highlights: List[Dict] = Field(
+        None,
+        description="Highlighted search terms when searching by keyword(s)."
+    )
diff --git a/src/mp_api/synthesis/resources.py b/src/mp_api/synthesis/resources.py
@@ -30,6 +30,10 @@ async def query_synth_text(
                             "path": "text",
                             "allowAnalyzedField": True,
                         },
+                        "highlight": {
+                            "path": "text",
+                            "maxNumPassages": 1
+                        }
                     }
                 },
                 {
@@ -39,6 +43,7 @@ async def query_synth_text(
                         "formula": 1,
                         "text": 1,
                         "search_score": {"$meta": "searchScore"},
+                        "highlights": {"$meta": "searchHighlights"}
                     }
                 },
                 {"$sort": {"search_score": -1}},