[PR #1403] [MERGED] docs: correct the web search provider pages against the search engine code and admin labels #1368

New issue

Closed

opened 2026-10-18 14:19:11 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:19:11 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1403
Author: @silentoplayz
Created: 9/18/2026
Status: ✅ Merged
Merged: 9/18/2026
Merged by: @Classic298

Base: main ← Head: docs/web-search-providers

📝 Commits (1)

16efa99 docs: correct the web search provider pages against the search engine code and admin labels

📊 Changes

13 files changed (+41 additions, -59 deletions)

View changed files

📝 docs/features/chat-conversations/web-search/providers/bing.md (+1 -1)
📝 docs/features/chat-conversations/web-search/providers/brave.md (+2 -2)
📝 docs/features/chat-conversations/web-search/providers/ddgs.mdx (+1 -1)
📝 docs/features/chat-conversations/web-search/providers/exa.md (+1 -1)
📝 docs/features/chat-conversations/web-search/providers/external.md (+5 -3)
📝 docs/features/chat-conversations/web-search/providers/firecrawl.md (+5 -5)
📝 docs/features/chat-conversations/web-search/providers/jina.md (+7 -30)
📝 docs/features/chat-conversations/web-search/providers/linkup.md (+2 -2)
📝 docs/features/chat-conversations/web-search/providers/perplexity.mdx (+2 -1)
📝 docs/features/chat-conversations/web-search/providers/perplexity_search.mdx (+1 -1)
📝 docs/features/chat-conversations/web-search/providers/searxng.md (+9 -7)
📝 docs/features/chat-conversations/web-search/providers/tavily.md (+4 -4)
📝 docs/features/chat-conversations/web-search/providers/youcom.md (+1 -1)

📄 Description

Summary

I compared thirteen web search provider pages with the engine dispatch in routers/retrieval.py, each engine's module under retrieval/web/, the variables in config.py and the admin field labels in WebSearch.svelte on dev. The four pages another open branch already edits (Ollama Cloud, Serper, Serply, Serpstack) are untouched.

Wrong claims corrected:

Bing: the key field is Bing Search V7 Subscription Key, not SearchApi API Key. The endpoint field and its default are now named.
Brave: brave_llm_context does not skip the page scrape by itself. Only Bypass Web Loader does, for every engine. The concurrency note now describes the shared session and per-search limit.
Firecrawl: the timeout is in seconds and applies to the web loader only, the search call uses a fixed three seconds per result, search returns titles and descriptions rather than page content, the key is optional for self-hosted instances, and the base URL must not carry a version path.
Jina: the integration calls the Search API at s.jina.ai, not DeepSearch. The DeepSearch parameter section is replaced by the two limits that apply (ten results, no domain filter).
Linkup: the admin UI has one Parameters JSON field, not separate Search Depth and Output Type fields.
Perplexity Search: the field is Perplexity Search API URL and holds the full endpoint.
SearXNG: the ?q=<query> form is a legacy shape the code strips, not a requirement. The examples use /search, and the language field is named.
Tavily: Web Search lives in the admin settings, WEBUI_URL is not a prerequisite, only query and max_results are sent, and the base URL variable is named.
External: the field labels and variable names, plus the User-Agent, identity and chat-id headers the request carries.

Missing facts added: the DDGS engine value is duckduckgo and the entry is disabled on slim, Exa's Max Content Length field, Perplexity's model and context-usage fields, and YDC_API_KEY as the fallback name for You.com.

None.

Checklist

I have reviewed the relevant documentation and matched the existing style.
This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility.
I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories.

Notes for reviewers

Three engines the dispatch accepts have no page: azure (env-only, not in the admin dropdown), bocha and sougou. Left for a separate change.

_{🔄 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/docs/pull/1403 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 9/18/2026 **Status:** ✅ Merged **Merged:** 9/18/2026 **Merged by:** [@Classic298](https://github.com/Classic298) **Base:** `main` ← **Head:** `docs/web-search-providers` --- ### 📝 Commits (1) - [`16efa99`](https://github.com/open-webui/docs/commit/16efa992bae5ae32ad6ab392c4ae77e361e3de68) docs: correct the web search provider pages against the search engine code and admin labels ### 📊 Changes **13 files changed** (+41 additions, -59 deletions) <details> <summary>View changed files</summary> 📝 `docs/features/chat-conversations/web-search/providers/bing.md` (+1 -1) 📝 `docs/features/chat-conversations/web-search/providers/brave.md` (+2 -2) 📝 `docs/features/chat-conversations/web-search/providers/ddgs.mdx` (+1 -1) 📝 `docs/features/chat-conversations/web-search/providers/exa.md` (+1 -1) 📝 `docs/features/chat-conversations/web-search/providers/external.md` (+5 -3) 📝 `docs/features/chat-conversations/web-search/providers/firecrawl.md` (+5 -5) 📝 `docs/features/chat-conversations/web-search/providers/jina.md` (+7 -30) 📝 `docs/features/chat-conversations/web-search/providers/linkup.md` (+2 -2) 📝 `docs/features/chat-conversations/web-search/providers/perplexity.mdx` (+2 -1) 📝 `docs/features/chat-conversations/web-search/providers/perplexity_search.mdx` (+1 -1) 📝 `docs/features/chat-conversations/web-search/providers/searxng.md` (+9 -7) 📝 `docs/features/chat-conversations/web-search/providers/tavily.md` (+4 -4) 📝 `docs/features/chat-conversations/web-search/providers/youcom.md` (+1 -1) </details> ### 📄 Description ## Summary I compared thirteen web search provider pages with the engine dispatch in `routers/retrieval.py`, each engine's module under `retrieval/web/`, the variables in `config.py` and the admin field labels in `WebSearch.svelte` on `dev`. The four pages another open branch already edits (Ollama Cloud, Serper, Serply, Serpstack) are untouched. Wrong claims corrected: - Bing: the key field is Bing Search V7 Subscription Key, not SearchApi API Key. The endpoint field and its default are now named. - Brave: `brave_llm_context` does not skip the page scrape by itself. Only Bypass Web Loader does, for every engine. The concurrency note now describes the shared session and per-search limit. - Firecrawl: the timeout is in seconds and applies to the web loader only, the search call uses a fixed three seconds per result, search returns titles and descriptions rather than page content, the key is optional for self-hosted instances, and the base URL must not carry a version path. - Jina: the integration calls the Search API at `s.jina.ai`, not DeepSearch. The DeepSearch parameter section is replaced by the two limits that apply (ten results, no domain filter). - Linkup: the admin UI has one Parameters JSON field, not separate Search Depth and Output Type fields. - Perplexity Search: the field is Perplexity Search API URL and holds the full endpoint. - SearXNG: the `?q=<query>` form is a legacy shape the code strips, not a requirement. The examples use `/search`, and the language field is named. - Tavily: Web Search lives in the admin settings, `WEBUI_URL` is not a prerequisite, only `query` and `max_results` are sent, and the base URL variable is named. - External: the field labels and variable names, plus the User-Agent, identity and chat-id headers the request carries. Missing facts added: the DDGS engine value is `duckduckgo` and the entry is disabled on slim, Exa's Max Content Length field, Perplexity's model and context-usage fields, and `YDC_API_KEY` as the fallback name for You.com. ## Related issue or discussion None. ## Checklist - [x] I have reviewed the relevant documentation and matched the existing style. - [x] This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility. - [x] I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories. ## Notes for reviewers Three engines the dispatch accepts have no page: `azure` (env-only, not in the admin dropdown), `bocha` and `sougou`. Left for a separate change. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:19:11 +00:00