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
SerpApi is a real-time API to access Google search results.
open-webui already supported web search via SearchApi, SerpApi is another way much like SearchApi
🔄 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/9980
**Author:** [@xring](https://github.com/xring)
**Created:** 2/14/2025
**Status:** ✅ Merged
**Merged:** 2/14/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `web_search_serpapi`
---
### 📝 Commits (1)
- [`27d395b`](https://github.com/open-webui/open-webui/commit/27d395ba06b8482cd0ed52c5dc77dd650bb06207) feat: add web search via SerpApi
### 📊 Changes
**5 files changed** (+119 additions, -0 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/config.py` (+12 -0)
📝 `backend/open_webui/main.py` (+4 -0)
➕ `backend/open_webui/retrieval/web/serpapi.py` (+48 -0)
📝 `backend/open_webui/routers/retrieval.py` (+26 -0)
📝 `src/lib/components/admin/Settings/WebSearch.svelte` (+29 -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 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
[SerpApi](https://serpapi.com/) is a real-time API to access Google search results.
open-webui already supported web search via [SearchApi](https://www.searchapi.io/), SerpApi is another way much like SearchApi
### Added
- backend/open_webui/retrieval/web/serpapi.py
### Changed
- backend/open_webui/config.py
- backend/open_webui/main.py
- backend/open_webui/routers/retrieval.py
- src/lib/components/admin/Settings/WebSearch.svelte
### Screenshots or Videos
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/9980
Author: @xring
Created: 2/14/2025
Status: ✅ Merged
Merged: 2/14/2025
Merged by: @tjbck
Base:
dev← Head:web_search_serpapi📝 Commits (1)
27d395bfeat: add web search via SerpApi📊 Changes
5 files changed (+119 additions, -0 deletions)
View changed files
📝
backend/open_webui/config.py(+12 -0)📝
backend/open_webui/main.py(+4 -0)➕
backend/open_webui/retrieval/web/serpapi.py(+48 -0)📝
backend/open_webui/routers/retrieval.py(+26 -0)📝
src/lib/components/admin/Settings/WebSearch.svelte(+29 -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:
devbranch.Changelog Entry
Description
SerpApi is a real-time API to access Google search results.
open-webui already supported web search via SearchApi, SerpApi is another way much like SearchApi
Added
Changed
Screenshots or Videos
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.