algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.personalization

algoliasearch.personalization

package algoliasearch.personalization

Members list

Type members

Classlikes

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

DeleteUserProfileResponse

DeleteUserProfileResponse

Value parameters

deletedUntil

Date and time when the user profile can be safely considered to be deleted. Any events received after the deletedUntil date start a new user profile.

userToken

Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see user token.

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: EventType)

EventScoring

EventScoring

Value parameters

eventName

Event name.

score

Event score.

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Click.type
object Conversion.type
object View.type
object EventType

Event type.

Event type.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
EventType.type
class EventTypeSerializer extends CustomSerializer[EventType]

Attributes

Supertypes
class CustomSerializer[EventType]
trait Serializer[EventType]
class Object
trait Matchable
class Any
case class FacetScoring(score: Int, facetName: String)

FacetScoring

FacetScoring

Value parameters

facetName

Facet attribute name.

score

Event score.

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 and time of the last event from this user, in RFC 3339 format.

scores

Scores for different facet values. Scores represent the user affinity for a user profile towards specific facet values, given the personalization strategy and past events.

userToken

Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see user token.

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 each event. The higher the scores, the higher the impact of those events on the personalization of search results.

facetScoring

Scores associated with each facet. The higher the scores, the higher the impact of those events on the personalization of search results.

personalizationImpact

Impact of personalization on the search results. If set to 0, personalization has no impact on the search results.

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
Generated with