-
Notifications
You must be signed in to change notification settings - Fork 2
Web
Serves the web-app and is the only endpoint for it. So every request by the frontend is directed to this module, which then calls the other modules as they are needed. For example: if a file is uploaded, the frontend sends it to the anonml-web module, which then sends it to the document-management module to set up the Document object. The annotation services of the recognition-ml and the recognition-rulebase modules are also called to update the document with anonymization suggestions. Basically the anonml-web module leads the most requests between the modules to keep it organized.
There are no additional dependencies.
mvn clean install
Hint: to use it locally it is necessary to set the local property in the application.properties file to true
The Frontend can be accessed via http://localhost:9000/anonml. The Api paths which are accessed by the frontend and by the admin ui.
| Method | Path | Result | Comment |
|---|---|---|---|
| GET | /anonml/ | the index page of the frontend | to deliver the frontend code |
| GET | /api/save/{id} | opens window to save the anonymized document | expects the id of the document to export |
| GET | /document/{id} | id of document is saved to get loaded by the frontend | expects the id of the document |
| GET | /api/get/document | returns the saved document or null if non was saved | |
| GET | /api/reset/id | removes the saved document id | |
| GET | /overview | redirects to the admin overview page | absolute or relative, depends on properties |
| GET | /admin | redirects to the admin page | absolute or relative, depends on properties |
| GET | /ml/retrain/ | true if retraining was successful | starts the retraining process of GermaNER with the saved training data |
| GET | /api/labels | list of Labels | |
| GET | /api/document/{id} | reload the document if the version is outdated | expects id of the document |
| POST | /api/upload | the resulting Document object | calls the annotation services to get anonymization suggestions |
| POST | /api/update/anonymizations/{id}/{version} | true if the updating worked | expects the document id and the version of the document in the path and the manually corrected list of Anonymization objects as request body; Evaluation data is calculated; Training data is expanded |