Swirl Metasearch 1.10

[sidprobstein]

SWIRL SEARCH 1.10

This version adds Quergy integration, improved and configurable hit highlighting, plus YouTrack SearchProviders and support for the open source Spyglass UI

PLEASE STAR OUR REPO: https://github.com/swirlai/swirl-search

Improves hit highlighting, and now supports configurable highlighting character(s) or tags with default term
Resolves issues with hit highlighting, BigQuery, providers that don't specify RESULTS and more
Adds Optional Spyglass UI integration

New Features

🔹 Swirl now incorporates feedback from Quergy including synonyms and other rewrites.

The terms are highlighted and used in relevancy.

🔹 Highlighting has been improved and supports tags as well as character markings. The default, specified in swirl_server/settings.py, is:

SWIRL_HIGHLIGHT_START_CHAR = '<em>'
SWIRL_HIGHLIGHT_END_CHAR = '</em>'

🔹 New YouTrack SearchProviders allows searching through Issues and Articles.

Here's the Issues provider JSON:

{
    "name": "Issues (web/YouTrack.cloud)",
    "connector": "RequestsGet",
    "url": "https://<your-domain>.youtrack.cloud/api/issues?fields=project(name),idReadable,tags(name),summary,description,reporter(fullName),created,votes,commentsCount,comments(text),subtasks(issues(idReadable)),customFields(name,value(name))",
    "query_template": "{url}&query={query_string}",
    "query_processors": [
        "AdaptiveQueryProcessor"
    ],
    "result_processors": [
        "MappingResultProcessor"
    ],
    "result_mappings": "title=summary,body=description,date_published=created,author=reporter.fullName,url='https://<your-domain>.youtrack.cloud/issue/{idReadable}',project.name,customFields[3].value[*].name,customFields[0].value[*].name,customFields[2].value[*].name,customFields[6].value[*].name,votes,tags[*].name,commentsCount,comments[*].text,subtasks[*].issues[*].idReadable,NO_PAYLOAD",
    "results_per_query": 10,
    "credentials": "bearer=your-youtrack-permanent-token",
    "tags": [
        "Issues",
        "YouTrack"
    ]
}

Here is an example result in JSON:

{
      "swirl_rank": 5,
      "searchprovider": "Issues (web/YouTrack.cloud)",
      "searchprovider_rank": 3,
      "title": "Bad <em>Relevancy</em> link in User Guide",
      "url": "https://swirl.youtrack.cloud/issue/SP-1",
      "body": "User Guide in '<em>Relevancy</em>' section shows link to: for 'Developers Guide, <em>Relevancy</em> Section' but it does not go anywhere.\n\n\n\n![](image.png){width=70%}",
      "date_published": "2023-03-22 11:35:30.956000",
      "date_retrieved": "2023-03-28 17:56:41.043101",
      "author": "Lee Eichelberger",
      "title_hit_highlights": [],
      "body_hit_highlights": [],
      "payload": {
          "project.name": "Swirl - Product",
          "customFields[3].value[*].name": "Sid Probstein",
          "customFields[0].value[*].name": "Normal",
          "customFields[2].value[*].name": "Fixed",
          "commentsCount": 1,
          "comments[*].text": "Fixed by Sid.  \n\nCommit: 1ffe987771e76643308ed2f97e1c0544be510ed8"
      }
      ...etc...

Resolved Issues

🔹 BigQuery connector error with single result_mapping that is type date #146

🔹 Review parsing of credentials and tokens everywhere #159

🔹 Hit highlighting: no highlighting of title terms with adjacent punctuation #77

🔹 Swirl now handles Unix-style dates in SearchProvider responses

🔹 RequestsGet no longer requires a RESULTS entry in the response_mapping

Known Issues

🔹 Creating searches from a browser with q= can sometimes create two Search objects.

This is because of browser prefetch AKA predictive service. Turn off Chrome prediction service. Turn off Safari prefetch

Please report any issues with this to support.

Upgrading

⚠️ Version 1.10 requires database migration. See Upgrading Swirl.

Documentation Wiki

🔹 Quick Start
🔹 User Guide
🔹 Developer Guide
🔹 Admin Guide

Support

🔹 Create an Issue if something doesn't work, isn't clear, or should be documented

🔹 Email: support@swirl.today with issues, requests, questions, etc - we'd love to hear from you!

---

This discussion was created from the release Swirl Metasearch 1.10.