github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-08-01 03:17:20 -05:00
Code Issues 2.4k Packages Projects Releases 129 Wiki Activity

[PR #2964] [MERGED] feat: adding Serply as another web search provider #108451

New Issue
Closed
opened 2026-05-18 07:28:46 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-05-18 07:28:46 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/2964
Author: @googio
Created: 6/10/2024
Status: ✅ Merged
Merged: 6/10/2024
Merged by: @tjbck

Base: dev ← Head: dev

📝 Commits (6)

  • efb4a71 adding Serply as an alternative web search
  • 4dcec48 adding Serply as an alternative web search
  • 14d33f0 Merge branch 'add-serply' into dev
  • 79bf8d6 undo changes to deprecated web search params
  • 14eb667 add changes to web search in admin settings
  • 3566002 doc

📊 Changes

7 files changed (+319 additions, -4 deletions)

View changed files

📝 README.md (+1 -1)
📝 backend/apps/rag/main.py (+18 -1)
➕ backend/apps/rag/search/serply.py (+68 -0)
➕ backend/apps/rag/search/testdata/serply.json (+206 -0)
📝 backend/config.py (+6 -0)
📝 src/lib/components/admin/Settings/WebSearch.svelte (+19 -1)
📝 src/lib/components/documents/Settings/WebParams.svelte (+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 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

Added function to perform web search with Serply.io because Serply supports Google, News, and Jobs search. It will be beneficial to be able to perform News and Job search in the future.

Added

  • Added SERPLY_API_KEY API Key for config
  • Added serply as an option for webSearchEngines
  • Added backend/apps/rag/search/serply.py which is the function for calling Serply Google Search API
  • Builds the query payload
  • Passes in SERPLY_API_KEY into the headers
  • Updated /config/update to set SERPLY_API_KEY in the config
  • Added serply testdata

Changed

  • Updated README.md to Serply.io as an option for Web Search

Additional Information

Documentation

Updated docs to reference the Serply https://github.com/open-webui/docs/pull/108

Screenshots or Videos

Screenshot of changes to Admin -> Web Search -> Settings

  • contribute_adding_serply_to_open-webui

Performing the search
image

🔄 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/2964 **Author:** [@googio](https://github.com/googio) **Created:** 6/10/2024 **Status:** ✅ Merged **Merged:** 6/10/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `dev` --- ### 📝 Commits (6) - [`efb4a71`](https://github.com/open-webui/open-webui/commit/efb4a710c80635cc0066fc060e5021de79732d1f) adding Serply as an alternative web search - [`4dcec48`](https://github.com/open-webui/open-webui/commit/4dcec4855eb66ef3a4c4adc7b2fa31da21fd3c3c) adding Serply as an alternative web search - [`14d33f0`](https://github.com/open-webui/open-webui/commit/14d33f0fccba6670ef7511a5c8ef1124ed197e91) Merge branch 'add-serply' into dev - [`79bf8d6`](https://github.com/open-webui/open-webui/commit/79bf8d6dd31dc17f37aea0bfb339b7150484050c) undo changes to deprecated web search params - [`14eb667`](https://github.com/open-webui/open-webui/commit/14eb667fc8b332d1d8027aee510a4d2a40edb93a) add changes to web search in admin settings - [`3566002`](https://github.com/open-webui/open-webui/commit/3566002b0bc87cb7025be00a03e18818f62b8ace) doc ### 📊 Changes **7 files changed** (+319 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+1 -1) 📝 `backend/apps/rag/main.py` (+18 -1) ➕ `backend/apps/rag/search/serply.py` (+68 -0) ➕ `backend/apps/rag/search/testdata/serply.json` (+206 -0) 📝 `backend/config.py` (+6 -0) 📝 `src/lib/components/admin/Settings/WebSearch.svelte` (+19 -1) 📝 `src/lib/components/documents/Settings/WebParams.svelte` (+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 for validating 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 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 Added function to perform web search with Serply.io because Serply supports Google, News, and Jobs search. It will be beneficial to be able to perform News and Job search in the future. ### Added - Added `SERPLY_API_KEY` API Key for config - Added `serply` as an option for `webSearchEngines` - Added `backend/apps/rag/search/serply.py` which is the function for calling [Serply](https://serply.io) Google Search API * Builds the query payload * Passes in SERPLY_API_KEY into the headers - Updated `/config/update` to set `SERPLY_API_KEY` in the config - Added serply testdata ### Changed - Updated README.md to `Serply.io` as an option for Web Search ### Additional Information - Enhancement, added more web search providers - [[Reference any related issues, commits, or other relevant information]](https://github.com/open-webui/open-webui/issues/2957#issue-2342613119) ### Documentation Updated docs to reference the Serply https://github.com/open-webui/docs/pull/108 ### Screenshots or Videos Screenshot of changes to Admin -> Web Search -> Settings - ![contribute_adding_serply_to_open-webui](https://github.com/open-webui/open-webui/assets/59339358/8cbdb7f1-162d-4ed6-b9b2-70c993b6956e) Performing the search ![image](https://github.com/open-webui/open-webui/assets/59339358/005a7881-7325-4485-8441-a3abda462170) --- <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-18 07:28:46 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
confirmed
confirmed issue
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No labels pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
GiteaMirror ninjasurge (Kaehlen Rog)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#108451