gigaspaces/erag-ui

eRAG UI 镜像文档

概述

eRAG UI是一个专为增强型检索增强生成（eRAG）系统设计的用户界面镜像，旨在提供直观、高效的交互平台，简化RAG应用的构建与使用流程。该镜像基于现代前端技术构建，可与后端eRAG服务无缝集成，支持从文档管理、检索配置到内容生成的全流程可视化操作，适用于各类需要检索增强生成能力的场景。

核心功能与特性

1. 文档管理与知识库构建

• 支持多格式文档（PDF、TXT、Markdown、DOCX等）上传与批量导入
• 文档自动解析与分块处理，支持自定义分块策略配置
• 知识库分类管理，支持多知识库创建与切换

2. 检索与生成交互

• 提供自然语言检索界面，支持关键词检索、语义检索及混合检索模式
• 实时生成响应展示，支持流式输出与格式化结果（表格、列表等）
• 检索结果相关性排序与来源标注，支持查看原文片段

3. 系统配置与管理

• 可视化配置检索参数（如相似度阈值、返回结果数量等）
• 支持模型参数调整（如生成温度、最大 tokens 等）
• 集成日志查看与操作审计功能

4. 多端适配与用户体验

• 响应式设计，适配桌面端与平板设备
• 对话历史记录与上下文管理，支持会话保存与加载
• 简洁直观的操作界面，降低使用门槛

使用场景与适用范围

企业级知识库问答

• 构建企业内部知识库交互界面，支持员工快速检索公司文档、政策、流程等信息
• 适用于HR政策查询、IT运维文档检索、财务制度问答等场景

智能文档处理平台

• 作为文档处理系统前端，支持用户上传文档并通过eRAG能力提取关键信息、生成摘要或分析报告
• 适用于***文档审查、学术论文分析、合同条款提取等场景

客服与用户支持系统

• 集成到客服系统中，提供智能问答界面，辅助客服人员快速检索产品信息、解决用户问题
• 支持自定义知识库更新，确保问答内容时效性

个人学习与研究助手

• 作为个人知识管理工具，帮助用户整理学习资料、生成学习笔记、解答专业问题
• 支持导入学术文献、技术文档，构建个性化学习知识库

使用方法与配置说明

基本使用（Docker Run）

通过以下命令快速启动eRAG UI容器：

bash
docker run -d \
  --name erag-ui \
  -p 8080:80 \  # 映射容器80端口到主机8080端口
  -v ./erag-data:/app/data \  # 持久化存储数据（如知识库、历史记录等）
  -e ERAG_BACKEND_URL="http://backend:5000" \  # 配置后端eRAG服务地址
  erag-ui:latest

启动后，通过浏览器访问 http://localhost:8080 即可打开eRAG UI界面。

环境变量配置

eRAG UI支持通过环境变量自定义配置，常用参数如下：

示例（带认证配置）：

bash
docker run -d \
  --name erag-ui \
  -p 8080:80 \
  -v ./erag-data:/app/data \
  -e ERAG_BACKEND_URL="http://erag-backend:5000" \
  -e AUTH_ENABLED="true" \
  -e AUTH_TOKEN="your-secure-token" \
  erag-ui:latest

持久化存储

为确保知识库数据、对话历史等信息不丢失，建议通过 -v 参数挂载本地目录到容器内 /app/data 路径：

bash
# 创建本地数据目录
mkdir -p ./erag-data

# 启动容器并挂载目录
docker run -d \
  --name erag-ui \
  -p 8080:80 \
  -v $(pwd)/erag-data:/app/data \  # 挂载当前目录下的erag-data到容器内
  erag-ui:latest

Docker Compose 配置示例

对于需要与eRAG后端服务协同部署的场景，可使用 docker-compose.yml 配置：

yaml
version: '3.8'

services:
  erag-ui:
    image: erag-ui:latest
    container_name: erag-ui
    ports:
      - "8080:80"
    volumes:
      - ./erag-ui-data:/app/data
    environment:
      - ERAG_BACKEND_URL="http://erag-backend:5000"
      - LOG_LEVEL="info"
    depends_on:
      - erag-backend

  erag-backend:
    image: erag-backend:latest  # 假设存在eRAG后端镜像
    container_name: erag-backend
    ports:
      - "5000:5000"
    volumes:
      - ./erag-backend-data:/app/data

通过 docker-compose up -d 启动整个eRAG系统（需确保后端服务镜像可用）。

注意事项

1. 后端服务依赖：eRAG UI需与eRAG后端服务配合使用，启动前需确保后端服务已部署并可访问，通过 ERAG_BACKEND_URL 环境变量指定后端地址。
2. 端口冲突：若主机8080端口已被占用，可修改 -p 参数中的主机端口（如 -p 8081:80）。
3. 数据安全：启用认证（AUTH_ENABLED=true）时，建议使用强令牌并定期更新，避免未授权访问。
4. 资源需求：根据并发用户数调整容器资源限制（如 --memory=2g --cpus=1），确保界面响应流畅。