exa-py 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

exa_py/api.py

@@ -115,10 +115,10 @@ class TextContentsOptions(TypedDict, total=False):
     """A class representing the options that you can specify when requesting text
 
     Attributes:
-        max_length (int): The maximum number of characters to return.
+        max_characters (int): The maximum number of characters to return. Default: None (no limit).
         include_html_tags (bool): If true, include HTML tags in the returned text. Default false.
     """
-    max_length: int
+    max_characters: int
     include_html_tags: bool
 
 
@@ -126,9 +126,9 @@ class HighlightsContentsOptions(TypedDict, total=False):
     """A class representing the options that you can specify when requesting highlights
 
     Attributes:
-        query (str): The query string for the highlights.
-        num_sentences (int): Size of highlights to return, in sentences.
-        highlights_per_url (int): The number of highlights to return per URL.
+        query (str): The query string for the highlights. if not specified, defaults to a generic summarization query.
+        num_sentences (int): Size of highlights to return, in sentences. Default: 5
+        highlights_per_url (int): The number of highlights to return per URL. Default: 1
     """
     query: str
     num_sentences: int
@@ -290,7 +290,7 @@ def nest_fields(original_dict: Dict, fields_to_nest: List[str], new_key: str):
 class Exa:
     """A client for interacting with Exa API."""
 
-    def __init__(self, api_key: Optional[str], base_url: str = "https://api.exa.ai"):
+    def __init__(self, api_key: Optional[str], base_url: str = "https://api.exa.ai", user_agent: str = "metaphor-python 1.0.2"):
         """Initialize the Exa client with the provided API key and optional base URL and user agent.
 
         Args:
@@ -306,7 +306,7 @@ class Exa:
                     "API key must be provided as argument or in EXA_API_KEY environment variable"
                 )
         self.base_url = base_url
-        self.headers = {"x-api-key": api_key}
+        self.headers = {"x-api-key": api_key, "User-Agent": user_agent}
 
     def request(self, endpoint: str, data):
         res = requests.post(self.base_url + endpoint, json=data, headers=self.headers)

exa_py-1.0.2.dist-info/METADATA

@@ -0,0 +1,114 @@
+Metadata-Version: 2.1
+Name: exa-py
+Version: 1.0.2
+Summary: Python SDK for Exa API.
+Home-page: https://github.com/exa-labs/exa-py
+Author: Exa
+Author-email: hello@exa.ai
+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
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+
+# Exa
+
+Exa API in Python
+
+## Installation
+
+```bash
+pip install exa_py
+```
+
+## Usage
+
+Import the package and initialize the Exa client with your API key:
+
+```python
+from exa_py import Exa
+
+exa = Exa(api_key="your-api-key")
+```
+
+## Search Request
+
+```python
+
+response = exa.search("funny article about silicon valley tech culture",
+    num_results=5,
+    include_domains=["nytimes.com", "wsj.com"],
+    start_published_date="2023-06-12"
+)
+
+for result in response.results:
+    print(result.title, result.url)
+```
+
+## Find Similar
+
+```python
+response = exa.find_similar("https://waitbutwhy.com/2014/05/fermi-paradox.html", num_results=5)
+
+for result in response.results:
+    print(result.title, result.url)
+```
+
+## Retrieve Document Contents
+
+```python
+ids = ["8U71IlQ5DUTdsZFherhhYA", "X3wd0PbJmAvhu_DQjDKA7A"]
+response = exa.get_contents(ids)
+
+for content in response.contents:
+    print(content.title, content.url)
+```
+
+## Reference
+
+### `exa.search()`
+
+This function performs a search on the Exa API.
+
+#### Args
+
+- query (str): The search query.
+- **options**: Additional search options. Valid options are:
+  - `num_results` (int): The number of search results to return.
+  - `include_domains` (list): A list of domains to include in the search.
+  - `exclude_domains` (list): A list of domains to exclude from the search.
+  - `start_crawl_date` (str): The start date for the crawl (in YYYY-MM-DD format).
+  - `end_crawl_date` (str): The end date for the crawl (in YYYY-MM-DD format).
+  - `start_published_date` (str): The start date for when the document was published (in YYYY-MM-DD format).
+  - `end_published_date` (str): The end date for when the document was published (in YYYY-MM-DD format).
+  - `use_autoprompt` (bool): Whether to use autoprompt for the search.
+  - `type` (str): The type of search, 'keyword' or 'neural'. Default: neural
+
+#### Returns
+`SearchResponse`: A dataclass containing the search results.
+
+### `exa.find_similar()`
+
+#### Args:
+- url (str): The base url to find similar links with.
+- **options**: Additional search options. Valid options are:
+    - `num_results` (int): The number of search results to return.
+    - `include_domains` (list): A list of domains to include in the search.
+    - `exclude_domains` (list): A list of domains to exclude from the search.
+    - `start_crawl_date` (str): The start date for the crawl (in YYYY-MM-DD format).
+    - `end_crawl_date` (str): The end date for the crawl (in YYYY-MM-DD format).
+    - `start_published_date` (str): The start date for when the document was published (in YYYY-MM-DD format).
+    - `end_published_date` (str): The end date for when the document was published (in YYYY-MM-DD format).
+
+#### Returns
+`SearchResponse`: A dataclass containing the search results.
+
+# Contribution
+Contributions to exa-py are very welcome! Feel free to submit pull requests or raise issues.

exa_py-1.0.2.dist-info/RECORD

@@ -0,0 +1,6 @@
+exa_py/__init__.py,sha256=aVF1zB_UV3dagJ5Vn2WrdcInzibdIW61M89sjwRCU_g,29
+exa_py/api.py,sha256=o_QmsTVYeiht_vsvUvG_YwfIOPSgHfDQK2HJaeue92A,22669
+exa_py-1.0.2.dist-info/METADATA,sha256=rY0HDDusSvHSCkIka87KcE5uefEUfNsYPEZTukkxmpM,3578
+exa_py-1.0.2.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+exa_py-1.0.2.dist-info/top_level.txt,sha256=Mfkmscdw9HWR1PtVhU1gAiVo6DHu_tyiVdb89gfZBVI,7
+exa_py-1.0.2.dist-info/RECORD,,

exa_py-1.0.0.dist-info/METADATA

@@ -1,15 +0,0 @@
-Metadata-Version: 2.1
-Name: exa-py
-Version: 1.0.0
-Summary: Python SDK for Exa API.
-Home-page: https://github.com/exa-labs/exa-py
-Author: Exa
-Author-email: hello@exa.ai
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Typing :: Typed
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Requires-Dist: requests
-

exa_py-1.0.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-exa_py/__init__.py,sha256=aVF1zB_UV3dagJ5Vn2WrdcInzibdIW61M89sjwRCU_g,29
-exa_py/api.py,sha256=ozFzoRFqob9BnR0e014PCstevrnXXSbIHFMDENAsjiY,22483
-exa_py-1.0.0.dist-info/METADATA,sha256=0pkL9t7VumVU-dep4DyjdQkH1BiJJl9FNg_RfYgprO0,472
-exa_py-1.0.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-exa_py-1.0.0.dist-info/top_level.txt,sha256=Mfkmscdw9HWR1PtVhU1gAiVo6DHu_tyiVdb89gfZBVI,7
-exa_py-1.0.0.dist-info/RECORD,,