[PR #15811] [CLOSED] feat: support extra metadata in vectordb #46996

Closed
opened 2026-04-29 22:02:12 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15811
Author: @guenhter
Created: 7/17/2025
Status: ❌ Closed

Base: dev ← Head: support-more-meta-in-vectordb


📝 Commits (2)

  • 794f733 feat: support extra metadata in vectordb
  • db3dfd3 feat: stringify meta of metadata of elastic again

📊 Changes

3 files changed (+8 additions, -5 deletions)

View changed files

📝 backend/open_webui/retrieval/vector/dbs/elasticsearch.py (+4 -3)
📝 backend/open_webui/retrieval/vector/dbs/opensearch.py (+3 -2)
📝 backend/open_webui/routers/retrieval.py (+1 -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 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

This PR is just a preparation for a bigger epic to support more sources for creating knowledge basis, like Sharepoint, Web, ... (https://github.com/open-webui/open-webui/issues/5872, https://github.com/open-webui/open-webui/discussions/13877, https://github.com/open-webui/open-webui/discussions/13713, https://discord.com/channels/1170866489302188073/1241654544639725609/threads/1395395559124238366)

The main aim of this PR is to support storing the extra metadata of table file field meta.data also in the vector db. Having extra metadata has several use cases:

  • allow to store additional information when the file upload is used via API
  • extra metadata can be used for better data analysis outside of OWUI
  • extra metadata can be used by tools/functions for better customization

Additionally, I've changed how nested meta data is treated. By default nested dict structures were converted so a string (I guess based on the comment this was done because of Chroma). For the Vector DBs which don't support nested structures, nothing changes. The DBs which definitely support nesting in the metadata, nothing is stringified but instead used as is:

  • Qdrant
  • Pinecone
  • Elasticsearch
  • OpenSearch

I've tested it with one DB supporting nesting (qdrant) and with one not supporting nesting (chroma)

Added

  • Allow to store extra metadata in vector DB (same meta as in sql table files column meta.data)

Changed

  • not stringify nested metadata datastructurs for databases which supports nested structures

Additional Information

This also works when the DB is re-indexed, as the metadata is used from the file table of the sql db.

This is also contributing as preparation for features like this: https://qdrant.tech/documentation/search-precision/automate-filtering-with-llms/

Screenshots or Videos

Qdrant point when metadata is nested:
image

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), 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/15811 **Author:** [@guenhter](https://github.com/guenhter) **Created:** 7/17/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `support-more-meta-in-vectordb` --- ### 📝 Commits (2) - [`794f733`](https://github.com/open-webui/open-webui/commit/794f733139b7e8db6e9e512c03eb2980baf74a24) feat: support extra metadata in vectordb - [`db3dfd3`](https://github.com/open-webui/open-webui/commit/db3dfd3e4b6c914db848bfd46b7397a138323ce8) feat: stringify meta of metadata of elastic again ### 📊 Changes **3 files changed** (+8 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/retrieval/vector/dbs/elasticsearch.py` (+4 -3) 📝 `backend/open_webui/retrieval/vector/dbs/opensearch.py` (+3 -2) 📝 `backend/open_webui/routers/retrieval.py` (+1 -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. - [x] **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? - [x] **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 This PR is just a preparation for a bigger epic to support more sources for creating knowledge basis, like Sharepoint, Web, ... (https://github.com/open-webui/open-webui/issues/5872, https://github.com/open-webui/open-webui/discussions/13877, https://github.com/open-webui/open-webui/discussions/13713, https://discord.com/channels/1170866489302188073/1241654544639725609/threads/1395395559124238366) The main aim of this PR is to support storing the extra metadata of table `file` field `meta.data` also in the vector db. Having extra metadata has several use cases: * allow to store additional information when the file upload is used via API * extra metadata can be used for better data analysis outside of OWUI * extra metadata can be used by tools/functions for better customization Additionally, I've changed how nested meta data is treated. By default nested dict structures were converted so a string (I guess based on the comment this was done because of Chroma). For the Vector DBs which don't support nested structures, nothing changes. The DBs which definitely support nesting in the metadata, nothing is stringified but instead used as is: * Qdrant * Pinecone * Elasticsearch * OpenSearch I've tested it with one DB supporting nesting (qdrant) and with one not supporting nesting (chroma) ### Added - Allow to store extra metadata in vector DB (same meta as in sql table `files` column `meta.data`) ### Changed - not stringify nested metadata datastructurs for databases which supports nested structures --- ### Additional Information This also works when the DB is re-indexed, as the metadata is used from the `file` table of the sql db. This is also contributing as preparation for features like this: https://qdrant.tech/documentation/search-precision/automate-filtering-with-llms/ ### Screenshots or Videos Qdrant point when metadata is nested: <img width="1469" height="1141" alt="image" src="https://github.com/user-attachments/assets/98f23aad-5184-4502-adb5-1670f6e4fdf2" /> ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/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-29 22:02:12 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#46996