poprox_concepts.api.recommendations.v3#

Classes

`ProtocolModelV3_0`(*[, protocol_version])	Version 3.0 of the POPROX protocol has embeddings in recommendation requests.
`RecommendationRequestV3`(*[, protocol_version])
`RecommendationResponseV3`(*[, ...])

class poprox_concepts.api.recommendations.v3.ProtocolModelV3_0(*, protocol_version=ProtocolVersions.VERSION_3_0)#

Bases: BaseModel

Version 3.0 of the POPROX protocol has embeddings in recommendation requests.

Parameters:: protocol_version (ProtocolVersions)

class poprox_concepts.api.recommendations.v3.RecommendationRequestV3(*, protocol_version=ProtocolVersions.VERSION_3_0, candidates, interacted, interest_profile, num_recs, embeddings)#

Bases: ProtocolModelV3_0

Parameters:

protocol_version (ProtocolVersions)
candidates (CandidateSet)
interacted (CandidateSet)
interest_profile (InterestProfile)
num_recs (Annotated[int, Gt(gt=0)])
embeddings (dict[UUID, dict[str, list[float]]])

class poprox_concepts.api.recommendations.v3.RecommendationResponseV3(*, protocol_version=ProtocolVersions.VERSION_3_0, recommendations, recommender=None)#

Bases: ProtocolModelV3_0

Parameters:

protocol_version (ProtocolVersions)
recommendations (RecommendationList)
recommender (RecommenderInfo | None)