[PR #11089] [MERGED] feat: Elasticsearch as a vector store support #9456

New Issue

GiteaMirror · 2025-11-11T18:23:01-06:00

GiteaMirror commented

2025-11-11 18:23:01 -06:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/11089
Author: @tupe2009
Created: 3/3/2025
Status: ✅ Merged
Merged: 3/4/2025
Merged by: @tjbck

Base: dev ← Head: kleqon.feat-add-elasticsearch-support

📝 Commits (1)

737dfd2 added elasticsearch support

📊 Changes

4 files changed (+298 additions, -0 deletions)

View changed files

📝 backend/open_webui/config.py (+9 -0)
📝 backend/open_webui/retrieval/vector/connector.py (+4 -0)
➕ backend/open_webui/retrieval/vector/dbs/elasticsearch.py (+283 -0)
📝 backend/requirements.txt (+2 -0)

📄 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 for validating 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 cleary 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

Adding a feature- Basic Elasticsearch as a vector store support.

Added

Elasticsearch as a vector store support

Additional Information

Even though collections in ChromaDB can be easily translated to Elasticsearch indexes, it is bad practice to have many small indexes(might stress the cluster). therefor, I preferred using a different index only when using different embedding length, and save the collection ID as a field, which I filter by.
to summarize:

I use an index for each different doembedding vector length
Each index holds a "collection" field which is how you actually search a collection

_{🔄 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/11089 **Author:** [@tupe2009](https://github.com/tupe2009) **Created:** 3/3/2025 **Status:** ✅ Merged **Merged:** 3/4/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `kleqon.feat-add-elasticsearch-support` --- ### 📝 Commits (1) - [`737dfd2`](https://github.com/open-webui/open-webui/commit/737dfd2763790431e7cfe688dd815a3d948e8f51) added elasticsearch support ### 📊 Changes **4 files changed** (+298 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+9 -0) 📝 `backend/open_webui/retrieval/vector/connector.py` (+4 -0) ➕ `backend/open_webui/retrieval/vector/dbs/elasticsearch.py` (+283 -0) 📝 `backend/requirements.txt` (+2 -0) </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? - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [ ] **Testing:** Have you written and run sufficient tests for validating 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? - [x] **Prefix:** To cleary 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 - Adding a feature- Basic Elasticsearch as a vector store support. ### Added - Elasticsearch as a vector store support ### Additional Information Even though collections in ChromaDB can be easily translated to Elasticsearch indexes, it is bad practice to have many small indexes(might stress the cluster). therefor, I preferred using a different index only when using different embedding length, and save the collection ID as a field, which I filter by. to summarize: 1. I use an index for each different doembedding vector length 2. Each index holds a "collection" field which is how you actually search a collection --- <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 2025-11-11 18:23:01 -06:00

GiteaMirror closed this issue