mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-05-17 21:11:04 +00:00
## Summary This PR introduces comprehensive Supermemory integration for the Microsoft Agent Framework, providing three complementary approaches to add persistent memory capabilities to agents: middleware for automatic memory injection, context providers for session-based memory management, and tools for explicit memory operations. ## Key Changes - **SupermemoryChatMiddleware**: Automatic memory injection middleware that fetches relevant memories from Supermemory before LLM calls and optionally saves conversations. Supports three modes: - `"profile"`: Injects all static and dynamic profile memories - `"query"`: Searches for memories relevant to the current user message - `"full"`: Combines both profile and query modes - **SupermemoryContextProvider**: Idiomatic context provider following the Agent Framework pattern (similar to built-in Mem0 integration). Integrates with the session pipeline via `before_run()` and `after_run()` hooks for automatic memory retrieval and storage. - **SupermemoryTools**: FunctionTool-compatible tools that agents can use for explicit memory operations: - `search_memories()`: Search for specific memories - `add_memory()`: Add new memories - `get_profile()`: Retrieve user profile - **Utility Functions**: Helper functions for: - Memory deduplication across static, dynamic, and search result sources - Profile-to-markdown conversion for LLM consumption - Message extraction and conversation formatting - Logging with configurable verbosity - **Exception Hierarchy**: Custom exceptions for better error handling: - `SupermemoryConfigurationError`: Missing/invalid configuration - `SupermemoryAPIError`: API request failures - `SupermemoryNetworkError`: Network connectivity issues - `SupermemoryMemoryOperationError`: Memory operation failures - **Comprehensive Documentation**: README with quick start examples, configuration options, and API reference for all three integration approaches. - **Test Suite**: Unit tests covering middleware, context provider, tools, and utility functions with proper mocking and error scenarios. ## Implementation Details - Supports both async (aiohttp) and sync (requests) HTTP clients with automatic fallback - Handles multiple message formats (dict, objects with attributes, content arrays) - Configurable memory storage with optional conversation grouping via `conversation_id` - Environment variable fallback for API key configuration (`SUPERMEMORY_API_KEY`) - Background task management for non-blocking memory operations in middleware - Proper async/sync compatibility for the Supermemory SDK https://claude.ai/code/session_012idB5y6UGK3zmeFULgTc4z
60 lines
2.2 KiB
Python
60 lines
2.2 KiB
Python
"""Tests for AgentSupermemory connection class."""
|
|
|
|
import os
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from supermemory_agent_framework import AgentSupermemory, SupermemoryConfigurationError
|
|
|
|
|
|
class TestAgentSupermemory:
|
|
def test_requires_api_key(self) -> None:
|
|
with patch.dict(os.environ, {}, clear=True):
|
|
os.environ.pop("SUPERMEMORY_API_KEY", None)
|
|
with pytest.raises(SupermemoryConfigurationError):
|
|
AgentSupermemory()
|
|
|
|
def test_accepts_api_key_param(self) -> None:
|
|
conn = AgentSupermemory(api_key="test-key")
|
|
assert conn.client is not None
|
|
|
|
@patch.dict(os.environ, {"SUPERMEMORY_API_KEY": "env-key"})
|
|
def test_reads_env_api_key(self) -> None:
|
|
conn = AgentSupermemory()
|
|
assert conn.client is not None
|
|
|
|
def test_default_container_tag(self) -> None:
|
|
conn = AgentSupermemory(api_key="test-key")
|
|
assert conn.container_tag == "msft_agent_chat"
|
|
|
|
def test_custom_container_tag(self) -> None:
|
|
conn = AgentSupermemory(api_key="test-key", container_tag="user-123")
|
|
assert conn.container_tag == "user-123"
|
|
|
|
def test_auto_generates_conversation_id(self) -> None:
|
|
conn = AgentSupermemory(api_key="test-key")
|
|
assert conn.conversation_id is not None
|
|
assert len(conn.conversation_id) > 0
|
|
assert conn.custom_id == f"conversation_{conn.conversation_id}"
|
|
|
|
def test_custom_conversation_id(self) -> None:
|
|
conn = AgentSupermemory(api_key="test-key", conversation_id="conv-abc")
|
|
assert conn.conversation_id == "conv-abc"
|
|
assert conn.custom_id == "conversation_conv-abc"
|
|
|
|
def test_entity_context(self) -> None:
|
|
conn = AgentSupermemory(
|
|
api_key="test-key",
|
|
entity_context="User is a Python developer",
|
|
)
|
|
assert conn.entity_context == "User is a Python developer"
|
|
|
|
def test_entity_context_default_none(self) -> None:
|
|
conn = AgentSupermemory(api_key="test-key")
|
|
assert conn.entity_context is None
|
|
|
|
def test_shared_client_instance(self) -> None:
|
|
conn = AgentSupermemory(api_key="test-key")
|
|
# Client should be the same object
|
|
assert conn.client is conn.client
|