caikit.interfaces.runtime.data_model.prediction_job_management
==============================================================

.. py:module:: caikit.interfaces.runtime.data_model.prediction_job_management


Classes
-------

.. autoapisummary::

   caikit.interfaces.runtime.data_model.prediction_job_management.PredictionJobInfoRequest
   caikit.interfaces.runtime.data_model.prediction_job_management.PredictionJob
   caikit.interfaces.runtime.data_model.prediction_job_management.PredictionJobStatusResponse


Module Contents
---------------

.. py:class:: PredictionJobInfoRequest

   Bases: :py:obj:`caikit.core.data_model.DataObjectBase`


   DataModel to request information about a PredictionJob


   .. py:attribute:: prediction_id
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]


.. py:class:: PredictionJob

   Bases: :py:obj:`caikit.core.data_model.DataObjectBase`


   DataModel returned as a result of starting a PredictionJob


   .. py:attribute:: prediction_id
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]


.. py:class:: PredictionJobStatusResponse

   Bases: :py:obj:`caikit.core.data_model.DataObjectBase`


   DataModel representing the status of a PredictionJob


   .. py:attribute:: prediction_id
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]


   .. py:attribute:: state
      :type:  py_to_proto.dataclass_to_proto.Annotated[caikit.core.data_model.JobStatus, FieldNumber(2)]


   .. py:attribute:: submission_timestamp
      :type:  py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(3)]


   .. py:attribute:: completion_timestamp
      :type:  py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(4)]


   .. py:attribute:: reasons
      :type:  py_to_proto.dataclass_to_proto.Annotated[List[str], FieldNumber(5)]