exa-py 1.4.0__tar.gz → 1.5.0__tar.gz

{exa_py-1.4.0 → exa_py-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: exa_py
-Version: 1.4.0
+Version: 1.5.0
 Summary: Python SDK for Exa API.
 Home-page: https://github.com/exa-labs/exa-py
 Author: Exa

{exa_py-1.4.0 → exa_py-1.5.0}/exa_py/api.py

@@ -146,6 +146,11 @@ CONTENTS_OPTIONS_TYPES = {
     "filter_empty_results": [bool],
 }
 
+CONTENTS_ENDPOINT_OPTIONS_TYPES = {
+    "subpages": [int],
+    "extras": [dict],
+}
+
 # FOR BETA OPTIONS
 # if is_beta:
 
@@ -214,6 +219,15 @@ class SummaryContentsOptions(TypedDict, total=False):
 
     query: str
 
+class ExtrasOptions(TypedDict, total=False):
+    """A class representing the options that you can specify when requesting summary
+
+    Attributes:
+        query (str): The query string for the summary. Summary will bias towards answering the query.
+    """
+
+    links: int
+
 @dataclass
 class _Result:
     """A class representing the base fields of a search result.
@@ -225,6 +239,9 @@ class _Result:
         score (float, optional): A number from 0 to 1 representing similarity between the query/url and the result.
         published_date (str, optional): An estimate of the creation date, from parsing HTML content.
         author (str, optional): If available, the author of the content.
+        image (str, optional): If available, a URL to an image associated with the content.
+        subpages (List[_Result], optional): If available, a list of Exa contents results for a page's subpages (e.g. tesla.com --subpage--> shop.tesla.com)
+        extras (Dict, optional): Additional metadata associated with the result; currently supports returning links in the text content
     """
 
     url: str
@@ -234,6 +251,8 @@ class _Result:
     published_date: Optional[str] = None
     author: Optional[str] = None
     image: Optional[str] = None
+    subpages: Optional[List[_Result]] = None
+    extras: Optional[Dict] = None
 
     def __init__(self, **kwargs):
         self.url = kwargs['url']
@@ -243,6 +262,8 @@ class _Result:
         self.published_date = kwargs.get('published_date')
         self.author = kwargs.get('author')
         self.image = kwargs.get('image')
+        self.subpages = kwargs.get('subpages')
+        self.extras = kwargs.get("extras")
 
     def __str__(self):
         return (
@@ -253,6 +274,8 @@ class _Result:
             f"Published Date: {self.published_date}\n"
             f"Author: {self.author}\n"
             f"Image: {self.image}\n"
+            f"Extras {self.extras}\n"
+            f"Subpages: {self.subpages}\n"
         )
 
 
@@ -273,6 +296,13 @@ class Result(_Result):
     highlight_scores: Optional[List[float]] = None
     summary: Optional[str] = None
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.text = kwargs.get('text')
+        self.highlights = kwargs.get('highlights')
+        self.highlight_scores = kwargs.get('highlight_scores')
+        self.summary = kwargs.get('summary')
+
     def __str__(self):
         base_str = super().__str__()
         return base_str + (
@@ -294,6 +324,10 @@ class ResultWithText(_Result):
 
     text: str = dataclasses.field(default_factory=str)
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.text = kwargs['text']
+
     def __str__(self):
         base_str = super().__str__()
         return base_str + f"Text: {self.text}\n"
@@ -312,6 +346,12 @@ class ResultWithHighlights(_Result):
     highlights: List[str] = dataclasses.field(default_factory=list)
     highlight_scores: List[float] = dataclasses.field(default_factory=list)
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.highlights = kwargs['highlights']
+        self.highlight_scores = kwargs['highlight_scores']
+
+
     def __str__(self):
         base_str = super().__str__()
         return base_str + (
@@ -335,6 +375,12 @@ class ResultWithTextAndHighlights(_Result):
     highlights: List[str] = dataclasses.field(default_factory=list)
     highlight_scores: List[float] = dataclasses.field(default_factory=list)
 
+    def __init__(self, **kwargs):
+        super.__init__(**kwargs)
+        self.text = kwargs['text']
+        self.highlights = kwargs['highlights']
+        self.highlight_scores = kwargs['highlight_scores']
+
     def __str__(self):
         base_str = super().__str__()
         return base_str + (
@@ -354,6 +400,10 @@ class ResultWithSummary(_Result):
 
     summary: str = dataclasses.field(default_factory=str)
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.summary = kwargs['summary']
+
     def __str__(self):
         base_str = super().__str__()
         return base_str + f"Summary: {self.summary}\n"
@@ -371,6 +421,11 @@ class ResultWithTextAndSummary(_Result):
     text: str = dataclasses.field(default_factory=str)
     summary: str = dataclasses.field(default_factory=str)
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.text = kwargs['text']
+        self.summary = kwargs['summary']
+
     def __str__(self):
         base_str = super().__str__()
         return base_str + f"Text: {self.text}\n" + f"Summary: {self.summary}\n"
@@ -390,6 +445,12 @@ class ResultWithHighlightsAndSummary(_Result):
     highlight_scores: List[float] = dataclasses.field(default_factory=list)
     summary: str = dataclasses.field(default_factory=str)
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.highlights = kwargs['highlights']
+        self.highlight_scores = kwargs['highlight_scores']
+        self.summary = kwargs['summary']
+
     def __str__(self):
         base_str = super().__str__()
         return base_str + (
@@ -415,6 +476,13 @@ class ResultWithTextAndHighlightsAndSummary(_Result):
     highlight_scores: List[float] = dataclasses.field(default_factory=list)
     summary: str = dataclasses.field(default_factory=str)
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.text = kwargs['text']
+        self.highlights = kwargs['highlights']
+        self.highlight_scores = kwargs['highlight_scores']
+        self.summary = kwargs['summary']
+
     def __str__(self):
         base_str = super().__str__()
         return base_str + (
@@ -477,7 +545,7 @@ class Exa:
         self,
         api_key: Optional[str],
         base_url: str = "https://api.exa.ai",
-        user_agent: str = "exa-py 1.4.0",
+        user_agent: str = "exa-py 1.5.0",
     ):
         """Initialize the Exa client with the provided API key and optional base URL and user agent.
 
@@ -571,6 +639,8 @@ class Exa:
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpages: Optional[int] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -592,9 +662,11 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        subpages: Optional[int] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -617,8 +689,10 @@ class Exa:
         type: Optional[str] = None,
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
+        subpages: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithHighlights]:
         ...
 
@@ -642,8 +716,10 @@ class Exa:
         type: Optional[str] = None,
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
+        subpages: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndHighlights]:
         ...
 
@@ -666,8 +742,10 @@ class Exa:
         type: Optional[str] = None,
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
+        subpages: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithSummary]:
         ...
 
@@ -690,9 +768,11 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
+        subpages: Optional[int] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndSummary]:
         ...
 
@@ -716,8 +796,10 @@ class Exa:
         type: Optional[str] = None,
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
+        subpages: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithHighlightsAndSummary]:
         ...
 
@@ -743,7 +825,9 @@ class Exa:
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        subpages: Optional[int] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndHighlightsAndSummary]:
         ...
 
@@ -753,12 +837,12 @@ class Exa:
             for k, v in {"query": query, **kwargs}.items()
             if k != "self" and v is not None
         }
-        if "text" not in options and "highlights" not in options and "summary" not in options:
+        if "text" not in options and "highlights" not in options and "summary" not in options and "subpages" not in options and "extras" not in options:
             options["text"] = True
         validate_search_options(
-            options, {**SEARCH_OPTIONS_TYPES, **CONTENTS_OPTIONS_TYPES}
+            options, {**SEARCH_OPTIONS_TYPES, **CONTENTS_OPTIONS_TYPES, **CONTENTS_ENDPOINT_OPTIONS_TYPES}
         )
-        options = nest_fields(options, ["text", "highlights", "summary"], "contents")
+        options = nest_fields(options, ["text", "highlights", "summary", "subpages", "livecrawl", "livecrawl_timeout", "extras"], "contents")
         options = to_camel_case(options)
         data = self.request("/search", options)
         return SearchResponse(
@@ -775,6 +859,8 @@ class Exa:
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpages: Optional[int] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -787,6 +873,8 @@ class Exa:
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpages: Optional[int] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -799,6 +887,8 @@ class Exa:
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpages: Optional[int] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithHighlights]:
         ...
 
@@ -812,6 +902,8 @@ class Exa:
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpages: Optional[int] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndHighlights]:
         ...
 
@@ -824,6 +916,8 @@ class Exa:
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpages: Optional[int] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithSummary]:
         ...
 
@@ -837,6 +931,8 @@ class Exa:
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpages: Optional[int] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndSummary]:
         ...
 
@@ -850,6 +946,8 @@ class Exa:
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpages: Optional[int] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithHighlightsAndSummary]:
         ...
 
@@ -864,6 +962,8 @@ class Exa:
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpages: Optional[int] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndHighlightsAndSummary]:
         ...
 
@@ -873,9 +973,9 @@ class Exa:
             for k, v in {"ids": ids, **kwargs}.items()
             if k != "self" and v is not None
         }
-        if "text" not in options and "highlights" not in options and "summary" not in options:
+        if "text" not in options and "highlights" not in options and "summary" not in options and "extras" not in options and "subpages" not in options:
             options["text"] = True
-        validate_search_options(options, {**CONTENTS_OPTIONS_TYPES})
+        validate_search_options(options, {**CONTENTS_OPTIONS_TYPES, **CONTENTS_ENDPOINT_OPTIONS_TYPES})
         options = to_camel_case(options)
         data = self.request("/contents", options)
         return SearchResponse(
@@ -929,8 +1029,10 @@ class Exa:
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
+        subpages: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -952,8 +1054,10 @@ class Exa:
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
+        subpages: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
 
@@ -974,9 +1078,11 @@ class Exa:
         exclude_text: Optional[List[str]] = None,
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
+        subpages: Optional[int] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithHighlights]:
         ...
 
@@ -999,8 +1105,10 @@ class Exa:
         exclude_source_domain: Optional[bool] = None,
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
+        subpages: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndHighlights]:
         ...
 
@@ -1023,7 +1131,9 @@ class Exa:
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        subpages: Optional[int] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithSummary]:
         ...
 
@@ -1047,7 +1157,9 @@ class Exa:
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        subpages: Optional[int] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndSummary]:
         ...
 
@@ -1071,7 +1183,9 @@ class Exa:
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        subpages: Optional[int] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithHighlightsAndSummary]:
         ...
 
@@ -1096,7 +1210,9 @@ class Exa:
         category: Optional[str] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        subpages: Optional[int] = None,
         filter_empty_results: Optional[bool] = None,
+        extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndHighlightsAndSummary]:
         ...
 
@@ -1106,13 +1222,13 @@ class Exa:
             for k, v in {"url": url, **kwargs}.items()
             if k != "self" and v is not None
         }
-        if "text" not in options and "highlights" not in options:
+        if "text" not in options and "highlights" not in options and "summary" not in options and "extras" not in options and "subpages" not in options:
             options["text"] = True
         validate_search_options(
-            options, {**FIND_SIMILAR_OPTIONS_TYPES, **CONTENTS_OPTIONS_TYPES}
+            options, {**FIND_SIMILAR_OPTIONS_TYPES, **CONTENTS_OPTIONS_TYPES, **CONTENTS_ENDPOINT_OPTIONS_TYPES}
         )
         options = to_camel_case(options)
-        options = nest_fields(options, ["text", "highlights", "summary"], "contents")
+        options = nest_fields(options, ["text", "highlights", "summary", "subpages", "livecrawl", "livecrawl_timeout", "extras"], "contents")
         data = self.request("/findSimilar", options)
         return SearchResponse(
             [Result(**to_snake_case(result)) for result in data["results"]],

{exa_py-1.4.0 → exa_py-1.5.0}/exa_py.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: exa_py
-Version: 1.4.0
+Version: 1.5.0
 Summary: Python SDK for Exa API.
 Home-page: https://github.com/exa-labs/exa-py
 Author: Exa

{exa_py-1.4.0 → exa_py-1.5.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="exa_py",
-    version="1.4.0",
+    version="1.5.0",
     description="Python SDK for Exa API.",
     long_description_content_type="text/markdown",
     long_description=open("README.md").read(),