the-algorithm/product-mixer/core/src/main/scala/com/twitter/product_mixer/core/pipeline/recommendation/RecommendationPipeline.scala
twitter-team ef4c5eb65e Twitter Recommendation Algorithm
Please note we have force-pushed a new initial commit in order to remove some publicly-available Twitter user information. Note that this process may be required in the future.
2023-03-31 17:36:31 -05:00

30 lines
1.2 KiB
Scala

package com.twitter.product_mixer.core.pipeline.recommendation
import com.twitter.product_mixer.core.model.common.UniversalNoun
import com.twitter.product_mixer.core.model.common.identifier.RecommendationPipelineIdentifier
import com.twitter.product_mixer.core.pipeline.Pipeline
import com.twitter.product_mixer.core.pipeline.PipelineQuery
import com.twitter.stitch.Arrow
/**
* A Recommendation Pipeline
*
* This is an abstract class, as we only construct these via the [[RecommendationPipelineBuilder]].
*
* A [[RecommendationPipeline]] is capable of processing requests (queries) and returning responses (results)
* in the correct format to directly send to users.
*
* @tparam Query the domain model for the query or request
* @tparam Candidate the type of the candidates
* @tparam Result the final marshalled result type
*/
abstract class RecommendationPipeline[
Query <: PipelineQuery,
Candidate <: UniversalNoun[Any],
Result]
extends Pipeline[Query, Result] {
override private[core] val config: RecommendationPipelineConfig[Query, Candidate, _, Result]
override val arrow: Arrow[Query, RecommendationPipelineResult[Candidate, Result]]
override val identifier: RecommendationPipelineIdentifier
}