Merge pull request #87 from algolia/feature/similarQuery

Add similar query search parameter

Author: q-litzler

src/commonMain/kotlin/com/algolia/search/model/search/Query.kt

@@ -455,5 +455,10 @@ public data class Query(
      * Engine default: true
      * [Documentation][https://www.algolia.com/doc/api-reference/api-parameters/percentileComputation/?language=kotlin]
      */
-    @SerialName(KeyPercentileComputation) var percentileComputation: Boolean? = null
+    @SerialName(KeyPercentileComputation) var percentileComputation: Boolean? = null,
+    /**
+     *  Overrides the query parameter and performs a more generic search that can be used to find "similar" results.
+     *  [Documentation][https://www.algolia.com/doc/api-reference/api-parameters/similarQuery/?language=kotlin]
+     */
+    @SerialName(KeySimilarQuery) var similarQuery: String? = null
 )

src/commonMain/kotlin/com/algolia/search/serialize/Keys.kt

@@ -358,4 +358,5 @@ public const val KeyDistrict = "district"
 public const val KeyDegradedQuery = "degradedQuery"
 public const val KeyGeoPoint = "geoPoint"
 public const val KeySuburb = "suburb"
-public const val KeyVillage = "village"
+public const val KeyVillage = "village"
+public const val KeySimilarQuery = "similarQuery"

src/commonTest/kotlin/serialize/TestKeys.kt

@@ -351,5 +351,6 @@ internal class TestKeys {
         KeyDegradedQuery shouldEqual "degradedQuery"
         KeyGeoPoint shouldEqual "geoPoint"
         KeyVillage shouldEqual "village"
+        KeySimilarQuery shouldEqual "similarQuery"
     }
 }

src/commonTest/kotlin/serialize/search/TestQuery.kt

@@ -86,7 +86,8 @@ internal class TestQuery : TestSerializer<Query>(Query.serializer()) {
             minProximity = int,
             responseFields = listOf(ResponseFields.NbHits),
             maxFacetHits = int,
-            percentileComputation = boolean
+            percentileComputation = boolean,
+            similarQuery = string
         ) to json {
             KeyQuery to string
             KeyAttributesToRetrieve to attributesJson
@@ -153,6 +154,7 @@ internal class TestQuery : TestSerializer<Query>(Query.serializer()) {
             KeyResponseFields to jsonArray { +ResponseFields.NbHits.raw }
             KeyMaxFacetHits to int
             KeyPercentileComputation to boolean
+            KeySimilarQuery to string
         }
     )