`api.views`

Module Contents

Classes

`TextInFilter`
`NumInFilter`
`UserViewSet`	API endpoint that allows users to be viewed or edited.
`ProjectAnnotateEntitiesViewSet`
`ProjectGroupFilter`
`ProjectGroupViewSet`
`AnnotatedEntityFilter`
`AnnotatedEntityViewSet`
`MetaTaskValueViewSet`
`MetaTaskViewSet`
`MetaAnnotationViewSet`
`DocumentViewSet`
`EntityViewSet`
`RelationFilter`
`RelationViewSet`
`EntityRelationViewSet`
`ConceptDBViewSet`
`VocabularyViewSet`
`ModelPackViewSet`
`DatasetViewSet`	ViewSet for managing datasets.
`ResetPasswordView`
`ResetPasswordView`

Functions

`index`(request)
`get_anno_tool_conf`(_)
`prepare_documents`(request)
`prepare_documents_bg`(request)
`prepare_docs_bg_tasks`(_)
`prepare_docs_bg_task`(request, proj_id)
`add_annotation`(request)
`add_concept`(request)
`import_cdb_concepts`(request)
`_submit_document`(project, document)
`submit_document`(request)
`save_models`(request)
`get_create_entity`(request)
`create_dataset`(request)	Upload a dataset and kick off document creation for each Doc. The dataset should be dict of form:
`update_meta_annotation`(request)
`annotate_text`(request)
`download_annos`(request)
`behind_reverse_proxy`(_)
`version`(_)
`concept_search_index_available`(request)
`search_solr`(request)
`upload_deployment`(request)
`cache_project_model`(request, project_id)
`cache_modelpack`(request, modelpack_id)
`model_loaded`(_)
`metrics_jobs`(request)
`remove_metrics_job`(request, report_id)
`view_metrics`(request, report_id)
`cdb_cui_children`(request, cdb_id)
`cdb_concept_path`(request)
`generate_concept_filter_flat_json`(request)
`generate_concept_filter`(request)
`cuis_to_concepts`(request)
`project_progress`(request)
`project_admin_projects`(request)	Get all projects where the user is a project admin.
`project_admin_detail`(request, project_id)	Get, update, or delete a project (only if user is project admin).
`project_admin_create`(request)	Create a new project (user must be authenticated).
`project_admin_clone`(request, project_id)	Clone a project (user must be authenticated and have permission).
`project_admin_reset`(request, project_id)	Reset a project (clear all annotations) - only if user is project admin.

Attributes

`logger`
`logger`
`cat`

api.views.logger: from environs import Env env = Env() env.read_env(“/home/ubuntu/projects/MedAnno/MedAnno/env_umls”, recurse=False) print(os.environ)

api.views.logger

api.views.cat

api.views.index(request)

class api.views.TextInFilter: Bases: django_filters.rest_framework.BaseInFilter, django_filters.rest_framework.CharFilter

class api.views.NumInFilter: Bases: django_filters.rest_framework.BaseInFilter, django_filters.rest_framework.NumberFilter

class api.views.UserViewSet

Bases: rest_framework.viewsets.ModelViewSet

API endpoint that allows users to be viewed or edited.

permission_classes

http_method_names = ['get', 'post', 'put']

queryset

serializer_class

filterset_fields = ['username']

class api.views.ProjectAnnotateEntitiesViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'post', 'put']

queryset

serializer_class

filterset_fields = ['members', 'dataset', 'id', 'project_status', 'annotation_classification']

get_queryset()

class api.views.ProjectGroupFilter

Bases: django_filters.rest_framework.FilterSet

class Meta

model

fields = ['id', 'name', 'description']

id__in

class api.views.ProjectGroupViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

queryset

serializer_class

filterset_fields = ['id']

filterset_class

class api.views.AnnotatedEntityFilter

Bases: django_filters.rest_framework.FilterSet

class Meta

model

fields = ['id', 'user', 'project', 'document', 'entity', 'validated', 'deleted']

id__in

class api.views.AnnotatedEntityViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

queryset

serializer_class

filterset_class

class api.views.MetaTaskValueViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'head', 'post', 'put']

queryset

serializer_class

class api.views.MetaTaskViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'head', 'post', 'put']

queryset

serializer_class

class api.views.MetaAnnotationViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'head', 'post', 'put', 'delete']

queryset

serializer_class

filterset_fields = ['id', 'annotated_entity', 'validated']

class api.views.DocumentViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

queryset

serializer_class

filterset_fields = ['dataset']

class api.views.EntityViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'post', 'head']

queryset

serializer_class

class api.views.RelationFilter

Bases: django_filters.rest_framework.FilterSet

class Meta

model

fields = ['label']

id__in

class api.views.RelationViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'post', 'head']

queryset

serializer_class

filterset_class

class api.views.EntityRelationViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'post', 'put', 'head', 'delete']

queryset

serializer_class

filterset_fields = ['project', 'document']

class api.views.ConceptDBViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'post', 'head', 'delete']

queryset

serializer_class

perform_create(serializer)

class api.views.VocabularyViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'post', 'head', 'delete']

queryset

serializer_class

class api.views.ModelPackViewSet

Bases: rest_framework.viewsets.ModelViewSet

permission_classes

http_method_names = ['get', 'post', 'head', 'delete']

queryset

serializer_class

class api.views.DatasetViewSet

Bases: rest_framework.viewsets.ModelViewSet

ViewSet for managing datasets.

File Schema Requirements: - Format: .csv or .xlsx file - Required columns:

name: A unique identifier for each document

text: The free-text content to annotate

Example CSV: name,text doc001,”First document text” doc002,”Second document text”

permission_classes

http_method_names = ['get', 'post', 'put', 'patch', 'delete']

queryset

serializer_class

class api.views.ResetPasswordView

Bases: django.contrib.auth.views.PasswordResetView

email_template_name = 'password_reset_email.html'

subject_template_name = 'password_reset_subject.txt'

post(request, *args, **kwargs)

class api.views.ResetPasswordView

Bases: django.contrib.auth.views.PasswordResetView

email_template_name = 'password_reset_email.html'

subject_template_name = 'password_reset_subject.txt'

post(request, *args, **kwargs)

api.views.get_anno_tool_conf(_)

api.views.prepare_documents(request)

api.views.prepare_documents_bg(request)

api.views.prepare_docs_bg_tasks(_)

api.views.prepare_docs_bg_task(request, proj_id)

api.views.add_annotation(request)

api.views.add_concept(request)

api.views.import_cdb_concepts(request)

api.views._submit_document(project, document)

Parameters:

project (api.permissions.ProjectAnnotateEntities) –
document (Document) –

api.views.submit_document(request)

api.views.save_models(request)

api.views.get_create_entity(request)

api.views.create_dataset(request)

Upload a dataset and kick off document creation for each Doc. The dataset should be dict of form: {

‘name’: [‘name1’, ‘name2’, ‘name3’, … ], ‘text’: [‘text1…’, ‘text2…’, ‘text3…’, … ]

} Args:

request: the HTTP request

Response:: An HTTP resonse with the id of the created dataset

api.views.update_meta_annotation(request)

api.views.annotate_text(request)

api.views.download_annos(request)

api.views.behind_reverse_proxy(_)

api.views.version(_)

api.views.concept_search_index_available(request)

api.views.search_solr(request)

api.views.upload_deployment(request)

api.views.cache_project_model(request, project_id)

api.views.cache_modelpack(request, modelpack_id)

Parameters:: modelpack_id (int) –

api.views.model_loaded(_)

api.views.metrics_jobs(request)

api.views.remove_metrics_job(request, report_id)

Parameters:: report_id (int) –

api.views.view_metrics(request, report_id)

api.views.cdb_cui_children(request, cdb_id)

api.views.cdb_concept_path(request)

api.views.generate_concept_filter_flat_json(request)

api.views.generate_concept_filter(request)

api.views.cuis_to_concepts(request)

api.views.project_progress(request)

api.views.project_admin_projects(request): Get all projects where the user is a project admin.

api.views.project_admin_detail(request, project_id): Get, update, or delete a project (only if user is project admin).

api.views.project_admin_create(request): Create a new project (user must be authenticated).

api.views.project_admin_clone(request, project_id): Clone a project (user must be authenticated and have permission).

api.views.project_admin_reset(request, project_id): Reset a project (clear all annotations) - only if user is project admin. This is equivalent to the reset_project admin action.

api.views

Module Contents

Classes

Functions

Attributes

`api.views`