caikit.runtime.servicers.prediction_job_management_servicer
===========================================================

.. py:module:: caikit.runtime.servicers.prediction_job_management_servicer


Attributes
----------

.. autoapisummary::

   caikit.runtime.servicers.prediction_job_management_servicer.log


Classes
-------

.. autoapisummary::

   caikit.runtime.servicers.prediction_job_management_servicer.PredictionJobManagementServicerImpl


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

.. py:data:: log

.. py:class:: PredictionJobManagementServicerImpl

   This class contains the implementation of all of the RPCs that are required to manage
   a prediction job. This includes fetching status, cancelling jobs, and getting the results.


   .. py:method:: GetPredictionJobResult(request: caikit.interfaces.runtime.data_model.PredictionJobInfoRequest, context, *_, **__) -> Union[google.protobuf.message.Message, Iterable[google.protobuf.message.Message]]

      Get the result of a prediction job by ID



   .. py:method:: GetPredictionJobStatus(request: caikit.interfaces.runtime.data_model.PredictionJobInfoRequest, context, *_, **__)

      Get the status of a prediction job ID



   .. py:method:: CancelPredictionJob(request: caikit.interfaces.runtime.data_model.PredictionJobInfoRequest, context, *_, **__)

      Cancel a prediction job.



   .. py:method:: get_prediction_result(prediction_id: str) -> caikit.core.DataObjectBase

      Get the result of a job by ID



   .. py:method:: get_prediction_status(prediction_id: str) -> caikit.interfaces.runtime.data_model.PredictionJobStatusResponse

      Get the status of a job by ID



   .. py:method:: cancel_prediction(prediction_id: str) -> caikit.interfaces.runtime.data_model.PredictionJobStatusResponse

      Cancel a prediction job.



   .. py:method:: _get_prediction_future(prediction_id: str, operation: str)
      :staticmethod:


      Returns a model future, or raises 404 caikit runtime exception on error.
      Wrapped here so that we only catch errors directly in the `predictor.get_prediction_future`
      call