exa-py 1.8.5__tar.gz → 1.8.6__tar.gz

{exa_py-1.8.5 → exa_py-1.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: exa-py
-Version: 1.8.5
+Version: 1.8.6
 Summary: Python SDK for Exa API.
 Author: Exa AI
 Author-email: hello@exa.ai
@@ -91,15 +91,16 @@ exa = Exa(api_key="your-api-key")
   # 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 full text
+  response = exa.answer("This is a query to answer a question", text=True)
 
   # answer with streaming
-  response = exa.answer("This is a query to answer with streaming:", stream=True)
+  response = exa.stream_answer("This is a query to answer:")
 
-  # Print each chunk as it arrives when answer streaming is enabled
+  # Print each chunk as it arrives when using the stream_answer method
   for chunk in response:
-    print(chunk)
+    print(chunk, end='', flush=True)
+
 ```
 
 

{exa_py-1.8.5 → exa_py-1.8.6}/README.md

@@ -73,14 +73,15 @@ exa = Exa(api_key="your-api-key")
   # 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 full text
+  response = exa.answer("This is a query to answer a question", text=True)
 
   # answer with streaming
-  response = exa.answer("This is a query to answer with streaming:", stream=True)
+  response = exa.stream_answer("This is a query to answer:")
 
-  # Print each chunk as it arrives when answer streaming is enabled
+  # Print each chunk as it arrives when using the stream_answer method
   for chunk in response:
-    print(chunk)
+    print(chunk, end='', flush=True)
+
 ```
 

{exa_py-1.8.5 → exa_py-1.8.6}/exa_py/api.py

@@ -17,8 +17,10 @@ from typing import (
     Literal,
     get_origin,
     get_args,
+    Iterator,
 )
 from typing_extensions import TypedDict
+import json
 
 from openai import OpenAI
 from openai.types.chat.chat_completion_message_param import ChatCompletionMessageParam
@@ -30,7 +32,6 @@ from exa_py.utils import (
     maybe_get_query,
 )
 import os
-from typing import Iterator
 
 is_beta = os.getenv("IS_BETA") == "True"
 
@@ -536,8 +537,34 @@ class AnswerResult:
             f"ID: {self.id}\n"
             f"Published Date: {self.published_date}\n"
             f"Author: {self.author}\n"
-            f"Text: {self.text}\n"
+            f"Text: {self.text}\n\n"
         )
+    
+@dataclass
+class StreamChunk:
+    """A class representing a single chunk of streaming data.
+    
+    Attributes:
+        content (Optional[str]): The partial text content of the answer
+        sources (Optional[List[AnswerResult]]): List of sources if provided in this chunk
+    """
+    content: Optional[str] = None
+    sources: Optional[List[AnswerResult]] = None
+    
+    def has_data(self) -> bool:
+        """Check if this chunk contains any data."""
+        return self.content is not None or self.sources is not None
+
+    def __str__(self) -> str:
+        """Format the chunk data as a string."""
+        output = ""
+        if self.content:
+            output += self.content
+        if self.sources:
+            output += "\nSources:"
+            for source in self.sources:
+                output += f"\n{source}"
+        return output
 
 
 @dataclass
@@ -553,11 +580,59 @@ class AnswerResponse:
     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)
+        output = f"Answer: {self.answer}\n\nSources:"
+        for source in self.sources:
+            output += f"\nTitle: {source.title}"
+            output += f"\nURL: {source.url}"
+            output += f"\nPublished: {source.published_date}"
+            output += f"\nAuthor: {source.author}"
+            if source.text:
+                output += f"\nText: {source.text}"
+            output += "\n"
         return output
 
 
+class StreamAnswerResponse:
+    """A class representing a streaming answer response."""
+    def __init__(self, raw_response: requests.Response):
+        self._raw_response = raw_response
+        self._ensure_ok_status()
+
+    def _ensure_ok_status(self):
+        if self._raw_response.status_code != 200:
+            raise ValueError(
+                f"Request failed with status code {self._raw_response.status_code}: {self._raw_response.text}"
+            )
+
+    def __iter__(self) -> Iterator[StreamChunk]:
+        for line in self._raw_response.iter_lines():
+            if not line:
+                continue
+            decoded_line = line.decode("utf-8").removeprefix("data: ")
+            try:
+                chunk = json.loads(decoded_line)
+            except json.JSONDecodeError:
+                continue
+
+            content = None
+            sources = None
+
+            if "choices" in chunk and chunk["choices"]:
+                if "delta" in chunk["choices"][0]:
+                    content = chunk["choices"][0]["delta"].get("content")
+
+            if "sources" in chunk and chunk["sources"] and chunk["sources"] != "null":
+                sources = [AnswerResult(**to_snake_case(s)) for s in chunk["sources"]]
+
+            stream_chunk = StreamChunk(content=content, sources=sources)
+            if stream_chunk.has_data():
+                yield stream_chunk
+
+    def close(self) -> None:
+        """Close the underlying raw response to release the network socket."""
+        self._raw_response.close()
+
+
 T = TypeVar("T")
 
 
@@ -611,7 +686,7 @@ class Exa:
         self,
         api_key: Optional[str],
         base_url: str = "https://api.exa.ai",
-        user_agent: str = "exa-py 1.8.5",
+        user_agent: str = "exa-py 1.8.6",
     ):
         """Initialize the Exa client with the provided API key and optional base URL and user agent.
 
@@ -638,7 +713,7 @@ class Exa:
             data (dict): The JSON payload to send.
 
         Returns:
-            Union[dict, Iterator[str]]: If streaming, returns an iterator of strings (line-by-line).
+            Union[dict, requests.Response]: If streaming, returns the Response object.
             Otherwise, returns the JSON-decoded response as a dict.
 
         Raises:
@@ -646,9 +721,7 @@ class Exa:
         """
         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)
+            return res
 
         res = requests.post(self.base_url + endpoint, json=data, headers=self.headers)
         if res.status_code != 200:
@@ -730,6 +803,7 @@ class Exa:
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
         subpages: Optional[int] = None,
+        subpage_target: Optional[Union[str, List[str]]] = None,
         extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
@@ -752,12 +826,11 @@ class Exa:
         use_autoprompt: Optional[bool] = None,
         type: Optional[str] = None,
         category: Optional[str] = None,
-        flags: Optional[List[str]] = None,
-        moderation: Optional[bool] = None,
         subpages: Optional[int] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
+        subpage_target: Optional[Union[str, List[str]]] = None,
         extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithText]:
         ...
@@ -901,8 +974,6 @@ class Exa:
         category: Optional[str] = None,
         subpages: Optional[int] = None,
         subpage_target: Optional[Union[str, List[str]]] = None,
-        flags: Optional[List[str]] = None,
-        moderation: Optional[bool] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
         filter_empty_results: Optional[bool] = None,
@@ -931,12 +1002,11 @@ class Exa:
         type: Optional[str] = None,
         category: Optional[str] = None,
         flags: Optional[List[str]] = None,
-        moderation: Optional[bool] = None,
         livecrawl_timeout: Optional[int] = None,
         livecrawl: Optional[LIVECRAWL_OPTIONS] = None,
+        filter_empty_results: Optional[bool] = None,
         subpages: Optional[int] = None,
         subpage_target: Optional[Union[str, List[str]]] = None,
-        filter_empty_results: Optional[bool] = None,
         extras: Optional[ExtrasOptions] = None,
     ) -> SearchResponse[ResultWithTextAndHighlightsAndSummary]:
         ...
@@ -1584,33 +1654,36 @@ class Exa:
         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]]]]:
+        text: Optional[bool] = False,
+    ) -> Union[AnswerResponse, StreamAnswerResponse]:
         ...
 
     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]]]]:
+        text: Optional[bool] = False,
+    ) -> Union[AnswerResponse, StreamAnswerResponse]:
         """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.
+            text (bool, optional): Whether to include full text in the results. Defaults to False.
 
         Returns:
-            Union[AnswerResponse, Iterator[Union[str, List[AnswerResult]]]]:
-                - If stream=False, returns an AnswerResponse object containing the answer and sources.
-                - If stream=True, returns an iterator that yields either answer chunks or sources.
+            AnswerResponse: An object containing the answer and sources.
+
+        Raises:
+            ValueError: If stream=True is provided. Use stream_answer() instead for streaming responses.
         """
+        if stream:
+            raise ValueError(
+                "stream=True is not supported in `answer()`. "
+                "Please use `stream_answer(...)` for streaming."
+            )
+
         options = {
             k: v
             for k, v in locals().items()
@@ -1619,10 +1692,34 @@ class Exa:
         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"]]
         )
+
+    def stream_answer(
+        self,
+        query: str,
+        *,
+        text: bool = False,
+    ) -> StreamAnswerResponse:
+        """Generate a streaming answer response.
+
+        Args:
+            query (str): The query to answer.
+            text (bool): Whether to include full text in the results. Defaults to False.
+
+        Returns:
+            StreamAnswerResponse: An object that can be iterated over to retrieve (partial text, partial sources).
+                Each iteration yields a tuple of (Optional[str], Optional[List[AnswerResult]]).
+        """
+        options = {
+            k: v
+            for k, v in locals().items()
+            if k != "self" and v is not None
+        }
+        options = to_camel_case(options)
+        options["stream"] = True
+        raw_response = self.request("/answer", options)
+        return StreamAnswerResponse(raw_response)
+

{exa_py-1.8.5 → exa_py-1.8.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "exa-py"
-version = "1.8.5"
+version = "1.8.6"
 description = "Python SDK for Exa API."
 authors = ["Exa AI <hello@exa.ai>"]
 readme = "README.md"