come-context-memory 0.3.1__py3-none-any.whl

come_context_memory-0.3.1.dist-info/METADATA

@@ -0,0 +1,223 @@
+Metadata-Version: 2.4
+Name: come_context_memory
+Version: 0.3.1
+Summary: A Memory System Base on Context
+Author-email: RicoZ <fiwrst@163.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Ricoz217/CoMe_context_memory
+Project-URL: Repository, https://github.com/Ricoz217/CoMe_context_memory
+Keywords: llm,memory,context,rag,knowledge-base
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx==0.28.1
+Requires-Dist: tiktoken==0.12.0
+Requires-Dist: PyYAML==6.0.3
+Requires-Dist: pillow==12.0.0
+Requires-Dist: requests==2.32.5
+Requires-Dist: networkx==3.6
+Requires-Dist: python-louvain==0.16
+Requires-Dist: Brotli==1.2.0
+Requires-Dist: zstandard==0.23.0
+Requires-Dist: typing_extensions==4.15.0
+Requires-Dist: fastapi==0.136.1
+Requires-Dist: uvicorn==0.46.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Dynamic: license-file
+
+# CoMe ContextMemory
+
+English version: [README_en.md](README_en.md)
+
+`CoMe_ContextMemory` 是一个基于 LLM 上下文的记忆库，通过另一种方式实现RAG。  
+它不依赖向量数据库，而是通过桶树结构组织记忆，并提供 `query / optimize / compress / split` 等流程进行维护与检索。
+
+## 文档入口
+- 项目介绍: [docs/project_introduction.md](docs/project_introduction.md)
+- 文档总览: [docs/README.md](docs/README.md)
+- Python API: [docs/python_api_guide.md](docs/python_api_guide.md)
+- CLI 指南: [docs/cli_guide.md](docs/cli_guide.md)
+- JSON-RPC 指南: [docs/jsonrpc_methods.md](docs/jsonrpc_methods.md)
+- 配置指南: [docs/config_guide.md](docs/config_guide.md)
+
+---  
+
+## 快速开始
+
+### 1. 通过 pip 安装（推荐）
+```powershell
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple come-context-memory
+```
+
+安装后可直接使用：
+- Python（`import context_memory`）
+- CLI 模式
+- JSON-RPC 服务器
+
+### 2. 使用 Release 的 Embedding 包（仅 Windows）
+适用于不想单独安装 Python 环境的场景。
+
+1. 下载并解压 release 中的 embedding 压缩包  
+2. 进入解压目录  
+3. 运行：
+```bat
+run_cli.bat
+```
+或
+```bat
+run_jsonrpc.bat --host 127.0.0.1 --port 8000
+```
+
+说明：
+- embedding 方案目前仅支持 Windows
+- 依赖和解释器都封装在目录内，不依赖系统 Python
+
+### 3. 手动安装
+```powershell
+git clone https://github.com/Ricoz217/CoMe_context_memory.git
+cd CoMe_context_memory
+pip install -r requirements.txt
+pip install -e ./
+```
+
+可直接启动：
+```powershell
+python -m context_memory.cli
+python -m context_memory.rpc_server
+```
+
+> 首次运行会在工作目录生成config文件夹，可配置你的 `LLM ApiKey` 后重启。详细说明: [docs/config_guide.md](docs/config_guide.md)
+
+## 三种接口
+1. Python 调用（主接口）
+2. CLI
+3. JSON-RPC 2.0（FastAPI）
+
+---  
+
+## 使用示例
+
+### Python 调用
+
+```python
+import os
+import asyncio
+from pathlib import Path
+from context_memory import get_context_memory_engine, ContextMemoryConfig  # 单例入口、配置
+
+
+"""
+初始化配置，设置记忆库目录(BASE_DIR)、主LLM预设、识图LLM预设
+"""
+_BASE_DIR = Path(os.getcwd()) / "MemoryLibrary"
+_init_config = ContextMemoryConfig(
+    base_dir=_BASE_DIR,  # 记忆库目录
+    llm_preset="CONTEXT_MEMORY",  # 主LLM预设，强烈建议使用DSV4-flash
+    image_llm_preset="KIMI2.6"  # 识图VLM预设
+)
+
+# Engine内部使用的是异步锁，因此需要自行管理多线程调用/事件循环。
+# CoMe为线程不安全，尽量把Engine实例放在一个单独的线程/唯一event_loop，跨线程调用可将任务提交到主线程。
+memory_engine = get_context_memory_engine(config=_init_config)  # 获取单例并配置
+
+
+"""
+全异步对象化操作
+"""
+async def main():
+    # 创建一个桶，ROOT本身也是一个桶，但不推荐直接把记忆放入ROOT
+    # 标题映射表为Engine全局，因此不要依赖标题，使用 `get_bucket()` 唯一桶ID更安全
+    # 旧桶ID在物理删除前一直可用，会自动追溯到最新可用桶id，`get_bucket()` 会返回该桶最新id
+    test_bucket = await memory_engine.set_bucket("TEST")  # 通过标题创建/获取桶。
+
+    # 添加一条记忆
+    print(await test_bucket.add_memory("今天是3月25日，地下室好冷，没什么人理我"))
+
+    # 从文件添加记忆
+    print(await test_bucket.add_memory_from_file("./母猪的产后护理.txt"))
+
+    # 从目录添加记忆
+    print(await test_bucket.add_memory_from_dir("./TypeScript Best Language of the World/"))
+
+    # 列出当前桶内容
+    print(await test_bucket.list_memories())
+
+    # Query
+    print(await test_bucket.query("谁是蒙古上单？"))
+    
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+详细说明: [docs/python_api_guide.md](docs/python_api_guide.md)
+
+### CLI
+
+- pip 安装: 直接在当前环境输入 `python -m context_memory.cli` 即可启动命令行模式，输入 `help` 获取命令列表
+- release 包: 运行 run_cli.bat，可附加参数。
+- 手动安装: 安装生产环境后运行 `python -m context_memory.cli`，  
+也可以直接运行以下文件 `./src/context_memory/cli.py` 
+- 详细说明: [docs/cli_guide.md](docs/cli_guide.md)
+
+### JSON-RPC (FastApi)
+
+- pip 安装: 直接在当前环境输入 `python -m context_memory.rpc_server` 即可开启本机服务器，其他程序通过调用API的方式使用
+- release 包: 运行 run_jsonrpc.bat，可附加参数。
+- 手动安装: 安装生产环境后运行 `python -m context_memory.rpc_server`，  
+也可以直接运行以下文件 `./src/context_memory/rpc_server.py`  
+- 详细说明: [docs/jsonrpc_methods.md](docs/jsonrpc_methods.md)
+
+---  
+
+## 注意事项
+
+- 不支持对同一记忆库使用多个进程(多个引擎实例)并发使用，会造成数据不安全
+- CLI/JSON-RPC 都会开启一个独立进程，不要同时使用不同的接口方式
+- 可通过以下代码手动创建不同的引擎实例，同时管理多个记忆库:  
+```python
+from context_memory import ContextMemoryEngineV3
+
+new_engine = ContextMemoryEngineV3()
+```
+- 不提供回退接口，批量入库需谨慎。记忆系统为了数据安全起见，即使中断了重启后也会继续未完成的任务。只能通过批量任务结果手动逐个删除新添加的记忆。
+- JSON-RPC 无鉴权，要自行编写网关。
+- 当前记忆未作时间管理，若要添加带时间要素的记忆(例如日程安排、重要事件)，需要在记忆中显式注明。  
+同时 `query` 也不会自动传入时间，若有需要请显式传入。 
+
+## 提问的智慧
+
+为了更快定位问题、减少来回沟通，建议提问时尽量包含以下信息：
+
+1. 明确目标
+   - 你想实现什么，而不只是“哪里报错了”。  
+
+2. 提供最小复现
+   - 最好给出最短代码片段、CLI 命令或 JSON-RPC 请求体。  
+
+3. 说明环境
+   - 包版本、安装方式（pip/embedding/source）、操作系统、Python 版本。  
+
+4. 提供完整报错
+   - 贴完整 traceback 或关键日志，不要只截最后一行。  
+
+5. 说明预期与实际差异
+   - 预期结果是什么，实际结果是什么。  
+
+6. 说明已尝试的排查
+   - 你已经做过哪些检查，能避免重复建议。  
+
+这样的问题通常能更快拿到准确答复。
+
+## TODO
+- [ ] 显式记忆权重管理
+- [ ] 显式设置记忆过期时间
+- [ ] 显式锁定记忆
+- [ ] 加入时间管理功能

come_context_memory-0.3.1.dist-info/RECORD

@@ -0,0 +1,58 @@
+come_context_memory-0.3.1.dist-info/licenses/LICENSE,sha256=KOkGhnIwtQbZicWNZXNjHa40V3FqCNCNRcsyfBz1KaQ,1083
+context_memory/LLM_connect.py,sha256=67bZwNQLzemullhf6VIh1Y6pQaX9kWMFjN_xdbF9TZo,99279
+context_memory/LLM_usage.py,sha256=oN7JAxXxBlaimLGl-SiZHdHMmnHiXFnyIan_7-Xrl6g,17579
+context_memory/__init__.py,sha256=1us_N7EsnrmlZygSaEH_gtW_2RRquMtw-uTCeB9JZK0,921
+context_memory/cli.py,sha256=6zXidPTznZgbGhaHzwqsvxGCa9aHA2F94E93jp_QWdQ,20631
+context_memory/config.py,sha256=4gp7RyYB-Dj5HfXVxnf0UdL32wkdIbDi0zE3twovZIg,6687
+context_memory/file_cache.py,sha256=JkFhq4CntrO7fqSiFS7RQd2mlM1Xhv0vaJIv1vGb6Qc,5716
+context_memory/logger.py,sha256=8IJU0-bRR7HZ1ObC8cPkSS-eZlVDt0IlnfQcpAVKEys,4785
+context_memory/rpc_server.py,sha256=R81JDHOqQ2lsUpRd7xg0FMd5rHoWlFgXdTuQjT0W1ho,14954
+context_memory/time_id.py,sha256=tVZRr643u3WOxR1dvWqyJ3ALtrCCLwPGSfOeo-S3K3U,5090
+context_memory/utils.py,sha256=weFODAJHeyKcCXyM7OlopZFn_vm9kBmYsYa-C3nd3kk,39510
+context_memory/memory/__init__.py,sha256=n3q0BWi_KcMUVjg5ywbAn0NQ__QGQnVe9sNrk_Tow4I,301
+context_memory/memory/aliasing.py,sha256=umGE-rb30EQAqi8Q2L1wdBLjlnab_sxpyVIIys2bjxE,13943
+context_memory/memory/context_bucket.py,sha256=gqhIANNom91Ac4YCbovL-w6DoEJt3KtU4O-8ISRWCQc,955
+context_memory/memory/engine.py,sha256=fVMlP5dW2NDFtAKGUGNxmJ74K00lr9YIuoj5k4I1W3E,247625
+context_memory/memory/llm_pipeline.py,sha256=vP92av-7oY3IE-dRGGBc2rymX3auherebjDjlUhvxcQ,62688
+context_memory/memory/memory_manager.py,sha256=ltWLUODxqUYXZ4URUzwylvIQK7PsqP4ZF8HBGH36a2A,4268
+context_memory/memory/models.py,sha256=rCfF5IOv2ys_Xr58xNhuF3oN3oGkHZeugA8qkgiuG2U,13902
+context_memory/memory/multimodal.py,sha256=-ImzOpeSxO1ii9rGEsw6eV8cES9AorsZqaAYtG9L6qU,8191
+context_memory/memory/rerank.py,sha256=RnhY_bwx5cHUCuFj430EEgBBNQ6YzxT05dS9wvWijgQ,8572
+context_memory/memory/storage.py,sha256=cHMbc2a5LOlbf18h03uMabkemPy-sVjnDppvoHG8Xv4,55475
+context_memory/memory/prompts/bucket_split_schema.md,sha256=4heMTrthfKGmbxtYM3BtPN-Gg-lUwnnEnaONS0lvNHY,331
+context_memory/memory/prompts/bucket_split_system.md,sha256=hSyPwglQ03y9838YmQ1LlM70bzXXo8pOWbo2LwEhOYk,884
+context_memory/memory/prompts/bucket_summary_schema.md,sha256=VDsBF6AJnYqNfSlcAu05Du6tIK5ZpiPuhWBtwIb-o4Q,83
+context_memory/memory/prompts/bucket_summary_system.md,sha256=sse-J9uONnbwjm83PN6buFha6btPvicYRox-q3adXdY,205
+context_memory/memory/prompts/clean_schema.md,sha256=gns9rT_s1YHClKkEnhUzhx5eFkq2RPRlUbMjWk50ld4,386
+context_memory/memory/prompts/clean_system.md,sha256=1w4alajBRBHeq0AMddT0Gf4xwO2e1jKXjKMLxE9ZCy4,1734
+context_memory/memory/prompts/compress_schema.md,sha256=awux_d4ZS_8scHdF9cl-oiyd8Sq5DolVhMpRsxR2aaQ,250
+context_memory/memory/prompts/compress_system.md,sha256=D0z9pyH6EKPeKhqL-dQ_QziiPv1XfNhjXv_HxrQlRDw,690
+context_memory/memory/prompts/image_extract_system.md,sha256=Zbr3R9ikMMv1EGpG5o9YWmLkU4lPcPbVGMs_wFMTwVY,315
+context_memory/memory/prompts/image_extract_user.md,sha256=tb-hLBhr-IF9VjG-ISkpI3_Bt_hWldId1_KFTQ006UI,139
+context_memory/memory/prompts/ingest_schema.md,sha256=_y9hRWPefbq4-bH5T7mZbF2mqtmp6Ra0XaImFtVMlTw,1101
+context_memory/memory/prompts/ingest_system.md,sha256=ZntsQefR2LwEHFeEPFgTvfkhwy27NvfLZ59_4TN8p0I,1322
+context_memory/memory/prompts/optimize_schema.md,sha256=UpzvwqRFCCMbTo4MXBWvdtsSni-aUVVI-P9DVnUrfz0,400
+context_memory/memory/prompts/optimize_system.md,sha256=4FT34uZ4R044-h3tkZ_rc1FnoJoB1P-FAJIWRwlWdz0,3285
+context_memory/memory/prompts/query_schema.md,sha256=K9SJIsSkVMKnn56IBK-LKCBQpcQoIHHrl6hQNxrsJkI,262
+context_memory/memory/prompts/query_system.md,sha256=JhT6JSEBvep48RF1_tq3j1nrWKBX26MKwuxN7UlgIho,1624
+context_memory/memory/prompts/split_schema.md,sha256=gNa3FuMWPuzHDl4ljPLcmF-Qp_lHFBki6gVEW31B8rI,178
+context_memory/memory/prompts/split_system.md,sha256=SqAmSlzeCeGXZ-DWYkIP-KlPE-eORpf6iKz9PlB5bWo,396
+context_memory/memory/prompts/text_chunk_line_schema.md,sha256=Wq-BnkJsl-p9zld2os6_dnZXQzIwuuMPPPTm5i5vb88,729
+context_memory/memory/prompts/text_chunk_line_system.md,sha256=4Y_rlwSzYH-7zkIj10t-dny_IV2sfXOO9BV0GlQKyxc,2849
+context_memory/memory/prompts/text_chunk_schema.md,sha256=ydlDNkBZSz4rSsV4JqgimftF1XVhwLCanQf0S1UD6mI,72
+context_memory/memory/prompts/text_chunk_system.md,sha256=6VKuZ5n1xGZO6-7xzPqj2YrD3Rzd4SRzPy7BMZ0ZETk,483
+context_memory/memory/services/__init__.py,sha256=8MWFKeA1VW3WJUljkN2s-qp_4c5l8Iudb8jdXLmAAGU,711
+context_memory/memory/services/bucket_summary_service.py,sha256=-4KaBIHY7xQ-dKyMj2clgxmDN-07jISq5stJRgFt-HU,512
+context_memory/memory/services/bucket_topology_service.py,sha256=kDPhbZjeWD67rtbWjGn5-nx6pDa2xNCyPBSMBOIIT1E,1084
+context_memory/memory/services/compress_split_service.py,sha256=h88-4bLxlUpdOP6FLiFnbSuCDWcJ_N4X1UOKvDJrLyQ,1150
+context_memory/memory/services/ingest_service.py,sha256=hxlUZwXzmnrYZR0dG9MnSOoYXkcw51e_K1kmglvvMO0,3677
+context_memory/memory/services/maintenance_service.py,sha256=TxI8vKdVr8vSNqMpXnk_p36nZlbkQpzcPVcD00Y0NPg,4938
+context_memory/memory/services/optimize_service.py,sha256=P9fkX-Nbkaei4nyf2IuC5zgAG_0hmWuUysqT3QrEi0Y,42290
+context_memory/memory/services/query_service.py,sha256=cKeqQhf9KcrN0sZ2mJuKDhFAHQWLNpGQJeDsGqKG-BI,39626
+context_memory/memory/services/runtime.py,sha256=yHf2vHl7rA9SB9IBa8xtsKDdDYUFd7OWi7G1J4IiN-o,360
+context_memory/memory/services/split_ingest_job_service.py,sha256=l1be_VmJSYvfucn5UuIqHKevMYs9JojukQCTVqbdoPk,1507
+come_context_memory-0.3.1.dist-info/METADATA,sha256=GByUUVHsrqd91nRmZjfRatXd32YVXxJsLhhYSs6F3lA,8040
+come_context_memory-0.3.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+come_context_memory-0.3.1.dist-info/entry_points.txt,sha256=OxnjaFaEGC2TEmma3MK_Aew4WXdsc_W_6wd7oPe-IIQ,115
+come_context_memory-0.3.1.dist-info/top_level.txt,sha256=V4KRM94HvvBwvVQZEULXlo-9xMevbbc9HE6kig0RCAk,15
+come_context_memory-0.3.1.dist-info/RECORD,,

come_context_memory-0.3.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

come_context_memory-0.3.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+context-memory-cli = context_memory.cli:main
+context-memory-rpc = context_memory.rpc_server:main

come_context_memory-0.3.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 RicoZ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

come_context_memory-0.3.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+context_memory