supermemory-openai-sdk 1.0.0__py3-none-any.whl

src/__init__.py

@@ -0,0 +1,36 @@
+"""Supermemory OpenAI SDK - Memory tools for OpenAI function calling."""
+
+from .tools import (
+    SupermemoryTools,
+    SupermemoryToolsConfig,
+    MemoryObject,
+    MemorySearchResult,
+    MemoryAddResult,
+    SearchMemoriesTool,
+    AddMemoryTool,
+    MEMORY_TOOL_SCHEMAS,
+    create_supermemory_tools,
+    get_memory_tool_definitions,
+    execute_memory_tool_calls,
+    create_search_memories_tool,
+    create_add_memory_tool,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    # Tools
+    "SupermemoryTools",
+    "SupermemoryToolsConfig",
+    "MemoryObject",
+    "MemorySearchResult",
+    "MemoryAddResult",
+    "SearchMemoriesTool",
+    "AddMemoryTool",
+    "MEMORY_TOOL_SCHEMAS",
+    "create_supermemory_tools",
+    "get_memory_tool_definitions",
+    "execute_memory_tool_calls",
+    "create_search_memories_tool",
+    "create_add_memory_tool",
+]

src/tools.py

@@ -0,0 +1,366 @@
+"""Supermemory tools for OpenAI function calling."""
+
+import json
+from typing import Dict, List, Optional, Union, TypedDict
+
+from openai.types.chat import (
+    ChatCompletionMessageToolCall,
+    ChatCompletionToolMessageParam,
+    ChatCompletionToolParam,
+)
+import supermemory
+from supermemory.types import (
+    MemoryAddResponse,
+    MemoryGetResponse,
+    SearchExecuteResponse,
+)
+from supermemory.types.search_execute_response import Result
+
+
+class SupermemoryToolsConfig(TypedDict, total=False):
+    """Configuration for Supermemory tools.
+
+    Only one of `project_id` or `container_tags` can be provided.
+    """
+
+    base_url: Optional[str]
+    container_tags: Optional[List[str]]
+    project_id: Optional[str]
+
+
+# Type aliases using inferred types from supermemory package
+MemoryObject = Union[MemoryGetResponse, MemoryAddResponse]
+
+
+class MemorySearchResult(TypedDict, total=False):
+    """Result type for memory search operations."""
+
+    success: bool
+    results: Optional[List[Result]]
+    count: Optional[int]
+    error: Optional[str]
+
+
+class MemoryAddResult(TypedDict, total=False):
+    """Result type for memory add operations."""
+
+    success: bool
+    memory: Optional[MemoryAddResponse]
+    error: Optional[str]
+
+
+# Function schemas for OpenAI function calling
+MEMORY_TOOL_SCHEMAS = {
+    "search_memories": {
+        "name": "search_memories",
+        "description": (
+            "Search (recall) memories/details/information about the user or other facts or entities. Run when explicitly asked or when context about user's past choices would be helpful."
+        ),
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "information_to_get": {
+                    "type": "string",
+                    "description": "Terms to search for in the user's memories",
+                },
+                "include_full_docs": {
+                    "type": "boolean",
+                    "description": (
+                        "Whether to include the full document content in the response. "
+                        "Defaults to true for better AI context."
+                    ),
+                    "default": True,
+                },
+                "limit": {
+                    "type": "number",
+                    "description": "Maximum number of results to return",
+                    "default": 10,
+                },
+            },
+            "required": ["information_to_get"],
+        },
+    },
+    "add_memory": {
+        "name": "add_memory",
+        "description": (
+            "Add (remember) memories/details/information about the user or other facts or entities. Run when explicitly asked or when the user mentions any information generalizable beyond the context of the current conversation."
+        ),
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "memory": {
+                    "type": "string",
+                    "description": (
+                        "The text content of the memory to add. This should be a "
+                        "single sentence or a short paragraph."
+                    ),
+                },
+            },
+            "required": ["memory"],
+        },
+    },
+}
+
+
+class SupermemoryTools:
+    """Create memory tool handlers for OpenAI function calling."""
+
+    def __init__(self, api_key: str, config: Optional[SupermemoryToolsConfig] = None):
+        """Initialize SupermemoryTools.
+
+        Args:
+            api_key: Supermemory API key
+            config: Optional configuration
+        """
+        config = config or {}
+
+        # Initialize Supermemory client
+        client_kwargs = {"api_key": api_key}
+        if config.get("base_url"):
+            client_kwargs["base_url"] = config["base_url"]
+
+        self.client = supermemory.Supermemory(**client_kwargs)
+
+        # Set container tags
+        if config.get("project_id"):
+            self.container_tags = [f"sm_project_{config['project_id']}"]
+        elif config.get("container_tags"):
+            self.container_tags = config["container_tags"]
+        else:
+            self.container_tags = ["sm_project_default"]
+
+    def get_tool_definitions(self) -> List[ChatCompletionToolParam]:
+        """Get OpenAI function definitions for all memory tools.
+
+        Returns:
+            List of ChatCompletionToolParam definitions
+        """
+        return [
+            {"type": "function", "function": MEMORY_TOOL_SCHEMAS["search_memories"]},
+            {"type": "function", "function": MEMORY_TOOL_SCHEMAS["add_memory"]},
+        ]
+
+    async def execute_tool_call(self, tool_call: ChatCompletionMessageToolCall) -> str:
+        """Execute a tool call based on the function name and arguments.
+
+        Args:
+            tool_call: The tool call from OpenAI
+
+        Returns:
+            JSON string result
+        """
+        function_name = tool_call.function.name
+        args = json.loads(tool_call.function.arguments)
+
+        if function_name == "search_memories":
+            result = await self.search_memories(**args)
+        elif function_name == "add_memory":
+            result = await self.add_memory(**args)
+        else:
+            result = {
+                "success": False,
+                "error": f"Unknown function: {function_name}",
+            }
+
+        return json.dumps(result)
+
+    async def search_memories(
+        self,
+        information_to_get: str,
+        include_full_docs: bool = True,
+        limit: int = 10,
+    ) -> MemorySearchResult:
+        """Search memories.
+
+        Args:
+            information_to_get: Terms to search for
+            include_full_docs: Whether to include full document content
+            limit: Maximum number of results
+
+        Returns:
+            MemorySearchResult
+        """
+        try:
+            response: SearchExecuteResponse = await self.client.search.execute(
+                q=information_to_get,
+                container_tags=self.container_tags,
+                limit=limit,
+                chunk_threshold=0.6,
+                include_full_docs=include_full_docs,
+            )
+
+            return MemorySearchResult(
+                success=True,
+                results=response.results,
+                count=len(response.results),
+            )
+        except Exception as error:
+            return MemorySearchResult(
+                success=False,
+                error=str(error),
+            )
+
+    async def add_memory(self, memory: str) -> MemoryAddResult:
+        """Add a memory.
+
+        Args:
+            memory: The memory content to add
+
+        Returns:
+            MemoryAddResult
+        """
+        try:
+            metadata: Dict[str, object] = {}
+
+            add_params = {
+                "content": memory,
+                "container_tags": self.container_tags,
+            }
+            if metadata:
+                add_params["metadata"] = metadata
+
+            response: MemoryAddResponse = await self.client.memories.add(**add_params)
+
+            return MemoryAddResult(
+                success=True,
+                memory=response,
+            )
+        except Exception as error:
+            return MemoryAddResult(
+                success=False,
+                error=str(error),
+            )
+
+
+def create_supermemory_tools(
+    api_key: str, config: Optional[SupermemoryToolsConfig] = None
+) -> SupermemoryTools:
+    """Helper function to create SupermemoryTools instance.
+
+    Args:
+        api_key: Supermemory API key
+        config: Optional configuration
+
+    Returns:
+        SupermemoryTools instance
+    """
+    return SupermemoryTools(api_key, config)
+
+
+def get_memory_tool_definitions() -> List[ChatCompletionToolParam]:
+    """Get OpenAI function definitions for memory tools.
+
+    Returns:
+        List of ChatCompletionToolParam definitions
+    """
+    return [
+        {"type": "function", "function": MEMORY_TOOL_SCHEMAS["search_memories"]},
+        {"type": "function", "function": MEMORY_TOOL_SCHEMAS["add_memory"]},
+    ]
+
+
+async def execute_memory_tool_calls(
+    api_key: str,
+    tool_calls: List[ChatCompletionMessageToolCall],
+    config: Optional[SupermemoryToolsConfig] = None,
+) -> List[ChatCompletionToolMessageParam]:
+    """Execute tool calls from OpenAI function calling.
+
+    Args:
+        api_key: Supermemory API key
+        tool_calls: List of tool calls from OpenAI
+        config: Optional configuration
+
+    Returns:
+        List of tool message parameters
+    """
+    tools = SupermemoryTools(api_key, config)
+
+    async def execute_single_call(
+        tool_call: ChatCompletionMessageToolCall,
+    ) -> ChatCompletionToolMessageParam:
+        result = await tools.execute_tool_call(tool_call)
+        return ChatCompletionToolMessageParam(
+            tool_call_id=tool_call.id,
+            role="tool",
+            content=result,
+        )
+
+    # Execute all tool calls concurrently
+    import asyncio
+
+    results = await asyncio.gather(
+        *[execute_single_call(tool_call) for tool_call in tool_calls]
+    )
+
+    return results
+
+
+# Individual tool creators for more granular control
+class SearchMemoriesTool:
+    """Individual search memories tool."""
+
+    def __init__(self, api_key: str, config: Optional[SupermemoryToolsConfig] = None):
+        self.tools = SupermemoryTools(api_key, config)
+        self.definition: ChatCompletionToolParam = {
+            "type": "function",
+            "function": MEMORY_TOOL_SCHEMAS["search_memories"],
+        }
+
+    async def execute(
+        self,
+        information_to_get: str,
+        include_full_docs: bool = True,
+        limit: int = 10,
+    ) -> MemorySearchResult:
+        """Execute search memories."""
+        return await self.tools.search_memories(
+            information_to_get=information_to_get,
+            include_full_docs=include_full_docs,
+            limit=limit,
+        )
+
+
+class AddMemoryTool:
+    """Individual add memory tool."""
+
+    def __init__(self, api_key: str, config: Optional[SupermemoryToolsConfig] = None):
+        self.tools = SupermemoryTools(api_key, config)
+        self.definition: ChatCompletionToolParam = {
+            "type": "function",
+            "function": MEMORY_TOOL_SCHEMAS["add_memory"],
+        }
+
+    async def execute(self, memory: str) -> MemoryAddResult:
+        """Execute add memory."""
+        return await self.tools.add_memory(memory=memory)
+
+
+def create_search_memories_tool(
+    api_key: str, config: Optional[SupermemoryToolsConfig] = None
+) -> SearchMemoriesTool:
+    """Create individual search memories tool.
+
+    Args:
+        api_key: Supermemory API key
+        config: Optional configuration
+
+    Returns:
+        SearchMemoriesTool instance
+    """
+    return SearchMemoriesTool(api_key, config)
+
+
+def create_add_memory_tool(
+    api_key: str, config: Optional[SupermemoryToolsConfig] = None
+) -> AddMemoryTool:
+    """Create individual add memory tool.
+
+    Args:
+        api_key: Supermemory API key
+        config: Optional configuration
+
+    Returns:
+        AddMemoryTool instance
+    """
+    return AddMemoryTool(api_key, config)

supermemory_openai_sdk-1.0.0.dist-info/METADATA

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: supermemory-openai-sdk
+Version: 1.0.0
+Summary: Memory tools for OpenAI function calling with supermemory
+Project-URL: Homepage, https://supermemory.ai
+Project-URL: Repository, https://github.com/supermemoryai/supermemory
+Project-URL: Documentation, https://supermemory.ai/docs
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ai,memory,openai,supermemory
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8.1
+Requires-Dist: openai>=1.102.0
+Requires-Dist: supermemory>=3.0.0a28
+Requires-Dist: typing-extensions>=4.0.0
+Description-Content-Type: text/markdown
+
+# Supermemory OpenAI Python SDK
+
+Memory tools for OpenAI function calling with Supermemory integration.
+
+This package provides memory management tools for the official [OpenAI Python SDK](https://github.com/openai/openai-python) using [Supermemory](https://supermemory.ai) capabilities.
+
+## Installation
+
+Install using uv (recommended):
+
+```bash
+uv add supermemory-openai
+```
+
+Or with pip:
+
+```bash
+pip install supermemory-openai
+```
+
+## Quick Start
+
+### Using Memory Tools with OpenAI
+
+```python
+import asyncio
+import openai
+from supermemory_openai import SupermemoryTools, execute_memory_tool_calls
+
+async def main():
+    # Initialize OpenAI client
+    client = openai.AsyncOpenAI(api_key="your-openai-api-key")
+    
+    # Initialize Supermemory tools
+    tools = SupermemoryTools(
+        api_key="your-supermemory-api-key",
+        config={"project_id": "my-project"}
+    )
+    
+    # Chat with memory tools
+    response = await client.chat.completions.create(
+        model="gpt-4o",
+        messages=[
+            {
+                "role": "system",
+                "content": "You are a helpful assistant with access to user memories."
+            },
+            {
+                "role": "user", 
+                "content": "Remember that I prefer tea over coffee"
+            }
+        ],
+        tools=tools.get_tool_definitions()
+    )
+    
+    # Handle tool calls if present
+    if response.choices[0].message.tool_calls:
+        tool_results = await execute_memory_tool_calls(
+            api_key="your-supermemory-api-key",
+            tool_calls=response.choices[0].message.tool_calls,
+            config={"project_id": "my-project"}
+        )
+        print("Tool results:", tool_results)
+    
+    print(response.choices[0].message.content)
+
+asyncio.run(main())
+```
+
+## Configuration
+
+## Memory Tools
+
+### SupermemoryTools Class
+
+```python
+from supermemory_openai import SupermemoryTools
+
+tools = SupermemoryTools(
+    api_key="your-supermemory-api-key",
+    config={
+        "project_id": "my-project",  # or use container_tags
+        "base_url": "https://custom-endpoint.com",  # optional
+    }
+)
+
+# Search memories
+result = await tools.search_memories(
+    information_to_get="user preferences",
+    limit=10,
+    include_full_docs=True
+)
+
+# Add memory  
+result = await tools.add_memory(
+    memory="User prefers tea over coffee"
+)
+
+# Fetch specific memory
+result = await tools.fetch_memory(
+    memory_id="memory-id-here"
+)
+```
+
+### Individual Tools
+
+```python
+from supermemory_openai import (
+    create_search_memories_tool,
+    create_add_memory_tool, 
+    create_fetch_memory_tool
+)
+
+search_tool = create_search_memories_tool("your-api-key")
+add_tool = create_add_memory_tool("your-api-key")
+fetch_tool = create_fetch_memory_tool("your-api-key")
+```
+
+### Function Calling Integration
+
+```python
+from supermemory_openai import execute_memory_tool_calls
+
+# After getting tool calls from OpenAI
+if response.choices[0].message.tool_calls:
+    tool_results = await execute_memory_tool_calls(
+        api_key="your-supermemory-api-key",
+        tool_calls=response.choices[0].message.tool_calls,
+        config={"project_id": "my-project"}
+    )
+    
+    # Add tool results to conversation
+    messages.append(response.choices[0].message)
+    messages.extend(tool_results)
+```
+
+## API Reference
+
+### SupermemoryTools
+
+Memory management tools for function calling.
+
+#### Constructor
+
+```python
+SupermemoryTools(
+    api_key: str,
+    config: Optional[SupermemoryToolsConfig] = None
+)
+```
+
+#### Methods
+
+- `get_tool_definitions()` - Get OpenAI function definitions
+- `search_memories()` - Search user memories
+- `add_memory()` - Add new memory
+- `fetch_memory()` - Fetch specific memory by ID
+- `execute_tool_call()` - Execute individual tool call
+
+## Error Handling
+
+```python
+try:
+    response = await client.chat_completion(
+        messages=[{"role": "user", "content": "Hello"}],
+        model="gpt-4o"
+    )
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## Environment Variables
+
+Set these environment variables for testing:
+
+- `SUPERMEMORY_API_KEY` - Your Supermemory API key
+- `OPENAI_API_KEY` - Your OpenAI API key
+- `MODEL_NAME` - Model to use (default: "gpt-4o-mini")
+- `SUPERMEMORY_BASE_URL` - Custom Supermemory base URL (optional)
+
+## Development
+
+### Setup
+
+```bash
+# Install uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Clone and setup
+git clone <repository-url>
+cd packages/openai-sdk-python
+uv sync --dev
+```
+
+### Testing
+
+```bash
+# Run tests
+uv run pytest
+
+# Run with coverage
+uv run pytest --cov=supermemory_openai
+
+# Run specific test file
+uv run pytest tests/test_infinite_chat.py
+```
+
+### Type Checking
+
+```bash
+uv run mypy src/supermemory_openai
+```
+
+### Formatting
+
+```bash
+uv run black src/ tests/
+uv run isort src/ tests/
+```
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Links
+
+- [Supermemory](https://supermemory.ai) - Infinite context memory platform
+- [OpenAI Python SDK](https://github.com/openai/openai-python) - Official OpenAI Python library
+- [Documentation](https://docs.supermemory.ai) - Full API documentation

supermemory_openai_sdk-1.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+src/__init__.py,sha256=TS-kf3lLC8S_HAq3130aEjfFjVCvVA_xu8rhn_wy6G0,845
+src/tools.py,sha256=5BHxJvJEcRD5CL559pvT3DmNa0CL6j8QfMSFfifd_so,11070
+supermemory_openai_sdk-1.0.0.dist-info/METADATA,sha256=-K1d4Uqp-94-SwmHzJdwWdUEdMOx28yZ_pbqbq17Bhw,6244
+supermemory_openai_sdk-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+supermemory_openai_sdk-1.0.0.dist-info/licenses/LICENSE,sha256=6lYiVGf2h1ooI6nxALS8yfG1qwWL5XvvdsTmrI_Y02s,1072
+supermemory_openai_sdk-1.0.0.dist-info/RECORD,,

supermemory_openai_sdk-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

supermemory_openai_sdk-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 Supermemory Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.