poprox_concepts.api.recommendations.v1

Classes

ProtocolModelV1_1(*[, protocol_version])	Version 1.1 of the POPROX protocol added the recommender field to RecommendationResponse to allow the platform to track which specific recommendation pipeline generated the returned recommendations
RecommendationRequestV1(*[, protocol_version])
RecommendationResponseV1(*[, ...])

class poprox_concepts.api.recommendations.v1.ProtocolModelV1_1(*, protocol_version=ProtocolVersions.VERSION_1_1)

Bases: BaseModel

Version 1.1 of the POPROX protocol added the recommender field to RecommendationResponse to allow the platform to track which specific recommendation pipeline generated the returned recommendations

Parameters:

protocol_version (ProtocolVersions)

class poprox_concepts.api.recommendations.v1.RecommendationRequestV1(*, protocol_version=ProtocolVersions.VERSION_1_1, todays_articles, past_articles, interest_profile, num_recs)

Bases: ProtocolModelV1_1

Parameters:

• protocol_version (ProtocolVersions)

• todays_articles (list[Article])

• past_articles (list[Article])

• interest_profile (InterestProfile)

• num_recs (Annotated[int, Gt(gt=0)])

class poprox_concepts.api.recommendations.v1.RecommendationResponseV1(*, protocol_version=ProtocolVersions.VERSION_1_1, recommendations, recommender=None)

Bases: ProtocolModelV1_1

Parameters:

• protocol_version (ProtocolVersions)

• recommendations (dict[UUID, list[Article]])

• recommender (RecommenderInfo | None)