hindsight-docs

Hindsight 文档技能

Hindsight 的完整技术文档——一个面向 AI Agent 的仿生记忆系统。

何时使用本技能

在以下情况使用本技能：

• 理解 Hindsight 架构与核心概念
• 了解 retain/recall/reflect 操作
• 配置记忆库与倾向
• 部署 Hindsight API 服务（Docker、Kubernetes、pip）
• 集成 Python/Node.js/Rust SDK
• 理解检索策略（语义、BM25、图、时间）
• 排查问题或优化性能
• 查阅 API 端点与参数

文档结构

所有文档均位于 references/，按类别组织：

references/
├── best-practices.md # START HERE — missions, tags, formats, anti-patterns
├── faq.md            # Common questions and decisions
├── changelog/        # Release history and version changes (index.md + integrations/)
├── openapi.json      # Full OpenAPI spec — endpoint schemas, request/response models
├── developer/
│   ├── api/          # Core operations: retain, recall, reflect, memory banks
│   └── *.md          # Architecture, configuration, deployment, performance
└── sdks/
    ├── *.md          # Python, Node.js, CLI, embedded
    └── integrations/ # Framework and tool integrations

如何查找文档

1. 按模式查找文件（使用 Glob 工具）

# Core API operations
references/developer/api/*.md

# SDK documentation
references/sdks/*.md
references/sdks/integrations/*.md

# Find specific topics
references/**/configuration.md
references/**/*python*.md
references/**/*deployment*.md

2. 搜索内容（使用 Grep 工具）

# Search for concepts
pattern: "disposition"        # Memory bank configuration
pattern: "graph retrieval"    # Graph-based search
pattern: "helm install"       # Kubernetes deployment
pattern: "document_id"        # Document management
pattern: "HINDSIGHT_API_"     # Environment variables

# Search in specific areas
path: references/developer/api/
pattern: "POST /v1"           # Find API endpoints

path: references/sdks/
pattern: "def |async def "    # Find Python examples

3. 阅读完整文档（使用 Read 工具）

references/developer/api/retain.md
references/sdks/python.md
references/sdks/integrations/litellm.md

从这里开始：最佳实践

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

references/best-practices.md

关键概念

• 记忆库：隔离的记忆存储（每个用户/Agent 一个）
• Retain：存储记忆（自动提取事实/实体/关系）
• Recall：检索记忆（4 种并行策略：语义、BM25、图、时间）
• Reflect：基于记忆、感知倾向的推理
• document_id：对会话中的消息进行分组（相同 ID 即 upsert）
• 倾向：怀疑主义、字面主义、共情特质（1-5），影响 reflect
• 心智模型：由事实综合而成的整合知识

说明

• 代码示例内联自可运行的示例
• 配置使用 HINDSIGHT_API_* 环境变量
• 数据库迁移在启动时自动运行
• 多库查询需要客户端侧编排
• 使用 document_id 处理会话演进（相同 ID = upsert）

---

自动生成自 hindsight-docs/docs/ 和 hindsight-docs/docs-integrations/。运行 ./scripts/generate-docs-skill.sh 以更新。