feat(search/settings): Add decompoundQuery search & settings parameter (#722)

Author: VladislavFitz

Sources/AlgoliaSearchClient/Models/Common/CommonParameters.swift

@@ -148,6 +148,15 @@ public protocol CommonParameters {
    - [Documentation](https://www.algolia.com/doc/api-reference/api-parameters/queryLanguages/?language=swift)
    */
   var queryLanguages: [Language]? { get set }
+  
+  /**
+    Enable word segmentation (also called decompounding) at query time for
+    compatible languages.
+    For example, this turns the Dutch query "spaanplaatbehang" into "spaan plaat behang" to retrieve more relevant results.
+   - Engine default: true
+   - [Documentation](https://www.algolia.com/doc/api-reference/api-parameters/decompoundQuery/?client=swift)
+  */
+  var decompoundQuery: Bool? { get set }
 
   // MARK: - Query rules
 

Sources/AlgoliaSearchClient/Models/Search/Query/Query+Codable.swift

@@ -50,6 +50,7 @@ extension SearchParametersStorage: Codable {
     ignorePlurals = try container.decodeIfPresent(forKey: .ignorePlurals)
     removeStopWords = try container.decodeIfPresent(forKey: .removeStopWords)
     queryLanguages = try container.decodeIfPresent(forKey: .queryLanguages)
+    decompoundQuery = try container.decodeIfPresent(forKey: .decompoundQuery)
     enableRules = try container.decodeIfPresent(forKey: .enableRules)
     ruleContexts = try container.decodeIfPresent(forKey: .ruleContexts)
     enablePersonalization = try container.decodeIfPresent(forKey: .enablePersonalization)
@@ -120,6 +121,7 @@ extension SearchParametersStorage: Codable {
     try container.encodeIfPresent(ignorePlurals, forKey: .ignorePlurals)
     try container.encodeIfPresent(removeStopWords, forKey: .removeStopWords)
     try container.encodeIfPresent(queryLanguages, forKey: .queryLanguages)
+    try container.encodeIfPresent(decompoundQuery, forKey: .decompoundQuery)
     try container.encodeIfPresent(enableRules, forKey: .enableRules)
     try container.encodeIfPresent(ruleContexts, forKey: .ruleContexts)
     try container.encodeIfPresent(enablePersonalization, forKey: .enablePersonalization)
@@ -189,6 +191,7 @@ extension SearchParametersStorage: Codable {
     case ignorePlurals
     case removeStopWords
     case queryLanguages
+    case decompoundQuery
     case enableRules
     case ruleContexts
     case enablePersonalization

Sources/AlgoliaSearchClient/Models/Search/Query/Query+URLEncodable.swift

@@ -167,6 +167,7 @@ extension Query: URLEncodable {
     urlEncoder.set(alternativesAsExact, for: .alternativesAsExact)
     urlEncoder.set(ignorePlurals, for: .ignorePlurals)
     urlEncoder.set(queryLanguages, for: .queryLanguages)
+    urlEncoder.set(decompoundQuery, for: .decompoundQuery)
     urlEncoder.set(enableRules, for: .enableRules)
     urlEncoder.set(ruleContexts, for: .ruleContexts)
     urlEncoder.set(enablePersonalization, for: .enablePersonalization)

Sources/AlgoliaSearchClient/Models/Search/SearchParameters.swift

@@ -277,5 +277,5 @@ public protocol SearchParameters: CommonParameters {
    - [Documentation](https://www.algolia.com/doc/api-reference/api-parameters/_/?language=swift)
    */
   var explainModules: [ExplainModule]? { get set }
-
+  
 }

Sources/AlgoliaSearchClient/Models/Search/SearchParametersStorage.swift

@@ -48,6 +48,7 @@ public struct SearchParametersStorage: SearchParameters, Equatable {
   public var removeStopWords: LanguageFeature?
   public var queryLanguages: [Language]?
   public var naturalLanguages: [Language]?
+  public var decompoundQuery: Bool?
   public var enableRules: Bool?
   public var ruleContexts: [String]?
   public var enablePersonalization: Bool?
@@ -244,6 +245,10 @@ extension SearchParametersStorageContainer {
     get { searchParametersStorage.naturalLanguages }
     set { searchParametersStorage.naturalLanguages = newValue }
   }
+  public var decompoundQuery: Bool? {
+    get { searchParametersStorage.decompoundQuery }
+    set { searchParametersStorage.decompoundQuery = newValue }
+  }
   public var enableRules: Bool? {
     get { searchParametersStorage.enableRules }
     set { searchParametersStorage.enableRules = newValue }

Sources/AlgoliaSearchClient/Models/Settings/SettingsParametersCodingKeys.swift

@@ -38,6 +38,7 @@ public enum SettingsParametersCodingKeys: String, CodingKey {
   case decompoundedAttributes
   case keepDiacriticsOnCharacters
   case queryLanguages
+  case decompoundQuery
   case enableRules
   case enablePersonalization
   case queryType

Sources/AlgoliaSearchClient/Models/Settings/SettingsParametersStorage.swift

@@ -40,6 +40,7 @@ struct SettingsParametersStorage: SettingsParameters {
   var customNormalization: [String: [String: String]]?
   var queryLanguages: [Language]?
   var indexLanguages: [Language]?
+  var decompoundQuery: Bool?
   var enableRules: Bool?
   var enablePersonalization: Bool?
   var queryType: QueryType?
@@ -203,6 +204,10 @@ extension SettingsParametersStorageContainer {
     get { settingsParametersStorage.indexLanguages }
     set { settingsParametersStorage.indexLanguages = newValue }
   }
+  public var decompoundQuery: Bool? {
+    get { settingsParametersStorage.decompoundQuery }
+    set { settingsParametersStorage.decompoundQuery = newValue }
+  }
   public var enableRules: Bool? {
     get { settingsParametersStorage.enableRules }
     set { settingsParametersStorage.enableRules = newValue }

Tests/AlgoliaSearchClientTests/Doc/APIParameters/APIParameters+Languages.swift

@@ -246,5 +246,33 @@ extension APIParameters {
         }
       }
     }
+    
+    func decompoundQuery() {
+      /*
+       decompoundQuery = true
+       */
+      func enable_decompound_query_by_default() {
+        let settings = Settings()
+          .set(\.decompoundQuery, to: true)
+        
+        index.setSettings(settings) { result in
+          if case .success(let response) = result {
+            print("Response: \(response)")
+          }
+        }
+      }
+      
+      func enable_decompound_query_search_time() {
+        let query = Query("query")
+          .set(\.decompoundQuery, to: true)
+        
+        index.search(query: query) { result in
+          if case .success(let response) = result {
+            print("Response: \(response)")
+          }
+        }
+      }
+    }
+
   }
 }

Tests/AlgoliaSearchClientTests/Misc/Settings.json

@@ -19,6 +19,7 @@
   "attributeForDistinct": null,
   "exactOnSingleWordQuery": "attribute",
   "enablePersonalization": true,
+  "decompoundQuery": true,
   "ranking": [
     "typo",
     "geo",

Tests/AlgoliaSearchClientTests/Unit/QueryTests.swift

@@ -63,6 +63,7 @@ class QueryTests: XCTestCase {
     .set(\.alternativesAsExact, to: [.ignorePlurals, .singleWordSynonym])
     .set(\.ignorePlurals, to: false)
     .set(\.queryLanguages, to: [.hindi, .albanian])
+    .set(\.decompoundQuery, to: false)
     .set(\.enableRules, to: true)
     .set(\.ruleContexts, to: ["rc1", "rc2"])
     .set(\.enablePersonalization, to: false)
@@ -137,6 +138,7 @@ class QueryTests: XCTestCase {
       "alternativesAsExact=ignorePlurals,singleWordSynonym",
       "ignorePlurals=false",
       "queryLanguages=hi,sq",
+      "decompoundQuery=false",
       "enableRules=true",
       "ruleContexts=rc1,rc2",
       "enablePersonalization=false",
@@ -223,6 +225,7 @@ class QueryTests: XCTestCase {
       "advancedSyntaxFeatures": ["excludeWords", "exactPhrase"],
       "optionalWords": ["optWord1", "optWord2"],
       "removeStopWords": ["ar", "fr"],
+      "decompoundQuery": false,
       "disableExactOnAttributes": ["deAttr1", "deAttr2"],
       "exactOnSingleWordQuery": "word",
       "alternativesAsExact": ["ignorePlurals", "singleWordSynonym"],