api.serializers

Module Contents

Classes

UserSerializer

EntitySerializer

RelationSerializer

EntityRelationSerializer

ModelPackSerializer

MetaCATModelSerializer

ConceptDBSerializer

VocabularySerializer

DatasetSerializer

Serializer for Dataset model.

ProjectAnnotateEntitiesSerializer

ProjectGroupSerializer

DocumentSerializer

AnnotatedEntitySerializer

MetaAnnotationSerializer

MetaTaskSerializer

MetaTaskValueSerializer

Attributes

logger

api.serializers.logger
class api.serializers.UserSerializer

Bases: rest_framework.serializers.HyperlinkedModelSerializer

class Meta
model
fields = ['url', 'username', 'email', 'id', 'is_staff', 'is_superuser']
class api.serializers.EntitySerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.RelationSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.EntityRelationSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.ModelPackSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.MetaCATModelSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.ConceptDBSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.VocabularySerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.DatasetSerializer

Bases: 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.”

class Meta
model
fields = '__all__'
original_file
class api.serializers.ProjectAnnotateEntitiesSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
cuis_file
to_representation(instance)
class api.serializers.ProjectGroupSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
to_representation(instance)
class api.serializers.DocumentSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.AnnotatedEntitySerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.MetaAnnotationSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.MetaTaskSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'
class api.serializers.MetaTaskValueSerializer

Bases: rest_framework.serializers.ModelSerializer

class Meta
model
fields = '__all__'