Show help when algorithm is switched in search

radis/search/site.py

@@ -22,7 +22,7 @@ class SearchHandler(NamedTuple):
 
 
 def register_search_handler(
-    name: str,
+    name: str,  # TODO: may rename to algorithm
     searcher: Searcher,
     template_name: str,
 ) -> None:

radis/search/templates/search/_search_form.html

@@ -15,8 +15,9 @@
                        margin-left: -40px;
                        padding: 0;
                        z-index: 100">{% bootstrap_icon "x" 20 %}</button>
-        <select hx-get=""
+        <select hx-get="{% url "search_help" %}"
                 hx-trigger="change"
+                hx-target="#search-panel"
                 name="algorithm"
                 class="form-select"
                 style="max-width: 200px"

radis/search/templates/search/_search_help.html

@@ -0,0 +1,6 @@
+<div class="card mt-3">
+    <div class="card-body">
+        <h5 class="card-title">{{ selected_algorithm }}</h5>
+        {% include help_template_name %}
+    </div>
+</div>

radis/search/templates/search/search.html

@@ -6,17 +6,17 @@ <h4 class="mb-3">Search Reports</h4>
 {% endblock heading %}
 {% block content %}
     {% include "search/_search_form.html" %}
-    {% if not selected_algorithm %}
-        <div class="alert alert-danger d-flex align-items-center mt-3"
-             role="alert">
-            {% bootstrap_icon "exclamation-triangle-fill" %}
-            <div class="ms-2">Setup of RADIS is incomplete. No search algorithms are registered.</div>
-        </div>
-    {% else %}
-        {% if query %}
+    <div id="search-panel">
+        {% if not selected_algorithm %}
+            <div class="alert alert-danger d-flex align-items-center mt-3"
+                 role="alert">
+                {% bootstrap_icon "exclamation-triangle-fill" %}
+                <div class="ms-2">Setup of RADIS is incomplete. No search algorithms are registered.</div>
+            </div>
+        {% elif query %}
             {% include "search/_search_results.html" %}
         {% else %}
-            <div class="mt-3">{% include help_template_name %}</div>
+            {% include "search/_search_help.html" %}
         {% endif %}
-    {% endif %}
+    </div>
 {% endblock content %}

radis/search/urls.py

@@ -1,10 +1,11 @@
 from django.urls import path
 from rest_framework.urlpatterns import format_suffix_patterns
 
-from .views import SearchView
+from .views import HelpView, SearchView
 
 urlpatterns = [
     path("", SearchView.as_view(), name="search"),
+    path("help", HelpView.as_view(), name="search_help"),
 ]
 
 urlpatterns = format_suffix_patterns(urlpatterns)

radis/search/views.py

@@ -1,11 +1,12 @@
 from typing import Any
 
 from django.contrib.auth.mixins import LoginRequiredMixin
-from django.core.exceptions import BadRequest
+from django.core.exceptions import BadRequest, ValidationError
 from django.core.paginator import Paginator
 from django.shortcuts import render
 from django.views import View
 
+from radis.core.mixins import HtmxOnlyMixin
 from radis.core.types import AuthenticatedRequest
 
 from .serializers import SearchParamsSerializer
@@ -58,3 +59,21 @@ def get(self, request: AuthenticatedRequest, *args, **kwargs):
             context["documents"] = result.documents
 
         return render(request, "search/search.html", context)
+
+
+class HelpView(LoginRequiredMixin, HtmxOnlyMixin, View):
+    def get(self, request: AuthenticatedRequest, *args, **kwargs):
+        algorithm = request.GET.get("algorithm", "")
+        search_handler = search_handlers.get(algorithm)
+
+        if not search_handler:
+            raise ValidationError(f"Invalid search algorithm: {algorithm}")
+
+        return render(
+            request,
+            "search/_search_help.html",
+            {
+                "selected_algorithm": algorithm,
+                "help_template_name": search_handler.template_name,
+            },
+        )

radis/vespa/apps.py

@@ -26,7 +26,7 @@ def register_app():
         fetch_document,
         update_document,
     )
-    from .utils.search_methods import search_bm25
+    from .utils.search_methods import search_bm25, search_hybrid
 
     def handle_report(event_type: ReportEventType, report: Report):
         # Sync reports with Vespa
@@ -48,3 +48,8 @@ def search_vespa_bm25(search: Search) -> SearchResult:
         return search_bm25(search.query, search.offset, search.page_size)
 
     register_search_handler("Vespa BM25", search_vespa_bm25, "vespa/_bm25_help.html")
+
+    def search_vespa_hybrid(search: Search) -> SearchResult:
+        return search_hybrid(search.query, search.offset, search.page_size)
+
+    register_search_handler("Vespa Hybrid", search_vespa_hybrid, "vespa/_hybrid_help.html")

radis/vespa/templates/vespa/_bm25_help.html

@@ -1,20 +1,15 @@
-<div class="card">
-    <div class="card-body">
-        <h5 class="card-title">Vespa BM25 Help</h5>
-        <p class="card-text">
-            Vespa ist a modern full text search database and BM25 is a simple search
-            ranking algorithm based on the query terms appearing in each document.
-        </p>
-        <p class="card-text">
-            {# https://docs.vespa.ai/en/reference/simple-query-language-reference.html #}
-            The following rules apply:
-            <ul>
-                <li>Search is case-insensitive.</li>
-                <li>All terms in the query must be matched by a document (implicit AND query).</li>
-                <li>term1 OR term2 (capital OR) means that either term1 or term2 must match.</li>
-                <li>Terms surrounded by quotes are search as exact phrase, e.g. "lung disease".</li>
-                <li>+ in front of a term means that the exact term must match.</li>
-            </ul>
-        </p>
-    </div>
-</div>
+<p class="card-text">
+    Vespa ist a modern full text search database and BM25 is a simple search
+    ranking algorithm based on the query terms appearing in each document.
+</p>
+<p class="card-text">
+    {# https://docs.vespa.ai/en/reference/simple-query-language-reference.html #}
+    The following rules apply:
+    <ul>
+        <li>Search is case-insensitive.</li>
+        <li>All terms in the query must be matched by a document (implicit AND query).</li>
+        <li>term1 OR term2 (capital OR) means that either term1 or term2 must match.</li>
+        <li>Terms surrounded by quotes are search as exact phrase, e.g. "lung disease".</li>
+        <li>+ in front of a term means that the exact term must match.</li>
+    </ul>
+</p>

radis/vespa/templates/vespa/_hybrid_help.html

@@ -0,0 +1 @@
+TODO: Hybrid Help

radis/vespa/utils/search_methods.py

@@ -20,3 +20,11 @@ def search_bm25(query: str, offset: int, page_size: int) -> SearchResult:
         coverage=response.json["root"]["coverage"]["coverage"],
         documents=[document_from_vespa_response(hit) for hit in response.hits],
     )
+
+
+def search_hybrid(query: str, offset: int, page_size: int) -> SearchResult:
+    return SearchResult(
+        total_count=0,
+        coverage=0,
+        documents=[],
+    )