fleet-memory/hindsight-docs/sidebars.ts
DK09876 b4320254b2
feat: add LangGraph integration (#610)
* feat: add LangGraph integration with tools, nodes, and store patterns

Add hindsight-langgraph SDK providing three integration patterns:
- Tools: retain/recall/reflect as LangChain tools for ReAct agents
- Nodes: automatic memory injection and storage as graph steps
- Store: LangGraph BaseStore implementation for checkpoint-based memory

Fix: remove `from __future__ import annotations` in nodes.py which
prevented LangGraph from passing RunnableConfig to node functions
(runtime type inspection saw string annotations instead of actual types).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* chore: register langgraph with independent versioning system

- Set version to 0.1.0 (integrations are versioned independently)
- Add langgraph to VALID_INTEGRATIONS in release-integration.sh
- Add changelog page for langgraph integration

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* chore: remove manual cookbook recipe page

The sync-cookbook script will auto-generate this from the notebook
in hindsight-cookbook once PR #17 is merged.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: comprehensive improvements to langgraph integration

Code fixes:
- Retain node only stores latest messages instead of all history (prevents duplicates)
- Handle multimodal msg.content (list type) in nodes
- Fix store docstring separator "/" → "."
- Apply search filters before pagination in store
- Add ttl parameter to store.aput for LangGraph BaseStore compat
- Fix _ensure_bank to not cache failed bank creations
- Fix falsy value bugs (or → is not None) in tools
- Remove from __future__ import annotations from all files
- Consistent default budget="mid" across tools/nodes/store
- Bump langgraph floor to >=0.3.0, remove duplicate dev deps

Docs fixes:
- Fix broken Cloud client example (base_url is required)
- Complete API reference tables with all parameters
- Add Limitations and Notes section (async-only store, etc.)
- Add Requirements section
- Fix broken cookbook link and Cloud claim in blog post

All 61 unit tests pass. E2E tested against Hindsight Cloud:
tools, nodes, store, configure(), multimodal content.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* chore: remove blog post (lives in hindsight-marketing-content)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* chore: remove Hindsight Cloud section from langgraph docs

Keep OSS docs self-hosted-first, consistent with other integration
docs (crewai, pydantic-ai, agno). Cloud setup details live in the
cookbook notebooks.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: explicitly mention LangChain compatibility in langgraph integration

The tools pattern (create_hindsight_tools) only depends on
langchain-core and works with plain LangChain via bind_tools() —
no LangGraph required. Update docs to make this clear with both
LangGraph and LangChain quick start examples.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: address PR review findings

1. Guard manual test files with if __name__ == "__main__" so pytest
   doesn't collect and execute them during test runs
2. Remove semantic fallback in HindsightStore.aget() — only return
   exact document_id matches, not unrelated semantic search hits
3. Make langgraph an optional dependency — tools pattern only needs
   langchain-core. Install with pip install hindsight-langgraph[langgraph]
   for nodes and store patterns. Lazy imports with clear error messages.
4. Clean up README to be self-hosted-first, consistent with other
   integration docs
5. Update docs requirements section to reflect optional langgraph dep

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: address PR review feedback for langgraph integration

- Fix #2: Add per-bank asyncio.Lock to _ensure_bank for concurrency safety
- Fix #3: Clamp search score to max(0.0, ...) to prevent negative values
- Fix #4: Implement suffix matching in _handle_list_namespaces
- Fix #5: Truncate namespaces to max_depth instead of filtering (per BaseStore contract)
- Fix #6: Remove list_namespaces/alist_namespaces overrides — let base class handle prefix=/suffix= kwargs
- Fix #7: Document ephemeral namespace tracking and get() limitations in class docstring
- Fix #8: Add stable ID to recall node SystemMessage, document ordering behavior
- Fix #9: Change budget/max_tokens/recall_tags_match defaults to None so global config fallback works
- Fix #10: Conditionally populate __all__ so import * works without langgraph installed
- Fix #11: Bump langgraph lower bound from >=0.3.0 to >=0.5.0
- Fix #12: Extract _resolve_client to shared _client.py module

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: address remaining review gaps for langgraph integration

- Add output_key parameter to create_recall_node for prompt ordering control
- Add prefix/suffix/combined filter tests for list_namespaces
- Add output_key unit tests (memory text, none on empty, none on error)
- Remove unused imports and backward-compat alias in tools.py
- Update docs with output_key usage example and API reference

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: relax langgraph version constraint to >=0.3.0

Research confirmed all required APIs (BaseStore, SearchItem, Result,
GetOp, PutOp, SearchOp, ListNamespacesOp) are available since
langgraph-checkpoint 2.0.7, which maps to langgraph >=0.2.63.
Using >=0.3.0 as a clean semver boundary — >=0.5.0 was unnecessarily
conservative and excluded many compatible versions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-20 13:36:57 +01:00

375 lines
9.8 KiB
TypeScript

import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
const sidebars: SidebarsConfig = {
developerSidebar: [
{
type: 'category',
label: 'Architecture',
collapsible: false,
items: [
{
type: 'doc',
id: 'developer/index',
label: 'Overview',
customProps: { icon: 'lu-book' },
},
{
type: 'doc',
id: 'developer/retain',
label: 'Retain',
customProps: { icon: 'lu-brain' },
},
{
type: 'doc',
id: 'developer/retrieval',
label: 'Recall',
customProps: { icon: 'lu-search' },
},
{
type: 'doc',
id: 'developer/reflect',
label: 'Reflect',
customProps: { icon: 'lu-message' },
},
{
type: 'doc',
id: 'developer/observations',
label: 'Observations',
customProps: { icon: 'lu-activity' },
},
{
type: 'doc',
id: 'developer/multilingual',
label: 'Multilingual',
customProps: { icon: 'lu-languages' },
},
{
type: 'doc',
id: 'developer/performance',
label: 'Performance',
customProps: { icon: 'lu-zap' },
},
{
type: 'doc',
id: 'developer/storage',
label: 'Storage',
customProps: { icon: 'lu-database' },
},
{
type: 'doc',
id: 'developer/rag-vs-hindsight',
label: 'RAG vs Memory',
customProps: { icon: 'lu-compare' },
},
],
},
{
type: 'category',
label: 'API',
collapsible: false,
items: [
{
type: 'doc',
id: 'developer/api/quickstart',
label: 'Quick Start',
customProps: { icon: 'lu-rocket' },
},
{
type: 'doc',
id: 'developer/api/retain',
label: 'Retain',
customProps: { icon: 'lu-brain' },
},
{
type: 'doc',
id: 'developer/api/recall',
label: 'Recall',
customProps: { icon: 'lu-search' },
},
{
type: 'doc',
id: 'developer/api/reflect',
label: 'Reflect',
customProps: { icon: 'lu-message' },
},
{
type: 'doc',
id: 'developer/api/mental-models',
label: 'Mental Models',
customProps: { icon: 'lu-layers' },
},
{
type: 'doc',
id: 'developer/api/memory-banks',
label: 'Memory Banks',
customProps: { icon: 'lu-memory' },
},
{
type: 'doc',
id: 'developer/api/documents',
label: 'Documents',
customProps: { icon: 'lu-file' },
},
{
type: 'doc',
id: 'developer/api/operations',
label: 'Operations',
customProps: { icon: 'lu-cpu' },
},
{
type: 'doc',
id: 'developer/api/webhooks',
label: 'Webhooks',
customProps: { icon: 'lu-webhook' },
},
{
type: 'link',
href: '/api-reference',
label: 'API Reference',
customProps: { icon: 'lu-book-open', iconAfter: 'lu-arrow-up-right' },
},
],
},
{
type: 'category',
label: 'Clients',
collapsible: false,
items: [
{
type: 'doc',
id: 'sdks/python',
label: 'Python',
customProps: { icon: 'si-python' },
},
{
type: 'doc',
id: 'sdks/nodejs',
label: 'TypeScript',
customProps: { icon: '/img/icons/typescript.png' },
},
{
type: 'doc',
id: 'sdks/go',
label: 'Go',
customProps: { icon: 'si-go' },
},
{
type: 'doc',
id: 'sdks/cli',
label: 'CLI',
customProps: { icon: 'lu-terminal' },
},
{
type: 'doc',
id: 'sdks/embed',
label: 'Embedded Python',
customProps: { icon: '/img/icons/package.svg' },
},
],
},
{
type: 'category',
label: 'Integrations',
collapsible: false,
items: [
{
type: 'doc',
id: 'sdks/integrations/local-mcp',
label: 'Local MCP Server',
customProps: { icon: '/img/icons/mcp.png' },
},
{
type: 'doc',
id: 'sdks/integrations/litellm',
label: 'LiteLLM',
customProps: { icon: '/img/icons/litellm.png' },
},
{
type: 'doc',
id: 'sdks/integrations/openclaw',
label: 'OpenClaw',
customProps: { icon: '/img/icons/openclaw.png' },
},
{
type: 'doc',
id: 'sdks/integrations/ai-sdk',
label: 'Vercel AI SDK',
customProps: { icon: '/img/icons/vercel.png' },
},
{
type: 'doc',
id: 'sdks/integrations/chat',
label: 'Vercel Chat SDK',
customProps: { icon: '/img/icons/vercel.png' },
},
{
type: 'doc',
id: 'sdks/integrations/crewai',
label: 'CrewAI',
customProps: { icon: '/img/icons/crewai.png' },
},
{
type: 'doc',
id: 'sdks/integrations/pydantic-ai',
label: 'Pydantic AI',
customProps: { icon: '/img/icons/pydanticai.png' },
},
{
type: 'doc',
id: 'sdks/integrations/agno',
label: 'Agno',
customProps: { icon: '/img/icons/agno.png' },
},
{
type: 'doc',
id: 'sdks/integrations/hermes',
label: 'Hermes Agent',
customProps: { icon: '/img/icons/hermes.png' },
},
{
type: 'doc',
id: 'sdks/integrations/langgraph',
label: 'LangGraph / LangChain',
customProps: { icon: '/img/icons/langgraph.png' },
},
{
type: 'doc',
id: 'sdks/integrations/skills',
label: 'Skills',
customProps: { icon: '/img/icons/skills.png' },
},
],
},
{
type: 'category',
label: 'Hosting',
collapsible: false,
items: [
{
type: 'link',
href: 'https://ui.hindsight.vectorize.io/signup',
label: 'Cloud',
customProps: { icon: 'lu-cloud', iconAfter: 'lu-arrow-up-right' },
},
{
type: 'doc',
id: 'developer/installation',
label: 'Installation',
customProps: { icon: 'lu-package' },
},
{
type: 'doc',
id: 'developer/services',
label: 'Services',
customProps: { icon: 'lu-server' },
},
{
type: 'doc',
id: 'developer/configuration',
label: 'Configuration',
customProps: { icon: 'lu-settings' },
},
{
type: 'doc',
id: 'developer/admin-cli',
label: 'Admin CLI',
customProps: { icon: 'lu-terminal' },
},
{
type: 'doc',
id: 'developer/extensions',
label: 'Extensions',
customProps: { icon: 'lu-plug' },
},
{
type: 'doc',
id: 'developer/models',
label: 'Models',
customProps: { icon: 'lu-cpu' },
},
{
type: 'doc',
id: 'developer/monitoring',
label: 'Monitoring',
customProps: { icon: 'lu-activity' },
},
{
type: 'doc',
id: 'developer/mcp-server',
label: 'MCP Server',
customProps: { icon: 'lu-network' },
},
],
},
{
type: 'category',
label: 'Resources',
collapsible: false,
items: [
{
type: 'link',
href: '/best-practices',
label: 'Best Practices',
customProps: { icon: 'lu-star', iconAfter: 'lu-arrow-up-right' },
},
{
type: 'link',
href: '/faq',
label: 'FAQ',
customProps: { icon: 'lu-circle-help', iconAfter: 'lu-arrow-up-right' },
},
],
},
{
type: 'category',
label: 'More',
collapsible: false,
items: [
{
type: 'link',
href: '/cookbook',
label: 'Cookbook',
customProps: { icon: 'lu-book', iconAfter: 'lu-arrow-up-right' },
},
{
type: 'link',
href: '/blog',
label: 'Blog',
customProps: { icon: 'lu-rss', iconAfter: 'lu-arrow-up-right' },
},
{
type: 'link',
href: 'https://join.slack.com/t/hindsight-space/shared_invite/zt-3nhbm4w29-LeSJ5Ixi6j8PdiYOCPlOgg',
label: 'Community',
customProps: { icon: 'si-slack', iconAfter: 'lu-arrow-up-right' },
},
{
type: 'link',
href: 'https://github.com/vectorize-io/hindsight',
label: 'GitHub',
customProps: { icon: 'si-github', iconAfter: 'lu-arrow-up-right' },
},
{
type: 'link',
href: 'https://benchmarks.hindsight.vectorize.io/',
label: 'Benchmarks',
customProps: { icon: 'lu-chart-bar', iconAfter: 'lu-arrow-up-right' },
},
{
type: 'link',
href: 'https://benchmarks.hindsight.vectorize.io/',
label: 'Which Model Should I Use?',
customProps: { icon: 'lu-cpu', iconAfter: 'lu-arrow-up-right' },
},
{
type: 'link',
href: 'https://arxiv.org/abs/2512.12818',
label: 'Paper',
customProps: { icon: 'lu-file-text', iconAfter: 'lu-arrow-up-right' },
},
],
},
],
};
export default sidebars;