exa-py 1.14.17__py3-none-any.whl → 1.14.19__py3-none-any.whl

exa_py/api.py

@@ -140,7 +140,7 @@ SEARCH_OPTIONS_TYPES = {
         list
     ],  # Must not be present in webpage text. (One string, up to 5 words)
     "use_autoprompt": [bool],  # Convert query to Exa. (Default: false)
-    "type": [str],  # 'keyword', 'neural', 'hybrid', or 'auto' (Default: auto)
+    "type": [str],  # 'keyword', 'neural', 'hybrid', 'fast', or 'auto' (Default: auto)
     "category": [
         str
     ],  # A data category to focus on: 'company', 'research paper', 'news', 'pdf', 'github', 'tweet', 'personal site', 'linkedin profile', 'financial report'
@@ -1251,7 +1251,7 @@ class Exa:
             include_text (List[str], optional): Strings that must appear in the page text.
             exclude_text (List[str], optional): Strings that must not appear in the page text.
             use_autoprompt (bool, optional): Convert query to Exa (default False).
-            type (str, optional): 'keyword', 'neural', or 'hybrid' (default 'neural').
+            type (str, optional): 'keyword', 'neural', 'hybrid', or 'fast' (default 'neural').
             category (str, optional): e.g. 'company'
             flags (List[str], optional): Experimental flags for Exa usage.
             moderation (bool, optional): If True, the search results will be moderated for safety.
@@ -2463,7 +2463,7 @@ class AsyncExa(Exa):
             include_text (List[str], optional): Strings that must appear in the page text.
             exclude_text (List[str], optional): Strings that must not appear in the page text.
             use_autoprompt (bool, optional): Convert query to Exa (default False).
-            type (str, optional): 'keyword', 'neural', or 'hybrid' (default 'neural').
+            type (str, optional): 'keyword', 'neural', 'hybrid', or 'fast' (default 'neural').
             category (str, optional): e.g. 'company'
             flags (List[str], optional): Experimental flags for Exa usage.
             moderation (bool, optional): If True, the search results will be moderated for safety.

exa_py/websets/types.py

@@ -173,7 +173,7 @@ class CreateWebsetSearchParameters(ExaBaseModel):
     """
     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.
+    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.
     """
     behavior: Optional[WebsetSearchBehavior] = WebsetSearchBehavior.override
     """
@@ -305,6 +305,7 @@ class ScopeSourceType(Enum):
     The source type for scope filtering.
     """
     import_ = 'import'
+    webset = 'webset'
 
 
 class PreviewWebsetResponseEnrichmentsFormat(Enum):
@@ -466,6 +467,20 @@ class ExcludeItem(ExaBaseModel):
     """
 
 
+class ScopeRelationship(ExaBaseModel):
+    """
+    Represents the relationship between entities for scoped searches.
+    """
+    definition: str
+    """
+    What the relationship of the entities you hope to find is relative to the entities contained in the provided source
+    """
+    limit: Optional[PositiveInt] = None
+    """
+    Optional limit on the number of related entities to find
+    """
+
+
 class ScopeItem(ExaBaseModel):
     """
     Represents a source to limit search scope to.
@@ -478,6 +493,10 @@ class ScopeItem(ExaBaseModel):
     """
     The ID of the source to search within
     """
+    relationship: Optional[ScopeRelationship] = None
+    """
+    Optional relationship definition for hop searches
+    """
 
 
 class PreviewWebsetParameters(ExaBaseModel):
@@ -1662,12 +1681,53 @@ class WebsetResearchPaperEntity(ExaBaseModel):
     type: Literal['research_paper']
 
 
+class WebsetSearchRecallConfidence(Enum):
+    """
+    Confidence level for search recall estimates.
+    """
+    high = 'high'
+    medium = 'medium'
+    low = 'low'
+
+
+class WebsetSearchRecallExpected(ExaBaseModel):
+    """
+    Expected search recall information.
+    """
+    total: int
+    """
+    Total expected matches
+    """
+    confidence: WebsetSearchRecallConfidence
+    """
+    Confidence level of the estimate
+    """
+
+
+class WebsetSearchRecall(ExaBaseModel):
+    """
+    Search recall estimate information.
+    """
+    expected: WebsetSearchRecallExpected
+    """
+    Expected recall information
+    """
+    reasoning: str
+    """
+    Reasoning for the recall estimate
+    """
+
+
 class WebsetSearch(ExaBaseModel):
     id: str
     """
     The unique identifier for the search
     """
     object: Literal['webset_search']
+    webset_id: Annotated[str, Field(alias='websetId')]
+    """
+    The unique identifier for the Webset this search belongs to
+    """
     status: WebsetSearchStatus = Field(..., title='WebsetSearchStatus')
     """
     The status of the search
@@ -1703,10 +1763,22 @@ class WebsetSearch(ExaBaseModel):
     - `override`: the search will replace the existing Items found in the Webset and evaluate them against the new criteria. Any Items that don't match the new criteria will be discarded.
     - `append`: the search will add the new Items found to the existing Webset. Any Items that don't match the new criteria will be discarded.
     """
+    exclude: Optional[List[ExcludeItem]] = None
+    """
+    Sources (existing imports or websets) used to omit certain results to be found during the search.
+    """
+    scope: Optional[List[ScopeItem]] = None
+    """
+    The scope of the search. By default, there is no scope - thus searching the web. If provided during creation, the search will only be performed on the sources provided.
+    """
     progress: Progress
     """
     The progress of the search
     """
+    recall: Optional[WebsetSearchRecall] = None
+    """
+    Estimate of total potential matches (if requested)
+    """
     metadata: Optional[Dict[str, Any]] = {}
     """
     Set of key-value pairs you want to associate with this object.

{exa_py-1.14.17.dist-info → exa_py-1.14.19.dist-info}/METADATA

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

{exa_py-1.14.17.dist-info → exa_py-1.14.19.dist-info}/RECORD

@@ -1,5 +1,5 @@
 exa_py/__init__.py,sha256=M2GC9oSdoV6m2msboW0vMWWl8wrth4o6gmEV4MYLGG8,66
-exa_py/api.py,sha256=S2GfFiUSQrogwqSWqQvN2w6wb4yrbZAmgERI6NntjSQ,106657
+exa_py/api.py,sha256=82uLarnXTTX2KPrvWsvVQRqUS2ZT2gt0ert0joDD-yU,106681
 exa_py/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 exa_py/research/__init__.py,sha256=QeY-j6bP4QP5tF9ytX0IeQhJvd0Wn4cJCD69U8pP7kA,271
 exa_py/research/client.py,sha256=mnoTA4Qoa0TA5d8nVTR9tAU9LJElXV-MlPozgMxlUp4,12799
@@ -24,9 +24,9 @@ exa_py/websets/monitors/runs/__init__.py,sha256=TmcETf3zdQouA_vAeLiosCNL1MYJnZ0y
 exa_py/websets/monitors/runs/client.py,sha256=WnwcWCf7UKk68VCNUp8mRXBtlU8vglTSX-eoWVXzKIw,1229
 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=KtBX_5yOu01R3sAZBFDv1Qaqan33rNdMF6AtdAmQHFc,45223
+exa_py/websets/types.py,sha256=DxO_T4Ijnd06gxFAX3f238Mt5P0_ulpY44M1kiT4y4U,47120
 exa_py/websets/webhooks/__init__.py,sha256=iTPBCxFd73z4RifLQMX6iRECx_6pwlI5qscLNjMOUHE,77
 exa_py/websets/webhooks/client.py,sha256=zS1eoWKliuiY4AIeFJdpAlPZeOINyphn7KEWANF-zaE,4384
-exa_py-1.14.17.dist-info/METADATA,sha256=r8tMRxGsjX6R8QGh-gJxJ2VqBx5K7Sl0rij0UeLX950,3827
-exa_py-1.14.17.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-exa_py-1.14.17.dist-info/RECORD,,
+exa_py-1.14.19.dist-info/METADATA,sha256=l_SaYT4cgVkMztfTIJm696WkuPNqZPJ4toB2rN3-yvs,3827
+exa_py-1.14.19.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+exa_py-1.14.19.dist-info/RECORD,,