Merge pull request #186 from algolia/fix/personalization

feat(personalization): add personalization as part of the RankingInfo

Author: aallam

src/commonMain/kotlin/com/algolia/search/model/response/ResponseSearch.kt

@@ -332,7 +332,7 @@ public data class ResponseSearch(
         public val distinctSeqIDOrNull: Int? = json.getPrimitiveOrNull(Key_DistinctSeqID)?.int
 
         public val rankingInfoOrNull: RankingInfo? = json.getObjectOrNull(Key_RankingInfo)?.let {
-            Json.fromJson(RankingInfo.serializer(), it)
+            JsonNonStrict.fromJson(RankingInfo.serializer(), it)
         }
 
         public val highlightResultOrNull: JsonObject? = json.getObjectOrNull(Key_HighlightResult)

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

@@ -0,0 +1,23 @@
+package com.algolia.search.model.search
+
+import com.algolia.search.serialize.KeyFiltersScore
+import com.algolia.search.serialize.KeyRankingScore
+import com.algolia.search.serialize.KeyScore
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+public data class Personalization(
+    /**
+     * Personalization Score
+     */
+    @SerialName(KeyScore) val score: Int,
+    /**
+     * Personalization Ranking Score
+     */
+    @SerialName(KeyRankingScore) val rankingScore: Int,
+    /**
+     * Personalization Filters Score
+     */
+    @SerialName(KeyFiltersScore) val filtersScore: Int
+)

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

@@ -1,6 +1,8 @@
 package com.algolia.search.model.search
 
 import com.algolia.search.endpoint.EndpointPlaces
+import com.algolia.search.model.multicluster.ClusterName
+import com.algolia.search.model.multicluster.UserID
 import com.algolia.search.model.settings.RankingCriterion
 import com.algolia.search.model.settings.Settings
 import com.algolia.search.serialize.GeoDistance
@@ -19,6 +21,7 @@ import com.algolia.search.serialize.KeyProximityDistance
 import com.algolia.search.serialize.KeyQuery
 import com.algolia.search.serialize.KeyUserScore
 import com.algolia.search.serialize.KeyWords
+import com.algolia.search.serialize.KeyPersonalization
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
@@ -83,5 +86,9 @@ public data class RankingInfo(
     /**
      * Only returned for [EndpointPlaces.searchPlaces].
      */
-    @SerialName(KeyQuery) val query: String? = null
+    @SerialName(KeyQuery) val query: String? = null,
+    /**
+     * Only returned when personalization is enabled
+     */
+    @SerialName(KeyPersonalization) val personalization: Personalization? = null
 )

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

@@ -195,3 +195,6 @@ public const val KeyInner_Queries = "inner_queries"
 public const val KeyIndex_Name = "index_name"
 public const val KeyQuery_ID = "query_id"
 public const val KeyUser_Token = "user_token"
+public const val KeyPersonalization = "personalization"
+public const val KeyRankingScore = "rankingScore"
+public const val KeyFiltersScore = "filtersScore"