[PR #9693] [MERGED] fix: Fixed error occurring when using OpenSearch as a vector db #22408

New Issue

GiteaMirror · 2026-04-20T04:07:44-05:00

GiteaMirror commented

2026-04-20 04:07:44 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/9693
Author: @vinsdragonis
Created: 2/9/2025
Status: ✅ Merged
Merged: 2/9/2025
Merged by: @tjbck

Base: dev ← Head: main

📝 Commits (5)

fd6b039 Added a query method for OpenSearch vector db.
7c78fac Update opensearch.py
5a1652b Update requirements.txt
b9d049c Create OpenSearch docker setup.md
40bba83 Delete docs/OpenSearch docker setup.md

📊 Changes

2 files changed (+35 additions, -1 deletions)

View changed files

📝 backend/open_webui/retrieval/vector/dbs/opensearch.py (+34 -0)
📝 backend/requirements.txt (+1 -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

This PR aims to fix the error 'OpenSeachClient' object has no attribute 'query'

Added

Added a query() function to OpenSearchClient based on the same logic as other vector db(s).
Added a new doc to provide some clarity on the setup process between Open-WebUI and OpenSearch.

Changed

Updated the version of OpenSearch-py being used in the backend.

Deprecated

N/A

Removed

N/A

Fixed

Fixes the error 'OpenSeachClient' object has no attribute 'query'

Security

N/A

Breaking Changes

BREAKING CHANGE: N/A

Additional Information

A doc addressing a certain issue that may be encountered during the setup process with OpenSearch as a docker container is added to /docs
Fixes issues #9336 , #8645

Screenshots or Videos

N/A

_{🔄 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/9693 **Author:** [@vinsdragonis](https://github.com/vinsdragonis) **Created:** 2/9/2025 **Status:** ✅ Merged **Merged:** 2/9/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `main` --- ### 📝 Commits (5) - [`fd6b039`](https://github.com/open-webui/open-webui/commit/fd6b0398591aa59b31879bef1f701ec18cb93fd8) Added a query method for OpenSearch vector db. - [`7c78fac`](https://github.com/open-webui/open-webui/commit/7c78facfd9ae16c69df93dcf7e8ce3e2ea5744be) Update opensearch.py - [`5a1652b`](https://github.com/open-webui/open-webui/commit/5a1652bc63065f5be7815945afd8674de7a4314c) Update requirements.txt - [`b9d049c`](https://github.com/open-webui/open-webui/commit/b9d049cb05ef229140a0416ce6a14c898c30cb36) Create OpenSearch docker setup.md - [`40bba83`](https://github.com/open-webui/open-webui/commit/40bba83cee82a376ecd68c74396e63e28334ba95) Delete docs/OpenSearch docker setup.md ### 📊 Changes **2 files changed** (+35 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/retrieval/vector/dbs/opensearch.py` (+34 -0) 📝 `backend/requirements.txt` (+1 -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. - [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 aims to fix the error **'OpenSeachClient' object has no attribute 'query'** ### Added - Added a query() function to OpenSearchClient based on the same logic as other vector db(s). - Added a new doc to provide some clarity on the setup process between Open-WebUI and OpenSearch. ### Changed - Updated the version of OpenSearch-py being used in the backend. ### Deprecated - N/A ### Removed - N/A ### Fixed - Fixes the error **'OpenSeachClient' object has no attribute 'query'** ### Security - N/A ### Breaking Changes - **BREAKING CHANGE**: N/A --- ### Additional Information - A doc addressing a certain issue that may be encountered during the setup process with OpenSearch as a docker container is added to `/docs` - Fixes issues [#9336 ](https://github.com/open-webui/open-webui/issues/9336), [#8645](https://github.com/open-webui/open-webui/issues/8645) ### Screenshots or Videos - N/A --- <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:07:44 -05:00

GiteaMirror closed this issue

2026-04-20 04:07:46 -05:00

GiteaMirror referenced this issue

2026-04-20 06:38:14 -05:00

[PR #22408] [MERGED] fix: filter out internal tool methods starting with underscore #26665

GiteaMirror referenced this issue

2026-04-25 14:15:05 -05:00

[PR #22408] [MERGED] fix: filter out internal tool methods starting with underscore #42295

GiteaMirror referenced this issue

2026-04-30 02:01:10 -05:00

[PR #22408] [MERGED] fix: filter out internal tool methods starting with underscore #49713