Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 41 additions & 5 deletions packages/openai-sdk-python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,17 @@ openai_with_memory = with_supermemory(

## Manual Memory Tools

`SupermemoryTools` exposes seven OpenAI function-calling tools:

- `search_memories` and `add_memory`
- `get_profile`
- `document_list`, `document_add`, and `document_delete`
- `memory_forget`

The configured `project_id` or `container_tags` define the trusted scope. The
primary tag is used for profile, list, search, and forget operations, and the
model cannot select a different tag.

### SupermemoryTools Class

```python
Expand All @@ -253,9 +264,21 @@ result = await tools.add_memory(
memory="User prefers tea over coffee"
)

# Fetch specific memory
result = await tools.fetch_memory(
memory_id="memory-id-here"
# Get the configured user's profile
result = await tools.get_profile(query="favorite drinks")

# List, add, or delete source documents
documents = await tools.document_list(limit=10, page=1)
document = await tools.document_add(
content="Meeting notes...",
title="Weekly meeting"
)
deleted = await tools.document_delete(document_id="document-id-here")

# Soft-forget one extracted memory
forgotten = await tools.memory_forget(
memory_id="memory-entry-id-here",
reason="outdated"
)
```

Expand All @@ -269,12 +292,20 @@ It is no longer exposed in the OpenAI tool schema.
from supermemory_openai import (
create_search_memories_tool,
create_add_memory_tool,
create_fetch_memory_tool
create_get_profile_tool,
create_document_list_tool,
create_document_delete_tool,
create_document_add_tool,
create_memory_forget_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")
profile_tool = create_get_profile_tool("your-api-key")
list_tool = create_document_list_tool("your-api-key")
delete_tool = create_document_delete_tool("your-api-key")
document_add_tool = create_document_add_tool("your-api-key")
forget_tool = create_memory_forget_tool("your-api-key")
```

### Function Calling Integration
Expand Down Expand Up @@ -346,6 +377,11 @@ SupermemoryTools(
- `get_tool_definitions()` - Get OpenAI function definitions
- `search_memories()` - Search user memories
- `add_memory()` - Add new memory
- `get_profile()` - Get the configured user's profile
- `document_list()` - List source document metadata
- `document_add()` - Queue a source document for processing
- `document_delete()` - Delete an in-scope source document
- `memory_forget()` - Soft-forget one extracted memory
- `execute_tool_call()` - Execute individual tool call

## Error Handling
Expand Down
2 changes: 1 addition & 1 deletion packages/openai-sdk-python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "hatchling.build"

[project]
name = "supermemory-openai-sdk"
version = "1.0.6"
version = "1.0.7"
description = "Memory tools for OpenAI function calling with supermemory"
readme = "README.md"
license = "MIT"
Expand Down
30 changes: 30 additions & 0 deletions packages/openai-sdk-python/src/supermemory_openai/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,29 @@
MemoryObject,
MemorySearchResult,
MemoryAddResult,
ProfileResult,
DocumentListResult,
DocumentDeleteResult,
DocumentAddResult,
MemoryForgetResult,
SearchMemoriesTool,
AddMemoryTool,
GetProfileTool,
DocumentListTool,
DocumentDeleteTool,
DocumentAddTool,
MemoryForgetTool,
MEMORY_TOOL_SCHEMAS,
create_supermemory_tools,
get_memory_tool_definitions,
execute_memory_tool_calls,
create_search_memories_tool,
create_add_memory_tool,
create_get_profile_tool,
create_document_list_tool,
create_document_delete_tool,
create_document_add_tool,
create_memory_forget_tool,
)

from .middleware import (
Expand Down Expand Up @@ -48,14 +63,29 @@
"MemoryObject",
"MemorySearchResult",
"MemoryAddResult",
"ProfileResult",
"DocumentListResult",
"DocumentDeleteResult",
"DocumentAddResult",
"MemoryForgetResult",
"SearchMemoriesTool",
"AddMemoryTool",
"GetProfileTool",
"DocumentListTool",
"DocumentDeleteTool",
"DocumentAddTool",
"MemoryForgetTool",
"MEMORY_TOOL_SCHEMAS",
"create_supermemory_tools",
"get_memory_tool_definitions",
"execute_memory_tool_calls",
"create_search_memories_tool",
"create_add_memory_tool",
"create_get_profile_tool",
"create_document_list_tool",
"create_document_delete_tool",
"create_document_add_tool",
"create_memory_forget_tool",
# Middleware
"with_supermemory",
"OpenAIMiddlewareOptions",
Expand Down
Loading
Loading