caikit.interfaces.runtime.data_model.info
=========================================

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

.. autoapi-nested-parse::

   This file contains interfaces to handle information requests



Attributes
----------

.. autoapisummary::

   caikit.interfaces.runtime.data_model.info.log
   caikit.interfaces.runtime.data_model.info.RUNTIME_PACKAGE


Classes
-------

.. autoapisummary::

   caikit.interfaces.runtime.data_model.info.RuntimeInfoRequest
   caikit.interfaces.runtime.data_model.info.RuntimeInfoResponse
   caikit.interfaces.runtime.data_model.info.ModelInfoRequest
   caikit.interfaces.runtime.data_model.info.ModelInfo
   caikit.interfaces.runtime.data_model.info.ModelInfoResponse


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

.. py:data:: log

.. py:data:: RUNTIME_PACKAGE
   :value: 'caikit_data_model.common.runtime'


.. py:class:: RuntimeInfoRequest

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


   Empty request for runtime server information


.. py:class:: RuntimeInfoResponse

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


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


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


   .. py:attribute:: python_packages
      :type:  py_to_proto.dataclass_to_proto.Annotated[Dict[str, str], FieldNumber(2)]


.. py:class:: ModelInfoRequest

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


   Empty request for runtime server information


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


.. py:class:: ModelInfo

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


   Information regarding a specific Model instance


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


   .. py:attribute:: name
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(2)]


   .. py:attribute:: size
      :type:  py_to_proto.dataclass_to_proto.Annotated[Optional[int], FieldNumber(3)]


   .. py:attribute:: metadata
      :type:  py_to_proto.dataclass_to_proto.Annotated[Optional[caikit.core.data_model.json_dict.JsonDict], FieldNumber(4)]


   .. py:attribute:: loaded
      :type:  py_to_proto.dataclass_to_proto.Annotated[bool, FieldNumber(7)]


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


   .. py:attribute:: module_metadata
      :type:  py_to_proto.dataclass_to_proto.Annotated[Optional[Dict[str, str]], FieldNumber(6)]


.. py:class:: ModelInfoResponse

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


   Model Info response contains a list of ModelInfos


   .. py:attribute:: models
      :type:  py_to_proto.dataclass_to_proto.Annotated[List[ModelInfo], FieldNumber(1)]