merge dev solve confict

Author: yuan.wang

src/memos/api/handlers/add_handler.py

@@ -7,6 +7,9 @@
 
 from memos.api.handlers.base_handler import BaseHandler, HandlerDependencies
 from memos.api.product_models import APIADDRequest, MemoryResponse
+from memos.memories.textual.item import (
+    list_all_fields,
+)
 from memos.multi_mem_cube.composite_cube import CompositeCubeView
 from memos.multi_mem_cube.single_cube import SingleCubeView
 from memos.multi_mem_cube.views import MemCubeView
@@ -44,6 +47,13 @@ def handle_add_memories(self, add_req: APIADDRequest) -> MemoryResponse:
         """
         self.logger.info(f"[AddHandler] Add Req is: {add_req}")
 
+        if add_req.info:
+            exclude_fields = list_all_fields()
+            info_len = len(add_req.info)
+            add_req.info = {k: v for k, v in add_req.info.items() if k not in exclude_fields}
+            if len(add_req.info) < info_len:
+                self.logger.warning(f"[AddHandler] info fields can not contain {exclude_fields}.")
+
         cube_view = self._build_cube_view(add_req)
 
         results = cube_view.add_memories(add_req)

src/memos/api/handlers/memory_handler.py

@@ -4,7 +4,7 @@
 This module handles retrieving all memories or specific subgraphs based on queries.
 """
 
-from typing import Any, Literal
+from typing import TYPE_CHECKING, Any, Literal
 
 from memos.api.handlers.formatters_handler import format_memory_item
 from memos.api.product_models import (
@@ -24,6 +24,10 @@
 )
 
 
+if TYPE_CHECKING:
+    from memos.memories.textual.preference import TextualMemoryItem
+
+
 logger = get_logger(__name__)
 
 
@@ -161,17 +165,20 @@ def handle_get_subgraph(
 def handle_get_memories(get_mem_req: GetMemoryRequest, naive_mem_cube: Any) -> GetMemoryResponse:
     # TODO: Implement get memory with filter
     memories = naive_mem_cube.text_mem.get_all(user_name=get_mem_req.mem_cube_id)["nodes"]
-    filter_params: dict[str, Any] = {}
-    if get_mem_req.user_id is not None:
-        filter_params["user_id"] = get_mem_req.user_id
-    if get_mem_req.mem_cube_id is not None:
-        filter_params["mem_cube_id"] = get_mem_req.mem_cube_id
-    preferences = naive_mem_cube.pref_mem.get_memory_by_filter(filter_params)
+    preferences: list[TextualMemoryItem] = []
+    if get_mem_req.include_preference:
+        filter_params: dict[str, Any] = {}
+        if get_mem_req.user_id is not None:
+            filter_params["user_id"] = get_mem_req.user_id
+        if get_mem_req.mem_cube_id is not None:
+            filter_params["mem_cube_id"] = get_mem_req.mem_cube_id
+        preferences = naive_mem_cube.pref_mem.get_memory_by_filter(filter_params)
+        preferences = [format_memory_item(mem) for mem in preferences]
     return GetMemoryResponse(
         message="Memories retrieved successfully",
         data={
             "text_mem": memories,
-            "pref_mem": [format_memory_item(mem) for mem in preferences],
+            "pref_mem": preferences,
         },
     )
 

src/memos/api/product_models.py

@@ -6,7 +6,7 @@
 
 # Import message types from core types module
 from memos.log import get_logger
-from memos.types import MessageDict, MessagesType, PermissionDict, SearchMode
+from memos.types import MessageList, MessagesType, PermissionDict, SearchMode
 
 
 logger = get_logger(__name__)
@@ -76,121 +76,43 @@ class ChatRequest(BaseRequest):
 
     # ==== Basic identifiers ====
     user_id: str = Field(..., description="User ID")
-    session_id: str | None = Field(
-        None,
-        description=(
-            "Session ID. Used as a soft signal to give higher weight to "
-            "recently related memories. Optional for developer API."
-        ),
-    )
-
-    # ==== Query ====
-    query: str = Field(..., description="Chat query message from user")
-
-    # ==== Cube scoping ====
+    query: str = Field(..., description="Chat query message")
     readable_cube_ids: list[str] | None = Field(
-        None,
-        description=(
-            "List of cube IDs user can read for multi-cube chat.\n"
-            "- Algorithm interface: required\n"
-            "- Developer API: optional (can fall back to mem_cube_id or defaults)"
-        ),
+        None, description="List of cube IDs user can read for multi-cube chat"
     )
-
     writable_cube_ids: list[str] | None = Field(
-        None,
-        description=(
-            "List of cube IDs user can write for multi-cube chat.\n"
-            "- Algorithm interface: required\n"
-            "- Developer API: optional (can fall back to mem_cube_id or defaults)"
-        ),
-    )
-
-    # ==== History & filters ====
-    history: MessagesType | None = Field(
-        None,
-        description=(
-            "Chat history (algorithm does NOT persist it). Algorithm interface default: []."
-        ),
+        None, description="List of cube IDs user can write for multi-cube chat"
     )
+    history: MessageList | None = Field(None, description="Chat history")
+    mode: SearchMode = Field(SearchMode.FAST, description="search mode: fast, fine, or mixture")
+    system_prompt: str | None = Field(None, description="Base system prompt to use for chat")
+    top_k: int = Field(10, description="Number of results to return")
+    session_id: str | None = Field(None, description="Session ID for soft-filtering memories")
+    include_preference: bool = Field(True, description="Whether to handle preference memory")
+    pref_top_k: int = Field(6, description="Number of preference results to return")
+    model_name_or_path: str | None = Field(None, description="Model name to use for chat")
+    max_tokens: int | None = Field(None, description="Max tokens to generate")
+    temperature: float | None = Field(None, description="Temperature for sampling")
+    top_p: float | None = Field(None, description="Top-p (nucleus) sampling parameter")
+    add_message_on_answer: bool = Field(True, description="Add dialogs to memory after chat")
 
+    # ==== Filter conditions ====
     filter: dict[str, Any] | None = Field(
         None,
-        description=(
-            "Memory filter. Developers can provide custom structured predicates "
-            "to precisely filter memories. Algorithm interface default: {}."
-        ),
-    )
-
-    # ==== Retrieval configuration ====
-    mode: SearchMode = Field(
-        SearchMode.FAST,
-        description="Search mode: fast, fine, or mixture.",
-    )
-
-    top_k: int = Field(
-        10,
-        ge=1,
-        description="Number of memories to retrieve (top-K).",
-    )
-
-    pref_top_k: int = Field(
-        6,
-        ge=0,
-        description="Number of preference memories to retrieve (top-K). Default: 6.",
-    )
-
-    include_preference: bool = Field(
-        True,
-        description=(
-            "Whether to retrieve preference memories. If enabled, the system will "
-            "automatically recall user preferences related to the query. Default: True."
-        ),
-    )
-
-    threshold: float = Field(
-        0.5,
-        description="Internal similarity threshold for filtering references (algorithm internal).",
-    )
-
-    # ==== LLM / generation configuration ====
-    system_prompt: str | None = Field(
-        None,
-        description="Custom system prompt / instruction for this chat.",
-    )
-
-    model_name_or_path: str | None = Field(
-        None,
-        description=("Name or path of the chat model to use.\nAlgorithm default: 'gpt-4o-mini'."),
-    )
-
-    max_tokens: int | None = Field(
-        None,
-        description="Max tokens to generate. Algorithm default: 8192.",
-    )
-
-    temperature: float | None = Field(
-        None,
-        description="Sampling temperature. Algorithm default: 0.7.",
-    )
-
-    top_p: float | None = Field(
-        None,
-        description="Top-p (nucleus) sampling parameter. Algorithm default: 0.95.",
-    )
-
-    add_message_on_answer: bool = Field(
-        True,
-        description="Whether to append dialog messages to memory after chat. Default: True.",
+        description="""
+        Filter for the memory, example:
+        {
+            "`and` or `or`": [
+                {"id": "uuid-xxx"},
+                {"created_at": {"gt": "2024-01-01"}},
+            ]
+        }
+        """,
     )
 
-    # ==== Search / pipeline toggles ====
-    internet_search: bool = Field(
-        True,
-        description=(
-            "Whether to use internet search (internal usage; external API may ignore this flag)."
-        ),
-    )
+    # ==== Extended capabilities ====
+    internet_search: bool = Field(True, description="Whether to use internet search")
+    threshold: float = Field(0.5, description="Threshold for filtering references")
 
     # ==== Backward compatibility ====
     moscube: bool = Field(
@@ -237,17 +159,13 @@ def _convert_deprecated_fields(self):
         return self
 
 
-class APIChatCompleteRequest(ChatRequest):
-    """Request model for complete chat."""
-
-
 class ChatCompleteRequest(BaseRequest):
-    """Request model for chat operations."""
+    """Request model for chat operations. will (Deprecated), instead use APIChatCompleteRequest."""
 
     user_id: str = Field(..., description="User ID")
     query: str = Field(..., description="Chat query message")
     mem_cube_id: str | None = Field(None, description="Cube ID to use for chat")
-    history: list[MessageDict] | None = Field(None, description="Chat history")
+    history: MessageList | None = Field(None, description="Chat history")
     internet_search: bool = Field(False, description="Whether to use internet search")
     system_prompt: str | None = Field(None, description="Base prompt to use for chat")
     top_k: int = Field(10, description="Number of results to return")
@@ -333,7 +251,7 @@ class MemoryCreateRequest(BaseRequest):
     """Request model for creating memories."""
 
     user_id: str = Field(..., description="User ID")
-    messages: list[MessageDict] | None = Field(None, description="List of messages to store.")
+    messages: MessagesType | None = Field(None, description="List of messages to store.")
     memory_content: str | None = Field(None, description="Memory content to store")
     doc_path: str | None = Field(None, description="Path to document to store")
     mem_cube_id: str | None = Field(None, description="Cube ID")
@@ -411,7 +329,15 @@ class APISearchRequest(BaseRequest):
     # TODO: maybe add detailed description later
     filter: dict[str, Any] | None = Field(
         None,
-        description=("Filter for the memory"),
+        description="""
+        Filter for the memory, example:
+        {
+            "`and` or `or`": [
+                {"id": "uuid-xxx"},
+                {"created_at": {"gt": "2024-01-01"}},
+            ]
+        }
+        """,
     )
 
     # ==== Extended capabilities ====
@@ -433,7 +359,7 @@ class APISearchRequest(BaseRequest):
     )
 
     # ==== Context ====
-    chat_history: MessagesType | None = Field(
+    chat_history: MessageList | None = Field(
         None,
         description=(
             "Historical chat messages used internally by algorithms. "
@@ -573,7 +499,7 @@ class APIADDRequest(BaseRequest):
     )
 
     # ==== Chat history ====
-    chat_history: MessagesType | None = Field(
+    chat_history: MessageList | None = Field(
         None,
         description=(
             "Historical chat messages used internally by algorithms. "
@@ -695,6 +621,55 @@ def _convert_deprecated_fields(self) -> "APIADDRequest":
         return self
 
 
+class APIChatCompleteRequest(BaseRequest):
+    """Request model for chat operations."""
+
+    user_id: str = Field(..., description="User ID")
+    query: str = Field(..., description="Chat query message")
+    readable_cube_ids: list[str] | None = Field(
+        None, description="List of cube IDs user can read for multi-cube chat"
+    )
+    writable_cube_ids: list[str] | None = Field(
+        None, description="List of cube IDs user can write for multi-cube chat"
+    )
+    history: MessageList | None = Field(None, description="Chat history")
+    mode: SearchMode = Field(SearchMode.FAST, description="search mode: fast, fine, or mixture")
+    system_prompt: str | None = Field(None, description="Base system prompt to use for chat")
+    top_k: int = Field(10, description="Number of results to return")
+    session_id: str | None = Field(None, description="Session ID for soft-filtering memories")
+    include_preference: bool = Field(True, description="Whether to handle preference memory")
+    pref_top_k: int = Field(6, description="Number of preference results to return")
+    model_name_or_path: str | None = Field(None, description="Model name to use for chat")
+    max_tokens: int | None = Field(None, description="Max tokens to generate")
+    temperature: float | None = Field(None, description="Temperature for sampling")
+    top_p: float | None = Field(None, description="Top-p (nucleus) sampling parameter")
+    add_message_on_answer: bool = Field(True, description="Add dialogs to memory after chat")
+
+    # ==== Filter conditions ====
+    filter: dict[str, Any] | None = Field(
+        None,
+        description="""
+        Filter for the memory, example:
+        {
+            "`and` or `or`": [
+                {"id": "uuid-xxx"},
+                {"created_at": {"gt": "2024-01-01"}},
+            ]
+        }
+        """,
+    )
+
+    # ==== Extended capabilities ====
+    internet_search: bool = Field(True, description="Whether to use internet search")
+    threshold: float = Field(0.5, description="Threshold for filtering references")
+
+    # ==== Backward compatibility ====
+    mem_cube_id: str | None = Field(None, description="Cube ID to use for chat")
+    moscube: bool = Field(
+        False, description="(Deprecated) Whether to use legacy MemOSCube pipeline"
+    )
+
+
 class AddStatusRequest(BaseRequest):
     """Request model for checking add status."""
 
@@ -723,7 +698,7 @@ class SuggestionRequest(BaseRequest):
     user_id: str = Field(..., description="User ID")
     mem_cube_id: str = Field(..., description="Cube ID")
     language: Literal["zh", "en"] = Field("zh", description="Language for suggestions")
-    message: list[MessageDict] | None = Field(None, description="List of messages to store.")
+    message: MessagesType | None = Field(None, description="List of messages to store.")
 
 
 # ─── MemOS Client Response Models ──────────────────────────────────────────────