hindsight-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Hindsight Documentation Skill

Hindsight文档Skill

Complete technical documentation for Hindsight - a biomimetic memory system for AI agents.

AI Agent的仿生记忆系统Hindsight的完整技术文档。

When to Use This Skill

何时使用此Skill

Use this skill when you need to:

Understand Hindsight architecture and core concepts
Learn about retain/recall/reflect operations
Configure memory banks and dispositions
Set up the Hindsight API server (Docker, Kubernetes, pip)
Integrate with Python/Node.js/Rust SDKs
Understand retrieval strategies (semantic, BM25, graph, temporal)
Debug issues or optimize performance
Review API endpoints and parameters
Find cookbook examples and recipes

当你需要以下操作时，可使用本Skill：

了解Hindsight的架构和核心概念
学习retain/recall/reflect操作
配置Memory Banks和Dispositions
搭建Hindsight API服务器（Docker、Kubernetes、pip方式）
与Python/Node.js/Rust SDKs集成
了解检索策略（semantic、BM25、graph、temporal）
调试问题或优化性能
查看API端点和参数
查找实用示例和使用指南

Documentation Structure

文档结构

All documentation is in

references/

organized by category:

references/
├── developer/
│   ├── api/          # Core operations: retain, recall, reflect, memory banks
│   └── *.md          # Architecture, configuration, deployment, performance
├── sdks/
│   ├── *.md          # Python, Node.js, CLI, embedded
│   └── integrations/ # LiteLLM, AI SDK, OpenClaw, MCP, skills
└── cookbook/
    ├── recipes/      # Usage patterns and examples
    └── applications/ # Full application demos

所有文档都按类别组织在

references/

目录下：

references/
├── developer/
│   ├── api/          # 核心操作：retain、recall、reflect、Memory Banks
│   └── *.md          # 架构、配置、部署、性能
├── sdks/
│   ├── *.md          # Python、Node.js、CLI、嵌入式
│   └── integrations/ # LiteLLM、AI SDK、OpenClaw、MCP、skills
└── cookbook/
    ├── recipes/      # 使用模式和示例
    └── applications/ # 完整应用演示

How to Find Documentation

如何查找文档

1. Find Files by Pattern (use Glob tool)

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

bash

undefined

bash

undefined

Core API operations

核心API操作

references/developer/api/*.md

SDK documentation

SDK文档

references/sdks/.md references/sdks/integrations/.md

Cookbook examples

实用示例

references/cookbook/recipes/.md references/cookbook/applications/.md

Find specific topics

查找特定主题

references//configuration.md references//python.md references/**/deployment.md

undefined

references//configuration.md references//python.md references/**/deployment.md

undefined

2. Search Content (use Grep tool)

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

bash

undefined

bash

undefined

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

pattern: "disposition" # Memory Bank配置 pattern: "graph retrieval" # 基于图的检索 pattern: "helm install" # Kubernetes部署 pattern: "document_id" # 文档管理 pattern: "HINDSIGHT_API_" # 环境变量

Search in specific areas

在特定区域搜索

path: references/developer/api/ pattern: "POST /v1" # Find API endpoints

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

undefined

path: references/developer/api/ pattern: "POST /v1" # 查找API端点

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

undefined

3. Read Full Documentation (use Read tool)

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

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

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

Key Concepts

核心概念

Memory Banks: Isolated memory stores (one per user/agent)
Retain: Store memories (auto-extracts facts/entities/relationships)
Recall: Retrieve memories (4 parallel strategies: semantic, BM25, graph, temporal)
Reflect: Disposition-aware reasoning using memories
document_id: Groups messages in a conversation (upsert on same ID)
Dispositions: Skepticism, literalism, empathy traits (1-5) affecting reflect
Mental Models: Consolidated knowledge synthesized from facts

Memory Banks：独立的内存存储（每个用户/Agent对应一个）
Retain：存储记忆（自动提取事实/实体/关系）
Recall：检索记忆（4种并行策略：semantic、BM25、graph、temporal）
Reflect：基于Dispositions的记忆推理
document_id：将对话中的消息分组（同一ID下执行更新插入操作）
Dispositions：怀疑、字面理解、共情等特质（1-5级），影响Reflect操作
Mental Models：从事实中整合而来的综合知识

Notes

注意事项

Code examples are inlined from working examples
Configuration uses
```
HINDSIGHT_API_*
```
environment variables
Database migrations run automatically on startup
Multi-bank queries require client-side orchestration
Use
```
document_id
```
for conversation evolution (same ID = upsert)

Auto-generated from

hindsight-docs/docs/

. Run

./scripts/generate-docs-skill.sh

to update.

代码示例均来自可运行的实际案例
配置使用
```
HINDSIGHT_API_*
```
环境变量
数据库迁移会在启动时自动运行
多Memory Bank查询需要客户端编排
使用
```
document_id
```
实现对话演进（同一ID = 更新插入）

自动生成自

hindsight-docs/docs/

。运行

./scripts/generate-docs-skill.sh

进行更新。