README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈
Pi Hindsight 扩展
文档: https://luxus.github.io/pi-hindsight/
Pi Hindsight 在模型调用前召回相关的项目记忆,在智能体运行完成后保留结构化的会话增量,并暴露显式的记忆工具以进行直接的 retain/recall/reflect 操作。
安装
安装已发布的 npm 包:
pi install npm:@luxusai/pi-hindsight
当您需要当前仓库源代码而非最新的 npm 发布版本时,您仍然可以从 GitHub 进行安装:
pi install https://github.com/luxus/pi-hindsight
包名:@luxusai/pi-hindsight。
有关本地检出安装,请参阅 Development。
快速开始
- 启动或选择一个 Hindsight 服务器:
- Hindsight Cloud 注册
- 自托管 Hindsight 安装;如果您希望配置无需 LLM API 密钥的私有环境,请使用 Hindsight 内置的 llama.cpp/local-LLM 选项
- 嵌入式(无 Docker): 安装
@vectorize-io/hindsight-all并使用HindsightServer以编程方式启动本地守护进程。主机上需要uv/uvx和 Python。
- 在您的仓库中打开 Pi 并运行
/hindsight。 - 配置 Hindsight API URL。默认的自托管 URL 为
http://localhost:8888。 - 选择最适合该仓库的最窄记忆配置文件:Project + User、Project Only、User Only 或 Recall Only。
- 开始编码。Recall 发生在 provider 调用之前;当所选配置文件允许自动 retain 时,retain 发生在已完成的 agent 运行之后。
有关设置详情,请参阅 入门指南。从旧版 path-bank 安装升级:升级到 domain banks。
安全默认设置
- 项目记忆默认保留在项目 bank 中。
- 用户记忆为可选功能,需显式配置。
- Recall 注入是临时的;召回的记忆不会写回转录记录。
- 自动 retain 在写入记忆前会屏蔽常见的机密信息。
- 精确删除文档需要精确的 bank ID、精确的文档 ID 以及
confirm: true。
有关详情,请参阅 memory behavior 和 session memory modes。
文档
- Start — 安装与初始设置
- Concepts — 内存模型、bank、队列、导入、安全性
- Guides — 设置、诊断、导入、恢复及 domain-bank 升级 的任务工作流
- Reference — 工具、命令、配置、钩子、生成表面
- Development — 贡献者设置、检查、发布、文档工作流
Development
npm install
npm run check
npm run check 包含 npm run docs:check,用于验证生成的 surface-reference 新鲜度、生成的 code-map 新鲜度、内部文档链接/侧边栏路由、打包的 Markdown 链接、GitHub Pages 带 base 前缀的文档链接,以及文档站点构建。
使用本地扩展运行 Pi:
pi -e ./extensions/index.ts
当您需要测试从工作树加载包时,请将本地检出安装到 Pi 中:
pi install /path/to/pi-hindsight
先前技术
Pi Hindsight 受 noctuid/pi-hindsight 启发。本包保留了相同的有用理念,随后收紧了项目隔离、队列持久性、诊断和发布加固。