lenskit.batch.BatchRecRequest

class lenskit.batch.BatchRecRequest

Bases: TypedDict

Full recommendation request for batch inference, including candidate items.

Stability:

Full (see Stability Levels).

query: lenskit.data.RecQuery

Recommendation query.

user_id: lenskit.data.ID

User ID (ignored if query is specified).

query_id: lenskit.data.ID | lenskit.data.GenericKey

Query ID (ignored if query is specified, defaults to user ID).

items: lenskit.data.ItemList

The items to score or possibly recommend. It is usually better to supply candidates and/or test_items.

candidates: lenskit.data.ItemList

Candidate items for the recommendations. Overrides items for top-N recommendation.

test_items: lenskit.data.ItemList

Test items for the recommendation query. Overrides items for scoring or rating prediction.