SuperAPI AI 工具集

hindsight-docs

智能体与模型

查看项目

更新于 10-16 08:31

技能介绍

Hindsight Documentation Skill 是 Hindsight 的完整技术文档技能包。Hindsight 被描述为一套面向 AI 智能体的仿生记忆系统。本技能用于在需要时查阅其架构、API、配置与最佳实践。

一、适用场景 当需要完成以下任务时,可使用该技能:理解 Hindsight 架构与核心概念;了解 retain/recall/reflect 操作;配置记忆库与 dispositions;搭建 Hindsight API 服务(Docker、Kubernetes、pip);与 Python/Node.js/Rust SDK 集成;理解检索策略(语义、BM25、图、时序);调试问题或优化性能;查阅 API 端点与参数。

二、文档结构 所有文档位于 references/ 目录,按类别组织:

  • references/:best-practices.md(建议从这里开始,涵盖 missions、tags、格式、反模式)、faq.md(常见问题与决策)、changelog/(发布历史与版本变更,含 index.md 及 integrations/)、openapi.json(完整 OpenAPI 规范,含端点 schema、请求/响应模型)。
  • references/developer/:api/(核心操作:retain、recall、reflect、memory banks)以及架构、配置、部署、性能等 *.md 文档。
  • references/sdks/:Python、Node.js、CLI、embedded 等 *.md 文档,以及 integrations/(框架与工具集成)。

三、如何查找文档

  1. 按模式查找文件(使用 Glob 工具):如 references/developer/api/.md 查看核心 API 操作;references/sdks/.md 与 references/sdks/integrations/*.md 查看 SDK 文档;也可查找 references//configuration.md、references//python.md、references/**/deployment.md 等。
  2. 搜索内容(使用 Grep 工具):例如搜索 "disposition"(记忆库配置)、"graph retrieval"(基于图的检索)、"helm install"(Kubernetes 部署)、"document_id"(文档管理)、"HINDSIGHT_API_"(环境变量);也可限定路径搜索,如 path: references/developer/api/ 中搜索 "POST /v1" 查找 API 端点,path: references/sdks/ 中搜索 "def |async def " 查找 Python 示例。
  3. 阅读完整文档(使用 Read 工具):如 references/developer/api/retain.md、references/sdks/python.md、references/sdks/integrations/litellm.md。

四、建议起点:最佳实践 在阅读 API 文档前,先阅读最佳实践指南,其中覆盖 missions、tags、内容格式、observation scopes 与反模式的实用规则,是正确集成的最快路径:references/best-practices.md。

五、核心概念

  • Memory Banks:隔离的记忆存储(每个用户/智能体一个)。
  • Retain:存储记忆(自动抽取事实/实体/关系)。
  • Recall:检索记忆(4 种并行策略:语义、BM25、图、时序)。
  • Reflect:基于记忆的、感知 disposition 的推理。
  • document_id:将同一会话中的消息分组(相同 ID 执行 upsert)。
  • Dispositions:怀疑、字面、共情等特质(1-5),影响 reflect。
  • Mental Models:从事实综合而来的整合知识。

六、说明与限制

  • 代码示例为内联自可运行示例。
  • 配置使用 HINDSIGHT_API_* 环境变量。
  • 数据库迁移在启动时自动运行。
  • 多记忆库查询需要客户端侧编排。
  • 使用 document_id 处理会话演进(相同 ID 即 upsert)。
  • 文档由 hindsight-docs/docs/ 与 hindsight-docs/docs-integrations/ 自动生成,运行 ./scripts/generate-docs-skill.sh 可更新。
  • 关于具体价格、收费与平台支持范围,资料中暂未提供。