caikit.interfaces.nlp.data_model.sentence_similarity
====================================================

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

.. autoapi-nested-parse::

   Data structures for embedding vector representations



Attributes
----------

.. autoapisummary::

   caikit.interfaces.nlp.data_model.sentence_similarity.log
   caikit.interfaces.nlp.data_model.sentence_similarity.error


Classes
-------

.. autoapisummary::

   caikit.interfaces.nlp.data_model.sentence_similarity.SentenceSimilarityScores
   caikit.interfaces.nlp.data_model.sentence_similarity.SentenceSimilarityResult
   caikit.interfaces.nlp.data_model.sentence_similarity.SentenceSimilarityResults


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

.. py:data:: log

.. py:data:: error

.. py:class:: SentenceSimilarityScores

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


   Scores for a sentence similarity task


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


.. py:class:: SentenceSimilarityResult

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


   Result for sentence similarity task


   .. py:attribute:: result
      :type:  py_to_proto.dataclass_to_proto.Annotated[SentenceSimilarityScores, 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:: SentenceSimilarityResults

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


   Results list for sentence similarity tasks


   .. py:attribute:: results
      :type:  py_to_proto.dataclass_to_proto.Annotated[List[SentenceSimilarityScores], 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)]