supermemory 3.7.0__py3-none-any.whl

supermemory/types/memory_list_response.py

@@ -0,0 +1,94 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+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: str = 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: str = 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")
+
+    total_items: float = FieldInfo(alias="totalItems")
+
+    total_pages: float = FieldInfo(alias="totalPages")
+
+    limit: Optional[float] = None
+
+
+class MemoryListResponse(BaseModel):
+    memories: List[Memory]
+
+    pagination: Pagination
+    """Pagination metadata"""

supermemory/types/memory_update_params.py

@@ -0,0 +1,55 @@
+# 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.
+    """
+
+    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.
+    """

supermemory/types/memory_update_response.py

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

supermemory/types/memory_upload_file_params.py

@@ -0,0 +1,44 @@
+# 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 container tags.
+
+    Can be either a JSON string of an array (e.g., '["user_123", "project_123"]') or
+    a single string (e.g., 'user_123'). Single strings will be automatically
+    converted to an array.
+    """
+
+    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: str
+    """Optional metadata for the document as a JSON string.
+
+    This is used to store additional information about the document. Keys must be
+    strings and values can be strings, numbers, or booleans.
+    """
+
+    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,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["MemoryUploadFileResponse"]
+
+
+class MemoryUploadFileResponse(BaseModel):
+    id: str
+    """Unique identifier of the document"""
+
+    status: str
+    """Status of the document"""

supermemory/types/profile_response.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["ProfileResponse", "Profile", "SearchResults"]
+
+
+class Profile(BaseModel):
+    dynamic: List[str]
+    """Dynamic profile information (recent memories)"""
+
+    static: List[str]
+    """Static profile information that remains relevant long-term"""
+
+
+class SearchResults(BaseModel):
+    results: List[object]
+    """Search results for the provided query"""
+
+    timing: float
+    """Search timing in milliseconds"""
+
+    total: float
+    """Total number of search results"""
+
+
+class ProfileResponse(BaseModel):
+    profile: Profile
+
+    search_results: Optional[SearchResults] = FieldInfo(alias="searchResults", default=None)
+    """Search results if a search query was provided"""

supermemory/types/search_documents_params.py

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+
+__all__ = ["SearchDocumentsParams", "Filters", "FiltersOr", "FiltersAnd"]
+
+
+class SearchDocumentsParams(TypedDict, total=False):
+    q: Required[str]
+    """Search query string"""
+
+    categories_filter: Annotated[SequenceNotStr[str], PropertyInfo(alias="categoriesFilter")]
+    """DEPRECATED: Optional category filters"""
+
+    chunk_threshold: Annotated[float, PropertyInfo(alias="chunkThreshold")]
+    """Threshold / sensitivity for chunk selection.
+
+    0 is least sensitive (returns most chunks, more results), 1 is most sensitive
+    (returns lesser chunks, accurate results)
+    """
+
+    container_tags: Annotated[SequenceNotStr[str], PropertyInfo(alias="containerTags")]
+    """Optional tags this search should be containerized by.
+
+    This can be an ID for your user, a project ID, or any other identifier you wish
+    to use to filter documents.
+    """
+
+    doc_id: Annotated[str, PropertyInfo(alias="docId")]
+    """Optional document ID to search within.
+
+    You can use this to find chunks in a very large document.
+    """
+
+    document_threshold: Annotated[float, PropertyInfo(alias="documentThreshold")]
+    """DEPRECATED: This field is no longer used in v3 search.
+
+    The search now uses chunkThreshold only. This parameter will be ignored.
+    """
+
+    filters: Filters
+    """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.
+
+    This is helpful if you want a chatbot to know the full context of the document.
+    """
+
+    include_summary: Annotated[bool, PropertyInfo(alias="includeSummary")]
+    """If true, include document summary in the response.
+
+    This is helpful if you want a chatbot to know the full context of the document.
+    """
+
+    limit: int
+    """Maximum number of results to return"""
+
+    only_matching_chunks: Annotated[bool, PropertyInfo(alias="onlyMatchingChunks")]
+    """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.
+    """
+
+    rerank: bool
+    """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: Annotated[bool, PropertyInfo(alias="rewriteQuery")]
+    """If true, rewrites the query to make it easier to find documents.
+
+    This increases the latency by about 400ms
+    """
+
+
+class FiltersOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
+
+
+class FiltersAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
+
+
+Filters: TypeAlias = Union[FiltersOr, FiltersAnd]

supermemory/types/search_documents_response.py

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["SearchDocumentsResponse", "Result", "ResultChunk"]
+
+
+class ResultChunk(BaseModel):
+    content: str
+    """Content of the matching chunk"""
+
+    is_relevant: bool = FieldInfo(alias="isRelevant")
+    """Whether this chunk is relevant to the query"""
+
+    score: float
+    """Similarity score for this chunk"""
+
+
+class Result(BaseModel):
+    chunks: List[ResultChunk]
+    """Matching content chunks from the document"""
+
+    created_at: str = FieldInfo(alias="createdAt")
+    """Document creation date"""
+
+    document_id: str = FieldInfo(alias="documentId")
+    """ID of the matching document"""
+
+    metadata: Optional[Dict[str, object]] = None
+    """Document metadata"""
+
+    score: float
+    """Relevance score of the match"""
+
+    title: Optional[str] = None
+    """Document title"""
+
+    type: Optional[str] = None
+    """Document type"""
+
+    updated_at: str = FieldInfo(alias="updatedAt")
+    """Document last update date"""
+
+    content: Optional[str] = None
+    """Full document content (only included when includeFullDocs=true)"""
+
+    summary: Optional[str] = None
+    """Document summary"""
+
+
+class SearchDocumentsResponse(BaseModel):
+    results: List[Result]
+
+    timing: float
+
+    total: float

supermemory/types/search_execute_params.py

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+
+__all__ = ["SearchExecuteParams", "Filters", "FiltersOr", "FiltersAnd"]
+
+
+class SearchExecuteParams(TypedDict, total=False):
+    q: Required[str]
+    """Search query string"""
+
+    categories_filter: Annotated[SequenceNotStr[str], PropertyInfo(alias="categoriesFilter")]
+    """DEPRECATED: Optional category filters"""
+
+    chunk_threshold: Annotated[float, PropertyInfo(alias="chunkThreshold")]
+    """Threshold / sensitivity for chunk selection.
+
+    0 is least sensitive (returns most chunks, more results), 1 is most sensitive
+    (returns lesser chunks, accurate results)
+    """
+
+    container_tags: Annotated[SequenceNotStr[str], PropertyInfo(alias="containerTags")]
+    """Optional tags this search should be containerized by.
+
+    This can be an ID for your user, a project ID, or any other identifier you wish
+    to use to filter documents.
+    """
+
+    doc_id: Annotated[str, PropertyInfo(alias="docId")]
+    """Optional document ID to search within.
+
+    You can use this to find chunks in a very large document.
+    """
+
+    document_threshold: Annotated[float, PropertyInfo(alias="documentThreshold")]
+    """DEPRECATED: This field is no longer used in v3 search.
+
+    The search now uses chunkThreshold only. This parameter will be ignored.
+    """
+
+    filters: Filters
+    """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.
+
+    This is helpful if you want a chatbot to know the full context of the document.
+    """
+
+    include_summary: Annotated[bool, PropertyInfo(alias="includeSummary")]
+    """If true, include document summary in the response.
+
+    This is helpful if you want a chatbot to know the full context of the document.
+    """
+
+    limit: int
+    """Maximum number of results to return"""
+
+    only_matching_chunks: Annotated[bool, PropertyInfo(alias="onlyMatchingChunks")]
+    """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.
+    """
+
+    rerank: bool
+    """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: Annotated[bool, PropertyInfo(alias="rewriteQuery")]
+    """If true, rewrites the query to make it easier to find documents.
+
+    This increases the latency by about 400ms
+    """
+
+
+class FiltersOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
+
+
+class FiltersAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
+
+
+Filters: TypeAlias = Union[FiltersOr, FiltersAnd]

supermemory/types/search_execute_response.py

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["SearchExecuteResponse", "Result", "ResultChunk"]
+
+
+class ResultChunk(BaseModel):
+    content: str
+    """Content of the matching chunk"""
+
+    is_relevant: bool = FieldInfo(alias="isRelevant")
+    """Whether this chunk is relevant to the query"""
+
+    score: float
+    """Similarity score for this chunk"""
+
+
+class Result(BaseModel):
+    chunks: List[ResultChunk]
+    """Matching content chunks from the document"""
+
+    created_at: str = FieldInfo(alias="createdAt")
+    """Document creation date"""
+
+    document_id: str = FieldInfo(alias="documentId")
+    """ID of the matching document"""
+
+    metadata: Optional[Dict[str, object]] = None
+    """Document metadata"""
+
+    score: float
+    """Relevance score of the match"""
+
+    title: Optional[str] = None
+    """Document title"""
+
+    type: Optional[str] = None
+    """Document type"""
+
+    updated_at: str = FieldInfo(alias="updatedAt")
+    """Document last update date"""
+
+    content: Optional[str] = None
+    """Full document content (only included when includeFullDocs=true)"""
+
+    summary: Optional[str] = None
+    """Document summary"""
+
+
+class SearchExecuteResponse(BaseModel):
+    results: List[Result]
+
+    timing: float
+
+    total: float

supermemory/types/search_memories_params.py

@@ -0,0 +1,75 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SearchMemoriesParams", "Filters", "FiltersOr", "FiltersAnd", "Include"]
+
+
+class SearchMemoriesParams(TypedDict, total=False):
+    q: Required[str]
+    """Search query string"""
+
+    container_tag: Annotated[str, PropertyInfo(alias="containerTag")]
+    """Optional tag this search should be containerized by.
+
+    This can be an ID for your user, a project ID, or any other identifier you wish
+    to use to filter memories.
+    """
+
+    filters: Filters
+    """Optional filters to apply to the search. Can be a JSON string or Query object."""
+
+    include: Include
+
+    limit: int
+    """Maximum number of results to return"""
+
+    rerank: bool
+    """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: Annotated[bool, PropertyInfo(alias="rewriteQuery")]
+    """If true, rewrites the query to make it easier to find documents.
+
+    This increases the latency by about 400ms
+    """
+
+    threshold: float
+    """Threshold / sensitivity for memories selection.
+
+    0 is least sensitive (returns most memories, more results), 1 is most sensitive
+    (returns lesser memories, accurate results)
+    """
+
+
+class FiltersOr(TypedDict, total=False):
+    or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
+
+
+class FiltersAnd(TypedDict, total=False):
+    and_: Required[Annotated[Iterable[object], 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