supermemory 3.0.0a30__py3-none-any.whl → 3.1.0__py3-none-any.whl

supermemory/types/memory_list_response.py

@@ -0,0 +1,95 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["MemoryListResponse", "Memory", "Pagination"]
+
+
+class Memory(BaseModel):
+    id: str
+    """Unique identifier of the document."""
+
+    connection_id: Optional[str] = FieldInfo(alias="connectionId", default=None)
+    """Optional ID of connection the document was created from.
+
+    This is useful for identifying the source of the document.
+    """
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Creation timestamp"""
+
+    custom_id: Optional[str] = FieldInfo(alias="customId", default=None)
+    """Optional custom ID of the document.
+
+    This could be an ID from your database that will uniquely identify this
+    document.
+    """
+
+    metadata: Union[str, float, bool, Dict[str, object], List[object], None] = None
+    """Optional metadata for the document.
+
+    This is used to store additional information about the document. You can use
+    this to store any additional information you need about the document. Metadata
+    can be filtered through. Keys must be strings and are case sensitive. Values can
+    be strings, numbers, or booleans. You cannot nest objects.
+    """
+
+    status: Literal["unknown", "queued", "extracting", "chunking", "embedding", "indexing", "done", "failed"]
+    """Status of the document"""
+
+    summary: Optional[str] = None
+    """Summary of the document content"""
+
+    title: Optional[str] = None
+    """Title of the document"""
+
+    type: Literal[
+        "text",
+        "pdf",
+        "tweet",
+        "google_doc",
+        "google_slide",
+        "google_sheet",
+        "image",
+        "video",
+        "notion_doc",
+        "webpage",
+        "onedrive",
+    ]
+    """Type of the document"""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Last update timestamp"""
+
+    container_tags: Optional[List[str]] = FieldInfo(alias="containerTags", default=None)
+    """Optional tags this document should be containerized by.
+
+    This can be an ID for your user, a project ID, or any other identifier you wish
+    to use to group documents.
+    """
+
+    content: Optional[str] = None
+    """Content of the document (only included when includeContent=true)"""
+
+
+class Pagination(BaseModel):
+    current_page: float = FieldInfo(alias="currentPage")
+
+    limit: float
+
+    total_items: float = FieldInfo(alias="totalItems")
+
+    total_pages: float = FieldInfo(alias="totalPages")
+
+
+class MemoryListResponse(BaseModel):
+    memories: List[Memory]
+
+    pagination: Pagination
+    """Pagination metadata"""

supermemory/types/memory_update_params.py

@@ -0,0 +1,69 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union
+from typing_extensions import Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+
+__all__ = ["MemoryUpdateParams"]
+
+
+class MemoryUpdateParams(TypedDict, total=False):
+    container_tag: Annotated[str, PropertyInfo(alias="containerTag")]
+    """Optional tag this document should be containerized by.
+
+    This can be an ID for your user, a project ID, or any other identifier you wish
+    to use to group documents.
+    """
+
+    container_tags: Annotated[SequenceNotStr[str], PropertyInfo(alias="containerTags")]
+    """
+    (DEPRECATED: Use containerTag instead) Optional tags this document should be
+    containerized by. This can be an ID for your user, a project ID, or any other
+    identifier you wish to use to group documents.
+    """
+
+    content: str
+    """The content to extract and process into a document.
+
+    This can be a URL to a website, a PDF, an image, or a video.
+
+    Plaintext: Any plaintext format
+
+    URL: A URL to a website, PDF, image, or video
+
+    We automatically detect the content type from the url's response format.
+    """
+
+    custom_id: Annotated[str, PropertyInfo(alias="customId")]
+    """Optional custom ID of the document.
+
+    This could be an ID from your database that will uniquely identify this
+    document.
+    """
+
+    file_type: Annotated[str, PropertyInfo(alias="fileType")]
+    """Optional file type override to force specific processing behavior.
+
+    Valid values: text, pdf, tweet, google_doc, google_slide, google_sheet, image,
+    video, notion_doc, webpage, onedrive
+    """
+
+    metadata: Dict[str, Union[str, float, bool, SequenceNotStr[str]]]
+    """Optional metadata for the document.
+
+    This is used to store additional information about the document. You can use
+    this to store any additional information you need about the document. Metadata
+    can be filtered through. Keys must be strings and are case sensitive. Values can
+    be strings, numbers, or booleans. You cannot nest objects.
+    """
+
+    mime_type: Annotated[str, PropertyInfo(alias="mimeType")]
+    """Required when fileType is 'image' or 'video'.
+
+    Specifies the exact MIME type to use (e.g., 'image/png', 'image/jpeg',
+    'video/mp4', 'video/webm')
+    """

supermemory/types/memory_update_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["MemoryUpdateResponse"]
+
+
+class MemoryUpdateResponse(BaseModel):
+    id: str
+
+    status: str

supermemory/types/memory_upload_file_params.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._types import FileTypes
+from .._utils import PropertyInfo
+
+__all__ = ["MemoryUploadFileParams"]
+
+
+class MemoryUploadFileParams(TypedDict, total=False):
+    file: Required[FileTypes]
+    """File to upload and process"""
+
+    container_tags: Annotated[str, PropertyInfo(alias="containerTags")]
+    """Optional JSON string of container tags array.
+
+    This can be an ID for your user, a project ID, or any other identifier you wish
+    to use to group documents.
+    """
+
+    file_type: Annotated[str, PropertyInfo(alias="fileType")]
+    """Optional file type override to force specific processing behavior.
+
+    Valid values: text, pdf, tweet, google_doc, google_slide, google_sheet, image,
+    video, notion_doc, webpage, onedrive
+    """
+
+    mime_type: Annotated[str, PropertyInfo(alias="mimeType")]
+    """Required when fileType is 'image' or 'video'.
+
+    Specifies the exact MIME type to use (e.g., 'image/png', 'image/jpeg',
+    'video/mp4', 'video/webm')
+    """

supermemory/types/memory_upload_file_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["MemoryUploadFileResponse"]
+
+
+class MemoryUploadFileResponse(BaseModel):
+    id: str
+
+    status: str

supermemory/types/search_documents_params.py

@@ -2,13 +2,26 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union, Iterable
+from typing import List, Union, Iterable
 from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
-__all__ = ["SearchDocumentsParams", "Filters", "FiltersUnionMember0"]
+__all__ = [
+    "SearchDocumentsParams",
+    "Filters",
+    "FiltersOr",
+    "FiltersOrOr",
+    "FiltersOrOrUnionMember0",
+    "FiltersOrOrOr",
+    "FiltersOrOrAnd",
+    "FiltersAnd",
+    "FiltersAndAnd",
+    "FiltersAndAndUnionMember0",
+    "FiltersAndAndOr",
+    "FiltersAndAndAnd",
+]
 
 
 class SearchDocumentsParams(TypedDict, total=False):
@@ -48,7 +61,7 @@ class SearchDocumentsParams(TypedDict, total=False):
     """
 
     filters: Filters
-    """Optional filters to apply to the search"""
+    """Optional filters to apply to the search. Can be a JSON string or Query object."""
 
     include_full_docs: Annotated[bool, PropertyInfo(alias="includeFullDocs")]
     """If true, include full document in the response.
@@ -85,10 +98,58 @@ class SearchDocumentsParams(TypedDict, total=False):
     """
 
 
-class FiltersUnionMember0(TypedDict, total=False):
-    and_: Annotated[Iterable[object], PropertyInfo(alias="AND")]
+class FiltersOrOrUnionMember0(TypedDict, total=False):
+    key: Required[str]
 
-    or_: Annotated[Iterable[object], PropertyInfo(alias="OR")]
+    value: Required[str]
 
+    filter_type: Annotated[Literal["metadata", "numeric", "array_contains"], PropertyInfo(alias="filterType")]
 
-Filters: TypeAlias = Union[FiltersUnionMember0, Dict[str, object]]
+    negate: Union[bool, Literal["true", "false"]]
+
+    numeric_operator: Annotated[Literal[">", "<", ">=", "<=", "="], PropertyInfo(alias="numericOperator")]
+
+
+class FiltersOrOrOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
+
+
+class FiltersOrOrAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
+
+
+FiltersOrOr: TypeAlias = Union[FiltersOrOrUnionMember0, FiltersOrOrOr, FiltersOrOrAnd]
+
+
+class FiltersOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[FiltersOrOr], PropertyInfo(alias="OR")]]
+
+
+class FiltersAndAndUnionMember0(TypedDict, total=False):
+    key: Required[str]
+
+    value: Required[str]
+
+    filter_type: Annotated[Literal["metadata", "numeric", "array_contains"], PropertyInfo(alias="filterType")]
+
+    negate: Union[bool, Literal["true", "false"]]
+
+    numeric_operator: Annotated[Literal[">", "<", ">=", "<=", "="], PropertyInfo(alias="numericOperator")]
+
+
+class FiltersAndAndOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
+
+
+class FiltersAndAndAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
+
+
+FiltersAndAnd: TypeAlias = Union[FiltersAndAndUnionMember0, FiltersAndAndOr, FiltersAndAndAnd]
+
+
+class FiltersAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[FiltersAndAnd], PropertyInfo(alias="AND")]]
+
+
+Filters: TypeAlias = Union[FiltersOr, FiltersAnd]

supermemory/types/search_execute_params.py

@@ -2,13 +2,26 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union, Iterable
+from typing import List, Union, Iterable
 from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
-__all__ = ["SearchExecuteParams", "Filters", "FiltersUnionMember0"]
+__all__ = [
+    "SearchExecuteParams",
+    "Filters",
+    "FiltersOr",
+    "FiltersOrOr",
+    "FiltersOrOrUnionMember0",
+    "FiltersOrOrOr",
+    "FiltersOrOrAnd",
+    "FiltersAnd",
+    "FiltersAndAnd",
+    "FiltersAndAndUnionMember0",
+    "FiltersAndAndOr",
+    "FiltersAndAndAnd",
+]
 
 
 class SearchExecuteParams(TypedDict, total=False):
@@ -48,7 +61,7 @@ class SearchExecuteParams(TypedDict, total=False):
     """
 
     filters: Filters
-    """Optional filters to apply to the search"""
+    """Optional filters to apply to the search. Can be a JSON string or Query object."""
 
     include_full_docs: Annotated[bool, PropertyInfo(alias="includeFullDocs")]
     """If true, include full document in the response.
@@ -85,10 +98,58 @@ class SearchExecuteParams(TypedDict, total=False):
     """
 
 
-class FiltersUnionMember0(TypedDict, total=False):
-    and_: Annotated[Iterable[object], PropertyInfo(alias="AND")]
+class FiltersOrOrUnionMember0(TypedDict, total=False):
+    key: Required[str]
 
-    or_: Annotated[Iterable[object], PropertyInfo(alias="OR")]
+    value: Required[str]
 
+    filter_type: Annotated[Literal["metadata", "numeric", "array_contains"], PropertyInfo(alias="filterType")]
 
-Filters: TypeAlias = Union[FiltersUnionMember0, Dict[str, object]]
+    negate: Union[bool, Literal["true", "false"]]
+
+    numeric_operator: Annotated[Literal[">", "<", ">=", "<=", "="], PropertyInfo(alias="numericOperator")]
+
+
+class FiltersOrOrOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
+
+
+class FiltersOrOrAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
+
+
+FiltersOrOr: TypeAlias = Union[FiltersOrOrUnionMember0, FiltersOrOrOr, FiltersOrOrAnd]
+
+
+class FiltersOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[FiltersOrOr], PropertyInfo(alias="OR")]]
+
+
+class FiltersAndAndUnionMember0(TypedDict, total=False):
+    key: Required[str]
+
+    value: Required[str]
+
+    filter_type: Annotated[Literal["metadata", "numeric", "array_contains"], PropertyInfo(alias="filterType")]
+
+    negate: Union[bool, Literal["true", "false"]]
+
+    numeric_operator: Annotated[Literal[">", "<", ">=", "<=", "="], PropertyInfo(alias="numericOperator")]
+
+
+class FiltersAndAndOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
+
+
+class FiltersAndAndAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
+
+
+FiltersAndAnd: TypeAlias = Union[FiltersAndAndUnionMember0, FiltersAndAndOr, FiltersAndAndAnd]
+
+
+class FiltersAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[FiltersAndAnd], PropertyInfo(alias="AND")]]
+
+
+Filters: TypeAlias = Union[FiltersOr, FiltersAnd]

supermemory/types/search_memories_params.py

@@ -2,12 +2,26 @@
 
 from __future__ import annotations
 
-from typing import Dict, Union, Iterable
-from typing_extensions import Required, Annotated, TypeAlias, TypedDict
+from typing import Union, Iterable
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from .._utils import PropertyInfo
 
-__all__ = ["SearchMemoriesParams", "Filters", "FiltersUnionMember0", "Include"]
+__all__ = [
+    "SearchMemoriesParams",
+    "Filters",
+    "FiltersOr",
+    "FiltersOrOr",
+    "FiltersOrOrUnionMember0",
+    "FiltersOrOrOr",
+    "FiltersOrOrAnd",
+    "FiltersAnd",
+    "FiltersAndAnd",
+    "FiltersAndAndUnionMember0",
+    "FiltersAndAndOr",
+    "FiltersAndAndAnd",
+    "Include",
+]
 
 
 class SearchMemoriesParams(TypedDict, total=False):
@@ -22,7 +36,7 @@ class SearchMemoriesParams(TypedDict, total=False):
     """
 
     filters: Filters
-    """Optional filters to apply to the search"""
+    """Optional filters to apply to the search. Can be a JSON string or Query object."""
 
     include: Include
 
@@ -49,18 +63,73 @@ class SearchMemoriesParams(TypedDict, total=False):
     """
 
 
-class FiltersUnionMember0(TypedDict, total=False):
-    and_: Annotated[Iterable[object], PropertyInfo(alias="AND")]
+class FiltersOrOrUnionMember0(TypedDict, total=False):
+    key: Required[str]
 
-    or_: Annotated[Iterable[object], PropertyInfo(alias="OR")]
+    value: Required[str]
 
+    filter_type: Annotated[Literal["metadata", "numeric", "array_contains"], PropertyInfo(alias="filterType")]
 
-Filters: TypeAlias = Union[FiltersUnionMember0, Dict[str, object]]
+    negate: Union[bool, Literal["true", "false"]]
+
+    numeric_operator: Annotated[Literal[">", "<", ">=", "<=", "="], PropertyInfo(alias="numericOperator")]
+
+
+class FiltersOrOrOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
+
+
+class FiltersOrOrAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
+
+
+FiltersOrOr: TypeAlias = Union[FiltersOrOrUnionMember0, FiltersOrOrOr, FiltersOrOrAnd]
+
+
+class FiltersOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[FiltersOrOr], PropertyInfo(alias="OR")]]
+
+
+class FiltersAndAndUnionMember0(TypedDict, total=False):
+    key: Required[str]
+
+    value: Required[str]
+
+    filter_type: Annotated[Literal["metadata", "numeric", "array_contains"], PropertyInfo(alias="filterType")]
+
+    negate: Union[bool, Literal["true", "false"]]
+
+    numeric_operator: Annotated[Literal[">", "<", ">=", "<=", "="], PropertyInfo(alias="numericOperator")]
+
+
+class FiltersAndAndOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
+
+
+class FiltersAndAndAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
+
+
+FiltersAndAnd: TypeAlias = Union[FiltersAndAndUnionMember0, FiltersAndAndOr, FiltersAndAndAnd]
+
+
+class FiltersAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[FiltersAndAnd], PropertyInfo(alias="AND")]]
+
+
+Filters: TypeAlias = Union[FiltersOr, FiltersAnd]
 
 
 class Include(TypedDict, total=False):
     documents: bool
 
+    forgotten_memories: Annotated[bool, PropertyInfo(alias="forgottenMemories")]
+    """If true, include forgotten memories in search results.
+
+    Forgotten memories are memories that have been explicitly forgotten or have
+    passed their expiration date.
+    """
+
     related_memories: Annotated[bool, PropertyInfo(alias="relatedMemories")]
 
     summaries: bool

{supermemory-3.0.0a30.dist-info → supermemory-3.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: supermemory
-Version: 3.0.0a30
+Version: 3.1.0
 Summary: The official Python library for the supermemory API
 Project-URL: Homepage, https://github.com/supermemoryai/python-sdk
 Project-URL: Repository, https://github.com/supermemoryai/python-sdk
@@ -52,7 +52,7 @@ The REST API documentation can be found on [docs.supermemory.ai](https://docs.su
 
 ```sh
 # install from PyPI
-pip install --pre supermemory
+pip install supermemory
 ```
 
 ## Usage
@@ -112,7 +112,7 @@ You can enable this by installing `aiohttp`:
 
 ```sh
 # install from PyPI
-pip install --pre supermemory[aiohttp]
+pip install supermemory[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
@@ -162,6 +162,23 @@ response = client.search.memories(
 print(response.include)
 ```
 
+## File uploads
+
+Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
+
+```python
+from pathlib import Path
+from supermemory import Supermemory
+
+client = Supermemory()
+
+client.memories.upload_file(
+    file=Path("/path/to/file"),
+)
+```
+
+The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `supermemory.APIConnectionError` is raised.
@@ -178,8 +195,8 @@ from supermemory import Supermemory
 client = Supermemory()
 
 try:
-    client.search.documents(
-        q="machine learning concepts",
+    client.memories.add(
+        content="This is a detailed article about machine learning concepts...",
     )
 except supermemory.APIConnectionError as e:
     print("The server could not be reached")
@@ -223,8 +240,8 @@ client = Supermemory(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).search.documents(
-    q="machine learning concepts",
+client.with_options(max_retries=5).memories.add(
+    content="This is a detailed article about machine learning concepts...",
 )
 ```
 
@@ -248,8 +265,8 @@ client = Supermemory(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).search.documents(
-    q="machine learning concepts",
+client.with_options(timeout=5.0).memories.add(
+    content="This is a detailed article about machine learning concepts...",
 )
 ```
 
@@ -291,13 +308,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from supermemory import Supermemory
 
 client = Supermemory()
-response = client.search.with_raw_response.documents(
-    q="machine learning concepts",
+response = client.memories.with_raw_response.add(
+    content="This is a detailed article about machine learning concepts...",
 )
 print(response.headers.get('X-My-Header'))
 
-search = response.parse()  # get the object that `search.documents()` would have returned
-print(search.results)
+memory = response.parse()  # get the object that `memories.add()` would have returned
+print(memory.id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/supermemoryai/python-sdk/tree/main/src/supermemory/_response.py) object.
@@ -311,8 +328,8 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.search.with_streaming_response.documents(
-    q="machine learning concepts",
+with client.memories.with_streaming_response.add(
+    content="This is a detailed article about machine learning concepts...",
 ) as response:
     print(response.headers.get("X-My-Header"))