WebUI User Guide

Access URL

After starting the service, access the following URLs:

• 📱 Frontend Interface: http://localhost:8000
• 📊 Monitoring Dashboard: http://localhost:8000/monitor

---

1️⃣ File Management

1.1 File Upload and Preview

Steps

1. Access the frontend interface at http://localhost:8000
2. Click "File Management" in the left sidebar
3. Click the "Upload File" button
4. Based on the file type and file management configuration, files will be processed through different paths and generate previewable content

Supported File Types

• PDF/Word/MD: Document files
• Excel: Spreadsheet data files
• IMAGE: Image files (PNG/JPG, etc.)
• Database: Database files
• Supports 12+ file formats

Demo Examples

File Upload Example Automatically extract metadata and generate summaries	PDF File Preview After Processing Requires OCR configuration support
PNG File Preview After Processing Requires OCR configuration support	HiChunk Parse Preview Requires HiChunk configuration support

💡 Tip: For OCR and HiChunk configuration, refer to the Environment Variables Configuration Documentation

---

1.2 Batch File Management

Feature Description

When OCR and HiChunk configuration are enabled, the parsing stage of document upload will incur additional time consumption. It is recommended to use single file import for such files (batch import will result in longer waiting times).

Supported Batch Operations

• Batch Delete: Select multiple files for batch deletion
• Batch Upload: Upload multiple files at once (recommended for files of the same type)
• Batch Metadata Editing: Supports batch export, editing, and importing metadata
• File Search: Supports searching by file name, metadata, summary, etc.

Demo Examples

Batch File Delete and Upload Recommended to batch import files of the same type at once	Batch File Metadata Editing Supports batch export, editing, and importing	File Search Supports file name, metadata, summary, etc.

---

2️⃣ Knowledge Base Management

2.1 Knowledge Base Creation and Deletion

Steps

1. Access the frontend interface at http://localhost:8000
2. Click "Knowledge Base" in the left sidebar
3. Click the "Create Knowledge Base" button
4. Fill in the knowledge base name (e.g., Technical Documentation)
5. Click to confirm creation

Demo Examples

Knowledge Base Creation and Deletion Only supports single knowledge base operations	Knowledge Base Search Supports knowledge base name and description search

---

2.2 Knowledge Base Content Association and Vectorization

Steps

1. File Association: Associate uploaded files to the knowledge base
2. Database Association: Associate local databases to the knowledge base
3. Example Association: Associate example Q&A pairs to the knowledge base (as experience information)

💡 Important: After completing each association configuration, you need to click the "Save Association" button to save the association configuration and avoid losing previous selections

Association Types

• File Association: Supports associating multiple files simultaneously
• Database Association: Supports Sqlite and MySQL databases
• Example Association: Supports association of example Q&A pairs

Demo Examples

File Association Can select multiple files for association at once	Database Association Supports Sqlite and MySQL	Example Association Supports association of example Q&A pairs
Knowledge Base Configuration View View association and build configurations	Knowledge Base Vectorization Build Unified build of different types of associated content	Knowledge Base Association Editing Supports editing and updating associated content

---

3️⃣ Intelligent Conversations

3.1 Agent Selection and Usage

You can select configured Agents for conversations or Q&A for different tasks:

• Some Agents require selecting a knowledge base or file before use
• Provides a temporary file upload button, supports temporary file upload for Q&A, but the file will only be automatically associated with the current knowledge base and will not undergo vector construction

3.2 Memory Function

In the frontend conversation interface, turn on the "Memory" switch in the bottom right corner to enable the two-tier memory mechanism. After enabling memory, the Agent will have:

• Short-term Memory: Remembers conversation context to avoid repetitive questions
• Long-term Memory: Accumulates successful experiences and prioritizes reuse when encountering similar problems

3.3 Available Agent List

💬 Chat Agent

Features:

• Basic conversation Agent
• Recommended to enable "Memory" to support multi-turn conversations

---

🔍 Web Search Agent

Features:

• Supports web search
• Can access links to explore detailed content and answer

---

📚 KB Search Agent

Features:

• Must select a knowledge base
• Supports vector retrieval and reranking

---

📚 Meta Retrieval Agent

Features:

• Must select a knowledge base
• Supports vector retrieval and reranking
• Supports question intent parsing and metadata filtering

---

📄 File QA Agent

Features:

• Must select a knowledge base and a file
• Supports Python reading and processing file content
• Supports vector retrieval and reranking

---

📊 Excel Agent

Features:

• Must select a knowledge base and an Excel file
• Problem decomposition and data processing step decomposition
• Python code execution and reflection

---

💻 Text2SQL Agent

Features:

• Must select a knowledge base with associated database
• Problem decomposition and SQL code generation and execution
• SQL query result display and reflection

---

3.4 Memory Function Examples

🧠 Short-term and Long-term Memory

Features:

• Short-term memory: Effective within Session, used to support multi-turn conversations
• Long-term memory: Long-term effectiveness, used to accumulate successful experiences

---

🧐 Text2SQL Agent with Memory

Features:

• Short-term memory is effective within Session
• Long-term memory can avoid additional token consumption for similar problems

---

🎯 QA Learning

Features:

• Record QA examples
• Automatically learn Agent routing strategies

---

Related Documentation

• Environment Variables Configuration
• Quick Start Guide