commonMain.com.algolia.client.model.search.Hit.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-client-kotlin Show documentation

"Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries, and pre-built integrations. Algolia API Client for Kotlin lets you easily use the Algolia Search REST API from your JVM project, such as Android or backend implementations."

There is a newer version: 3.10.1

Show newest version

/** Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. */
package com.algolia.client.model.search

import com.algolia.client.extensions.internal.*
import kotlinx.serialization.*
import kotlinx.serialization.descriptors.*
import kotlinx.serialization.encoding.*
import kotlinx.serialization.json.*

/**
 * Search result.  A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
 *
 * @param objectID Unique record identifier.
 * @param highlightResult Surround words that match the query with HTML tags for highlighting.
 * @param snippetResult Snippets that show the context around a matching search query.
 * @param rankingInfo
 * @param distinctSeqID
 */
@Serializable(HitSerializer::class)
public data class Hit(

  /** Unique record identifier. */
  val objectID: String,

  /** Surround words that match the query with HTML tags for highlighting. */
  val highlightResult: Map? = null,

  /** Snippets that show the context around a matching search query. */
  val snippetResult: Map? = null,

  val rankingInfo: RankingInfo? = null,

  val distinctSeqID: Int? = null,

  val additionalProperties: Map? = null,
)

internal object HitSerializer : KSerializer {

  override val descriptor: SerialDescriptor = buildClassSerialDescriptor("Hit") {
    element("objectID")
    element>("_highlightResult", isOptional = true)
    element>("_snippetResult", isOptional = true)
    element("_rankingInfo", isOptional = true)
    element("_distinctSeqID", isOptional = true)
  }

  override fun deserialize(decoder: Decoder): Hit {
    val input = decoder.asJsonDecoder()
    val tree = input.decodeJsonObject()
    return Hit(
      objectID = tree.getValue("objectID").let { input.json.decodeFromJsonElement(it) },
      highlightResult = tree["_highlightResult"]?.let { input.json.decodeFromJsonElement(it) },
      snippetResult = tree["_snippetResult"]?.let { input.json.decodeFromJsonElement(it) },
      rankingInfo = tree["_rankingInfo"]?.let { input.json.decodeFromJsonElement(it) },
      distinctSeqID = tree["_distinctSeqID"]?.let { input.json.decodeFromJsonElement(it) },
      additionalProperties = tree.filterKeys { it !in descriptor.elementNames },
    )
  }

  override fun serialize(encoder: Encoder, value: Hit) {
    val output = encoder.asJsonEncoder()
    val json = buildJsonObject {
      put("objectID", output.json.encodeToJsonElement(value.objectID))
      value.highlightResult?.let { put("_highlightResult", output.json.encodeToJsonElement(it)) }
      value.snippetResult?.let { put("_snippetResult", output.json.encodeToJsonElement(it)) }
      value.rankingInfo?.let { put("_rankingInfo", output.json.encodeToJsonElement(it)) }
      value.distinctSeqID?.let { put("_distinctSeqID", output.json.encodeToJsonElement(it)) }
      value.additionalProperties?.onEach { (key, element) -> put(key, element) }
    }
    (encoder as JsonEncoder).encodeJsonElement(json)
  }
}