voice-api

This is the API endpoint used by the voice-fe user interface. Search requests are transformed to CQL and then passed on to a separate NoSketchEngine instance. The official instance is not open to public access. But using the VOICE 3.0 XML files you can run your own instance.

xml

A swagger UI and an openapi.json endpoint is built into the API.

Short summary:

/xml/ - List Ids
/xml/LEcon329/file - Get XML-File
/xml/LEcon329/header - Get TEI Header
/xml/LEcon329/body - Get TEI Body
/xml/LEcon329/uid/LEcon329_u_15 - Get u-Tag
/xml/*/uid/LEcon329_u_15;LEcon329_u_16 - Get u-Tags from any Document

Dev

nodemon --inspect app.js

Local testing

To make sure your tests run in the AutoDevOps pipline you can test the test stage locally using your own docker instance like this

docker run --rm -v $(pwd):/tmp/app gliderlabs/herokuish /bin/herokuish buildpack test

docker run --rm -v ${PWD}:/tmp/app gliderlabs/herokuish /bin/herokuish buildpack test

Search engine

The search engine used here is the NoSketchEngine.

https://nlp.fi.muni.cz/trac/noske

Credits:

RYCHLÝ, Pavel. Manatee/Bonito-A Modular Corpus Manager. In: RASLAN. 2007. p. 65-70.

KILGARRIFF, Adam, et al. The Sketch Engine: Ten Years on. Lexicography, 2014, 1.1: 7-36.

The search engine used can be changed using the NOSKE_BONITO environment variable. e. g. NOSKE_BONITO=http://localhost:4000/bonito/run.cgi