api

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 RecommenderRequest with Product with Serializable

   

   A request to obtain a recommendation.

   A request to obtain a recommendation.

   query

   the query definition for the recommendation

3. case class GetRecommendationResponse(recommendation: Option[Recommendation]) extends RecommenderResponse with Product with Serializable

   

   The response for a GetRecommendation request.

   The response for a GetRecommendation request.

   recommendation

   a recommendation wrapped a Some if a recommendation was available, None otherwise

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

   

   A query to obtain a recommendation for a product.

   A query to obtain a recommendation for a product.

   productId

   the identifier of the product

   clientId

   the identifier of the client

   siteId

   the identifier of the site

   uidToSegment

   the user identififer 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

   

   A product recommendation.

   A product recommendation.

   userId

   the identifier of the queried user wrapped in a Some if the recommendation is for a user, None otherwise

   productId

   the identifier of the queried product wrapped in a Some if the recommendation is for a product, None otherwise

   clientId

   the identifier of the client

   siteId

   the identifier of the site

   recommendedProductIds

   the recommended product identifiers

   timestamp

   the time the recommendation was issued

6. sealed trait RecommendationQuery extends AnyRef

   

   A specification of a recommendation query.

7. trait RecommenderClient extends AnyRef

   

   Interface for clients capable of interacting with the Recommender module for retrieving recommendations for users or other products.

8. sealed trait RecommenderRequest extends AnyRef

   

   A request to be sent to the Recommender module.

9. sealed trait RecommenderResponse extends AnyRef

   

   A response from the Recommender module to a RecommenderRequest.

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

    

    A query to obtain a recommendation for a user.

    A query to obtain a recommendation for a user.

    userId

    the identifier of the user

    clientId

    the identifier of the client

    siteId

    the identifier of the site

    features

    the features related to this query