hindsight-docs

hindsight-docs

热门

面向AI代理的完整Hindsight文档。使用此文档了解Hindsight架构、API、配置和最佳实践。

1.9万Star
1141Fork
更新于 2026/7/17
SKILL.md
readonly只读
name
hindsight-docs
description

面向AI代理的完整Hindsight文档。使用此文档了解Hindsight架构、API、配置和最佳实践。

Hindsight 文档技能

Hindsight的完整技术文档——一个用于AI代理的仿生记忆系统。

何时使用此技能

当你需要以下内容时使用此技能:

  • 理解Hindsight架构和核心概念
  • 学习retain/recall/reflect操作
  • 配置记忆库和dispositions
  • 设置Hindsight API服务器(Docker、Kubernetes、pip)
  • 集成Python/Node.js/Rust SDK
  • 理解检索策略(语义、BM25、图、时间)
  • 调试问题或优化性能
  • 查看API端点和参数
  • 查找cookbook示例和配方

文档结构

所有文档位于references/中,按类别组织:

references/
├── best-practices.md # 从这里开始——任务、标签、格式、反模式
├── faq.md            # 常见问题和决策
├── changelog/        # 发布历史和版本变更(index.md + integrations/)
├── openapi.json      # 完整的OpenAPI规范——端点模式、请求/响应模型
├── developer/
│   ├── api/          # 核心操作:retain、recall、reflect、记忆库
│   └── *.md          # 架构、配置、部署、性能
├── sdks/
│   ├── *.md          # Python、Node.js、CLI、嵌入式
│   └── integrations/ # 框架和工具集成
└── cookbook/
    ├── recipes/      # 使用模式和示例
    └── applications/ # 完整应用演示

如何查找文档

1. 按模式查找文件(使用Glob工具)

# 核心API操作
references/developer/api/*.md

# SDK文档
references/sdks/*.md
references/sdks/integrations/*.md

# Cookbook示例
references/cookbook/recipes/*.md
references/cookbook/applications/*.md

# 查找特定主题
references/**/configuration.md
references/**/*python*.md
references/**/*deployment*.md

2. 搜索内容(使用Grep工具)

# 搜索概念
pattern: "disposition"        # 记忆库配置
pattern: "graph retrieval"    # 基于图的搜索
pattern: "helm install"       # Kubernetes部署
pattern: "document_id"        # 文档管理
pattern: "HINDSIGHT_API_"     # 环境变量

# 在特定区域搜索
path: references/developer/api/
pattern: "POST /v1"           # 查找API端点

path: references/cookbook/
pattern: "def |async def "    # 查找Python示例

3. 阅读完整文档(使用Read工具)

references/developer/api/retain.md
references/sdks/python.md
references/cookbook/recipes/per-user-memory.md

从这里开始:最佳实践

在阅读API文档之前,请先阅读最佳实践指南。它涵盖了任务、标签、内容格式、观察范围以及反模式的实际规则——这是正确集成的最快方式。

references/best-practices.md

关键概念

  • 记忆库:隔离的记忆存储(每个用户/代理一个)
  • Retain:存储记忆(自动提取事实、实体、关系)
  • Recall:检索记忆(4种并行策略:语义、BM25、图、时间)
  • Reflect:基于记忆的disposition感知推理
  • document_id:将消息分组到对话中(相同ID时更新)
  • Dispositions:怀疑、字面、共情特质(1-5),影响reflect
  • 心智模型:从事实中综合提炼的知识

备注

  • 代码示例来自工作示例
  • 配置使用HINDSIGHT_API_*环境变量
  • 数据库迁移在启动时自动运行
  • 多库查询需要客户端编排
  • 使用document_id实现对话演进(相同ID = 更新)

自动生成,来源:hindsight-docs/docs/hindsight-docs/src/pages/cookbook/hindsight-docs/docs-integrations/。运行./scripts/generate-docs-skill.sh更新。