REST API

The reader can be used through the REST API. After building the docker image, launch a container using the following command:

docker run --name="logx-reader" \
  -it \
  --restart "on-failure" \
  -e "HOME=/app" \
  -p "0.0.0.0:9000:9000" \
  "gitlab-registry.logx.cloud/team/bbn/logx-reader:latest"

Navigate to localhost:9000/api to interactively explore the API through the OpenAPI 3.0 specification.

API Endpoints and Examples

The main endpoint is /api/extract, which returns a json file of extracted mentions over the query.

Endpoint	Example
/api/extract	Github Gist
/api/annotate	Github Gist
/api/parse-query	Github Gist
/api/taxonomy/hyponyms-for	Github Gist
/api/taxonomy/hypernyms-for	Github Gist

Common Workflows

• Extraction from documents: To extract over a document we use a python package, doculist, to convert documents (PDF, Word, HTML, etc) to a structured format available to the LogX-Reader. The system is then run over the document iteratively.