feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 21
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-689fa821bc106e236bde463b0a1898788ce8913e70215a7ba49aa8f487115c5c.yml
-openapi_spec_hash: 1f5a6e36a198acd72308a315a042daa7
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-622b43986c45c1efbeb06dd933786980257f300b7a0edbb2d2a4f708afacce36.yml
+openapi_spec_hash: ade837ffc4873d3b50a0fab3f061b397
 config_hash: ca45358b5407440488ec988e3ee21412

src/hyperspell/resources/memories.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Mapping, Optional, cast
+from typing import Dict, List, Union, Mapping, Optional, cast
 from datetime import datetime
 from typing_extensions import Literal
 
@@ -257,6 +257,7 @@ def add(
         text: str,
         collection: Optional[str] | Omit = omit,
         date: Union[str, datetime] | Omit = omit,
+        metadata: Optional[Dict[str, Union[str, float, bool]]] | Omit = omit,
         resource_id: str | Omit = omit,
         title: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -282,6 +283,9 @@ def add(
               the date of the last message). This helps the ranking algorithm and allows you
               to filter by date range.
 
+          metadata: Custom metadata for filtering. Keys must be alphanumeric with underscores, max
+              64 chars. Values must be string, number, or boolean.
+
           resource_id: The resource ID to add the document to. If not provided, a new resource ID will
               be generated. If provided, the document will be updated if it already exists.
 
@@ -302,6 +306,7 @@ def add(
                     "text": text,
                     "collection": collection,
                     "date": date,
+                    "metadata": metadata,
                     "resource_id": resource_id,
                     "title": title,
                 },
@@ -528,6 +533,7 @@ def upload(
         *,
         file: FileTypes,
         collection: Optional[str] | Omit = omit,
+        metadata: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -547,6 +553,9 @@ def upload(
 
           collection: The collection to add the document to.
 
+          metadata: Custom metadata as JSON string for filtering. Keys must be alphanumeric with
+              underscores, max 64 chars. Values must be string, number, or boolean.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -559,6 +568,7 @@ def upload(
             {
                 "file": file,
                 "collection": collection,
+                "metadata": metadata,
             }
         )
         files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
@@ -803,6 +813,7 @@ async def add(
         text: str,
         collection: Optional[str] | Omit = omit,
         date: Union[str, datetime] | Omit = omit,
+        metadata: Optional[Dict[str, Union[str, float, bool]]] | Omit = omit,
         resource_id: str | Omit = omit,
         title: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -828,6 +839,9 @@ async def add(
               the date of the last message). This helps the ranking algorithm and allows you
               to filter by date range.
 
+          metadata: Custom metadata for filtering. Keys must be alphanumeric with underscores, max
+              64 chars. Values must be string, number, or boolean.
+
           resource_id: The resource ID to add the document to. If not provided, a new resource ID will
               be generated. If provided, the document will be updated if it already exists.
 
@@ -848,6 +862,7 @@ async def add(
                     "text": text,
                     "collection": collection,
                     "date": date,
+                    "metadata": metadata,
                     "resource_id": resource_id,
                     "title": title,
                 },
@@ -1074,6 +1089,7 @@ async def upload(
         *,
         file: FileTypes,
         collection: Optional[str] | Omit = omit,
+        metadata: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -1093,6 +1109,9 @@ async def upload(
 
           collection: The collection to add the document to.
 
+          metadata: Custom metadata as JSON string for filtering. Keys must be alphanumeric with
+              underscores, max 64 chars. Values must be string, number, or boolean.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1105,6 +1124,7 @@ async def upload(
             {
                 "file": file,
                 "collection": collection,
+                "metadata": metadata,
             }
         )
         files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])

src/hyperspell/types/memory_add_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Union, Optional
+from typing import Dict, Union, Optional
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
@@ -27,6 +27,13 @@ class MemoryAddParams(TypedDict, total=False):
     range.
     """
 
+    metadata: Optional[Dict[str, Union[str, float, bool]]]
+    """Custom metadata for filtering.
+
+    Keys must be alphanumeric with underscores, max 64 chars. Values must be string,
+    number, or boolean.
+    """
+
     resource_id: str
     """The resource ID to add the document to.
 

src/hyperspell/types/memory_search_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import Dict, List, Union, Optional
 from datetime import datetime
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
@@ -99,6 +99,12 @@ class OptionsBox(TypedDict, total=False):
     before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Only query documents created before this date."""
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     weight: float
     """Weight of results from this source.
 
@@ -117,6 +123,12 @@ class OptionsCollections(TypedDict, total=False):
     before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Only query documents created before this date."""
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     weight: float
     """Weight of results from this source.
 
@@ -142,6 +154,12 @@ class OptionsGoogleCalendar(TypedDict, total=False):
     list of calendars with the `/integrations/google_calendar/list` endpoint.
     """
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     weight: float
     """Weight of results from this source.
 
@@ -160,6 +178,12 @@ class OptionsGoogleDrive(TypedDict, total=False):
     before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Only query documents created before this date."""
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     weight: float
     """Weight of results from this source.
 
@@ -178,6 +202,12 @@ class OptionsGoogleMail(TypedDict, total=False):
     before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Only query documents created before this date."""
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     label_ids: SequenceNotStr[str]
     """List of label IDs to filter messages (e.g., ['INBOX', 'SENT', 'DRAFT']).
 
@@ -204,6 +234,12 @@ class OptionsNotion(TypedDict, total=False):
     before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Only query documents created before this date."""
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     notion_page_ids: SequenceNotStr[str]
     """List of Notion page IDs to search.
 
@@ -228,6 +264,12 @@ class OptionsReddit(TypedDict, total=False):
     before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Only query documents created before this date."""
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     period: Literal["hour", "day", "week", "month", "year", "all"]
     """The time period to search. Defaults to 'month'."""
 
@@ -264,6 +306,12 @@ class OptionsSlack(TypedDict, total=False):
     exclude_archived: Optional[bool]
     """If set, pass 'exclude_archived' to Slack. If None, omit the param."""
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     include_dms: bool
     """Include direct messages (im) when listing conversations."""
 
@@ -294,6 +342,12 @@ class OptionsWebCrawler(TypedDict, total=False):
     before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Only query documents created before this date."""
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     max_depth: int
     """Maximum depth to crawl from the starting URL"""
 
@@ -327,6 +381,12 @@ class Options(TypedDict, total=False):
     collections: OptionsCollections
     """Search options for vault"""
 
+    filter: Optional[Dict[str, object]]
+    """Metadata filters using MongoDB-style operators.
+
+    Example: {'status': 'published', 'priority': {'$gt': 3}}
+    """
+
     google_calendar: OptionsGoogleCalendar
     """Search options for Google Calendar"""
 

src/hyperspell/types/memory_upload_params.py

@@ -16,3 +16,10 @@ class MemoryUploadParams(TypedDict, total=False):
 
     collection: Optional[str]
     """The collection to add the document to."""
+
+    metadata: Optional[str]
+    """Custom metadata as JSON string for filtering.
+
+    Keys must be alphanumeric with underscores, max 64 chars. Values must be string,
+    number, or boolean.
+    """