exa-py 1.14.15__tar.gz → 1.14.17__tar.gz

{exa_py-1.14.15 → exa_py-1.14.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: exa-py
-Version: 1.14.15
+Version: 1.14.17
 Summary: Python SDK for Exa API.
 License: MIT
 Author: Exa AI

{exa_py-1.14.15 → exa_py-1.14.17}/exa_py/websets/client.py

@@ -10,6 +10,8 @@ from .types import (
     UpdateWebsetRequest,
     WebsetStatus,
     CreateWebsetParameters,
+    PreviewWebsetParameters,
+    PreviewWebsetResponse,
 )
 from .core.base import WebsetsBaseClient
 from .items import WebsetItemsClient
@@ -45,6 +47,23 @@ class WebsetsClient(WebsetsBaseClient):
         response = self.request("/v0/websets", data=params)
         return Webset.model_validate(response)
 
+    def preview(self, params: Union[Dict[str, Any], PreviewWebsetParameters]) -> PreviewWebsetResponse:
+        """Preview a webset query.
+        
+        Preview how a search query will be decomposed before creating a webset. 
+        This endpoint performs the same query analysis that happens during webset creation, 
+        allowing you to see the detected entity type, generated search criteria, and 
+        available enrichment columns in advance.
+        
+        Args:
+            params (PreviewWebsetParameters): The parameters for previewing a webset.
+        
+        Returns:
+            PreviewWebsetResponse: The preview response showing how the query will be decomposed.
+        """
+        response = self.request("/v0/websets/preview", data=params)
+        return PreviewWebsetResponse.model_validate(response)
+
     def get(self, id: str, *, expand: Optional[List[Literal["items"]]] = None) -> GetWebsetResponse:
         """Get a Webset by ID.
         

{exa_py-1.14.15 → exa_py-1.14.17}/exa_py/websets/items/client.py

@@ -15,34 +15,36 @@ class WebsetItemsClient(WebsetsBaseClient):
         super().__init__(client)
 
     def list(self, webset_id: str, *, cursor: Optional[str] = None, 
-             limit: Optional[int] = None) -> ListWebsetItemResponse:
+             limit: Optional[int] = None, source_id: Optional[str] = None) -> ListWebsetItemResponse:
         """List all Items for a Webset.
         
         Args:
             webset_id (str): The id or externalId of the Webset.
             cursor (str, optional): The cursor to paginate through the results.
             limit (int, optional): The number of results to return (max 200).
+            source_id (str, optional): Filter items by source ID.
         
         Returns:
             ListWebsetItemResponse: List of webset items.
         """
-        params = {k: v for k, v in {"cursor": cursor, "limit": limit}.items() if v is not None}
+        params = {k: v for k, v in {"cursor": cursor, "limit": limit, "sourceId": source_id}.items() if v is not None}
         response = self.request(f"/v0/websets/{webset_id}/items", params=params, method="GET")
         return ListWebsetItemResponse.model_validate(response)
 
-    def list_all(self, webset_id: str, *, limit: Optional[int] = None) -> Iterator[WebsetItem]:
+    def list_all(self, webset_id: str, *, limit: Optional[int] = None, source_id: Optional[str] = None) -> Iterator[WebsetItem]:
         """Iterate through all Items in a Webset, handling pagination automatically.
         
         Args:
             webset_id (str): The id or externalId of the Webset.
             limit (int, optional): The number of results to return per page (max 200).
+            source_id (str, optional): Filter items by source ID.
             
         Yields:
             WebsetItem: Each item in the webset.
         """
         cursor = None
         while True:
-            response = self.list(webset_id, cursor=cursor, limit=limit)
+            response = self.list(webset_id, cursor=cursor, limit=limit, source_id=source_id)
             for item in response.data:
                 yield item
             

{exa_py-1.14.15 → exa_py-1.14.17}/exa_py/websets/types.py

@@ -171,6 +171,10 @@ class CreateWebsetSearchParameters(ExaBaseModel):
     """
     Sources (existing imports or websets) to exclude from search results. Any results found within these sources will be omitted to prevent finding them during search.
     """
+    scope: Optional[List[ScopeItem]] = None
+    """
+    Limit the search to specific sources (existing imports). Any results found within these sources matching the search criteria will be included in the Webset.
+    """
     behavior: Optional[WebsetSearchBehavior] = WebsetSearchBehavior.override
     """
     The behavior of the Search when it is added to a Webset.
@@ -296,6 +300,25 @@ class ImportSource(Enum):
     webset = 'webset'
 
 
+class ScopeSourceType(Enum):
+    """
+    The source type for scope filtering.
+    """
+    import_ = 'import'
+
+
+class PreviewWebsetResponseEnrichmentsFormat(Enum):
+    """
+    Format of the enrichment in preview response.
+    """
+    text = 'text'
+    date = 'date'
+    number = 'number'
+    options = 'options'
+    email = 'email'
+    phone = 'phone'
+
+
 class ListEventsResponse(ExaBaseModel):
     data: List[Annotated[
       Union[
@@ -443,6 +466,103 @@ class ExcludeItem(ExaBaseModel):
     """
 
 
+class ScopeItem(ExaBaseModel):
+    """
+    Represents a source to limit search scope to.
+    """
+    source: ScopeSourceType
+    """
+    The type of source (import)
+    """
+    id: str
+    """
+    The ID of the source to search within
+    """
+
+
+class PreviewWebsetParameters(ExaBaseModel):
+    """
+    Parameters for previewing a webset query.
+    """
+    query: str
+    """
+    Natural language search query describing what you are looking for.
+    """
+    entity: Optional[Union[
+        WebsetCompanyEntity,
+        WebsetPersonEntity,
+        WebsetArticleEntity,
+        WebsetResearchPaperEntity,
+        WebsetCustomEntity,
+    ]] = None
+    """
+    Entity used to inform the decomposition. Not required - we automatically detect 
+    the entity from the query. Only use when you need more fine control.
+    """
+
+
+class PreviewWebsetResponseEnrichment(ExaBaseModel):
+    """
+    Detected enrichment in preview response.
+    """
+    description: str
+    """
+    Description of the enrichment.
+    """
+    format: PreviewWebsetResponseEnrichmentsFormat
+    """
+    Format of the enrichment.
+    """
+    options: Optional[List[Option]] = None
+    """
+    When format is options, the options detected from the query.
+    """
+
+
+class PreviewWebsetResponseSearchCriterion(ExaBaseModel):
+    """
+    Detected search criterion in preview response.
+    """
+    description: str
+    """
+    Description of the criterion.
+    """
+
+
+class PreviewWebsetResponseSearch(ExaBaseModel):
+    """
+    Search information in preview response.
+    """
+    entity: Union[
+        WebsetCompanyEntity,
+        WebsetPersonEntity,
+        WebsetArticleEntity,
+        WebsetResearchPaperEntity,
+        WebsetCustomEntity,
+    ]
+    """
+    Detected entity from the query.
+    """
+    criteria: List[PreviewWebsetResponseSearchCriterion]
+    """
+    Detected criteria from the query.
+    """
+
+
+class PreviewWebsetResponse(ExaBaseModel):
+    """
+    Response from previewing a webset query.
+    """
+    search: PreviewWebsetResponseSearch
+    """
+    Search analysis from the query.
+    """
+    enrichments: List[PreviewWebsetResponseEnrichment]
+    """
+    Detected enrichments from the query.
+    """
+
+
 class CsvImportConfig(ExaBaseModel):
     """
     Configuration for CSV imports.
@@ -758,6 +878,10 @@ class CreateWebsetParametersSearch(ExaBaseModel):
     """
     Sources (existing imports or websets) to exclude from search results. Any results found within these sources will be omitted to prevent finding them during search.
     """
+    scope: Optional[List[ScopeItem]] = None
+    """
+    Limit the search to specific sources (existing imports or websets). Any results found within these sources matching the search criteria will be included in the Webset.
+    """
 
 
 class Source(Enum):

{exa_py-1.14.15 → exa_py-1.14.17}/exa_py/websets/webhooks/client.py

@@ -19,7 +19,8 @@ class WebhookAttemptsClient(WebsetsBaseClient):
         super().__init__(client)
     
     def list(self, webhook_id: str, *, cursor: Optional[str] = None, 
-             limit: Optional[int] = None, event_type: Optional[Union[EventType, str]] = None) -> ListWebhookAttemptsResponse:
+             limit: Optional[int] = None, event_type: Optional[Union[EventType, str]] = None,
+             successful: Optional[bool] = None) -> ListWebhookAttemptsResponse:
         """List all attempts made by a Webhook ordered in descending order.
         
         Args:
@@ -27,6 +28,7 @@ class WebhookAttemptsClient(WebsetsBaseClient):
             cursor (str, optional): The cursor to paginate through the results.
             limit (int, optional): The number of results to return (max 200).
             event_type (Union[EventType, str], optional): The type of event to filter by.
+            successful (bool, optional): Filter attempts by success status.
         
         Returns:
             ListWebhookAttemptsResponse: List of webhook attempts.
@@ -41,7 +43,8 @@ class WebhookAttemptsClient(WebsetsBaseClient):
         params = {k: v for k, v in {
             "cursor": cursor, 
             "limit": limit,
-            "eventType": event_type_value
+            "eventType": event_type_value,
+            "successful": successful
         }.items() if v is not None}
         
         response = self.request(f"/v0/webhooks/{webhook_id}/attempts", params=params, method="GET")

{exa_py-1.14.15 → exa_py-1.14.17}/pyproject.toml

@@ -25,7 +25,7 @@ in-project = true
 
 [project]
 name = "exa-py"
-version = "1.14.15"
+version = "1.14.17"
 description = "Python SDK for Exa API."
 readme = "README.md"
 requires-python = ">=3.9"