caikit.interfaces.nlp.data_model.text_generation
================================================

.. py:module:: caikit.interfaces.nlp.data_model.text_generation

.. autoapi-nested-parse::

   Data structures for text generation representations



Attributes
----------

.. autoapisummary::

   caikit.interfaces.nlp.data_model.text_generation.log


Classes
-------

.. autoapisummary::

   caikit.interfaces.nlp.data_model.text_generation.FinishReason
   caikit.interfaces.nlp.data_model.text_generation.GeneratedToken
   caikit.interfaces.nlp.data_model.text_generation.GeneratedTextResult
   caikit.interfaces.nlp.data_model.text_generation.TokenStreamDetails
   caikit.interfaces.nlp.data_model.text_generation.GeneratedTextStreamResult


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

.. py:data:: log

.. py:class:: FinishReason(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: NOT_FINISHED
      :value: 0



   .. py:attribute:: MAX_TOKENS
      :value: 1



   .. py:attribute:: EOS_TOKEN
      :value: 2



   .. py:attribute:: CANCELLED
      :value: 3



   .. py:attribute:: TIME_LIMIT
      :value: 4



   .. py:attribute:: STOP_SEQUENCE
      :value: 5



   .. py:attribute:: TOKEN_LIMIT
      :value: 6



   .. py:attribute:: ERROR
      :value: 7



.. py:class:: GeneratedToken

   Bases: :py:obj:`caikit.core.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:: text
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]


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


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


.. py:class:: GeneratedTextResult

   Bases: :py:obj:`caikit.core.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:: generated_text
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]


   .. py:attribute:: generated_tokens
      :type:  py_to_proto.dataclass_to_proto.Annotated[int, FieldNumber(2)]


   .. py:attribute:: finish_reason
      :type:  py_to_proto.dataclass_to_proto.Annotated[FinishReason, FieldNumber(3)]


   .. py:attribute:: producer_id
      :type:  py_to_proto.dataclass_to_proto.Annotated[caikit.interfaces.common.data_model.ProducerId, FieldNumber(4)]


   .. py:attribute:: input_token_count
      :type:  py_to_proto.dataclass_to_proto.Annotated[int, FieldNumber(5)]


   .. py:attribute:: seed
      :type:  py_to_proto.dataclass_to_proto.Annotated[Optional[numpy.uint64], FieldNumber(6)]


   .. py:attribute:: tokens
      :type:  py_to_proto.dataclass_to_proto.Annotated[Optional[List[GeneratedToken]], FieldNumber(7)]


   .. py:attribute:: input_tokens
      :type:  py_to_proto.dataclass_to_proto.Annotated[Optional[List[GeneratedToken]], FieldNumber(8)]


.. py:class:: TokenStreamDetails

   Bases: :py:obj:`caikit.core.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:: finish_reason
      :type:  py_to_proto.dataclass_to_proto.Annotated[FinishReason, FieldNumber(1)]


   .. py:attribute:: generated_tokens
      :type:  py_to_proto.dataclass_to_proto.Annotated[numpy.uint32, FieldNumber(2)]


   .. py:attribute:: seed
      :type:  py_to_proto.dataclass_to_proto.Annotated[Optional[numpy.uint64], FieldNumber(3)]


   .. py:attribute:: input_token_count
      :type:  py_to_proto.dataclass_to_proto.Annotated[int, FieldNumber(4)]


.. py:class:: GeneratedTextStreamResult

   Bases: :py:obj:`caikit.core.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:: generated_text
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]


   .. py:attribute:: tokens
      :type:  py_to_proto.dataclass_to_proto.Annotated[Optional[List[GeneratedToken]], FieldNumber(2)]


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


   .. py:attribute:: producer_id
      :type:  py_to_proto.dataclass_to_proto.Annotated[caikit.interfaces.common.data_model.ProducerId, FieldNumber(4)]


   .. py:attribute:: input_tokens
      :type:  py_to_proto.dataclass_to_proto.Annotated[Optional[List[GeneratedToken]], FieldNumber(5)]