Web Search Functionality in Open WebUI

EveryoneUpdated 11 Jun 2024LLM & Open WebUI
Web Search Functionality in Open WebUI
Overview

This guide explains how to configure and use the web search functionality in Open WebUI, including how administrators can enable and set up different search engines. It also covers how users can access web search if permitted by the administrator. Integration with GRACE is supported.

User Guide
For Administrators
  1. Access Web Search Settings:
    • Log in to Open WebUI as an administrator.
    • Navigate to the Admin Panel.
    • Go to Settings > Web Search.
  2. Enable Web Search:
    • Toggle the option to enable web search functionality for users.
  3. Select and Configure a Search Engine:
    • Choose your preferred search engine from the available options (e.g., DuckDuckGo, Google Search, or others).
    • For DuckDuckGo:
      • No API key is required. This is a free-to-use option.
    • For Google Search:
      • You must provide a Google Search API key and a Search Engine ID.
      • Obtain these credentials from your Google Cloud Console.
      • Enter the API key and Search Engine ID in the configuration fields.
    • Other Search Engines:
      • Review the requirements for each engine and configure accordingly.
  4. Save Settings:
    • After configuring your preferred search engine, save the settings to apply changes.
For Normal Users
  1. Using Web Search:
    • If web search is enabled by the administrator, you will see an option to toggle web search on or off in Open WebUI.
    • When enabled, your queries can include real-time web search results to provide the most relevant and up-to-date information.
Summary
  • Administrators can enable and configure web search in Open WebUI, choosing from multiple search engines.
  • Some search engines, like Google, require API credentials, while others like DuckDuckGo are free to use.
  • Once enabled, users can toggle web search to enhance their queries with live web data.
  • GRACE integration is supported for advanced configurations.