logo
Documentation Powered by ReDoc

NLP Sandbox COVID Symptom Annotator API (1.2.0)

Download OpenAPI specification:Download

NLP Sandbox Team: team@nlpsandbox.io URL: https://nlpsandbox.io License: Apache 2.0

Introduction

A COVID symptom annotator takes as input a clinical note and outputs a list of predicted COVID-19 sign and symptom annotations found in the clinical note. This OpenAPI document describes the specification of the NLP Sandbox COVID Symptom Annotator API. This specification includes the schemas of the input and output data, and the requirements that this annotator must meet if you want to benchmark its performance on nlpsandbox.io.

Getting Started

The GitHub repository nlpsandbox/covid-symptom-annotator-example provides an example implementation of the NLP Sandbox COVID Symptom Annotator API in Python-Flask. By the end of the tutorial available in the README, you will have built a Docker image for this NLP Sandbox tool. You will then be able to submit this image to nlpsandbox.io to benchmark its performance.

Benchmarking Requirements

Your NLP Sandbox tool must meet the following requirements before evaluating its performance on nlpsandbox.io.

  • The endpoint / must redirect to /api/v1/tool.

  • The endpoint /ui must redirect to the Swagger User Interface (UI).

  • The output of this tool must be reproducible: a given input should always generate the same output.

  • To ensure the results are reproducible and robust, and the data are secured, this tool must not connect to any remote server. When benchmarked on nlpsandbox.io, this tool will not be able to connect to remote servers.

HealthCheck

Operations about health checks

Get health check information

Get information about the health of the service

Responses

Response samples

Content type
application/json
{
  • "status": "pass"
}

TextCovidSymptomAnnotation

Operations about COVID symptom annotations

Annotate COVID symptoms in a clinical note

Return the COVID symptom annotations found in a clinical note

Request Body schema: application/json
required
object (Note)

A clinical note

Responses

Request samples

Content type
application/json
{
  • "note": {
    }
}

Response samples

Content type
application/json
{
  • "textCovidSymptomAnnotations": [
    ]
}

Tool

Operations about this tool

Get tool information

Get information about the tool

Responses

Response samples

Content type
application/json
{
  • "name": "awesome-nlp-tool",
  • "version": "1.0.6",
  • "license": "apache-2.0",
  • "repository": "github:awesome-org/awesome-nlp-tool",
  • "description": "An awesome NLP Tool that takes as input X and outputs Y.",
  • "author": "Awesome Team",
  • "authorEmail": "author@example.com",
  • "url": "https://example.com",
  • "type": "nlpsandbox:date-annotator",
  • "apiVersion": "1.2.0"
}

Get tool dependencies

Get the dependencies of this tool

Responses

Response samples

Content type
application/json
{
  • "tools": [
    ]
}