[PR #16355] [CLOSED] fix: S3Vector compatibility with boto3 upgrade and metadata sanitization #62966

New Issue

GiteaMirror · 2026-05-06T07:26:52-05:00

GiteaMirror commented

2026-05-06 07:26:52 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/16355
Author: @flex-yeongjunchoi
Created: 8/7/2025
Status: ❌ Closed

Base: dev ← Head: fix-s3vector-upload-error

📝 Commits (3)

a31e8f5 sanitize metadata values before putobject to s3vector store
b0e9f51 upgrade boto3 verison to latest
8abf316 fix: restore unintentionally deleted static assets

📊 Changes

4 files changed (+87 additions, -113 deletions)

View changed files

📝 backend/open_webui/retrieval/vector/dbs/s3vector.py (+34 -0)
📝 backend/requirements.txt (+1 -1)
📝 pyproject.toml (+1 -1)
📝 uv.lock (+51 -111)

📄 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 updates boto3 from version 1.35.53 to 1.40.4 and fixes a bug in the S3Vector store implementation by adding metadata sanitization to ensure compatibility with AWS S3 Vector API requirements.

Fixed

Updated boto3 from version 1.35.53 to 1.40.4, as the previous version didn't correctly support S3Vector functionality
Added metadata value sanitization in S3Vector store to prevent errors when uploading objects with unsupported metadata types
Sanitization ensures metadata values are compatible with S3 Vector API (strings, numbers, booleans, or arrays)
related refer
- aws boto3 1.35.53 docs
- aws boto3 1.40.4 docs

Additional Information

This change addresses a ValidationException that occurred during vector uploads using S3VectorStore.
The error was caused by invalid metadata values (e.g., None, datetime, or nested objects) that are not supported by the Bedrock PutVectors API.
Related issues: None (identified during internal testing)
Testing was performed in a local development environment using the openwebui dev branch

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/16355 **Author:** [@flex-yeongjunchoi](https://github.com/flex-yeongjunchoi) **Created:** 8/7/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `fix-s3vector-upload-error` --- ### 📝 Commits (3) - [`a31e8f5`](https://github.com/open-webui/open-webui/commit/a31e8f56d9a26064c49fd9f2057cf73c8c29390a) sanitize metadata values before putobject to s3vector store - [`b0e9f51`](https://github.com/open-webui/open-webui/commit/b0e9f5114fc0e55aabed69e3e8fd5b62b59ad351) upgrade boto3 verison to latest - [`8abf316`](https://github.com/open-webui/open-webui/commit/8abf316836b538c988de2424d3f3fe1229d75a16) fix: restore unintentionally deleted static assets ### 📊 Changes **4 files changed** (+87 additions, -113 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/retrieval/vector/dbs/s3vector.py` (+34 -0) 📝 `backend/requirements.txt` (+1 -1) 📝 `pyproject.toml` (+1 -1) 📝 `uv.lock` (+51 -111) </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. - [ ] **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? - [ ] **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 updates boto3 from version 1.35.53 to 1.40.4 and fixes a bug in the S3Vector store implementation by adding metadata sanitization to ensure compatibility with AWS S3 Vector API requirements. ### Fixed - Updated boto3 from version 1.35.53 to 1.40.4, as the previous version didn't correctly support S3Vector functionality - Added metadata value sanitization in S3Vector store to prevent errors when uploading objects with unsupported metadata types - Sanitization ensures metadata values are compatible with S3 Vector API (strings, numbers, booleans, or arrays) - related refer - [aws boto3 1.35.53 docs](https://boto3.amazonaws.com/v1/documentation/api/1.35.35/guide/migrationpy3.html) - [aws boto3 1.40.4 docs](https://boto3.amazonaws.com/v1/documentation/api/1.40.4/guide/migrationpy3.html) --- ### Additional Information - This change addresses a ValidationException that occurred during vector uploads using S3VectorStore. - The error was caused by invalid metadata values (e.g., None, datetime, or nested objects) that are not supported by the Bedrock PutVectors API. - Related issues: None (identified during internal testing) - Testing was performed in a local development environment using the openwebui dev branch ### 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-05-06 07:26:52 -05:00

GiteaMirror closed this issue

2026-05-06 07:26:54 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#62966