{"id":18043255,"url":"https://github.com/BBC-Esq/VectorDB-Plugin","last_synced_at":"2025-10-25T06:31:02.810Z","repository":{"id":187979094,"uuid":"677904482","full_name":"BBC-Esq/VectorDB-Plugin-for-LM-Studio","owner":"BBC-Esq","description":"Plugin that lets you ask questions about your documents including audio and video files.","archived":false,"fork":false,"pushed_at":"2024-10-29T22:20:38.000Z","size":13861,"stargazers_count":283,"open_issues_count":18,"forks_count":36,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-30T00:43:38.334Z","etag":null,"topics":["bark","database-management","embedding-models","embedding-vectors","embeddings","gtts","koboldai","koboldcpp","python","rag","retrieval-augmented-generation","retrieval-chatbot","tiledb","vector-data-management","vector-database","vector-search","vision","whisper","whispers2t","whisperspeech"],"latest_commit_sha":null,"homepage":"https://www.youtube.com/@AI_For_Lawyers","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BBC-Esq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-13T03:21:20.000Z","updated_at":"2024-10-29T22:20:41.000Z","dependencies_parsed_at":"2024-01-20T15:24:51.322Z","dependency_job_id":"da1da433-c5c4-4bd0-b85c-678a97722713","html_url":"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio","commit_stats":null,"previous_names":["bbc-esq/chromadb-plugin-for-lm-studio"],"tags_count":89,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BBC-Esq%2FVectorDB-Plugin-for-LM-Studio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BBC-Esq%2FVectorDB-Plugin-for-LM-Studio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BBC-Esq%2FVectorDB-Plugin-for-LM-Studio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BBC-Esq%2FVectorDB-Plugin-for-LM-Studio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BBC-Esq","download_url":"https://codeload.github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238093098,"owners_count":19415165,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bark","database-management","embedding-models","embedding-vectors","embeddings","gtts","koboldai","koboldcpp","python","rag","retrieval-augmented-generation","retrieval-chatbot","tiledb","vector-data-management","vector-database","vector-search","vision","whisper","whispers2t","whisperspeech"],"created_at":"2024-10-30T17:07:43.262Z","updated_at":"2025-10-25T06:31:02.804Z","avatar_url":"https://github.com/BBC-Esq.png","language":"Python","readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003e🚀 Supercharged Vector Database!\u003c/h1\u003e\n\n  \u003ca href=\"#requirements\"\u003eRequirements\u003c/a\u003e\n  \u0026nbsp;\u0026bull;\u0026nbsp;\n  \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\n  \u0026nbsp;\u0026bull;\u0026nbsp;\n  \u003ca href=\"#using-the-program\"\u003eUsing the Program\u003c/a\u003e\n  \u0026nbsp;\u0026bull;\u0026nbsp;\n  \u003ca href=\"#request-a-feature-or-report-a-bug\"\u003eRequest a Feature or Report a Bug\u003c/a\u003e\n  \u0026nbsp;\u0026bull;\u0026nbsp;\n  \u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\n\u003c/div\u003e\n\nCreate and search a vector database to get a response from the large language model that's more accurate.  This is commonly referred to as \"retrieval augmented generation\" (RAG)!  You can watch an introductory [Video](https://www.youtube.com/watch?v=8-ZAYI4MvtA) or read a [Medium article](https://medium.com/@vici0549/search-images-with-vector-database-retrieval-augmented-generation-rag-3d5a48881de5) about the program. \u003cbr\u003e\n\n\u003cdetails\u003e\u003csummary\u003eGraphic of How This Program Works\u003c/summary\u003e\n  \n![image](https://github.com/user-attachments/assets/b3784da7-91a5-426b-882c-756468ffdc20)\n\n\u003c/details\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch3\u003e\u003cu\u003eRequirements\u003c/u\u003e\u003c/h3\u003e\n\n| [🐍 Python 3.11](https://www.python.org/downloads/release/python-3119/) or [Python 3.12](https://www.python.org/downloads/release/python-31210/) \u0026nbsp;\u0026bull;\u0026nbsp; [📁 Git](https://git-scm.com/downloads) \u0026nbsp;\u0026bull;\u0026nbsp; [📁 Git LFS](https://git-lfs.com/) \u0026nbsp;\u0026bull;\u0026nbsp; [🌐 Pandoc](https://github.com/jgm/pandoc/releases) \u0026nbsp;\u0026bull;\u0026nbsp; [🛠️ Compiler](https://visualstudio.microsoft.com/) |\n|---|\n\nThe above link downloads Visual Studio as an example.  Make sure to install the required SDKs, however.\n\n\u003e \u003cdetails\u003e\n\u003e   \u003csummary\u003eEXAMPLE error when no compiler installed:\u003c/summary\u003e\n\u003e   \u003cimg src=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/sample_error.png?raw=true\"\u003e\n\u003e \u003c/details\u003e\n\u003e \n\u003e \u003cdetails\u003e\n\u003e   \u003csummary\u003eEXAMPLE of installing the correct SDKs:\u003c/summary\u003e\n\u003e   \u003cimg src=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/build_tools.png?raw=true\"\u003e\n\u003e \u003c/details\u003e\n\n\u003c/div\u003e\n\n[Back to Top](#top)\n\n\u003ca name=\"installation\"\u003e\u003c/a\u003e\n\u003cdiv align=\"center\"\u003e \u003ch2\u003eInstallation\u003c/h2\u003e\u003c/div\u003e\n  \n### Step 1\nDownload the ZIP file for the latest \"release.\"  Extract its contents and navigate to the `src` folder.\n\u003e [!CAUTION]\n\u003e If you simply clone this repository you will get the development version, which might not be stable.\n### Step 2\nWithin the `src` folder, create a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/):\n```\npython -m venv .\n```\n### Step 3\nActivate the virtual environment:\n```\n.\\Scripts\\activate\n```\n### Step 4\nRun the setup script:\n   \u003e Only ```Windows``` is supported for now.\n\n```\npython setup_windows.py\n```\n\n[Back to Top](#top)\n\n\u003ca name=\"using-the-program\"\u003e\u003c/a\u003e\n\u003cdiv align=\"center\"\u003e \u003ch2\u003e🖥️Usage🖥️\u003c/h2\u003e\u003c/div\u003e\n\n\u003e [!IMPORTANT]\n\u003e 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.\n\n### Start the Program\n```\n.\\Scripts\\activate\n```\n```\npython gui.py\n```\n\n### 🏗️ Create a Vector Database Download an embedding model from the ```Models Tab```.\n1. Set the `chunk size` and `chunk overlap` settings within the `Settings Tab`.\n2. Within the `Create Database Tab`, select the files that you want in the vector database.\n\u003e 🖼️ images can be selected by clicking the `Choose Files` button.\\\n\u003e 🎵 Audio files must be transcribed first within the `Tools Tab`.\n3. Select the embedding model you want to use.\n4. Click `Create Vector Database`.\n\n### 🔍 Query a Vector Database\n* Select the database you want to search within the `Query Database Tab`.\n* Select `Local Models`, `Kobold`, `LM Studio` or `ChatGPT` for the backend that you want to provide a response to your question.\n* Click `Submit Question`.\n  \u003e The `chunks only` checkbox will display the results from the vector database without getting a response.\n\n### ❓ Which Backend Should I Use?\nIf you use either the `Kobold` or `LM Studio` you must be familiar with those programs.  For example, `LM Studio` must be running in \"server mode\" and handles the prompt formatting.  However,`Kobold` automatically starts in server mode but requires you to specify the prompt formatting.\n\u003e [!TIP]\n\u003e Kobold [home page](https://github.com/LostRuins/koboldcpp), [instructions](https://github.com/LostRuins/koboldcpp/wiki), and [Discord server](https://koboldai.org/discord)\\\n\u003e LM Studio [home page](https://lmstudio.ai/), [instructions](https://lmstudio.ai/docs), and [Discord server](https://discord.gg/aPQfnNkxGC).\n\n### 🗑️ Deleting a Database\n* In the `Manage Databases Tab`, select a database and click `Delete Database`.\n\n[Back to Top](#top)\n\n\u003ca name=\"request-a-feature-or-report-a-bug\"\u003e\u003c/a\u003e\n## Request a Feature or Report a Bug\n\nFeel free to report bugs or request enhancements by creating an issue on github and I will respond promptly.\n\n\u003ca name=\"contact\"\u003e\u003c/a\u003e\n\u003cdiv align=\"center\"\u003e\u003ch3\u003eCONTACT\u003c/h3\u003e\u003c/div\u003e\n\nI 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 ```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```).\n\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example1.png\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example1.png?raw=true\" alt=\"Example Image\" width=\"350\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example2.png\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example2.png?raw=true\" alt=\"Example Image\" width=\"350\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example3.png\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example3.png?raw=true\" alt=\"Example Image\" width=\"350\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example4.png\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example4.png?raw=true\" alt=\"Example Image\" width=\"350\"\u003e\n    \u003c/a\u003e\n      \u003c/a\u003e\n    \u003ca href=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example5.png\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://github.com/BBC-Esq/VectorDB-Plugin-for-LM-Studio/blob/main/src/Assets/example5.png?raw=true\" alt=\"Example Image\" width=\"350\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBBC-Esq%2FVectorDB-Plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBBC-Esq%2FVectorDB-Plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBBC-Esq%2FVectorDB-Plugin/lists"}