supermemory 0.1.0a1__py3-none-any.whl → 3.0.0a1__py3-none-any.whl

supermemory/resources/search.py

@@ -56,6 +56,8 @@ class SearchResource(SyncAPIResource):
         include_summary: bool | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         only_matching_chunks: bool | NotGiven = NOT_GIVEN,
+        rerank: bool | NotGiven = NOT_GIVEN,
+        rewrite_query: bool | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
         # 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.
@@ -65,29 +67,43 @@ class SearchResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SearchExecuteResponse:
         """
-        Search through documents with metadata filtering
+        Search memories with filtering
 
         Args:
           q: Search query string
 
           categories_filter: Optional category filters
 
-          chunk_threshold: Maximum number of chunks to return
+          chunk_threshold: Threshold / sensitivity for chunk selection. 0 is least sensitive (returns most
+              chunks, more results), 1 is most sensitive (returns lesser chunks, accurate
+              results)
 
-          doc_id: Optional document ID to search within
+          doc_id: Optional document ID to search within. You can use this to find chunks in a very
+              large document.
 
-          document_threshold: Maximum number of documents to return
+          document_threshold: Threshold / sensitivity for document selection. 0 is least sensitive (returns
+              most documents, more results), 1 is most sensitive (returns lesser documents,
+              accurate results)
 
           filters: Optional filters to apply to the search
 
           include_summary: If true, include document summary in the response. This is helpful if you want a
-              chatbot to know the context of the document.
+              chatbot to know the full context of the document.
 
           limit: Maximum number of results to return
 
-          only_matching_chunks: If true, only return matching chunks without context
+          only_matching_chunks: If true, only return matching chunks without context. Normally, we send the
+              previous and next chunk to provide more context for LLMs. If you only want the
+              matching chunk, set this to true.
 
-          user_id: End user ID this search is associated with
+          rerank: If true, rerank the results based on the query. This is helpful if you want to
+              ensure the most relevant results are returned.
+
+          rewrite_query: If true, rewrites the query to make it easier to find documents. This increases
+              the latency by about 400ms
+
+          user_id: End user ID this search is associated with. NOTE: This also acts as a filter for
+              the search.
 
           extra_headers: Send extra headers
 
@@ -97,25 +113,30 @@ class SearchResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return self._post(
-            "/search",
-            body=maybe_transform(
-                {
-                    "q": q,
-                    "categories_filter": categories_filter,
-                    "chunk_threshold": chunk_threshold,
-                    "doc_id": doc_id,
-                    "document_threshold": document_threshold,
-                    "filters": filters,
-                    "include_summary": include_summary,
-                    "limit": limit,
-                    "only_matching_chunks": only_matching_chunks,
-                    "user_id": user_id,
-                },
-                search_execute_params.SearchExecuteParams,
-            ),
+        return self._get(
+            "/v3/search",
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "q": q,
+                        "categories_filter": categories_filter,
+                        "chunk_threshold": chunk_threshold,
+                        "doc_id": doc_id,
+                        "document_threshold": document_threshold,
+                        "filters": filters,
+                        "include_summary": include_summary,
+                        "limit": limit,
+                        "only_matching_chunks": only_matching_chunks,
+                        "rerank": rerank,
+                        "rewrite_query": rewrite_query,
+                        "user_id": user_id,
+                    },
+                    search_execute_params.SearchExecuteParams,
+                ),
             ),
             cast_to=SearchExecuteResponse,
         )
@@ -153,6 +174,8 @@ class AsyncSearchResource(AsyncAPIResource):
         include_summary: bool | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         only_matching_chunks: bool | NotGiven = NOT_GIVEN,
+        rerank: bool | NotGiven = NOT_GIVEN,
+        rewrite_query: bool | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
         # 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.
@@ -162,29 +185,43 @@ class AsyncSearchResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SearchExecuteResponse:
         """
-        Search through documents with metadata filtering
+        Search memories with filtering
 
         Args:
           q: Search query string
 
           categories_filter: Optional category filters
 
-          chunk_threshold: Maximum number of chunks to return
+          chunk_threshold: Threshold / sensitivity for chunk selection. 0 is least sensitive (returns most
+              chunks, more results), 1 is most sensitive (returns lesser chunks, accurate
+              results)
 
-          doc_id: Optional document ID to search within
+          doc_id: Optional document ID to search within. You can use this to find chunks in a very
+              large document.
 
-          document_threshold: Maximum number of documents to return
+          document_threshold: Threshold / sensitivity for document selection. 0 is least sensitive (returns
+              most documents, more results), 1 is most sensitive (returns lesser documents,
+              accurate results)
 
           filters: Optional filters to apply to the search
 
           include_summary: If true, include document summary in the response. This is helpful if you want a
-              chatbot to know the context of the document.
+              chatbot to know the full context of the document.
 
           limit: Maximum number of results to return
 
-          only_matching_chunks: If true, only return matching chunks without context
+          only_matching_chunks: If true, only return matching chunks without context. Normally, we send the
+              previous and next chunk to provide more context for LLMs. If you only want the
+              matching chunk, set this to true.
 
-          user_id: End user ID this search is associated with
+          rerank: If true, rerank the results based on the query. This is helpful if you want to
+              ensure the most relevant results are returned.
+
+          rewrite_query: If true, rewrites the query to make it easier to find documents. This increases
+              the latency by about 400ms
+
+          user_id: End user ID this search is associated with. NOTE: This also acts as a filter for
+              the search.
 
           extra_headers: Send extra headers
 
@@ -194,25 +231,30 @@ class AsyncSearchResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return await self._post(
-            "/search",
-            body=await async_maybe_transform(
-                {
-                    "q": q,
-                    "categories_filter": categories_filter,
-                    "chunk_threshold": chunk_threshold,
-                    "doc_id": doc_id,
-                    "document_threshold": document_threshold,
-                    "filters": filters,
-                    "include_summary": include_summary,
-                    "limit": limit,
-                    "only_matching_chunks": only_matching_chunks,
-                    "user_id": user_id,
-                },
-                search_execute_params.SearchExecuteParams,
-            ),
+        return await self._get(
+            "/v3/search",
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "q": q,
+                        "categories_filter": categories_filter,
+                        "chunk_threshold": chunk_threshold,
+                        "doc_id": doc_id,
+                        "document_threshold": document_threshold,
+                        "filters": filters,
+                        "include_summary": include_summary,
+                        "limit": limit,
+                        "only_matching_chunks": only_matching_chunks,
+                        "rerank": rerank,
+                        "rewrite_query": rewrite_query,
+                        "user_id": user_id,
+                    },
+                    search_execute_params.SearchExecuteParams,
+                ),
             ),
             cast_to=SearchExecuteResponse,
         )

supermemory/resources/settings.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Iterable
+from typing import Dict, List
 
 import httpx
 
@@ -18,6 +18,7 @@ from .._response import (
     async_to_streamed_response_wrapper,
 )
 from .._base_client import make_request_options
+from ..types.setting_get_response import SettingGetResponse
 from ..types.setting_update_response import SettingUpdateResponse
 
 __all__ = ["SettingsResource", "AsyncSettingsResource"]
@@ -46,10 +47,9 @@ class SettingsResource(SyncAPIResource):
     def update(
         self,
         *,
-        categories: List[str] | NotGiven = NOT_GIVEN,
         exclude_items: List[str] | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
-        filter_tags: Iterable[setting_update_params.FilterTag] | NotGiven = NOT_GIVEN,
+        filter_tags: Dict[str, List[str]] | NotGiven = NOT_GIVEN,
         include_items: List[str] | NotGiven = NOT_GIVEN,
         should_llm_filter: bool | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -71,11 +71,10 @@ class SettingsResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return self._put(
-            "/settings",
+        return self._patch(
+            "/v3/settings",
             body=maybe_transform(
                 {
-                    "categories": categories,
                     "exclude_items": exclude_items,
                     "filter_prompt": filter_prompt,
                     "filter_tags": filter_tags,
@@ -90,6 +89,25 @@ class SettingsResource(SyncAPIResource):
             cast_to=SettingUpdateResponse,
         )
 
+    def get(
+        self,
+        *,
+        # 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> SettingGetResponse:
+        """Get settings for an organization"""
+        return self._get(
+            "/v3/settings",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SettingGetResponse,
+        )
+
 
 class AsyncSettingsResource(AsyncAPIResource):
     @cached_property
@@ -114,10 +132,9 @@ class AsyncSettingsResource(AsyncAPIResource):
     async def update(
         self,
         *,
-        categories: List[str] | NotGiven = NOT_GIVEN,
         exclude_items: List[str] | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
-        filter_tags: Iterable[setting_update_params.FilterTag] | NotGiven = NOT_GIVEN,
+        filter_tags: Dict[str, List[str]] | NotGiven = NOT_GIVEN,
         include_items: List[str] | NotGiven = NOT_GIVEN,
         should_llm_filter: bool | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -139,11 +156,10 @@ class AsyncSettingsResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return await self._put(
-            "/settings",
+        return await self._patch(
+            "/v3/settings",
             body=await async_maybe_transform(
                 {
-                    "categories": categories,
                     "exclude_items": exclude_items,
                     "filter_prompt": filter_prompt,
                     "filter_tags": filter_tags,
@@ -158,6 +174,25 @@ class AsyncSettingsResource(AsyncAPIResource):
             cast_to=SettingUpdateResponse,
         )
 
+    async def get(
+        self,
+        *,
+        # 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> SettingGetResponse:
+        """Get settings for an organization"""
+        return await self._get(
+            "/v3/settings",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SettingGetResponse,
+        )
+
 
 class SettingsResourceWithRawResponse:
     def __init__(self, settings: SettingsResource) -> None:
@@ -166,6 +201,9 @@ class SettingsResourceWithRawResponse:
         self.update = to_raw_response_wrapper(
             settings.update,
         )
+        self.get = to_raw_response_wrapper(
+            settings.get,
+        )
 
 
 class AsyncSettingsResourceWithRawResponse:
@@ -175,6 +213,9 @@ class AsyncSettingsResourceWithRawResponse:
         self.update = async_to_raw_response_wrapper(
             settings.update,
         )
+        self.get = async_to_raw_response_wrapper(
+            settings.get,
+        )
 
 
 class SettingsResourceWithStreamingResponse:
@@ -184,6 +225,9 @@ class SettingsResourceWithStreamingResponse:
         self.update = to_streamed_response_wrapper(
             settings.update,
         )
+        self.get = to_streamed_response_wrapper(
+            settings.get,
+        )
 
 
 class AsyncSettingsResourceWithStreamingResponse:
@@ -193,3 +237,6 @@ class AsyncSettingsResourceWithStreamingResponse:
         self.update = async_to_streamed_response_wrapper(
             settings.update,
         )
+        self.get = async_to_streamed_response_wrapper(
+            settings.get,
+        )

supermemory/types/__init__.py

@@ -2,15 +2,23 @@
 
 from __future__ import annotations
 
+from .memory_add_params import MemoryAddParams as MemoryAddParams
 from .memory_list_params import MemoryListParams as MemoryListParams
+from .memory_add_response import MemoryAddResponse as MemoryAddResponse
 from .memory_get_response import MemoryGetResponse as MemoryGetResponse
-from .memory_create_params import MemoryCreateParams as MemoryCreateParams
 from .memory_list_response import MemoryListResponse as MemoryListResponse
+from .memory_update_params import MemoryUpdateParams as MemoryUpdateParams
+from .setting_get_response import SettingGetResponse as SettingGetResponse
 from .search_execute_params import SearchExecuteParams as SearchExecuteParams
 from .setting_update_params import SettingUpdateParams as SettingUpdateParams
-from .memory_create_response import MemoryCreateResponse as MemoryCreateResponse
+from .connection_list_params import ConnectionListParams as ConnectionListParams
 from .memory_delete_response import MemoryDeleteResponse as MemoryDeleteResponse
+from .memory_update_response import MemoryUpdateResponse as MemoryUpdateResponse
+from .connection_get_response import ConnectionGetResponse as ConnectionGetResponse
 from .search_execute_response import SearchExecuteResponse as SearchExecuteResponse
 from .setting_update_response import SettingUpdateResponse as SettingUpdateResponse
 from .connection_create_params import ConnectionCreateParams as ConnectionCreateParams
+from .connection_list_response import ConnectionListResponse as ConnectionListResponse
+from .memory_upload_file_params import MemoryUploadFileParams as MemoryUploadFileParams
 from .connection_create_response import ConnectionCreateResponse as ConnectionCreateResponse
+from .memory_upload_file_response import MemoryUploadFileResponse as MemoryUploadFileResponse

supermemory/types/connection_create_params.py

@@ -2,7 +2,8 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, Annotated, TypedDict
+from typing import Dict, Union, Optional
+from typing_extensions import Annotated, TypedDict
 
 from .._utils import PropertyInfo
 
@@ -10,6 +11,8 @@ __all__ = ["ConnectionCreateParams"]
 
 
 class ConnectionCreateParams(TypedDict, total=False):
-    id: Required[str]
+    end_user_id: Annotated[str, PropertyInfo(alias="endUserId")]
 
     redirect_url: Annotated[str, PropertyInfo(alias="redirectUrl")]
+
+    metadata: Optional[Dict[str, Union[str, float, bool]]]

supermemory/types/connection_create_response.py

@@ -1,5 +1,7 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from typing import Optional
+
 from pydantic import Field as FieldInfo
 
 from .._models import BaseModel
@@ -8,6 +10,10 @@ __all__ = ["ConnectionCreateResponse"]
 
 
 class ConnectionCreateResponse(BaseModel):
+    id: str
+
+    auth_link: str = FieldInfo(alias="authLink")
+
     expires_in: str = FieldInfo(alias="expiresIn")
 
-    magic_link: str = FieldInfo(alias="magicLink")
+    redirects_to: Optional[str] = FieldInfo(alias="redirectsTo", default=None)

supermemory/types/connection_get_response.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["ConnectionGetResponse"]
+
+
+class ConnectionGetResponse(BaseModel):
+    id: str
+
+    created_at: float = FieldInfo(alias="createdAt")
+
+    provider: str
+
+    expires_at: Optional[float] = FieldInfo(alias="expiresAt", default=None)
+
+    metadata: Optional[Dict[str, object]] = None

supermemory/types/connection_list_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["ConnectionListParams"]
+
+
+class ConnectionListParams(TypedDict, total=False):
+    end_user_id: Annotated[str, PropertyInfo(alias="endUserId")]

supermemory/types/connection_list_response.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from typing_extensions import TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["ConnectionListResponse", "ConnectionListResponseItem"]
+
+
+class ConnectionListResponseItem(BaseModel):
+    id: str
+
+    created_at: float = FieldInfo(alias="createdAt")
+
+    provider: str
+
+    expires_at: Optional[float] = FieldInfo(alias="expiresAt", default=None)
+
+    metadata: Optional[Dict[str, object]] = None
+
+
+ConnectionListResponse: TypeAlias = List[ConnectionListResponseItem]

supermemory/types/memory_add_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Union
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["MemoryAddParams"]
+
+
+class MemoryAddParams(TypedDict, total=False):
+    content: Required[str]
+
+    container_tags: Annotated[List[str], PropertyInfo(alias="containerTags")]
+
+    metadata: Dict[str, Union[str, float, bool]]

supermemory/types/{memory_create_response.py → memory_add_response.py}

@@ -2,10 +2,10 @@
 
 from .._models import BaseModel
 
-__all__ = ["MemoryCreateResponse"]
+__all__ = ["MemoryAddResponse"]
 
 
-class MemoryCreateResponse(BaseModel):
+class MemoryAddResponse(BaseModel):
     id: str
 
     status: str

supermemory/types/memory_get_response.py

@@ -1,27 +1,11 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, Optional
-
-from pydantic import Field as FieldInfo
-
 from .._models import BaseModel
 
-__all__ = ["MemoryGetResponse", "Doc"]
-
-
-class Doc(BaseModel):
-    created_at: str = FieldInfo(alias="createdAt")
-
-    updated_at: str = FieldInfo(alias="updatedAt")
-
-    metadata: Optional[Dict[str, object]] = None
-
-    summary: Optional[str] = None
-
-    title: Optional[str] = None
+__all__ = ["MemoryGetResponse"]
 
 
 class MemoryGetResponse(BaseModel):
-    doc: Doc
+    id: str
 
-    status: Optional[str] = None
+    status: str

supermemory/types/memory_list_response.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, List, Optional
+from typing import Dict, List, Union, Optional
 from datetime import datetime
 from typing_extensions import Literal
 
@@ -13,33 +13,69 @@ __all__ = ["MemoryListResponse", "Memory", "Pagination"]
 
 class Memory(BaseModel):
     id: str
-    """Unique identifier of the memory"""
+    """Unique identifier of the memory."""
+
+    content: Optional[str] = None
+    """The content to extract and process into a memory.
+
+    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.
+    """
 
     created_at: datetime = FieldInfo(alias="createdAt")
     """Creation timestamp"""
 
-    metadata: Dict[str, object]
-    """Custom metadata associated with the memory"""
+    custom_id: Optional[str] = FieldInfo(alias="customId", default=None)
+    """Optional custom ID of the memory.
+
+    This could be an ID from your database that will uniquely identify this memory.
+    """
+
+    metadata: Union[str, float, bool, Dict[str, object], List[object], None] = None
+    """Optional metadata for the memory.
 
-    status: Optional[Literal["queued", "extracting", "chunking", "embedding", "indexing", "done", "failed"]] = None
-    """Processing status of the memory"""
+    This is used to store additional information about the memory. You can use this
+    to store any additional information you need about the memory. Metadata can be
+    filtered through. Keys must be strings and are case sensitive. Values can be
+    strings, numbers, or booleans. You cannot nest objects.
+    """
+
+    og_image: Optional[str] = FieldInfo(alias="ogImage", default=None)
+
+    source: Optional[str] = None
+
+    status: Literal["unknown", "queued", "extracting", "chunking", "embedding", "indexing", "done", "failed"]
+    """Status of the memory"""
 
     summary: Optional[str] = None
     """Summary of the memory content"""
 
-    title: str
+    title: Optional[str] = None
     """Title of the memory"""
 
+    type: Literal["text", "pdf", "tweet", "google_doc", "image", "video", "notion_doc", "webpage"]
+    """Type of the memory"""
+
     updated_at: datetime = FieldInfo(alias="updatedAt")
     """Last update timestamp"""
 
     url: Optional[str] = None
-    """Source URL of the memory"""
+    """URL of the memory"""
+
+    container_tags: Optional[List[str]] = FieldInfo(alias="containerTags", default=None)
+    """Optional tags this memory 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 memories.
+    """
 
-    workflow_status: Optional[Literal["PENDING", "IN_PROGRESS", "COMPLETED", "FAILED"]] = FieldInfo(
-        alias="workflowStatus", default=None
-    )
-    """Current workflow status"""
+    raw: None = None
+    """Raw content of the memory"""
 
 
 class Pagination(BaseModel):

supermemory/types/memory_update_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Union
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["MemoryUpdateParams"]
+
+
+class MemoryUpdateParams(TypedDict, total=False):
+    content: Required[str]
+
+    container_tags: Annotated[List[str], PropertyInfo(alias="containerTags")]
+
+    metadata: Dict[str, Union[str, float, bool]]