poprox_concepts.api.recommendations.v2#

Classes

`ProtocolModelV2_0`(*[, protocol_version])	Version 2.0 of the POPROX protocol changed the names of types of the fields representing interacted and candidate items, as well as the returned recommendations
`RecommendationRequestV2`(*[, protocol_version])
`RecommendationResponseV2`(*[, ...])

class poprox_concepts.api.recommendations.v2.ProtocolModelV2_0(*, protocol_version=ProtocolVersions.VERSION_2_0)#

Bases: BaseModel

Version 2.0 of the POPROX protocol changed the names of types of the fields representing interacted and candidate items, as well as the returned recommendations

Parameters:: protocol_version (ProtocolVersions)

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class poprox_concepts.api.recommendations.v2.RecommendationRequestV2(*, protocol_version=ProtocolVersions.VERSION_2_0, candidates, interacted, interest_profile, num_recs)#

Bases: ProtocolModelV2_0

Parameters:

protocol_version (ProtocolVersions)
candidates (CandidateSet)
interacted (CandidateSet)
interest_profile (InterestProfile)
num_recs (Annotated[int, Gt(gt=0)])

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class poprox_concepts.api.recommendations.v2.RecommendationResponseV2(*, protocol_version=ProtocolVersions.VERSION_2_0, recommendations, recommender=None)#

Bases: ProtocolModelV2_0

Parameters:

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

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].