exa-py 1.12.0__py3-none-any.whl → 1.13.0__py3-none-any.whl

exa_py/api.py

@@ -834,6 +834,36 @@ def nest_fields(original_dict: Dict, fields_to_nest: List[str], new_key: str):
 
     return original_dict
 
+@dataclass
+class ResearchTaskResponse:
+    """A class representing the response for a research task.
+
+    Attributes:
+        id (str): The unique identifier for the research request.
+        status (str): Status of the research request.
+        output (Optional[Dict[str, Any]]): The answer structured as JSON, if available.
+        citations (Optional[Dict[str, List[_Result]]]): List of citations used to generate the answer, grouped by root field in the output schema.
+    """
+
+    id: str
+    status: str
+    output: Optional[Dict[str, Any]]
+    citations: Dict[str, List[_Result]]
+
+    def __str__(self):
+        output_repr = (
+            json.dumps(self.output, indent=2, ensure_ascii=False)
+            if self.output is not None
+            else "None"
+        )
+        citations_str = "\n\n".join(str(src) for src in self.citations)
+        return (
+            f"ID: {self.id}\n"
+            f"Status: {self.status}\n"
+            f"Output: {output_repr}\n\n"
+            f"Citations:\n{citations_str}"
+        )
+
 
 class Exa:
     """A client for interacting with Exa API."""
@@ -842,7 +872,7 @@ class Exa:
         self,
         api_key: Optional[str],
         base_url: str = "https://api.exa.ai",
-        user_agent: str = "exa-py 1.12.0",
+        user_agent: str = "exa-py 1.12.1",
     ):
         """Initialize the Exa client with the provided API key and optional base URL and user agent.
 
@@ -1911,6 +1941,37 @@ class Exa:
         raw_response = self.request("/answer", options)
         return StreamAnswerResponse(raw_response)
 
+    def researchTask(
+        self,
+        *,
+        input_instructions: str,
+        output_schema: Dict[str, Any],
+    ) -> ResearchTaskResponse:
+        """Submit a research request to Exa.
+
+        Args:
+            input_instructions (str): The instructions for the research task.
+            output_schema (Dict[str, Any]): JSON schema describing the desired answer structure.
+        """
+        # Build the request payload expected by the Exa API
+        options = {
+            "input": {"instructions": input_instructions},
+            "output": {"schema": output_schema},
+        }
+
+        response = self.request("/research/tasks", options)
+
+        return ResearchTaskResponse(
+            id=response["id"],
+            status=response["status"],
+            output=response.get("output"),
+            citations={
+                key: [_Result(**to_snake_case(citation)) for citation in citations_list]
+                for key, citations_list in response.get("citations", {}).items()
+            },
+        )
+
+
 class AsyncExa(Exa):
     def __init__(self, api_key: str, api_base: str = "https://api.exa.ai"):
         super().__init__(api_key, api_base)
@@ -2244,3 +2305,36 @@ class AsyncExa(Exa):
         options["stream"] = True
         raw_response = await self.async_request("/answer", options)
         return AsyncStreamAnswerResponse(raw_response)
+
+    async def researchTask(
+        self,
+        *,
+        input_instructions: str,
+        output_schema: Dict[str, Any],
+    ) -> ResearchTaskResponse:
+        """Asynchronously submit a research request to Exa.
+
+        Args:
+            input_instructions (str): The instructions for the research task.
+            output_schema (Dict[str, Any]): JSON schema describing the desired answer structure.
+
+        Returns:
+            ResearchTaskResponse: The parsed response from the Exa API.
+        """
+        # Build the request payload expected by the Exa API
+        options = {
+            "input": {"instructions": input_instructions},
+            "output": {"schema": output_schema},
+        }
+
+        response = await self.async_request("/research/tasks", options)
+
+        return ResearchTaskResponse(
+            id=response["id"],
+            status=response["status"],
+            output=response.get("output"),
+            citations={
+                key: [_Result(**to_snake_case(citation)) for citation in citations_list]
+                for key, citations_list in response.get("citations", {}).items()
+            },
+        )

exa_py/websets/types.py

@@ -18,14 +18,14 @@ class CanceledReason(Enum):
 
 
 class CreateCriterionParameters(ExaBaseModel):
-    description: constr(min_length=1, max_length=300)
+    description: constr(min_length=1)
     """
     The description of the criterion
     """
 
 
 class CreateEnrichmentParameters(ExaBaseModel):
-    description: constr(min_length=1, max_length=5000)
+    description: constr(min_length=1)
     """
     Provide a description of the enrichment task you want to perform to each Webset Item.
     """
@@ -88,7 +88,7 @@ class CreateWebsetSearchParameters(ExaBaseModel):
 
     The actual number of Items found may be less than this number depending on the query complexity.
     """
-    query: constr(min_length=1, max_length=5000) = Field(
+    query: constr(min_length=1) = Field(
         ...,
         examples=[
             'Marketing agencies based in the US, that focus on consumer products. Get brands worked with and city'
@@ -136,7 +136,7 @@ class CreateWebsetSearchParameters(ExaBaseModel):
 
 
 class Criterion(ExaBaseModel):
-    description: constr(min_length=1, max_length=300)
+    description: constr(min_length=1)
     """
     The description of the criterion
     """
@@ -338,7 +338,7 @@ class Search(ExaBaseModel):
     Create initial search for the Webset.
     """
 
-    query: constr(min_length=1, max_length=5000) = Field(
+    query: constr(min_length=1) = Field(
         ...,
         examples=[
             'Marketing agencies based in the US, that focus on consumer products.'
@@ -405,7 +405,7 @@ class UpdateWebhookParameters(ExaBaseModel):
 
 
 class UpdateWebsetRequest(ExaBaseModel):
-    metadata: Optional[Dict[str, constr(max_length=1000)]] = None
+    metadata: Optional[Dict[str, str]] = None
     """
     Set of key-value pairs you want to associate with this object.
     """
@@ -564,7 +564,7 @@ class WebsetCreatedEvent(ExaBaseModel):
 
 class WebsetCustomEntity(ExaBaseModel):
     type: Literal['custom']
-    description: constr(min_length=2, max_length=200)
+    description: constr(min_length=2)
     """
     When you decide to use a custom entity, this is the description of the entity.
 
@@ -972,7 +972,7 @@ class WebsetSearch(ExaBaseModel):
     """
     The status of the search
     """
-    query: constr(min_length=1, max_length=5000)
+    query: constr(min_length=1)
     """
     The query used to create the search.
     """

{exa_py-1.12.0.dist-info → exa_py-1.13.0.dist-info}/METADATA

@@ -1,25 +1,21 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: exa-py
-Version: 1.12.0
+Version: 1.13.0
 Summary: Python SDK for Exa API.
+Home-page: https://github.com/exa-labs/exa-py
+Author: Exa
+Author-email: Exa AI <hello@exa.ai>
 License: MIT
-Author: Exa AI
-Author-email: hello@exa.ai
 Requires-Python: >=3.9
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: httpx (>=0.28.1)
-Requires-Dist: openai (>=1.48)
-Requires-Dist: pydantic (>=2.10.6)
-Requires-Dist: pytest-mock (>=3.14.0)
-Requires-Dist: requests (>=2.32.3)
-Requires-Dist: typing-extensions (>=4.12.2)
 Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.32.3
+Requires-Dist: typing-extensions>=4.12.2
+Requires-Dist: openai>=1.48
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pytest-mock>=3.14.0
+Requires-Dist: httpx>=0.28.1
+Dynamic: author
+Dynamic: home-page
 
 # Exa
 
@@ -50,9 +46,6 @@ exa = Exa(api_key="your-api-key")
   # basic search
   results = exa.search("This is a Exa query:")
 
-  # autoprompted search
-  results = exa.search("autopromptable query", use_autoprompt=True)
-
   # keyword search (non-neural)
   results = exa.search("Google-style query", type="keyword")
 
@@ -65,13 +58,9 @@ exa = Exa(api_key="your-api-key")
   # search and get text contents
   results = exa.search_and_contents("This is a Exa query:")
 
-  # search and get highlights
-  results = exa.search_and_contents("This is a Exa query:", highlights=True)
-
   # search and get contents with contents options
   results = exa.search_and_contents("This is a Exa query:", 
-                                    text={"include_html_tags": True, "max_characters": 1000}, 
-                                    highlights={"highlights_per_url": 2, "num_sentences": 1, "query": "This is the highlight query:"})
+                                    text={"include_html_tags": True, "max_characters": 1000})
                                     
   # find similar documents
   results = exa.find_similar("https://example.com")
@@ -80,18 +69,14 @@ exa = Exa(api_key="your-api-key")
   results = exa.find_similar("https://example.com", exclude_source_domain=True)
 
   # find similar with contents
-  results = exa.find_similar_and_contents("https://example.com", text=True, highlights=True)
+  results = exa.find_similar_and_contents("https://example.com", text=True)
 
   # get text contents
-  results = exa.get_contents(["urls"])
-
-  # get highlights
-  results = exa.get_contents(["urls"], highlights=True)
+  results = exa.get_contents(["tesla.com"])
 
   # get contents with contents options
   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:"})
+                             text={"include_html_tags": True, "max_characters": 1000})
 
   # basic answer
   response = exa.answer("This is a query to answer a question")
@@ -108,4 +93,3 @@ exa = Exa(api_key="your-api-key")
 
 ```
 
-

{exa_py-1.12.0.dist-info → exa_py-1.13.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 exa_py/__init__.py,sha256=M2GC9oSdoV6m2msboW0vMWWl8wrth4o6gmEV4MYLGG8,66
-exa_py/api.py,sha256=y8CZs-fYcpxeCLpmiZAL8TxSgqKgMXl9jPaAEYOD7XY,83941
+exa_py/api.py,sha256=0Xa2s-ZhOI4mynqZ6zZQW5tWwRK_SNQNUvmwhEPPk4s,87147
 exa_py/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 exa_py/utils.py,sha256=Rc1FJjoR9LQ7L_OJM91Sd1GNkbHjcLyEvJENhRix6gc,2405
 exa_py/websets/__init__.py,sha256=uOBAb9VrIHrPKoddGOp2ai2KgWlyUVCLMZqfbGOlboA,70
-exa_py/websets/_generator/pydantic/BaseModel.jinja2,sha256=RUDCmPZVamoVx1WudylscYFfDhGoNNtRYlpTvKjAiuA,1276
 exa_py/websets/client.py,sha256=GWHebkvfiGY46sIuksAhYE1RLJrHQVS2PGhlA3xbxhE,4757
+exa_py/websets/types.py,sha256=jKnJFAHTFN55EzsusgDce-yux71zVbdSJ1m8utR4EjU,28096
 exa_py/websets/core/__init__.py,sha256=xOyrFaqtBocMUu321Jpbk7IzIQRNZufSIGJXrKoG-Bg,323
 exa_py/websets/core/base.py,sha256=2vCkPLEKI2K2U7d-76kqVL7qyye007iDdp15GseJN1c,3936
 exa_py/websets/enrichments/__init__.py,sha256=5dJIEKKceUost3RnI6PpCSB3VjUCBzxseEsIXu-ZY-Y,83
@@ -13,9 +13,9 @@ exa_py/websets/items/__init__.py,sha256=DCWZJVtRmUjnMEkKdb5gW1LT9cHcb-J8lENMnyyB
 exa_py/websets/items/client.py,sha256=oZoYr52WrE76Ox6GyoS9rMn7bTrIpno0FKgIWFtb57U,2796
 exa_py/websets/searches/__init__.py,sha256=_0Zx8ES5fFTEL3T8mhLxq_xK2t0JONx6ad6AtbvClsE,77
 exa_py/websets/searches/client.py,sha256=X3f7axWGfecmxf-2tBTX0Yf_--xToz1X8ZHbbudEzy0,1790
-exa_py/websets/types.py,sha256=3AUOFKSKFhqKzXfnvHdj19vI7l6uxinhNpEmqHa-62w,28232
 exa_py/websets/webhooks/__init__.py,sha256=iTPBCxFd73z4RifLQMX6iRECx_6pwlI5qscLNjMOUHE,77
 exa_py/websets/webhooks/client.py,sha256=zsIRMTeJU65yj-zo7Zz-gG02Prtzgcx6utGFSoY4HQQ,4222
-exa_py-1.12.0.dist-info/METADATA,sha256=SASw2EHQ8YYYwbxed5CfqoszNrJKkAcJQ1V5Q7U1w2E,3565
-exa_py-1.12.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-exa_py-1.12.0.dist-info/RECORD,,
+exa_py-1.13.0.dist-info/METADATA,sha256=gRNplBW67MFSW6rKGHP-i_1R6VhyNy68Yxjh4n07rsA,2726
+exa_py-1.13.0.dist-info/WHEEL,sha256=FBI2p9UMPaLApXXRpz7jgjcaDrkbla1BGsqZ5aB70OM,97
+exa_py-1.13.0.dist-info/top_level.txt,sha256=Mfkmscdw9HWR1PtVhU1gAiVo6DHu_tyiVdb89gfZBVI,7
+exa_py-1.13.0.dist-info/RECORD,,

{exa_py-1.12.0.dist-info → exa_py-1.13.0.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: setuptools (78.1.0.post0)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

exa_py-1.13.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+exa_py

exa_py/websets/_generator/pydantic/BaseModel.jinja2

@@ -1,42 +0,0 @@
-{% for decorator in decorators -%}
-{{ decorator }}
-{% endfor -%}
-class {{ class_name }}({{ base_class }}):{% if comment is defined %}  # {{ comment }}{% endif %}
-{%- if description %}
-    """
-    {{ description | indent(4) }}
-    """
-{%- endif %}
-{%- if not fields and not description %}
-    pass
-{%- endif %}
-{%- if config %}
-{%- filter indent(4) %}
-{%- endfilter %}
-{%- endif %}
-{%- for field in fields -%}
-    {%- if field.name == "type" and field.field %}
-    type: Literal['{{ field.default }}']
-    {%- elif field.name == "object" and field.field %}
-    object: Literal['{{ field.default }}']
-    {%- elif not field.annotated and field.field %}
-    {{ field.name }}: {{ field.type_hint }} = {{ field.field }}
-    {%- else %}
-    {%- if field.annotated %}
-    {{ field.name }}: {{ field.annotated }}
-    {%- else %}
-    {{ field.name }}: {{ field.type_hint }}
-    {%- endif %}
-    {%- if not (field.required or (field.represented_default == 'None' and field.strip_default_none)) or field.data_type.is_optional
-            %} = {{ field.represented_default }}
-    {%- endif -%}
-    {%- endif %}
-    {%- if field.docstring %}
-    """
-    {{ field.docstring | indent(4) }}
-    """
-    {%- endif %}
-{%- for method in methods -%}
-    {{ method }}
-{%- endfor -%}
-{%- endfor -%}