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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: exa-py
-Version: 1.8.6
+Version: 1.8.8
 Summary: Python SDK for Exa API.
 Author: Exa AI
 Author-email: hello@exa.ai
@@ -91,8 +91,8 @@ exa = Exa(api_key="your-api-key")
   # basic answer
   response = exa.answer("This is a query to answer a question")
 
-  # answer with full text
-  response = exa.answer("This is a query to answer a question", text=True)
+  # answer with full text, using the exa-pro model (sends 2 expanded quries to exa search)
+  response = exa.answer("This is a query to answer a question", text=True, model="exa-pro")
 
   # answer with streaming
   response = exa.stream_answer("This is a query to answer:")

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

@@ -73,8 +73,8 @@ exa = Exa(api_key="your-api-key")
   # basic answer
   response = exa.answer("This is a query to answer a question")
 
-  # answer with full text
-  response = exa.answer("This is a query to answer a question", text=True)
+  # answer with full text, using the exa-pro model (sends 2 expanded quries to exa search)
+  response = exa.answer("This is a query to answer a question", text=True, model="exa-pro")
 
   # answer with streaming
   response = exa.stream_answer("This is a query to answer:")

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

@@ -505,7 +505,7 @@ class ResultWithTextAndHighlightsAndSummary(_Result):
 
 @dataclass
 class AnswerResult:
-    """A class representing a source result for an answer.
+    """A class representing a result for an answer.
 
     Attributes:
         title (str): The title of the search result.
@@ -513,21 +513,21 @@ class AnswerResult:
         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.
+        text (str, optional): The full page text from each search result.
     """
-
+    id: str 
     url: str
-    id: str
     title: Optional[str] = None
-    author: Optional[str] = None
     published_date: Optional[str] = None
+    author: Optional[str] = None
     text: Optional[str] = None
 
     def __init__(self, **kwargs):
-        self.url = kwargs['url']
         self.id = kwargs['id']
-        self.title = kwargs.get('title')
-        self.author = kwargs.get('author')  
+        self.url = kwargs['url']
+        self.title = kwargs.get('title')    
         self.published_date = kwargs.get('published_date')
+        self.author = kwargs.get('author')  
         self.text = kwargs.get('text')
 
     def __str__(self):
@@ -546,23 +546,23 @@ class StreamChunk:
     
     Attributes:
         content (Optional[str]): The partial text content of the answer
-        sources (Optional[List[AnswerResult]]): List of sources if provided in this chunk
+        citations (Optional[List[AnswerResult]]): List of citations if provided in this chunk
     """
     content: Optional[str] = None
-    sources: Optional[List[AnswerResult]] = None
+    citations: 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
+        return self.content is not None or self.citations 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:
+        if self.citations:
+            output += "\nCitations:"
+            for source in self.citations:
                 output += f"\n{source}"
         return output
 
@@ -573,21 +573,21 @@ class AnswerResponse:
 
     Attributes:
         answer (str): The generated answer.
-        sources (List[AnswerResult]): A list of sources used to generate the answer.
+        citations (List[AnswerResult]): A list of citations used to generate the answer.
     """
 
     answer: str
-    sources: List[AnswerResult]
+    citations: List[AnswerResult]
 
     def __str__(self):
-        output = f"Answer: {self.answer}\n\nSources:"
-        for source in self.sources:
+        output = f"Answer: {self.answer}\n\nCitations:"
+        for source in self.citations:
             output += f"\nTitle: {source.title}"
+            output += f"\nID: {source.id}"
             output += f"\nURL: {source.url}"
-            output += f"\nPublished: {source.published_date}"
+            output += f"\nPublished Date: {source.published_date}"
             output += f"\nAuthor: {source.author}"
-            if source.text:
-                output += f"\nText: {source.text}"
+            output += f"\nText: {source.text}"
             output += "\n"
         return output
 
@@ -615,16 +615,16 @@ class StreamAnswerResponse:
                 continue
 
             content = None
-            sources = None
+            citations = 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"]]
+            if "citations" in chunk and chunk["citations"] and chunk["citations"] != "null":
+                citations = [AnswerResult(**to_snake_case(s)) for s in chunk["citations"]]
 
-            stream_chunk = StreamChunk(content=content, sources=sources)
+            stream_chunk = StreamChunk(content=content, citations=citations)
             if stream_chunk.has_data():
                 yield stream_chunk
 
@@ -686,7 +686,7 @@ class Exa:
         self,
         api_key: Optional[str],
         base_url: str = "https://api.exa.ai",
-        user_agent: str = "exa-py 1.8.6",
+        user_agent: str = "exa-py 1.8.8",
     ):
         """Initialize the Exa client with the provided API key and optional base URL and user agent.
 
@@ -826,6 +826,8 @@ 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,
@@ -974,6 +976,8 @@ 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,
@@ -1002,11 +1006,12 @@ 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]:
         ...
@@ -1656,6 +1661,7 @@ class Exa:
         *,
         stream: Optional[bool] = False,
         text: Optional[bool] = False,
+        model: Optional[Literal["exa", "exa-pro"]] = None,
     ) -> Union[AnswerResponse, StreamAnswerResponse]:
         ...
 
@@ -1665,15 +1671,17 @@ class Exa:
         *,
         stream: Optional[bool] = False,
         text: Optional[bool] = False,
+        model: Optional[Literal["exa", "exa-pro"]] = None,
     ) -> Union[AnswerResponse, StreamAnswerResponse]:
         """Generate an answer to a query using Exa's search and LLM capabilities.
 
         Args:
             query (str): The query to answer.
             text (bool, optional): Whether to include full text in the results. Defaults to False.
+            model (str, optional): The model to use for answering. Either "exa" or "exa-pro". Defaults to None.
 
         Returns:
-            AnswerResponse: An object containing the answer and sources.
+            AnswerResponse: An object containing the answer and citations.
 
         Raises:
             ValueError: If stream=True is provided. Use stream_answer() instead for streaming responses.
@@ -1694,7 +1702,7 @@ class Exa:
 
         return AnswerResponse(
             response["answer"],
-            [AnswerResult(**to_snake_case(result)) for result in response["sources"]]
+            [AnswerResult(**to_snake_case(result)) for result in response["citations"]]
         )
 
     def stream_answer(
@@ -1702,15 +1710,17 @@ class Exa:
         query: str,
         *,
         text: bool = False,
+        model: Optional[Literal["exa", "exa-pro"]] = None,
     ) -> 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.
+            model (str, optional): The model to use for answering. Either "exa" or "exa-pro". Defaults to None.
 
         Returns:
-            StreamAnswerResponse: An object that can be iterated over to retrieve (partial text, partial sources).
+            StreamAnswerResponse: An object that can be iterated over to retrieve (partial text, partial citations).
                 Each iteration yields a tuple of (Optional[str], Optional[List[AnswerResult]]).
         """
         options = {

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

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