exa-py 1.7.3__py3-none-any.whl → 1.8.3__py3-none-any.whl

exa_py/api.py

@@ -30,6 +30,7 @@ from exa_py.utils import (
     maybe_get_query,
 )
 import os
+from typing import Iterator
 
 is_beta = os.getenv("IS_BETA") == "True"
 
@@ -494,6 +495,56 @@ class ResultWithTextAndHighlightsAndSummary(_Result):
             f"Summary: {self.summary}\n"
         )
 
+@dataclass
+class AnswerResult:
+    """A class representing a source result for an answer.
+
+    Attributes:
+        title (str): The title of the search result.
+        url (str): The URL of the search result.
+        id (str): The temporary ID for the document.
+        published_date (str, optional): An estimate of the creation date, from parsing HTML content.
+        author (str, optional): If available, the author of the content.
+    """
+
+    url: str
+    id: str
+    title: Optional[str] = None
+    published_date: Optional[str] = None
+    author: Optional[str] = None
+
+    def __init__(self, **kwargs):
+        self.url = kwargs['url']
+        self.id = kwargs['id']
+        self.title = kwargs.get('title')
+        self.published_date = kwargs.get('published_date')
+        self.author = kwargs.get('author')
+
+    def __str__(self):
+        return (
+            f"Title: {self.title}\n"
+            f"URL: {self.url}\n"
+            f"ID: {self.id}\n"
+            f"Published Date: {self.published_date}\n"
+            f"Author: {self.author}\n"
+        )
+
+@dataclass
+class AnswerResponse:
+    """A class representing the response for an answer operation.
+
+    Attributes:
+        answer (str): The generated answer.
+        sources (List[AnswerResult]): A list of sources used to generate the answer.
+    """
+
+    answer: str
+    sources: List[AnswerResult]
+
+    def __str__(self):
+        output = f"Answer: {self.answer}\n\nSources:\n"
+        output += "\n\n".join(str(source) for source in self.sources)
+        return output
 
 T = TypeVar("T")
 
@@ -548,7 +599,7 @@ class Exa:
         self,
         api_key: Optional[str],
         base_url: str = "https://api.exa.ai",
-        user_agent: str = "exa-py 1.7.3",
+        user_agent: str = "exa-py 1.8.3",
     ):
         """Initialize the Exa client with the provided API key and optional base URL and user agent.
 
@@ -568,11 +619,15 @@ class Exa:
         self.headers = {"x-api-key": api_key, "User-Agent": user_agent}
 
     def request(self, endpoint: str, data):
+        if data.get("stream"):
+            res = requests.post(self.base_url + endpoint, json=data, headers=self.headers, stream=True)
+            if res.status_code != 200:
+                raise ValueError(f"Request failed with status code {res.status_code}: {res.text}")
+            return (line.decode('utf-8') for line in res.iter_lines() if line)
+            
         res = requests.post(self.base_url + endpoint, json=data, headers=self.headers)
         if res.status_code != 200:
-            raise ValueError(
-                f"Request failed with status code {res.status_code}: {res.text}"
-            )
+            raise ValueError(f"Request failed with status code {res.status_code}: {res.text}")
         return res.json()
 
     def search(
@@ -1453,3 +1508,50 @@ class Exa:
             completion=completion, exa_result=exa_result
         )
         return exa_completion
+
+    @overload
+    def answer(
+        self,
+        query: str,
+        *,
+        expanded_queries_limit: Optional[int] = 1,
+        stream: Optional[bool] = False,
+        include_text: Optional[bool] = False,
+    ) -> Union[AnswerResponse, Iterator[Union[str, List[AnswerResult]]]]:
+        ...
+
+    def answer(
+        self,
+        query: str,
+        *,
+        expanded_queries_limit: Optional[int] = 1,
+        stream: Optional[bool] = False,
+        include_text: Optional[bool] = False,
+    ) -> Union[AnswerResponse, Iterator[Union[str, List[AnswerResult]]]]:
+        """Generate an answer to a query using Exa's search and LLM capabilities.
+
+        Args:
+            query (str): The query to answer.
+            expanded_queries_limit (int, optional): Maximum number of query variations (0-4). Defaults to 1.
+            stream (bool, optional): Whether to stream the response. Defaults to False.
+            include_text (bool, optional): Whether to include full text in the results. Defaults to False.
+
+        Returns:
+            Union[AnswerResponse, Iterator[Union[str, List[AnswerResult]]]]: Either an AnswerResponse object containing the answer and sources,
+            or an iterator that yields either answer chunks or sources when streaming is enabled.
+        """
+        options = {
+            k: v
+            for k, v in locals().items()
+            if k != "self" and v is not None
+        }
+        options = to_camel_case(options)
+        response = self.request("/answer", options)
+        
+        if stream:
+            return response
+            
+        return AnswerResponse(
+            response["answer"],
+            [AnswerResult(**to_snake_case(result)) for result in response["sources"]]
+        )

{exa_py-1.7.3.dist-info → exa_py-1.8.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: exa-py
-Version: 1.7.3
+Version: 1.8.3
 Summary: Python SDK for Exa API.
 Author: Exa AI
 Author-email: hello@exa.ai
@@ -87,6 +87,19 @@ exa = Exa(api_key="your-api-key")
   results = exa.get_contents(["urls"], 
                              text={"include_html_tags": True, "max_characters": 1000}, 
                              highlights={"highlights_per_url": 2, "num_sentences": 1, "query": "This is the highlight query:"})
+
+  # basic answer
+  response = exa.answer("This is a query to answer a question")
+
+  # answer with expanded queries and full text
+  response = exa.answer("This is a query to answer a question", expanded_queries_limit=3, include_text=True)
+
+  # answer with streaming
+  response = exa.answer("This is a query to answer with streaming:", stream=True)
+
+  # Print each chunk as it arrives when answer streaming is enabled
+  for chunk in response:
+    print(chunk)
 ```
 
 

exa_py-1.8.3.dist-info/RECORD

@@ -0,0 +1,7 @@
+exa_py/__init__.py,sha256=1selemczpRm1y8V9cWNm90LARnU1jbtyp-Qpx3c7cTw,28
+exa_py/api.py,sha256=1Bc9S8OMgGwtih1hXqhYzv54d2Sj04EunMuNoDuqqrg,57257
+exa_py/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exa_py/utils.py,sha256=Rc1FJjoR9LQ7L_OJM91Sd1GNkbHjcLyEvJENhRix6gc,2405
+exa_py-1.8.3.dist-info/METADATA,sha256=Tp7sUiNVUCyL37ZcfL7v0goOSHn0q35vg-qrYLYAG2I,3389
+exa_py-1.8.3.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+exa_py-1.8.3.dist-info/RECORD,,

exa_py-1.7.3.dist-info/RECORD

@@ -1,7 +0,0 @@
-exa_py/__init__.py,sha256=1selemczpRm1y8V9cWNm90LARnU1jbtyp-Qpx3c7cTw,28
-exa_py/api.py,sha256=s2PzWTN_NSECTlJjEnaN22frTnoxXw0PdO2aalKUX2I,53610
-exa_py/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-exa_py/utils.py,sha256=Rc1FJjoR9LQ7L_OJM91Sd1GNkbHjcLyEvJENhRix6gc,2405
-exa_py-1.7.3.dist-info/METADATA,sha256=tMUP_KFmo-S9zvX72MFY3qW8MIMMj5ZtYUldP_4fTt4,2930
-exa_py-1.7.3.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-exa_py-1.7.3.dist-info/RECORD,,