lenskit.batch.BatchRecRequest
=============================

.. py:class:: lenskit.batch.BatchRecRequest
   :canonical: lenskit.batch._queries.BatchRecRequest

   Bases: :py:obj:`TypedDict`


   Full recommendation request for batch inference, including candidate items.

   :Stability: Full


   .. py:attribute:: query
      :type:  lenskit.data.RecQuery

      Recommendation query.


   .. py:attribute:: user_id
      :type:  lenskit.data.ID

      User ID (ignored if :attr:`query` is specified).


   .. py:attribute:: query_id
      :type:  lenskit.data.ID | lenskit.data.GenericKey

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


   .. py:attribute:: items
      :type:  lenskit.data.ItemList

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


   .. py:attribute:: candidates
      :type:  lenskit.data.ItemList

      Candidate items for the recommendations.  Overrides :attr:`items` for
      top-*N* recommendation.


   .. py:attribute:: test_items
      :type:  lenskit.data.ItemList

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