hindsight-docs

Hindsight ドキュメントスキル

Hindsight の完全な技術ドキュメント。Hindsight は AI エージェント向けの生物模倣型メモリシステムです。

このスキルを使う場面

次のような場合に、このスキルを使ってください。

• 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/ # LiteLLM, AI SDK, OpenClaw, MCP, skills
└── cookbook/
    ├── recipes/      # Usage patterns and examples
    └── applications/ # Full application demos

ドキュメントの探し方

1. パターンでファイルを検索する（Glob ツールを使用）

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

# SDK documentation
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

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/cookbook/
pattern: "def |async def "    # Find Python examples

3. ドキュメント全体を読む（Read ツールを使用）

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

まず読む：ベストプラクティス

API ドキュメントを読む前に、ベストプラクティスガイドを読んでください。ミッション、タグ、コンテンツ形式、観測範囲、アンチパターンに関する実践的なルールを解説しており、正しく統合するための最短ルートです。

references/best-practices.md

主な概念

• メモリバンク：分離されたメモリストア（ユーザー／エージェントごとに 1 つ）
• Retain：メモリを保存します（事実／エンティティ／関係を自動抽出）
• Recall：メモリを取得します（4 つの並列戦略：セマンティック、BM25、グラフ、時間）
• Reflect：特性を考慮した、メモリを使った推論
• document_id：会話内のメッセージをグループ化します（同じ ID に対するアップサート）
• 特性：Reflect に影響する懐疑主義、字義主義、共感の特性（1～5）
• メンタルモデル：事実から統合された、集約済みの知識

注意事項

• コード例は、動作する例からインラインで取り込まれています
• 設定には HINDSIGHT_API_* 環境変数を使用します
• データベースのマイグレーションは起動時に自動実行されます
• 複数のバンクに対するクエリには、クライアント側でのオーケストレーションが必要です
• 会話の変化を管理するには document_id を使用します（同じ ID = アップサート）

---

hindsight-docs/docs/ から自動生成されています。更新するには ./scripts/generate-docs-skill.sh を実行してください。