Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,12 @@ REDIS_RETRY_DELAY=100 # Retry delay in ms
# - Memory storage: Fast access, no persistence between restarts
# - Redis storage: Persistent storage, survives restarts, supports clustering

# =============================================================================
# HIPPOCAMPUS MEMORY ENGINE (Embedded SDK)
# =============================================================================
# HC_CONDENSATION_PROMPT= # Custom condensation prompt (placeholders: {{OLD_MEMORY}}, {{NEW_CONTENT}}, {{MAX_WORDS}})
# HC_LOG_LEVEL=warn # Memory SDK log level (debug, info, warn, error)

# =============================================================================
# ANTHROPIC CLAUDE CONFIGURATION
# =============================================================================
Expand Down
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Extracted from production systems at Juspay and battle-tested at enterprise scal

| Feature | Version | Description | Guide |
| ----------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| **Memory** | v9.12.0 | Per-user condensed memory that persists across conversations. LLM-powered condensation with S3, Redis, or SQLite backends. | [Memory Guide](docs/features/memory.md) |
| **Context Window Management** | v9.2.0 | 4-stage compaction pipeline with auto-detection, budget gate at 80% usage, per-provider token estimation | [Context Compaction Guide](docs/features/context-compaction.md) |
| **Tool Execution Control** | v9.3.0 | `prepareStep` and `toolChoice` support for per-step tool enforcement in multi-step agentic loops. API-level control over tool calls. | [API Reference](docs/api/type-aliases/GenerateOptions.md#preparestep) |
| **File Processor System** | v9.1.0 | 17+ file type processors with ProcessorRegistry, security sanitization, SVG text injection | [File Processors Guide](docs/features/file-processors.md) |
Expand All @@ -48,6 +49,7 @@ Extracted from production systems at Juspay and battle-tested at enterprise scal
| **Image Generation with Gemini** | v8.31.0 | Native image generation using Gemini 2.0 Flash Experimental (`imagen-3.0-generate-002`). High-quality image synthesis directly from Google AI. | [Image Generation Guide](docs/image-generation-streaming.md) |
| **HTTP/Streamable HTTP Transport** | v8.29.0 | Connect to remote MCP servers via HTTP with authentication headers, automatic retry with exponential backoff, and configurable rate limiting. | [HTTP Transport Guide](docs/mcp-http-transport.md) |

- **Memory** – Per-user condensed memory that persists across all conversations. Automatically retrieves and stores memory on each `generate()`/`stream()` call. Supports S3, Redis, and SQLite storage with LLM-powered condensation. → [Memory Guide](docs/features/memory.md)
- **External TracerProvider Support** – Integrate NeuroLink with applications that already have OpenTelemetry instrumentation. Supports auto-detection and manual configuration. → [Observability Guide](docs/features/observability.md)
- **Server Adapters** – Deploy NeuroLink as an HTTP API server with your framework of choice (Hono, Express, Fastify, Koa). Full CLI support with `serve` and `server` commands for foreground/background modes, route management, and OpenAPI generation. → [Server Adapters Guide](docs/guides/server-adapters/index.md)
- **Title Generation Events** – Emit real-time events when conversation titles are auto-generated. Listen to `conversation:titleGenerated` for session tracking. → [Conversation Memory Guide](docs/conversation-memory.md#title-generation-events)
Expand Down Expand Up @@ -240,7 +242,7 @@ const result = await neurolink.generate({
| --------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------- |
| **Auto Provider Selection** | Intelligent provider fallback | [SDK Guide](docs/sdk/index.md#auto-selection) |
| **Streaming Responses** | Real-time token streaming | [Streaming Guide](docs/advanced/streaming.md) |
| **Conversation Memory** | Automatic context management | [Memory Guide](docs/sdk/index.md#memory) |
| **Conversation Memory** | Automatic context management with embedded per-user memory | [Memory Guide](docs/sdk/index.md#memory) |
| **Full Type Safety** | Complete TypeScript types | [Type Reference](docs/sdk/api-reference.md) |
| **Error Handling** | Graceful provider fallback | [Error Guide](docs/reference/troubleshooting.md) |
| **Analytics & Evaluation** | Usage tracking, quality scores | [Analytics Guide](docs/advanced/analytics.md) |
Expand Down Expand Up @@ -297,16 +299,17 @@ const result = await neurolink.generate({

**Production-ready capabilities for regulated industries:**

| Feature | Description | Use Case | Documentation |
| --------------------------- | ---------------------------------- | ------------------------- | ----------------------------------------------------------- |
| **Enterprise Proxy** | Corporate proxy support | Behind firewalls | [Proxy Setup](docs/enterprise-proxy-setup.md) |
| **Redis Memory** | Distributed conversation state | Multi-instance deployment | [Redis Guide](docs/getting-started/provider-setup.md#redis) |
| **Cost Optimization** | Automatic cheapest model selection | Budget control | [Cost Guide](docs/advanced/index.md) |
| **Multi-Provider Failover** | Automatic provider switching | High availability | [Failover Guide](docs/advanced/index.md) |
| **Telemetry & Monitoring** | OpenTelemetry integration | Observability | [Telemetry Guide](docs/telemetry-guide.md) |
| **Security Hardening** | Credential management, auditing | Compliance | [Security Guide](docs/advanced/enterprise.md) |
| **Custom Model Hosting** | SageMaker integration | Private models | [SageMaker Guide](docs/sagemaker-integration.md) |
| **Load Balancing** | LiteLLM proxy integration | Scale & routing | [Load Balancing](docs/litellm-integration.md) |
| Feature | Description | Use Case | Documentation |
| --------------------------- | ------------------------------------------- | ------------------------- | ----------------------------------------------------------- |
| **Enterprise Proxy** | Corporate proxy support | Behind firewalls | [Proxy Setup](docs/enterprise-proxy-setup.md) |
| **Redis Memory** | Distributed conversation state | Multi-instance deployment | [Redis Guide](docs/getting-started/provider-setup.md#redis) |
| **Memory** | Per-user condensed memory (S3/Redis/SQLite) | Long-term user context | [Memory Guide](docs/features/memory.md) |
| **Cost Optimization** | Automatic cheapest model selection | Budget control | [Cost Guide](docs/advanced/index.md) |
| **Multi-Provider Failover** | Automatic provider switching | High availability | [Failover Guide](docs/advanced/index.md) |
| **Telemetry & Monitoring** | OpenTelemetry integration | Observability | [Telemetry Guide](docs/telemetry-guide.md) |
| **Security Hardening** | Credential management, auditing | Compliance | [Security Guide](docs/advanced/enterprise.md) |
| **Custom Model Hosting** | SageMaker integration | Private models | [SageMaker Guide](docs/sagemaker-integration.md) |
| **Load Balancing** | LiteLLM proxy integration | Scale & routing | [Load Balancing](docs/litellm-integration.md) |

**Security & Compliance:**

Expand Down
5 changes: 5 additions & 0 deletions docs-site/scripts/sync-docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ const FILE_MAPPINGS: Record<string, string> = {
"conversation-memory.md": "memory/conversation.md",
"context-summarization.md": "memory/summarization.md",
"mem0-integration.md": "memory/mem0.md",
"features/memory.md": "features/memory.md",

// Workflow docs -> workflows/
"advanced-orchestration.md": "workflows/orchestration.md",
Expand Down Expand Up @@ -943,6 +944,10 @@ const LINK_MAPPINGS: Record<string, string> = {
"session-management-guide": "/guides/session-management",

// Features - absolute paths often used
memory: "/features/memory",
"memory.md": "/features/memory",
"features/memory": "/features/memory",
"features/memory.md": "/features/memory",
guardrails: "/features/guardrails",
hitl: "/features/hitl",
multimodal: "/features/multimodal",
Expand Down
1 change: 1 addition & 0 deletions docs-site/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ const sidebars: SidebarsConfig = {
"features/file-processors",
"features/mcp-tools-showcase",
"features/rag",
"features/memory",
],
},
{
Expand Down
4 changes: 3 additions & 1 deletion docs/features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Comprehensive guides for all NeuroLink features organized by category. Each guid
| :material-server: **[Server Adapters](../guides/server-adapters/index.md)** | Expose NeuroLink AI agents as HTTP APIs with Hono, Express, Fastify, and Koa. Production-ready with auth, rate limiting, and streaming. |
| :material-database-search: **[RAG Document Processing](rag.md)** | Comprehensive document chunking (10 strategies), hybrid search (BM25 + vector), and reranking (5 types) for retrieval-augmented generation. |
| :material-compress-arrows: **[Context Compaction](context-compaction.md)** | 4-stage context compaction pipeline with automatic budget management, per-provider token estimation, and non-destructive message tagging. |
| :material-brain: **[Memory](memory.md)** | Per-user condensed memory that persists across conversations. LLM-powered condensation with S3, Redis, or SQLite storage backends. |

**Q1 2026 Highlights:**

Expand Down Expand Up @@ -72,7 +73,7 @@ Comprehensive guides for all NeuroLink features organized by category. Each guid
| **Provider unification** | 12+ providers with automatic failover, cost-aware routing, provider orchestration (Q3) | [Provider Setup](../getting-started/provider-setup.md) |
| **Multimodal pipeline** | Stream images + CSV data + PDF documents + Office files across providers with auto-detection for mixed file types. | [Multimodal Guide](multimodal-chat.md), [CSV Support](csv-support.md), [PDF Support](pdf-support.md), [Office Docs](office-documents.md) |
| **Quality & governance** | Auto-evaluation engine (Q3), guardrails middleware (Q4), HITL workflows (Q4), audit logging | [Auto Evaluation](auto-evaluation.md), [Guardrails](guardrails.md), [HITL](hitl.md) |
| **Memory & context** | Conversation memory, Mem0 integration, Redis history export (Q4), context summarization (Q4) | [Conversation Memory](../conversation-memory.md), [Redis Export](conversation-history.md) |
| **Memory & context** | Conversation memory, per-user memory, Mem0 integration, Redis history export (Q4), context summarization (Q4) | [Conversation Memory](../conversation-memory.md), [Memory](memory.md), [Redis Export](conversation-history.md) |
| **CLI tooling** | Loop sessions (Q3), setup wizard, config validation, Redis auto-detect, JSON output | [CLI Loop](cli-loop-sessions.md), [CLI Commands](../cli/commands.md) |
| **Enterprise ops** | Proxy support, regional routing (Q3), telemetry hooks, configuration management | [Enterprise Proxy](../enterprise-proxy-setup.md), [Observability](observability.md) |
| **Tool ecosystem** | MCP auto discovery, LiteLLM hub access, SageMaker custom deployment, web search | [MCP Integration](../advanced/mcp-integration.md), [MCP Catalog](../guides/mcp/server-catalog.md) |
Expand Down Expand Up @@ -524,6 +525,7 @@ Production-grade fault tolerance:
| :material-server-network: **[LiteLLM Integration](../litellm-integration.md)** | Access 100+ models from all major providers via LiteLLM routing with unified interface. |
| :material-aws: **[SageMaker Integration](../sagemaker-integration.md)** | Deploy and call custom endpoints directly from NeuroLink CLI/SDK with full control. |
| :material-brain-circuit: **[Mem0 Integration](../mem0-integration.md)** | Persistent semantic memory with vector store support for long-term conversations. |
| :material-brain: **[Memory](memory.md)** | Per-user condensed memory with S3/Redis/SQLite storage and LLM-powered condensation. |
| :material-shield-lock: **[Enterprise Proxy](../enterprise-proxy-setup.md)** | Configure outbound policies and compliance posture for corporate environments. |
| :material-cog: **[Configuration Management](../configuration-management.md)** | Manage environments, regions, and credentials safely across deployments. |

Expand Down
Loading
Loading