abacusai.annotations_status
===========================

.. py:module:: abacusai.annotations_status


Classes
-------

.. autoapisummary::

   abacusai.annotations_status.AnnotationConfig
   abacusai.annotations_status.AbstractApiClass
   abacusai.annotations_status.AnnotationsStatus


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

.. py:class:: AnnotationConfig(client, featureAnnotationConfigs=None, labels=None, statusFeature=None, commentsFeatures=None, metadataFeature=None)

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   Annotation config for a feature group

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param featureAnnotationConfigs: List of feature annotation configs
   :type featureAnnotationConfigs: list
   :param labels: List of labels
   :type labels: list
   :param statusFeature: Name of the feature that contains the status of the annotation (Optional)
   :type statusFeature: str
   :param commentsFeatures: Features that contain comments for the annotation (Optional)
   :type commentsFeatures: list
   :param metadataFeature: Name of the feature that contains the metadata for the annotation (Optional)
   :type metadataFeature: str


   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict



.. py:class:: AbstractApiClass(client, id)

   .. py:method:: __eq__(other)

      Return self==value.



   .. py:method:: _get_attribute_as_dict(attribute)


.. py:class:: AnnotationsStatus(client, total=None, done=None, inProgress=None, todo=None, latestUpdatedAt=None, isMaterializationNeeded=None, latestMaterializedAnnotationConfig={})

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   The status of annotations for a feature group

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param total: The total number of documents annotated
   :type total: int
   :param done: The number of documents annotated
   :type done: int
   :param inProgress: The number of documents currently being annotated
   :type inProgress: int
   :param todo: The number of documents that need to be annotated
   :type todo: int
   :param latestUpdatedAt: The latest time an annotation was updated (ISO-8601 format)
   :type latestUpdatedAt: str
   :param isMaterializationNeeded: Whether feature group needs to be materialized before using for annotations
   :type isMaterializationNeeded: bool
   :param latestMaterializedAnnotationConfig: The annotation config corresponding to the latest materialized feature group
   :type latestMaterializedAnnotationConfig: AnnotationConfig


   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict



