:py:mod:`api.serializers`
=========================

.. py:module:: api.serializers


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

Classes
~~~~~~~

.. autoapisummary::

   api.serializers.UserSerializer
   api.serializers.EntitySerializer
   api.serializers.RelationSerializer
   api.serializers.EntityRelationSerializer
   api.serializers.ModelPackSerializer
   api.serializers.MetaCATModelSerializer
   api.serializers.ConceptDBSerializer
   api.serializers.VocabularySerializer
   api.serializers.DatasetSerializer
   api.serializers.ProjectAnnotateEntitiesSerializer
   api.serializers.ProjectGroupSerializer
   api.serializers.DocumentSerializer
   api.serializers.AnnotatedEntitySerializer
   api.serializers.MetaAnnotationSerializer
   api.serializers.MetaTaskSerializer
   api.serializers.MetaTaskValueSerializer




Attributes
~~~~~~~~~~

.. autoapisummary::

   api.serializers.logger


.. py:data:: logger

   

.. py:class:: UserSerializer


   Bases: :py:obj:`rest_framework.serializers.HyperlinkedModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: ['url', 'username', 'email', 'id', 'is_staff', 'is_superuser']

         



.. py:class:: EntitySerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: RelationSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: EntityRelationSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: ModelPackSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: MetaCATModelSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: ConceptDBSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: VocabularySerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: DatasetSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   Serializer for Dataset model.

   Schema Requirements:
   - File format: .csv or .xlsx
   - Required columns:
     * name: A unique identifier for each document (string)
     * text: The free-text content to annotate (string)
   - Additional columns are allowed but will be ignored

   Example CSV structure:
   name,text
   doc001,"This is the first document to annotate."
   doc002,"This is the second document with medical text."

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         


   .. py:attribute:: original_file

      


.. py:class:: ProjectAnnotateEntitiesSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         


   .. py:attribute:: cuis_file

      

   .. py:method:: to_representation(instance)



.. py:class:: ProjectGroupSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         


   .. py:method:: to_representation(instance)



.. py:class:: DocumentSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: AnnotatedEntitySerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: MetaAnnotationSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: MetaTaskSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'

         



.. py:class:: MetaTaskValueSerializer


   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`

   .. py:class:: Meta


      .. py:attribute:: model

         

      .. py:attribute:: fields
         :value: '__all__'