poprox_concepts.api.recommendations.v3#

Classes

`ProtocolModelV3_0`(*[, protocol_version])	Version 3.0 of the POPROX protocol changed the return model of a recommendation to return a list of "sections"
`RecommendationList_v3`(*[, protocol_version, ...])
`RecommendationRequestV3`(*[, protocol_version])
`RecommendationResponseSection`(*, title, ...)
`RecommendationResponseV3`(*[, ...])

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

Bases: BaseModel

Version 3.0 of the POPROX protocol changed the return model of a recommendation to return a list of “sections”

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.v3.RecommendationRequestV3(*, protocol_version=ProtocolVersions.VERSION_3_0, candidates, interacted, interest_profile, num_recs)#

Bases: ProtocolModelV3_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.v3.RecommendationResponseSection(**data)#

Bases: BaseModel

Parameters:

data (Any)
title (str)
recommendations (RecommendationList_v3)

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

class poprox_concepts.api.recommendations.v3.RecommendationList_v3(*, protocol_version=ProtocolVersions.VERSION_3_0, impressions=<factory>, extras=<factory>)#

Bases: ProtocolModelV3_0

Parameters:

protocol_version (ProtocolVersions)
impressions (list[Impression])
extras (list[dict[str, JsonValue]])

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

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

Bases: ProtocolModelV3_0

Parameters:

protocol_version (ProtocolVersions)
recommendations (list[RecommendationResponseSection])
recommender (RecommenderInfo | None)

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