caikit.interfaces.nlp.data_model.embedding_vectors
==================================================

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

.. autoapi-nested-parse::

   Data structures for embedding vector representations



Attributes
----------

.. autoapisummary::

   caikit.interfaces.nlp.data_model.embedding_vectors.log
   caikit.interfaces.nlp.data_model.embedding_vectors.error


Classes
-------

.. autoapisummary::

   caikit.interfaces.nlp.data_model.embedding_vectors.EmbeddingResult
   caikit.interfaces.nlp.data_model.embedding_vectors.EmbeddingResults


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

.. py:data:: log

.. py:data:: error

.. py:class:: EmbeddingResult

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


   Result from text embedding task


   .. py:attribute:: result
      :type:  py_to_proto.dataclass_to_proto.Annotated[caikit.interfaces.common.data_model.Vector1D, FieldNumber(1)]


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


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


.. py:class:: EmbeddingResults

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


   Results from text embeddings task


   .. py:attribute:: results
      :type:  py_to_proto.dataclass_to_proto.Annotated[caikit.interfaces.common.data_model.ListOfVector1D, FieldNumber(1)]


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


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