Merge pull request #381 from MITLibraries/use-493

Add feature to enable semantic search

Author: jazairi

README.md

@@ -106,6 +106,7 @@ may have unexpected consequences if applied to other TIMDEX UI apps.
 - `FEATURE_TAB_TIMDEX_ALL`: Display a tab for displaying the combined TIMDEX data. `TIMDEX_INDEX` affects which data appears in this tab.
 - `FEATURE_TAB_TIMDEX_ALMA`: Display a tab for displaying Alma data from TIMDEX. `TIMDEX_INDEX` must include `Alma` data or no results will return.
 - `FEATURE_TIMDEX_FULLTEXT`: Activate fulltext searching for sources in TIMDEX that support it
+- `FEATURE_TIMDEX_SEMANTIC_SEARCH`: Enables semantic query mode (`queryMode: semantic`) for TIMDEX searches. When disabled, TIMDEX defaults to lexical search behavior.
 - `FEATURE_PRIMO_NDE_LINKS`: Enables all Primo UI links to target the NDE version of Primo. When enabled, links will use `/nde/search` and `/nde/fulldisplay` paths along with the NDE view ID from `PRIMO_NDE_VID`.
 - `FILTER_ACCESS_TO_FILES`: The name to use instead of "Access to files" for that filter / aggregation.
 - `FILTER_CONTENT_TYPE`: The name to use instead of "Content type" for that filter / aggregation.

app/controllers/search_controller.rb

@@ -217,6 +217,8 @@ def query_primo(per_page, offset)
   end
 
   def execute_geospatial_query(query)
+    query = query.except('queryMode')
+
     if query['geobox'] == 'true' && query[:geodistance] == 'true'
       TimdexBase::Client.query(TimdexSearch::AllQuery, variables: query)
     elsif query['geobox'] == 'true'

app/models/feature.rb

@@ -34,7 +34,7 @@
 class Feature
   # List of all valid features in the application
   VALID_FEATURES = %i[bot_detection geodata boolean_picker oa_always primo_nde_links simulate_search_latency tab_primo_all tab_timdex_all
-                      tab_timdex_alma record_link timdex_fulltext].freeze
+                      tab_timdex_alma record_link timdex_fulltext timdex_semantic_search].freeze
 
   # Check if a feature is enabled by name
   #

app/models/query_builder.rb

@@ -20,6 +20,7 @@ def initialize(enhanced_query)
     extract_query(enhanced_query)
     extract_geosearch(enhanced_query)
     extract_filters(enhanced_query)
+    @query['queryMode'] = 'semantic' if Feature.enabled?(:timdex_semantic_search)
     @query['index'] = ENV.fetch('TIMDEX_INDEX', nil)
     @query['booleanType'] = enhanced_query[:booleanType]
     @query.compact!

app/models/timdex_search.rb

@@ -15,6 +15,7 @@ class TimdexSearch < TimdexBase
       $index: String
       $from: String
       $booleanType: String
+      $queryMode: String
       $fulltext: Boolean
       $perPage: Int
       $accessToFilesFilter: [String!]
@@ -39,6 +40,7 @@ class TimdexSearch < TimdexBase
         index: $index
         from: $from
         booleanType: $booleanType
+        queryMode: $queryMode
         fulltext: $fulltext
         perPage: $perPage
         accessToFilesFilter: $accessToFilesFilter

config/schema/schema.json

@@ -1360,6 +1360,16 @@
                   },
                   "defaultValue": "\"OR\""
                 },
+                {
+                  "name": "queryMode",
+                  "description": "Search mode to use. Defaults to \"lexical\". Options include: \"lexical\", \"semantic\"",
+                  "type": {
+                    "kind": "SCALAR",
+                    "name": "String",
+                    "ofType": null
+                  },
+                  "defaultValue": "\"lexical\""
+                },
                 {
                   "name": "accessToFilesFilter",
                   "description": "Filter results by access type. Use the `AccessToFiles` aggregation for a list of possible values. Multiple values are ORed.",

test/models/query_builder_test.rb

@@ -120,4 +120,16 @@ class QueryBuilderTest < ActiveSupport::TestCase
     }
     assert_equal expected, QueryBuilder.new(search).query
   end
+
+  test 'query builder defaults to lexical mode by omitting queryMode' do
+    search = { q: 'blah' }
+    refute_includes(QueryBuilder.new(search).query.keys, 'queryMode')
+  end
+
+  test 'query builder adds semantic queryMode when feature flag is enabled' do
+    ClimateControl.modify FEATURE_TIMDEX_SEMANTIC_SEARCH: 'true' do
+      search = { q: 'blah' }
+      assert_equal('semantic', QueryBuilder.new(search).query['queryMode'])
+    end
+  end
 end