-
Notifications
You must be signed in to change notification settings - Fork 1.4k
feat: knowledge base for long-term memory (#1099) #1115
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bitloi
wants to merge
41
commits into
eigent-ai:main
Choose a base branch
from
bitloi:feature/knowledge-base-1099
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+235
−6
Open
Changes from 33 commits
Commits
Show all changes
41 commits
Select commit
Hold shift + click to select a range
2c18d7c
feat: knowledge base for long-term memory (issue #1099)
bitloi d07d875
fix: use os.environ in knowledge_base for testability; add unit and A…
bitloi f45ca7c
Merge origin/main into feature/knowledge-base-1099
bitloi ece99c9
fix: resolve chat_service.py conflict with main (keep KB integration)
bitloi 852ab43
Merge upstream/main, resolve chat_service.py (keep KB integration)
bitloi f678309
Merge branch 'main' into feature/knowledge-base-1099
bitloi 3b9c0e4
Merge branch 'main' into feature/knowledge-base-1099
bitloi 3d10e6d
Merge branch 'main' into feature/knowledge-base-1099
bitloi 47f4f10
Merge branch 'main' into feature/knowledge-base-1099
bitloi fbd480b
Merge branch 'main' into feature/knowledge-base-1099
bitloi b7af46a
Merge branch 'main' into feature/knowledge-base-1099
bitloi 7216ce8
fix: resolve merge conflicts with main (router.py, chat_service.py)
bitloi 4e2dcb2
Merge upstream/main into feature/knowledge-base-1099, resolve conflicts
bitloi c363187
Merge branch 'main' into feature/knowledge-base-1099
bitloi 3d2f4b6
Merge branch 'main' into feature/knowledge-base-1099
bitloi d328676
Merge branch 'main' into feature/knowledge-base-1099
bitloi b2fd959
PR feedback: rename to sqlite_toolkit, FTS5/BM25 search, add tool onl…
bitloi 70cd6df
Remove knowledge base from developer agent for now (per review)
bitloi b4bfc4e
Merge branch 'main' into feature/knowledge-base-1099
bitloi e195c47
Merge branch 'main' into feature/knowledge-base-1099
bitloi dd804f2
Merge branch 'main' into feature/knowledge-base-1099
bitloi 606533f
Merge branch 'main' into feature/knowledge-base-1099
bitloi 06d19b1
Merge branch 'main' into feature/knowledge-base-1099
Wendong-Fan b4fba05
Merge branch 'main' into feature/knowledge-base-1099
bitloi 1b0f125
PR feedback: remove KB from chat context, rename tool to store_projec…
bitloi e134793
Merge branch 'main' into feature/knowledge-base-1099
bitloi 52d06b2
Merge branch 'main' into feature/knowledge-base-1099
bitloi 3086710
Merge branch 'main' into feature/knowledge-base-1099
bitloi a275992
Merge upstream/main into feature/knowledge-base-1099
bitloi ba023f5
Merge branch 'feature/knowledge-base-1099' of https://github.com/bitl…
bitloi 8d8b573
Merge branch 'main' into feature/knowledge-base-1099
bitloi 3564835
refactor(knowledge-base): switch from SQLite to markdown file-based m…
bitloi 60367cb
Merge branch 'main' into feature/knowledge-base-1099
nitpicker55555 b2d810a
refactor(memory): index-only prompt, no dedicated tools (reviewer fee…
bitloi 3bd0880
Merge branch 'feature/knowledge-base-1099' of https://github.com/bitl…
bitloi 0971ae6
Address nitpicker55555 review: remove unused memory helpers, wire pro…
bitloi 4cbdaf2
chore(backend): remove ruff from dev dependencies
bitloi 7e7991e
Merge branch 'main' into feature/knowledge-base-1099
bitloi 516caa2
Replace knowledge_base_toolkit with use_project_memory flag
bitloi d000b44
Merge branch 'feature/knowledge-base-1099' of https://github.com/bitl…
bitloi dafac62
Revert linter-only changes in router.py (review feedback)
bitloi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| # ========= Copyright 2025-2026 @ Eigent.ai All Rights Reserved. ========= | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # ========= Copyright 2025-2026 @ Eigent.ai All Rights Reserved. ========= | ||
|
|
||
| """ | ||
| Toolkit for long-term memory using markdown files (issue #1099). | ||
|
|
||
| Agents can both read and write to the project's memory file (.eigent/memory.md). | ||
| This provides a simple, file-based approach for persistent knowledge storage. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import logging | ||
| import os | ||
| from typing import Final | ||
|
|
||
| from camel.toolkits.base import BaseToolkit | ||
| from camel.toolkits.function_tool import FunctionTool | ||
|
|
||
| from app.agent.toolkit.abstract_toolkit import AbstractToolkit | ||
| from app.component.environment import env | ||
| from app.utils.memory_file import append_memory, read_memory | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
| _DEFAULT_WORKING_DIR: Final[str] = "~/.eigent" | ||
| _NO_MEMORY_MESSAGE: Final[str] = ( | ||
| "No project memory exists yet. Use remember_this to save information." | ||
| ) | ||
| _SUCCESS_MESSAGE: Final[str] = ( | ||
| "Saved to project memory (.eigent/memory.md). " | ||
| "This will be available in future conversations." | ||
| ) | ||
| _FAILURE_MESSAGE: Final[str] = "Failed to save to project memory. Please try again." | ||
|
|
||
|
|
||
| def _resolve_working_directory(working_directory: str | None) -> str: | ||
| """Resolve and validate the working directory path.""" | ||
| if working_directory is None: | ||
| working_directory = env("file_save_path", os.path.expanduser(_DEFAULT_WORKING_DIR)) | ||
| resolved = os.path.expanduser(working_directory) | ||
| os.makedirs(resolved, exist_ok=True) | ||
| return resolved | ||
|
|
||
|
|
||
| class KnowledgeBaseToolkit(BaseToolkit, AbstractToolkit): | ||
| """Toolkit for reading and writing project long-term memory. | ||
|
|
||
| Uses a simple markdown file (.eigent/memory.md) in the project's working | ||
| directory. Agents can both read existing memories and write new ones. | ||
| """ | ||
|
|
||
| def __init__( | ||
| self, | ||
| api_task_id: str, | ||
| working_directory: str | None = None, | ||
| agent_name: str | None = None, | ||
| timeout: float | None = None, | ||
| ) -> None: | ||
| if not api_task_id or not api_task_id.strip(): | ||
| raise ValueError("api_task_id cannot be empty") | ||
|
|
||
| super().__init__(timeout=timeout) | ||
| self.api_task_id = api_task_id.strip() | ||
| self.working_directory = _resolve_working_directory(working_directory) | ||
| self.agent_name = agent_name.strip() if agent_name else "agent" | ||
|
|
||
| logger.debug( | ||
| "KnowledgeBaseToolkit initialized", | ||
| extra={ | ||
| "api_task_id": self.api_task_id, | ||
| "working_directory": self.working_directory, | ||
| "agent_name": self.agent_name, | ||
| }, | ||
| ) | ||
|
|
||
| def read_project_memory(self) -> str: | ||
| """Read the project's long-term memory file. | ||
|
|
||
| Returns the content of .eigent/memory.md which contains facts, | ||
| preferences, and decisions that should persist across sessions. | ||
|
|
||
| Returns: | ||
| str: The memory file content, or a message if no memory exists yet. | ||
| """ | ||
| try: | ||
| content = read_memory(self.working_directory) | ||
| if content is None: | ||
| return _NO_MEMORY_MESSAGE | ||
| return content | ||
| except Exception as e: | ||
| logger.error( | ||
| f"Error reading project memory: {e}", | ||
| extra={"working_directory": self.working_directory}, | ||
| ) | ||
| return _NO_MEMORY_MESSAGE | ||
|
|
||
| def remember_this(self, content: str) -> str: | ||
| """Save a fact or piece of information to the project's long-term memory. | ||
|
|
||
| Use this when the user or task establishes something that should be | ||
| remembered for future conversations (e.g. preferences, decisions, | ||
| project-specific facts). The content will be appended to .eigent/memory.md. | ||
|
|
||
| Args: | ||
| content (str): The information to remember (clear, self-contained text). | ||
|
|
||
| Returns: | ||
| str: Confirmation message indicating success or failure. | ||
| """ | ||
| if not content or not content.strip(): | ||
| return "Cannot save empty content. Please provide information to remember." | ||
|
|
||
| try: | ||
| success = append_memory(self.working_directory, content) | ||
| if success: | ||
| logger.info( | ||
| "Memory saved successfully", | ||
| extra={ | ||
| "api_task_id": self.api_task_id, | ||
| "content_length": len(content), | ||
| }, | ||
| ) | ||
| return _SUCCESS_MESSAGE | ||
| return _FAILURE_MESSAGE | ||
| except Exception as e: | ||
| logger.error( | ||
| f"Error saving to project memory: {e}", | ||
| extra={"working_directory": self.working_directory}, | ||
| ) | ||
| return _FAILURE_MESSAGE | ||
|
|
||
| def get_tools(self) -> list[FunctionTool]: | ||
| """Return the list of tools provided by this toolkit.""" | ||
| return [ | ||
| FunctionTool(self.read_project_memory), | ||
| FunctionTool(self.remember_this), | ||
| ] | ||
|
|
||
|
|
||
| def get_tools( | ||
| api_task_id: str, | ||
| working_directory: str | None = None, | ||
| agent_name: str | None = None, | ||
| ) -> list[FunctionTool]: | ||
| """Return the memory tools for use by an agent.""" | ||
| return KnowledgeBaseToolkit( | ||
| api_task_id=api_task_id, | ||
| working_directory=working_directory, | ||
| agent_name=agent_name, | ||
| ).get_tools() |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.