algoliasearch.personalization

Members list

Type members

Classlikes

case class DeleteUserProfileResponse(userToken: String, deletedUntil: String)

DeleteUserProfileResponse

DeleteUserProfileResponse

Value parameters

deletedUntil

A date until which the data can safely be considered as deleted for the given user. Any data received after the deletedUntil date will start building a new user profile.

userToken

userToken representing the user for which to fetch the Personalization profile.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ErrorBase(message: Option[String], additionalProperties: Option[List[JField]])

Error.

Error.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class ErrorBaseSerializer extends Serializer[ErrorBase]

Attributes

Supertypes
trait Serializer[ErrorBase]
class Object
trait Matchable
class Any
case class EventScoring(score: Int, eventName: String, eventType: String)

EventScoring

EventScoring

Value parameters

eventName

The name of the event.

eventType

The type of the event.

score

The score for the event.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class FacetScoring(score: Int, facetName: String)

FacetScoring

FacetScoring

Value parameters

facetName

The name of the facet.

score

The score for the event.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetUserTokenResponse(userToken: String, lastEventAt: String, scores: Any)

GetUserTokenResponse

GetUserTokenResponse

Value parameters

lastEventAt

Date of last event update. (ISO-8601 format).

scores

The userToken scores.

userToken

userToken representing the user for which to fetch the Personalization profile.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object JsonSupport

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class PersonalizationStrategyParams(eventScoring: Seq[EventScoring], facetScoring: Seq[FacetScoring], personalizationImpact: Int)

PersonalizationStrategyParams

PersonalizationStrategyParams

Value parameters

eventScoring

Scores associated with the events.

facetScoring

Scores associated with the facets.

personalizationImpact

The impact that personalization has on search results: a number between 0 (personalization disabled) and 100 (personalization fully enabled).

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SetPersonalizationStrategyResponse(message: String)

SetPersonalizationStrategyResponse

SetPersonalizationStrategyResponse

Value parameters

message

A message confirming the strategy update.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all