commonMain.com.algolia.client.model.recommend.TrendingItemsQuery.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-jvm 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.recommend

import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
 * TrendingItemsQuery
 *
 * @param indexName Index name (case-sensitive).
 * @param threshold Minimum score a recommendation must have to be included in the response.
 * @param model
 * @param maxRecommendations Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
 * @param queryParameters
 * @param facetName Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
 * @param facetValue Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
 * @param fallbackParameters
 */
@Serializable
public data class TrendingItemsQuery(

  /** Index name (case-sensitive). */
  @SerialName(value = "indexName") val indexName: String,

  /** Minimum score a recommendation must have to be included in the response. */
  @SerialName(value = "threshold") val threshold: Double,

  @SerialName(value = "model") val model: TrendingItemsModel,

  /** Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.  */
  @SerialName(value = "maxRecommendations") val maxRecommendations: Int? = null,

  @SerialName(value = "queryParameters") val queryParameters: RecommendSearchParams? = null,

  /** Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.  */
  @SerialName(value = "facetName") val facetName: String? = null,

  /** Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.  */
  @SerialName(value = "facetValue") val facetValue: String? = null,

  @SerialName(value = "fallbackParameters") val fallbackParameters: FallbackParams? = null,
) : RecommendationsRequest