[PR #13098] [MERGED] feat: Add abstract base class for vector database integration #23101

New Issue

GiteaMirror · 2026-04-20T04:37:53-05:00

GiteaMirror commented

2026-04-20 04:37:53 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/13098
Author: @athoik
Created: 4/21/2025
Status: ✅ Merged
Merged: 4/23/2025
Merged by: @tjbck

Base: dev ← Head: dev

📝 Commits (1)

1e291af feat: Add abstract base class for vector database integration

📊 Changes

8 files changed (+117 additions, -15 deletions)

View changed files

📝 backend/open_webui/retrieval/vector/dbs/chroma.py (+7 -2)
📝 backend/open_webui/retrieval/vector/dbs/elasticsearch.py (+7 -2)
📝 backend/open_webui/retrieval/vector/dbs/milvus.py (+7 -2)
📝 backend/open_webui/retrieval/vector/dbs/opensearch.py (+7 -2)
📝 backend/open_webui/retrieval/vector/dbs/pgvector.py (+7 -2)
📝 backend/open_webui/retrieval/vector/dbs/pinecone.py (+7 -2)
📝 backend/open_webui/retrieval/vector/dbs/qdrant.py (+7 -2)
📝 backend/open_webui/retrieval/vector/main.py (+68 -1)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.

Before submitting, make sure you've checked the following:

Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
- BREAKING CHANGE: Significant changes that may affect compatibility
- build: Changes that affect the build system or external dependencies
- ci: Changes to our continuous integration processes or workflows
- chore: Refactor, cleanup, or other non-functional code changes
- docs: Documentation update or addition
- feat: Introduces a new feature or enhancement to the codebase
- fix: Bug fix or error correction
- i18n: Internationalization or localization changes
- perf: Performance improvement
- refactor: Code restructuring for better maintainability, readability, or scalability
- style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
- WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

Created VectorDBBase as an abstract base class to standardize vector database operations.
The base class can now be extended by any vector database implementation (e.g., Qdrant, Pinecone) to ensure a consistent API across different database systems.

Added

Added required methods for common vector database operations: has_collection, delete_collection, insert, upsert, search, query, get, delete, reset.

Changed

All vector database classes (e.g., Qdrant, Pinecone) now implement the VectorDBBase class to ensure a consistent API across different systems.
This provides a unified interface for all supported vector databases.

Deprecated

[List any deprecated functionality or features that have been removed]

Removed

[List any removed features, files, or functionalities]

Fixed

[List any fixes, corrections, or bug fixes]

Security

[List any new or updated security-related changes, including vulnerability fixes]

Breaking Changes

BREAKING CHANGE: NONE

Additional Information

[Insert any additional context, notes, or explanations for the changes]
- [Reference any related issues, commits, or other relevant information]

Screenshots or Videos

[Attach any relevant screenshots or videos demonstrating the changes]

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the CONTRIBUTOR_LICENSE_AGREEMENT, and I am providing my contributions under its terms.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/13098 **Author:** [@athoik](https://github.com/athoik) **Created:** 4/21/2025 **Status:** ✅ Merged **Merged:** 4/23/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `dev` --- ### 📝 Commits (1) - [`1e291af`](https://github.com/open-webui/open-webui/commit/1e291aff25a0793b3d24a66d076ffe27eec51241) feat: Add abstract base class for vector database integration ### 📊 Changes **8 files changed** (+117 additions, -15 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/retrieval/vector/dbs/chroma.py` (+7 -2) 📝 `backend/open_webui/retrieval/vector/dbs/elasticsearch.py` (+7 -2) 📝 `backend/open_webui/retrieval/vector/dbs/milvus.py` (+7 -2) 📝 `backend/open_webui/retrieval/vector/dbs/opensearch.py` (+7 -2) 📝 `backend/open_webui/retrieval/vector/dbs/pgvector.py` (+7 -2) 📝 `backend/open_webui/retrieval/vector/dbs/pinecone.py` (+7 -2) 📝 `backend/open_webui/retrieval/vector/dbs/qdrant.py` (+7 -2) 📝 `backend/open_webui/retrieval/vector/main.py` (+68 -1) </details> ### 📄 Description # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Please verify that the pull request targets the `dev` branch. - [x] **Description:** Provide a concise description of the changes made in this pull request. - [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [ ] **Testing:** Have you written and run sufficient tests to validate the changes? - [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description - Created `VectorDBBase` as an abstract base class to standardize vector database operations. - The base class can now be extended by any vector database implementation (e.g., Qdrant, Pinecone) to ensure a consistent API across different database systems. ### Added - Added required methods for common vector database operations: `has_collection`, `delete_collection`, `insert`, `upsert`, `search`, `query`, `get`, `delete`, `reset`. ### Changed - All vector database classes (e.g., Qdrant, Pinecone) now implement the `VectorDBBase` class to ensure a consistent API across different systems. - This provides a unified interface for all supported vector databases. ### Deprecated - [List any deprecated functionality or features that have been removed] ### Removed - [List any removed features, files, or functionalities] ### Fixed - [List any fixes, corrections, or bug fixes] ### Security - [List any new or updated security-related changes, including vulnerability fixes] ### Breaking Changes - **BREAKING CHANGE**: NONE --- ### Additional Information - [Insert any additional context, notes, or explanations for the changes] - [Reference any related issues, commits, or other relevant information] ### Screenshots or Videos - [Attach any relevant screenshots or videos demonstrating the changes] ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [CONTRIBUTOR_LICENSE_AGREEMENT](CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-04-20 04:37:53 -05:00

GiteaMirror closed this issue