You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-6Lines changed: 19 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,15 +40,25 @@ docker compose up -d --build
40
40
41
41
Docker rebuilds the image with the latest code while preserving your `data/` directory (database, config, history).
42
42
43
-
### Recommended Out-of-the-Box Setup (DashScope)
43
+
### Recommended Out-of-the-Box Setup
44
44
45
-
The project is highly optimized for [Alibaba Cloud DashScope (Bailian/阿里云百炼)](https://bailian.console.aliyun.com/). Go to **Settings** → **LLM Providers** → click **OneShot Setting (DashScope API)**, enter your API Key, and all services (LLM, Embedding, Reranker, STT) will automatically auto-configure with optimal defaults:
45
+
Two OneShot configuration paths are available:
46
+
47
+
**DashScope** (Alibaba Cloud): Go to **Settings** → **LLM Providers** → **OneShot Setting (DashScope API)**:
**OpenRouter**: Go to **Settings** → **LLM Providers** → **OneShot Setting (OpenRouter API)**. Enter your API Key; models are auto-fetched and classified:
@@ -58,8 +68,10 @@ The project is highly optimized for [Alibaba Cloud DashScope (Bailian/阿里云
58
68
***Full-Featured Markdown Workspace (Collection Notes)**: Create structured personal notes explicitly bound to specific operational contexts, featuring full WYSIWYG editing with markdown support (headings, tables, task lists, code blocks, images, YouTube embeds).
59
69
***Intelligent Note Distillation (Drag-to-Distill)**: Drag an existing old note or document into your current workspace, and the system automatically extracts the core insights into a dense citation block, seamlessly aggregating scattered ideas without manual rewriting.
60
70
***AI Image Ingestion**: One click prompts the AI to generate a precise contextual text description, weaving visual data into your markdown memory map for vector indexing. Supports image pasting, drag-and-drop, and resizing with inline captions.
61
-
***Audio Scribing & Tri-Fold Pipeline**: Upload recordings or record live meetings/lectures via WebSockets. Transcription (STT) can be handled via the embedded local engine or flexible external API endpoints. The system then generates a structured tri-fold artifact: *Summary* (semantic synthesis), *To-Do List/Action Items*, and *Detail* (deep-dive information extraction that filters conversational noise while preserving core intent).
71
+
***Audio Transcription & Multi-Phase Pipeline**: Upload recordings or record live meetings/lectures via WebSockets. Transcription (STT) can be handled by the embedded local FunASR engine or external APIs (DashScope, OpenRouter, etc.). After transcription, a multi-phase analysis runs: **Pass 1 — General Summary + Blueprint** (SSE streaming, builds section structure); **Pass 2 — Section Summary** (one-click custom sections, one keyword generates description and summary); **Pass 3 — Final Merge** producing Summary, To-Do List, and Detail artifacts.
62
72
***Hot Words**: Manage custom vocabulary libraries for domain-specific terminology to improve transcription accuracy.
73
+
***Quick Chat Panel**: A floating side panel in the Collection view for rapid Q&A via Direct RAG. Diamond button with animation, per-collection sessions, SSE streaming with thinking step display.
74
+
***Multi-turn Agentic Chat**: The main Chat supports multi-turn conversation with tool-calling Agent that autonomously decides whether, where, and how to search — exposing the full Agentic RAG capability through conversational interaction.
63
75
64
76
### 📥 02. Sink: Anti-Hoarding Ingestion Pipeline
65
77
@@ -70,13 +82,14 @@ The project is highly optimized for [Alibaba Cloud DashScope (Bailian/阿里云
70
82
***Granular Document Parsing & Chunking**: Utilizes the natively embedded parsing engine (supporting 12 format parsers) or links to powerful cloud parsing APIs (e.g., *MinerU*). Supports advanced **Parent-Child chunking** by headings, paragraphs, and max token configurations while keeping word boundaries intact.
71
83
***Context Enrichment Engine**: When enabled, an LLM evaluates each split chunk and injects its missing global context, mitigating the "chunk isolation" effect during retrieval.
72
84
***Auto-Summarization & Consolidation**: Every document gets a structured summary. Collections get consolidated overviews with automatic conflict detection when documents contradict each other.
85
+
***Auto-Updating Collection Coverage**: Collection-level coverage maps update automatically after each ingestion, comparing new and existing documents to keep retrieval context aligned with the latest knowledge boundaries.
**Educe** implements a cutting-edge retrieval architecture to turn cold data into active intelligence.
77
90
78
91
***Advanced Hybrid Retrieval**: Supports dense vector similarity search, keyword-semantic hybrid querying (BM25 + Dense via Qdrant), and advanced **Reranking** algorithms to surface top-tier context.
79
-
***Iterative Agentic RAG Pipeline**: Moves far beyond naïve single-shot semantic search. Sinkduce orchestrates a multi-step Agentic loop: *Analyze → Route → Retrieve → Grade → Decompose → Rerank → Synthesize* until it locks onto the exact underlying truth.
92
+
***Agentic RAG Pipeline**: Complex queries are decomposed into atomic sub-queries, routed to multiple Collections in parallel, each executing a Variant loop (Rewrite + Grade), then aggregated and synthesized. Full event stream observability (`decompose → variant_generation → scoring → synthesize_merge`).
80
93
***Multi-Collection Federated Search**: Context isolation does not limit high-dimensional synthesis. Users can choreograph inquiries spanning multiple explicit Collections simultaneously, harmonizing cross-domain shards via top-level reasoning.
81
94
***Absolute Source Traceability (3-Layer Traceability)**: Build bulletproof trust in AI answers by drilling straight to the raw text. Instantly inspect the source lineage across three deep-dive levels: the specific *Vector Chunk*, the *Full-Text Context*, or the *Original Source File*.
82
95
***Recall Evaluation**: Built-in benchmarking with adjustable parameters to evaluate retrieval recall and precision.
@@ -145,7 +158,7 @@ The MCP server uses **stdio** transport — Claude Code launches it as a subproc
0 commit comments