refac

backend/open_webui/retrieval/web/searxng.py

@@ -2,87 +2,65 @@ from __future__ import annotations
 
 import logging
 
-import requests
 from open_webui.retrieval.web.main import SearchResult, get_filtered_results
+from open_webui.utils.session_pool import get_session
 
 log = logging.getLogger(__name__)
 
+# SearXNG request headers — identifies the bot to instance operators.
+_SEARXNG_HEADERS = {
+    'User-Agent': 'Open WebUI (https://github.com/open-webui/open-webui) RAG Bot',
+    'Accept': 'text/html',
+    'Accept-Encoding': 'gzip, deflate',
+    'Accept-Language': 'en-US,en;q=0.5',
+    'Connection': 'keep-alive',
+}
 
-def search_searxng(  # noqa: PLR0913
+
+async def search_searxng(
     query_url: str,
     query: str,
     count: int,
-    filter_list: list[str | None] = None,
+    filter_list: list[str | None] | None = None,
     **kwargs,
 ) -> list[SearchResult]:
+    """Query a SearXNG instance and return results sorted by relevance score.
+
+    Optional keyword arguments (language, safesearch, time_range, categories)
+    are forwarded directly as SearXNG query parameters.
     """
-    Search a SearXNG instance for a given query and return the results as a list of SearchResult objects.
-
-    The function allows passing additional parameters such as language or time_range to tailor the search result.
-
-    Args:
-        query_url (str): The base URL of the SearXNG server.
-        query (str): The search term or question to find in the SearXNG database.
-        count (int): The maximum number of results to retrieve from the search.
-
-    Keyword Args:
-        language (str): Language filter for the search results; e.g., "all", "en-US", "es". Defaults to "all".
-        safesearch (int): Safe search filter for safer web results; 0 = off, 1 = moderate, 2 = strict. Defaults to 1 (moderate).
-        time_range (str): Time range for filtering results by date; e.g., "2023-04-05..today" or "all-time". Defaults to ''.
-        categories: (list[str | None]): Specific categories within which the search should be performed, defaulting to an empty string if not provided.
-
-    Returns:
-        list[SearchResult]: A list of SearchResults sorted by relevance score in descending order.
-
-    Raise:
-        requests.exceptions.RequestException: If a request error occurs during the search process.
-    """
-
-    # Default values for optional parameters are provided as empty strings or None when not specified.
-    language = kwargs.get('language', 'all').strip().rstrip(',')
-    safesearch = kwargs.get('safesearch', '1')
-    time_range = kwargs.get('time_range', '')
-    categories = ''.join(kwargs.get('categories', []))
+    # Normalise legacy ``<query>``-style URLs by stripping any query string.
+    if '<query>' in query_url:
+        query_url = query_url.split('?')[0]
 
     params = {
         'q': query,
         'format': 'json',
         'pageno': 1,
-        'safesearch': safesearch,
-        'language': language,
-        'time_range': time_range,
-        'categories': categories,
+        'safesearch': kwargs.get('safesearch', '1'),
+        'language': kwargs.get('language', 'all').strip().rstrip(','),
+        'time_range': kwargs.get('time_range', ''),
+        'categories': ''.join(kwargs.get('categories', [])),
         'theme': 'simple',
         'image_proxy': 0,
     }
 
-    # Legacy query format
-    if '<query>' in query_url:
-        # Strip all query parameters from the URL
-        query_url = query_url.split('?')[0]
+    log.debug('searching %s', query_url)
 
-    log.debug(f'searching {query_url}')
+    session = await get_session()
+    async with session.get(query_url, headers=_SEARXNG_HEADERS, params=params) as response:
+        response.raise_for_status()
+        payload = await response.json()
 
-    response = requests.get(
-        query_url,
-        headers={
-            'User-Agent': 'Open WebUI (https://github.com/open-webui/open-webui) RAG Bot',
-            'Accept': 'text/html',
-            'Accept-Encoding': 'gzip, deflate',
-            'Accept-Language': 'en-US,en;q=0.5',
-            'Connection': 'keep-alive',
-        },
-        params=params,
-    )
-
-    response.raise_for_status()  # Raise an exception for HTTP errors.
-
-    json_response = response.json()
-    results = json_response.get('results', [])
-    sorted_results = sorted(results, key=lambda x: x.get('score', 0), reverse=True)
+    results = sorted(payload.get('results', []), key=lambda x: x.get('score', 0), reverse=True)
     if filter_list:
-        sorted_results = get_filtered_results(sorted_results, filter_list)
+        results = get_filtered_results(results, filter_list)
+
     return [
-        SearchResult(link=result['url'], title=result.get('title'), snippet=result.get('content'))
-        for result in sorted_results[:count]
+        SearchResult(
+            link=item.get('url', ''),
+            title=item.get('title'),
+            snippet=item.get('content'),
+        )
+        for item in results[:count]
     ]