hindsight-docs

Hindsight ドキュメントスキル

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

このスキルを使用する場面

次のような場合にこのスキルを使用してください：

• 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

主要な概念

• メモリバンク：分離されたメモリストア（ユーザー/エージェントごとに1つ）
• Retain：メモリを保存する（事実/エンティティ/関係を自動抽出）
• Recall：メモリを取得する（4つの並列戦略：セマンティック、BM25、グラフ、時間的）
• Reflect：メモリを用いたディスポジションを考慮した推論
• document_id：会話内のメッセージをグループ化する（同じ ID で upsert）
• ディスポジション：reflect に影響する懐疑心、文字通り解釈する傾向、共感の特性（1〜5）
• メンタルモデル：事実から統合された知識

注記

• コード例は動作する例からインライン展開されています
• 設定には HINDSIGHT_API_* 環境変数を使用します
• データベースマイグレーションは起動時に自動的に実行されます
• マルチバンクのクエリにはクライアント側でのオーケストレーションが必要です
• 会話の進化には document_id を使用してください（同じ ID = upsert）

---

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