exa-py 1.0.17__py3-none-any.whl → 1.0.18b1__py3-none-any.whl

exa_py/api.py

@@ -27,6 +27,12 @@ from exa_py.utils import (
     format_exa_result,
     maybe_get_query,
 )
+from dotenv import load_dotenv
+import os
+
+load_dotenv()
+
+is_beta = os.getenv("IS_BETA") == "True"
 
 
 def snake_to_camel(snake_str: str) -> str:
@@ -132,8 +138,18 @@ CONTENTS_OPTIONS_TYPES = {
     "text": [dict, bool],
     "highlights": [dict, bool],
     "summary": [dict, bool],
+    "metadata": [dict, bool],
+    
 }
 
+if is_beta:
+    # the livecrawl options
+    LIVECRAWL_OPTIONS = Literal["always", "fallback", "never"]
+    
+    CONTENTS_OPTIONS_TYPES["livecrawl_timeout"] = [int]
+    CONTENTS_OPTIONS_TYPES["livecrawl"] = [LIVECRAWL_OPTIONS]
+    CONTENTS_OPTIONS_TYPES["filter_empty_results"] = [bool]
+
 
 def validate_search_options(
     options: Dict[str, Optional[object]], expected: dict
@@ -399,15 +415,20 @@ class SearchResponse(Generic[T]):
     Attributes:
         results (List[Result]): A list of search results.
         autoprompt_string (str, optional): The Exa query created by the autoprompt functionality.
+        resolved_search_type (str, optional): What "auto" search resolved to. "neural" or "keyword".
     """
 
     results: List[T]
     autoprompt_string: Optional[str]
+    resolved_search_type: Optional[str]
 
     def __str__(self):
         output = "\n\n".join(str(result) for result in self.results)
         if self.autoprompt_string:
             output += f"\n\nAutoprompt String: {self.autoprompt_string}"
+        if self.resolved_search_type:
+            output += f"\nResolved Search Type: {self.resolved_search_type}"
+
         return output
 
 
@@ -435,7 +456,7 @@ class Exa:
         self,
         api_key: Optional[str],
         base_url: str = "https://api.exa.ai",
-        user_agent: str = "exa-py 1.0.17",
+        user_agent: str = "exa-py 1.0.18",
     ):
         """Initialize the Exa client with the provided API key and optional base URL and user agent.
 
@@ -505,6 +526,7 @@ class Exa:
         return SearchResponse(
             [Result(**to_snake_case(result)) for result in data["results"]],
             data["autopromptString"] if "autopromptString" in data else None,
+            data["resolvedSearchType"] if "resolvedSearchType" in data else None,
         )
 
     @overload
@@ -524,6 +546,9 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -545,6 +570,9 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -566,6 +594,9 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithHighlights]:
         ...
 
@@ -588,6 +619,9 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithTextAndHighlights]:
         ...
 
@@ -609,6 +643,9 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithSummary]:
         ...
 
@@ -631,6 +668,9 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithTextAndSummary]:
         ...
 
@@ -653,6 +693,9 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithHighlightsAndSummary]:
         ...
 
@@ -676,6 +719,9 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithTextAndHighlightsAndSummary]:
         ...
 
@@ -696,12 +742,16 @@ class Exa:
         return SearchResponse(
             [Result(**to_snake_case(result)) for result in data["results"]],
             data["autopromptString"] if "autopromptString" in data else None,
+            data["resolvedSearchType"] if "resolvedSearchType" in data else None,
         )
 
     @overload
     def get_contents(
         self,
         ids: Union[str, List[str], List[_Result]],
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -711,6 +761,9 @@ class Exa:
         ids: Union[str, List[str], List[_Result]],
         *,
         text: Union[TextContentsOptions, Literal[True]],
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -720,6 +773,9 @@ class Exa:
         ids: Union[str, List[str], List[_Result]],
         *,
         highlights: Union[HighlightsContentsOptions, Literal[True]],
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithHighlights]:
         ...
 
@@ -730,6 +786,9 @@ class Exa:
         *,
         text: Union[TextContentsOptions, Literal[True]],
         highlights: Union[HighlightsContentsOptions, Literal[True]],
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithTextAndHighlights]:
         ...
 
@@ -739,6 +798,9 @@ class Exa:
         ids: Union[str, List[str], List[_Result]],
         *,
         summary: Union[SummaryContentsOptions, Literal[True]],
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithSummary]:
         ...
 
@@ -749,6 +811,9 @@ class Exa:
         *,
         text: Union[TextContentsOptions, Literal[True]],
         summary: Union[SummaryContentsOptions, Literal[True]],
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithTextAndSummary]:
         ...
 
@@ -759,6 +824,9 @@ class Exa:
         *,
         highlights: Union[HighlightsContentsOptions, Literal[True]],
         summary: Union[SummaryContentsOptions, Literal[True]],
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithHighlightsAndSummary]:
         ...
 
@@ -770,6 +838,9 @@ class Exa:
         text: Union[TextContentsOptions, Literal[True]],
         highlights: Union[HighlightsContentsOptions, Literal[True]],
         summary: Union[SummaryContentsOptions, Literal[True]],
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithTextAndHighlightsAndSummary]:
         ...
 
@@ -787,6 +858,7 @@ class Exa:
         return SearchResponse(
             [Result(**to_snake_case(result)) for result in data["results"]],
             data["autopromptString"] if "autopromptString" in data else None,
+            data["resolvedSearchType"] if "resolvedSearchType" in data else None,
         )
 
     def find_similar(
@@ -812,6 +884,7 @@ class Exa:
         return SearchResponse(
             [Result(**to_snake_case(result)) for result in data["results"]],
             data["autopromptString"] if "autopromptString" in data else None,
+            data["resolvedSearchType"] if "resolvedSearchType" in data else None,
         )
 
     @overload
@@ -830,6 +903,9 @@ class Exa:
         exclude_text: Optional[List[str]] = None,
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -850,6 +926,9 @@ class Exa:
         exclude_text: Optional[List[str]] = None,
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -870,6 +949,9 @@ class Exa:
         exclude_text: Optional[List[str]] = None,
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithHighlights]:
         ...
 
@@ -891,6 +973,9 @@ class Exa:
         exclude_text: Optional[List[str]] = None,
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithTextAndHighlights]:
         ...
 
@@ -911,6 +996,9 @@ class Exa:
         exclude_text: Optional[List[str]] = None,
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithSummary]:
         ...
 
@@ -932,6 +1020,9 @@ class Exa:
         exclude_text: Optional[List[str]] = None,
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithTextAndSummary]:
         ...
 
@@ -953,6 +1044,9 @@ class Exa:
         exclude_text: Optional[List[str]] = None,
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithHighlightsAndSummary]:
         ...
 
@@ -975,6 +1069,9 @@ class Exa:
         exclude_text: Optional[List[str]] = None,
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
+        livecrawl_timeout: Optional[int] = None,
+        livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
     ) -> SearchResponse[ResultWithTextAndHighlightsAndSummary]:
         ...
 
@@ -995,6 +1092,7 @@ class Exa:
         return SearchResponse(
             [Result(**to_snake_case(result)) for result in data["results"]],
             data["autopromptString"] if "autopromptString" in data else None,
+            data["resolvedSearchType"] if "resolvedSearchType" in data else None,
         )
 
     def wrap(self, client: OpenAI):

{exa_py-1.0.17.dist-info → exa_py-1.0.18b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: exa-py
-Version: 1.0.17
+Name: exa_py
+Version: 1.0.18b1
 Summary: Python SDK for Exa API.
 Home-page: https://github.com/exa-labs/exa-py
 Author: Exa
@@ -9,7 +9,6 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Typing :: Typed
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -18,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
 Requires-Dist: requests
 Requires-Dist: typing-extensions
-Requires-Dist: openai (>=1.10.0)
+Requires-Dist: openai >=1.10.0
 
 # Exa
 

exa_py-1.0.18b1.dist-info/RECORD

@@ -0,0 +1,8 @@
+exa_py/__init__.py,sha256=aVF1zB_UV3dagJ5Vn2WrdcInzibdIW61M89sjwRCU_g,29
+exa_py/api.py,sha256=gHQ-_6LKiK4rj72nqfITKmTIPH40aiRWAra6VG7mKcU,45930
+exa_py/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exa_py/utils.py,sha256=Rc1FJjoR9LQ7L_OJM91Sd1GNkbHjcLyEvJENhRix6gc,2405
+exa_py-1.0.18b1.dist-info/METADATA,sha256=KtG9yo8VrLLhjmptonQo3X6w06GP4XAk6QRxIzg8tBM,3033
+exa_py-1.0.18b1.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
+exa_py-1.0.18b1.dist-info/top_level.txt,sha256=Mfkmscdw9HWR1PtVhU1gAiVo6DHu_tyiVdb89gfZBVI,7
+exa_py-1.0.18b1.dist-info/RECORD,,

{exa_py-1.0.17.dist-info → exa_py-1.0.18b1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: setuptools (74.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

exa_py-1.0.17.dist-info/RECORD

@@ -1,8 +0,0 @@
-exa_py/__init__.py,sha256=aVF1zB_UV3dagJ5Vn2WrdcInzibdIW61M89sjwRCU_g,29
-exa_py/api.py,sha256=6xiQ1yNRqM4z6Qh-PyQWx_HBBKAx3Iq1h9q7Lh31DG0,41075
-exa_py/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-exa_py/utils.py,sha256=Rc1FJjoR9LQ7L_OJM91Sd1GNkbHjcLyEvJENhRix6gc,2405
-exa_py-1.0.17.dist-info/METADATA,sha256=Ow1jUrcf5JE6jueKxDMdD4DTjrCBgbuurn3gTCcioZc,3083
-exa_py-1.0.17.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-exa_py-1.0.17.dist-info/top_level.txt,sha256=Mfkmscdw9HWR1PtVhU1gAiVo6DHu_tyiVdb89gfZBVI,7
-exa_py-1.0.17.dist-info/RECORD,,