Program that lets you ask questions about your documents, audio, and video files.
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."
Requirements
| Tool | Purpose | | ---------------------------------------------------------------------------------------- | ------------------------------------------------- | | ๐ช Microsoft Windows | Only for Windows but open to pull requests | | ๐ Python 3.11โ3.13 | Run the application | | ๐ฟ Git | Clone / manage the repository | | ๐งฒ Git LFS | Handle large model files | | ๐ Pandoc | Document parsing support | | ๐ ๏ธ Visual C++ Build Tools | Required for compiling dependencies |
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
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 "bbc@chintellalaw.com" or I can frequently be seen on the
Discord server (moniker is ). I am always happy to answer any quesitons or discuss anything vector database related! (no formal affiliation with ).