feat: factory reset endpoint

core/cat/routes/memory/collections.py

@@ -6,6 +6,7 @@
 from cat.auth.permissions import AuthPermission, AuthResource
 from cat.memory.vector_memory import VectorMemory
 from cat.looking_glass.stray_cat import StrayCat
+from cat import utils
 
 router = APIRouter()
 
@@ -40,19 +41,14 @@ async def wipe_collections(
     """Delete and create all collections"""
 
     vector_memory: VectorMemory = stray.memory.vectors
-    collections = list(vector_memory.collections.keys())
+    deleted_memories = utils.delete_collections(vector_memory)
 
-    to_return = {}
-    for c in collections:
-        ret = vector_memory.delete_collection(c)
-        to_return[c] = ret
-
     ccat: CheshireCat = request.app.state.ccat
     ccat.load_memory()  # recreate the long term memories
     ccat.mad_hatter.find_plugins()
 
     return {
-        "deleted": to_return,
+        "deleted": deleted_memories,
     }
 
 

core/cat/routes/settings.py

@@ -1,9 +1,15 @@
+import os
+import json
+
+from cat import utils
 from cat.auth.permissions import AuthPermission, AuthResource
 from cat.auth.connection import HTTPAuth
-from fastapi import Depends, APIRouter, HTTPException
+from fastapi import Depends, APIRouter, HTTPException, Request
 from cat.db import models
 from cat.db import crud
-
+from cat.env import get_env
+from cat.looking_glass.cheshire_cat import CheshireCat
+from cat.memory.vector_memory import VectorMemory
 
 router = APIRouter()
 
@@ -102,3 +108,41 @@ def delete_setting(
     crud.delete_setting_by_id(settingId)
 
     return {"deleted": settingId}
+
+
+@router.post("/factory-reset")
+def factory_reset(
+    request: Request,
+    stray=Depends(HTTPAuth(AuthResource.SETTINGS, AuthPermission.WRITE)),
+):
+    """Delete Cat's memory and metadata.json file (settings db).
+    A 'soft restart' is performed recreating the Cat instance and the metadata.json file.
+    Plugins are not affected but need to be switched on.
+    """
+
+    metadata_file = get_env("CCAT_METADATA_FILE")
+    metadata_content = {}
+
+    try:
+        if os.path.exists(metadata_file):
+            with open(metadata_file, 'r') as file:
+                metadata_content = json.load(file)
+
+            os.remove(metadata_file)
+
+        vector_memory: VectorMemory = stray.memory.vectors
+        deleted_memories = utils.delete_collections(vector_memory)
+
+        utils.singleton.instances.clear()
+        request.app.state.strays.clear()
+
+        request.app.state.ccat = CheshireCat()
+    except Exception as e:
+        raise HTTPException(
+            status_code=500,
+            detail={
+                "error": f"An unexpected error occurred during factory reset: {str(e)}",
+            },
+        )
+
+    return {"deleted_metadata": metadata_content, "deleted_memories": deleted_memories}

core/cat/utils.py

@@ -1,5 +1,11 @@
 """Various utiles used from the projects."""
 
+# Avoids circular import issues for type hints
+from __future__ import annotations
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+    from cat.memory.vector_memory import VectorMemory
+
 import os
 import traceback
 import inspect
@@ -310,3 +316,16 @@ def items(self):
 
     def __contains__(self, key):
         return key in self.keys()
+
+
+def delete_collections(vector_memory: VectorMemory) -> Dict[str, bool]:
+    """Delete all collections"""
+
+    collections = list(vector_memory.collections.keys())
+
+    deleted = {}
+    for c in collections:
+        ret = vector_memory.delete_collection(c)
+        deleted[c] = ret
+
+    return deleted