From fa2072a720cda2eda5ac328c1a2175c7e075c81d Mon Sep 17 00:00:00 2001 From: Yiorgis Gozadinos Date: Mon, 26 Jan 2026 13:53:40 +0200 Subject: [PATCH] Docs --- CHANGELOG.md | 7 +++++++ docs/apps.md | 29 +++++++++++++++++++++-------- 2 files changed, 28 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 76f12654..e0d2cccd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,13 @@ - New `session_context` field on `ChatSessionState` synced via AG-UI state protocol - Chat TUI: New context modal (`Ctrl+O`) to view current session context - Planner can now return empty sub_questions when context is sufficient to answer directly +- **Session Document Filter**: Restrict all search/ask operations to selected documents + - New `document_filter` field on `ChatSessionState` stores list of document titles/URIs + - Session filter combines with per-tool `document_name` filter using AND logic + - Multi-document selection uses OR logic within the session filter + - Filter persists across tool calls and chat clears via AG-UI state protocol + - Chat TUI: Access via command palette ("Filter documents" command) + - Web Application: Filter button in header shows count of selected documents ### Changed diff --git a/docs/apps.md b/docs/apps.md index 296fb72b..3c5cf241 100644 --- a/docs/apps.md +++ b/docs/apps.md @@ -25,26 +25,39 @@ The chat interface provides: - Session memory for context-aware follow-up questions - Visual grounding to inspect chunk source locations -### Keyboard Shortcuts +### Command Palette -| Key | Action | -|-----|--------| -| `Ctrl+L` | Clear chat history and reset session | -| `Ctrl+G` | Show visual grounding for selected citation | -| `Ctrl+I` | Show database info (document/chunk counts) | -| `Escape` | Focus input field or cancel processing | +Press `Ctrl+P` to open the command palette: + +| Command | Description | +|---------|-------------| +| Filter documents | Select documents to restrict searches | +| Show context | View current session context | +| Show database info | View document/chunk counts and storage info | +| Visual grounding | View chunk source location in document | +| Clear chat | Clear chat history and reset session | ### Session Management - Conversation history is maintained in memory for the session - Previous Q/A pairs are used as context for follow-up questions - Citations are tracked per response and can be inspected -- Clearing chat (`Ctrl+L`) resets the session state +- Document filter restricts all searches to selected documents +- Clearing chat resets session state but preserves document filter ## Web Application Browser-based conversational RAG with a CopilotKit frontend. +### Features + +- Streaming chat with real-time tool execution visibility +- Expandable citations with source documents, pages, and headings +- Visual grounding to view chunk source locations in documents +- Document filter to restrict searches to selected documents +- Session context that summarizes conversation history +- Settings panel for background context configuration + ### Quick Start ```bash