Memory Playground

packages/evals/benchmark_memory_module.py

@@ -14,13 +14,12 @@
 
 sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
 
+from evals.helpers import Dataset, DatasetItem, load_dataset, setup_mlflow
+from evals.metrics import string_check_metric
 from memory_module.config import LLMConfig, MemoryModuleConfig
 from memory_module.core.memory_module import MemoryModule
 from memory_module.interfaces.types import AssistantMessage, UserMessage
 
-from evals.helpers import Dataset, DatasetItem, load_dataset, setup_mlflow
-from evals.metrics import string_check_metric
-
 setup_mlflow(experiment_name="memory_module")
 
 

packages/memory-server/.python-version

@@ -0,0 +1 @@
+3.12

packages/memory-server/README.md

@@ -0,0 +1,18 @@
+# Memory Server
+FastAPI wrapper around the memory module.
+
+
+## Setup Instructions
+
+To set up and run the Memory Server, follow these steps:
+
+1. Set up the dependencies by doing `uv sync` in the root folder.
+1. Ensure the virtual environment activated in your terminal. See the root README.md file for details.
+1. Configure the memory module in the `memory_service.py` file.
+1. Navigate to this folder and run the following command:
+
+```sh
+uvicorn main:app
+```
+
+This will start the FastAPI server on port 8000.

packages/memory-server/main.py

@@ -0,0 +1,17 @@
+import routes
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+
+app = FastAPI(title="Chat API")
+
+# CORS configuration
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["http://localhost:5173"],  # Frontend URL
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+# Include routers
+app.include_router(routes.router, tags=["memory"])

packages/memory-server/memory_service.py

@@ -0,0 +1,39 @@
+import os
+import sys
+import uuid
+from datetime import datetime
+from typing import Optional
+
+sys.path.append(os.path.join(os.path.dirname(__file__), "../"))
+
+from memory_module import LLMConfig, MemoryModule, MemoryModuleConfig
+from memory_module.interfaces.types import AssistantMessageInput, MessageInput, UserMessageInput
+
+
+class MemoryService:
+    def __init__(self, openai_api_key: str):
+        # Initialize memory module
+        config = MemoryModuleConfig(
+            db_path=os.path.join(os.path.dirname(__file__), "../memory_module/data/memory.db"),
+            llm=LLMConfig(model="gpt-4o", embedding_model="text-embedding-3-small", api_key=openai_api_key),
+        )
+        self._memory = MemoryModule(config)
+
+    async def add_message(self, type: str, content: str):
+        message: MessageInput
+        if type == "assistant":
+            message = AssistantMessageInput(id=str(uuid.uuid4()), content=content, author_id="1", conversation_ref="1")
+        elif type == "user":
+            message = UserMessageInput(
+                id=str(uuid.uuid4()), content=content, author_id="1", conversation_ref="1", created_at=datetime.now()
+            )
+        else:
+            raise ValueError("Invalid message type")
+
+        await self._memory.add_message(message)
+
+    async def retrieve_memories(self, query: str, user_id: str, limit: Optional[int] = None):
+        return await self._memory.retrieve_memories(query, user_id=user_id, limit=limit)
+
+    async def get_all_memories(self, user_id: str):
+        return await self._memory.get_user_memories(user_id=user_id)

packages/memory-server/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "memory-server"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "memory-module",
+    "fastapi==0.115.6",
+    "pydantic",
+    "python-dotenv",
+    "uvicorn"
+]
+
+[tool.uv]
+package = false
+
+[tool.uv.sources]
+memory-module = { workspace = true }

packages/memory-server/routes.py

@@ -0,0 +1,52 @@
+import os
+import sys
+
+from dotenv import load_dotenv
+from fastapi import APIRouter
+from memory_service import MemoryService
+from pydantic import BaseModel
+
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+
+from memory_module.interfaces.types import Memory
+
+load_dotenv()
+
+router = APIRouter()
+openai_api_key = os.environ.get("OPENAI_API_KEY")
+memory_service = MemoryService(openai_api_key=openai_api_key)
+
+
+@router.get("/memories", response_model=list[Memory])
+async def get_memories(user_id: str):
+    return await memory_service.get_all_memories(user_id=user_id)
+
+
+class SearchQueryRequest(BaseModel):
+    query: str
+    user_id: str
+    limit: int
+
+
+@router.post("/search")
+async def search_memories(request: SearchQueryRequest):
+    if not request.user_id:
+        raise ValueError("User ID is required to search memories")
+
+    print(request)
+    if len(request.query) > 0:
+        return await memory_service.retrieve_memories(request.query, request.user_id, request.limit)
+    else:
+        # Return all memories if no query is provided
+        return await memory_service.get_all_memories(user_id=request.user_id)
+
+
+class AddMessageRequest(BaseModel):
+    type: str
+    content: str
+
+
+@router.post("/message")
+async def add_message(request: AddMessageRequest):
+    await memory_service.add_message(request.type, request.content)
+    return {"message": "Message added successfully"}

packages/memory-server/sample.env

@@ -0,0 +1 @@
+OPENAI_API_KEY=

packages/memory_module/storage/in_memory_storage.py

@@ -4,6 +4,7 @@
 from typing import Dict, List, NamedTuple, Optional, TypedDict
 
 import numpy as np
+
 from memory_module.interfaces.base_memory_storage import BaseMemoryStorage
 from memory_module.interfaces.base_message_buffer_storage import (
     BaseMessageBufferStorage,

packages/memory_module/storage/sqlite_memory_storage.py

@@ -5,6 +5,7 @@
 from typing import Dict, List, Optional
 
 import sqlite_vec
+
 from memory_module.interfaces.base_memory_storage import BaseMemoryStorage
 from memory_module.interfaces.types import (
     BaseMemoryInput,

packages/memory_module/storage/sqlite_storage.py

@@ -5,6 +5,7 @@
 
 import aiosqlite
 import sqlite_vec
+
 from memory_module.storage.migrations_manager import MigrationManager
 
 logger = logging.getLogger(__name__)

packages/memory_module/utils/teams_bot_middlware.py

@@ -5,6 +5,7 @@
 from botbuilder.core import TurnContext
 from botbuilder.core.middleware_set import Middleware
 from botbuilder.schema import Activity, ResourceResponse
+
 from memory_module.interfaces.base_memory_module import BaseMemoryModule
 from memory_module.interfaces.types import (
     AssistantMessageInput,

playground/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

playground/README.md

@@ -0,0 +1,19 @@
+# Memory Playground UI
+
+A simple web application to easily view and interact with the memory module.
+
+## Setup Instructions
+
+To set up and run the playground, follow these steps:
+
+1. Navigate to this folder in the termainl.
+1. Set up the dependencies by doing `pnpm install` in the root folder.
+1. Run `pnpm run dev` to start the application on port 5173.
+1. Ensure that the memory server is configured and running locally. See `packages/memory-server`.
+
+## Notes
+The memory server base url is defined in the `api/memoryServer.ts` file. By default it points to http://127.0.0.1:8000, i.e localhost:8000
+
+# Disclaimer
+
+Some components were taken from [TailAdmin](https://tailadmin.com/)'s free to use component package, which is under the MIT License.

playground/eslint.config.js

@@ -0,0 +1,29 @@
+import js from '@eslint/js';
+import globals from 'globals';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+      '@typescript-eslint/no-explicit-any': 'warn',
+    },
+  }
+);

playground/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Memory Playground</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>