项目介绍

BBC-Esq/VectorDB-Plugin 是一个托管在 GitHub 上的开源项目,主要使用 Python 编写,目前获得 371 个 Star、48 次 Fork。

仓库全名
BBC-Esq/VectorDB-Plugin
Star 数
371
Fork 数
48
未关闭 Issue
15

README 摘要

Create and search a vector database from a wide variety of file types and get more reliable responses from an LLM. This is commonly referred to as "retrieval augmented generation." Images of the program Requirements Tool | Purpose | 🪟 Microsoft Windows | Only for Windows but open to pull requests | 🐍 Python 3.11–3.14 | Run the application | 🌿 Git | Clone / manage the repository | 🧲 Git LFS | Handle large model…

完整内容见 GitHub 原始 README 或本页 。

常见问题

VectorDB-Plugin 用什么语言开发?

主要使用 Python 编写,目前有 371 个 Star。

如何获取 VectorDB-Plugin 的源码?

可以直接克隆仓库:git clone https://github.com/BBC-Esq/VectorDB-Plugin.git,默认分支为 main;安装与运行步骤见仓库 README。

VectorDB-Plugin 最近还在维护吗?

仓库最近一次更新为 1 周前,当前有 15 个未关闭 Issue;Star 数为 371,可作为社区活跃度的参考。

关于

GitHub 原始描述(英文)

Program that lets you ask questions about your documents, audio, and video files.

描述取自 GitHub 官方 API,保持仓库作者书写的原文。

语言占比

CSS
HTML
JavaScript
Python

Release

README

splash

Create and search a vector database from a wide variety of file types and get more reliable responses from an LLM. This is commonly referred to as “retrieval augmented generation.”

Images of the program

Models tab Settings tab Tools tab Query Database tab

Requirements

Tool Purpose
🪟 Microsoft Windows Only for Windows but open to pull requests
🐍 Python 3.11–3.14 Run the application
🌿 Git Clone / manage the repository
🧲 Git LFS Handle large model files
🛠️ Visual C++ Build Tools Required for compiling dependencies
🎮 NVIDIA GPU (optional) GTX 16-series / RTX 20-series or newer (driver 580+) for GPU acceleration; without one the program runs in CPU-only mode
Or you can try running these commands in Powershell on Windows:

Install:

winget install Microsoft.VisualStudio.2022.BuildTools --silent --accept-source-agreements --accept-package-agreements --override "--wait --quiet --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --add Microsoft.VisualStudio.Component.Windows11SDK.22621"

Verify installation:

Test-Path "C:\Program Files\Microsoft Visual Studio\2022\BuildTools\VC\Tools\MSVC"

Installation

Download the latest “release,” extract, navigate to the src folder, and run the following commands:

python -m venv .
.\Scripts\activate
python setup_windows.py
python gui.py
Tip 提示

The installer detects your hardware automatically. If no supported NVIDIA GPU is found, it installs the CPU-only version, which offers smaller models suited to running on a CPU. To force a CPU-only install on a computer that has a GPU, run python setup_windows.py --force-cpu instead.

Inputs → Processing → Vector Database

📂 Ingest 📄 .pdf, .docx, .txt, .html, .htm, .md, .csv, .xls, .xlsx, .xlsm, .rtf, .eml, .msg
🖼️ .png, .jpg, .jpeg, .bmp, .gif, .tif, .tiff
🎵 .mp3, .wav, .m4a, .ogg, .wma, .flac
⚙️ Process 📝 Extract text from documents
🖼️ Generate descriptions from images
🎧 Transcribe speech from audio
🧠 Store All processed content is embedded and saved into the vector database for searching.

Query → LLM → Output

❓ Ask ⌨️ Type or 🎙️ record a question
🧠 Retrieve Relevant chunks are pulled from the vector database
🤖 Generate Sent to an LLM (Local Model, Kobold, LM Studio, or ChatGPT)
💬 Respond LLM returns an answer based on the context you provided
🔊 Optional Text-to-speech can read the response aloud

Usage

Note 注意

Instructions on how to use the program are being consolidated into the Ask Jeeves functionality, which can be accessed from the “Ask Jeeves” menu option. Please create an issue if Jeeves is not working.

Request a Feature or Report a Bug

Feel free to report bugs or request enhancements by creating an issue on github and I will respond promptly.

Contact

I welcome all suggestions - both positive and negative. You can e-mail me directly at “[email protected]” or I can frequently be seen on the KoboldAI Discord server (moniker is vic49). I am always happy to answer any quesitons or discuss anything vector database related! (no formal affiliation with KoboldAI).

评论

暂无评论