recommender

Type Members

1. class Features extends AnyRef

   

   A set of features that can be extracted to improve recommendations

2. case class GetRecommendation(query: RecommendationQuery) extends RecommenderOperation with Product with Serializable

   

   Gets a recommendation.

   Gets a recommendation.

   query

   the query for the recommendation (userId, siteId, ...)

3. case class GetRecommendationResult(recommendationResult: Option[Recommendation]) extends RecommenderResult with Product with Serializable

   

4. case class ProductRecommendationQuery(productId: String, clientId: Option[String], siteId: Option[String], uidToSegment: Option[String] = None, features: Option[Features] = None) extends RecommendationQuery with Product with Serializable

   

   Represents a query to retrieve a recommendation for a product id.

   Represents a query to retrieve a recommendation for a product id.

   productId

   the product Id

   clientId

   the client Id or None

   siteId

   the site Id or None

   uidToSegment

   the user Id to be used for segmentation

   features

   the features related to this query

5. case class Recommendation(userId: Option[String], productId: Option[String], clientId: Option[String] = None, siteId: Option[String] = None, recommendedProductIds: Seq[String] = List.empty, timestamp: Option[String] = None) extends Product with Serializable

   

   Represents a recommendation.

   Represents a recommendation.

   userId

   user ID

   productId

   product ID (query)

   clientId

   client ID

   siteId

   site ID

   recommendedProductIds

   recommended product IDs

   timestamp

   timestamp

6. sealed trait RecommendationQuery extends AnyRef

   

7. sealed trait RecommenderOperation extends AnyRef

   

   Represents a supported operation of the RecommenderActor.

8. sealed trait RecommenderResult extends AnyRef

   

   Represents a supported response from the RecommenderActor

9. trait RecommenderRmqRpcClient extends RmqRpcJsonClient

   

10. case class UpdateRecommendations(dateTime: com.github.nscala_time.time.Imports.DateTime, clientId: Option[String] = None, siteId: Option[String] = None) extends RecommenderOperation with Product with Serializable

    

    Updates recommendations in bulk, for a given clientId and siteId, if provided.

    Updates recommendations in bulk, for a given clientId and siteId, if provided.

    dateTime

    the timestamp for which to update recommendations. This should enforce that only events prior to the provided timestamp are considered for the new recommendations

    clientId

    the optional clientId, in order to filter events

    siteId

    the optional siteId, in order to filter events

11. case class UserRecommendationQuery(userId: String, clientId: Option[String], siteId: Option[String], features: Option[Features] = None) extends RecommendationQuery with Product with Serializable

    

    Represents a query to retrieve a recommendation for a user id.

    Represents a query to retrieve a recommendation for a user id.

    userId

    the user Id

    clientId

    the client Id or None

    siteId

    the siteId or None

    features

    the features related to this query