BBC-Esq/VectorDB-Plugin

VectorDB‑Plugin – Windows 平台的检索增强生成 GUI

功能概述

• 支持摄入多种常见文件类型（文档、图像、音频），提取内容并进行向量化，随后将嵌入存储在本地向量数据库中。
• 提供简洁的图形界面，用户可以通过输入或语音提问，系统会自动检索最相关的片段，并将其提供给 LLM 以生成上下文相关的回答。
• 支持本地 LLM 后端（KoboldCPP, LM Studio）以及远程 ChatGPT，并可通过 TTS 将答案朗读出来。

核心特性

• 广泛的摄入能力：支持 PDF、DOCX、TXT、HTML、CSV、Excel、RTF、电子邮件格式，以及 PNG/JPG/GIF/TIFF 图像和 MP3/WAV 等音频文件。
• 自动处理：为图像生成 OCR 风格的描述，为音频进行语音转文字转录，并提取文档的纯文本。
• 本地向量存储：所有嵌入均保存在磁盘上，无需外部服务即可实现快速相似度搜索。
• RAG 工作流：查询 → 检索 → 生成 → 可选的 TTS，全程通过 GUI 编排。
• GPU 加速（可选）：自动检测 NVIDIA GPU 并安装支持 GPU 的模型；否则将回退到仅使用 CPU 的小型模型配置。
• 仅限 Windows：针对 Windows 打包并提供一键安装脚本；欢迎提交 PR 以支持其他平台。

系统要求

要求	详情
操作系统	Microsoft Windows（唯一官方支持的平台）
Python	3.11 – 3.14
构建工具	Visual C++ Build Tools（用于编译原生依赖项）
GPU（可选）	NVIDIA GTX 16 系列 / RTX 20 系列或更新版本，驱动程序 580+ 以实现加速
Git & Git‑LFS	克隆仓库并获取大型模型文件所需

安装步骤

1. 下载最新的发布版 ZIP 并解压。
2. 在 src 文件夹内打开 PowerShell 提示符。
3. 创建并激活虚拟环境：

   python -m venv .
   .\Scripts\activate
   

4. 运行 Windows 专用安装脚本（它将自动检测 GPU 并安装相应的模型二进制文件）：

   python setup_windows.py
   

   添加 --force‑cpu 以强制进行仅 CPU 安装。
5. 启动 GUI：

   python gui.py
   

使用方法

• 通过 Ingest 选项卡摄入文件 – 选择任何支持的文档、图像或音频文件。
• 应用程序会提取文本、生成图像说明或转录音频，然后对生成的片段进行嵌入并存储。
• 打开 Ask Jeeves 菜单（或主查询面板），输入或录制问题。
• 系统检索最相关的片段，将其发送给选定的 LLM，并显示答案。启用 TTS 开关即可收听回复。

支持与贡献

• 错误报告、功能请求和一般反馈通过 GitHub issues 处理。
• 可通过电子邮件 (bbc@chintellalaw.com) 或 KoboldAI Discord (用户名 vic49) 联系作者。
• 欢迎通过 pull requests 为非 Windows 平台做出贡献。

许可证

• README 中未明确说明；请检查仓库中的 LICENSE 文件。