Merge pull request #167 from athina-ai/add-highlights-in-search

Add highlights in search

athina/steps/search.py

@@ -32,6 +32,7 @@ class Search(Step):
         endPublishedDate: Optional end date for the search results. Format: YYYY-MM-DD.
         startCrawlDate: Optional Crawl date refers to the date that Exa discovered a link. Results will include links that were crawled after this date. Format: YYYY-MM-DD.
         endCrawlDate: Crawl date refers to the date that Exa discovered a link. Results will include links that were crawled before this date. Format: YYYY-MM-DD.
+        highlights: Text snippets the LLM identifies as most relevant from each page.
         x_api_key: The API key to use for the request.
     """
 
@@ -47,6 +48,7 @@ class Search(Step):
     endPublishedDate: Optional[str] = None
     startCrawlDate: Optional[str] = None
     endCrawlDate: Optional[str] = None
+    highlights: Optional[Dict[str, Any]] = None
 
     x_api_key: str
     env: Environment = None
@@ -87,6 +89,7 @@ def execute(self, input_data: Any) -> Union[Dict[str, Any], None]:
             "contents": {
                 "highlights": {
                     "query": self.query,
+                    **(self.highlights or {})  # Merging self.highlights if it exists, otherwise an empty dict
                 },
                 "summary": {"query": self.query},
             },

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "athina"
-version = "1.7.10"
+version = "1.7.11"
 description = "Python SDK to configure and run evaluations for your LLM-based application"
 authors = ["Shiv Sakhuja <[email protected]>", "Akshat Gupta <[email protected]>", "Vivek Aditya <[email protected]>", "Akhil Bisht <[email protected]>"]
 readme = "README.md"