Metadata-Version: 2.5
Name: memgarden
Version: 0.20.0
Summary: 可插拔的 AI 记忆编辑内核：落卡、召回、整理与可替换存储编排。
Project-URL: Homepage, https://github.com/teleport-computer/memgarden
Project-URL: Source, https://github.com/teleport-computer/memgarden
Project-URL: Issues, https://github.com/teleport-computer/memgarden/issues
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           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.
License-File: LICENSE
Keywords: agent,llm,long-term-memory,memory
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Typing :: Typed
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: jsonschema>=4.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: tomli>=2.0; (python_version < '3.11') and extra == 'dev'
Provides-Extra: sqlite
Description-Content-Type: text/markdown

# Memory Garden

可插拔的 AI 记忆库：把对话整理成可读的记忆卡，在后续对话中召回，并维护记忆的更新、归档和删除。

保留 Garden 自己的 Capture、挑卡和 Maintenance/Dream 能力，通过 SDK 或 JSON 协议接入 Runtime。存储后端可以替换；兼容其他记忆系统整套算法不属于本库目标。运行包零第三方依赖，全链路明文，不包含加解密或密钥管理。

## 文档入口

| 想了解什么 | 阅读位置 |
|---|---|
| 产品范围、快速接入、宿主分工 | 本 README |
| 字段、实际存储表、生命周期、接口与恢复规则 | [接入与数据参考](docs/INTEGRATION-AND-DATA.md) |
| 哪些已验证、哪些仍待验收、工程师下一步检查什么 | [当前验收状态](docs/STATUS.md) |
| DeepSeek Harness 安装、配置与验收 | [DSH Adapter](adapters/dsh-memgarden/README.md) |
| 判断质量评测 / 发布流程 | [Evals](evals/README.md) · [发版指南](docs/RELEASING.md) |

文档描述当前 checkout。PR 中的改动在合并、发版前，不等于 PyPI 已发布版本具备这些行为；验证基线和证据见当前验收状态。

## 分工与接入方式

| 层 | 负责什么 | 接入方提供什么 |
|---|---|---|
| `GardenComponent` | 提示词、解析校验、记忆编辑判断、挑卡与整理计划 | 模型、候选卡、读写与权限编排 |
| `MountedGarden` | 在判断层上接好读库、owner/mount 检查、CAS、幂等写入、维护账本和回执 | 可信 Scope、模型、满足 StoragePort 的存储 |
| `memgarden serve` | 把 MountedGarden 暴露成 JSON Lines 请求/响应 | 子进程管理、认证边界、模型调用方式 |
| DSH Adapter | DSH 每轮召回、轮末 Capture、Maintenance、工具与待办恢复 | DSH provider、稳定 owner、持久数据库和 stateDir |

Runtime 负责身份认证、凭证、模型超时/取消/用量、任务调度、备份与部署。Garden 负责记忆业务规则。JSON 是接入协议；单独放一个 JSON 文件不会执行这些能力。

## 快速开始

安装已发布包：

```bash
pip install memgarden
memgarden manifest
```

审核当前源码时，在仓库根目录运行：

```bash
uv run python examples/quickstart.py
uv run python examples/mount_in_ten_minutes.py
```

两个示例都使用假模型，无需联网或凭据。以下 SDK 示例也可直接执行：

```python
import json
from memgarden import CaptureRequest, MountedGarden, Scope
from memgarden.selection import Chain, RecentStage
from memgarden.stores.memory import InMemoryStore

class ExampleModel:
    def complete(self, prompt: str, *, purpose: str = "") -> str:
        # 教学用固定回复；接入时换成宿主自己的模型调用。
        return json.dumps({"cards": [{
            "action": "add", "summary": "饮食清淡",
            "content": "对方不吃辣，一吃就胃疼。",
            "bucket": "饮食", "threads": ["饮食习惯"],
        }]}, ensure_ascii=False)

garden = MountedGarden(
    model=ExampleModel(),
    store=InMemoryStore(),  # 进程内演示；持久化可用 SqliteStore("memory.db")
    selection_policy=Chain(stages=(RecentStage(limit=4),)),
)
scope = Scope(tenant_id="example", memory_owner_id="user-42")
receipt = garden.capture_and_store(scope, CaptureRequest(
    window="对方：我不吃辣，一吃就胃疼。", locale="zh-Hans",
    idempotency_key="conversation-1:turn-1",
))
assert receipt.error is None, receipt.error
assert receipt.written
context = garden.context_for_turn(scope, "晚饭吃什么？")
assert context.record_ids
print(context.blocks)
```

`GardenComponent.capture()` 只返回建议的 mutations；`MountedGarden.capture_and_store()` 才返回存储回执。收到 RPC 响应后还要检查业务结果的 `error`，不能仅凭请求成功就告诉用户“记住了”。

## 主要能力

| 能力 | 当前行为 |
|---|---|
| 自动 Capture | 按对话策略筛选、写卡；支持新增和取代旧卡、解析失败反馈与重试 |
| 上下文召回 | 从可见且有效的卡中挑选，返回上下文块与来源 ID；挑卡策略可注入 |
| Maintenance / Dream | 判断是否需要整理，将多张旧卡合并成新卡，原子保存结果和整理进度 |
| 用户明确写入 | 直接保存用户选择的内容，不再判断“值不值得记” |
| History Import | 串行分批、每批重读已有记忆、游标续传与失败回执；当前需要服务侧注入模型 |
| 浏览 / 导出 | 分页读取；导出默认包含归档及被取代的记忆 |
| 归档 / 取代 / 删除 | 归档和取代保留内容；用户删除从当前 Store 移除目标卡 |
| Promote / Migrate | 经宿主授权移动 mount；升级已有卡字段并写回 |
| 模型工具 | 注册 `memory_search` / `memory_write`；自动 Capture 不依赖模型主动调用工具 |

具体运行能力取决于所接存储和模型。连接服务后读取 `manifest.get`，它会返回真实能力和降级信息；独立 CLI `memgarden manifest` 是包的静态声明。

## DeepSeek Harness

Adapter 随 Python wheel 分发，与 Garden 共用版本；安装后用 `memgarden install-dsh` 拷入 DSH profile。升级包后需要重新运行安装命令更新副本。

Capture 与 Maintenance 都支持宿主驱动：Garden 返回提示词，DSH 用自己的 provider 调用模型，再把结果交回 Garden。当前 DSH 默认无模型服务不提供 History Import / Migrate。详细步骤及 pinned DSH 版本见 [Adapter 文档](adapters/dsh-memgarden/README.md)。

## 存储与适用范围

内置 `InMemoryStore` 和 `SqliteStore` 两个参考实现，共用 mutation 执行语义和契约测试。SQLite 存储的是明文 JSON 卡片及并发、幂等、整理辅助状态；[数据参考](docs/INTEGRATION-AND-DATA.md)列出了六张表与真实字段形状。

新卡自动记录创建／更新时间；实际修改才更新修改时间，读取和幂等重放不刷新。事情发生时间 `occurred_at` 与这两个写入时间分开；旧卡缺失的历史创建时间不补造。

当前读写路径会加载 owner 的卡片集合。接口分页限制响应大小，不代表数据库读取已按页执行；大规模导入、并发导出和跨进程共享 outbox 需要另外验证。[当前验收状态](docs/STATUS.md)集中记录这些边界。

## 开发验证

```bash
uv run --extra dev pytest -q
uv run --extra dev python evals/run.py --baseline evals/baseline.json
uv run python examples/quickstart.py
uv run python examples/mount_in_ten_minutes.py
uv build
```

DSH 离线 Adapter 回归包含在 pytest 中，需要 Node；CI 固定 Node 20，并覆盖 Python 3.10–3.13。真实 DSH 和真实模型验收单独执行，未运行或 SKIP 不能算通过。

Apache-2.0，见 [LICENSE](LICENSE)。
