algoliasearch.personalization.PersonalizationStrategyParams.scala Maven / Gradle / Ivy

Go to download

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

Scala client for Algolia Search API

There is a newer version: 2.9.2

Show newest version

/** Personalization API The Personalization API lets you access user profiles built from the personalization strategy.
  * ## Base URLs The base URLs for requests to the Personalization API are: - `https://personalization.us.algolia.com` -
  * `https://personalization.eu.algolia.com` Use the URL that matches your [analytics
  * region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
  * Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
  * application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
  * access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
  * and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
  * be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
  * guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
  * return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
  * responses have a `message` property with more information. ## Version The current version of the Personalization API
  * is version 1, as indicated by the `/1/` in each endpoint's URL.
  *
  * The version of the OpenAPI document: 1.0.0
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech Do not edit the class manually.
  */
package algoliasearch.personalization

/** PersonalizationStrategyParams
  *
  * @param eventScoring
  *   Scores associated with each event. The higher the scores, the higher the impact of those events on the
  *   personalization of search results.
  * @param facetScoring
  *   Scores associated with each facet. The higher the scores, the higher the impact of those events on the
  *   personalization of search results.
  * @param personalizationImpact
  *   Impact of personalization on the search results. If set to 0, personalization has no impact on the search results.
  */
case class PersonalizationStrategyParams(
    eventScoring: Seq[EventScoring],
    facetScoring: Seq[FacetScoring],
    personalizationImpact: Int
)