From b07407d4aa47f86d10ac0c60d0f4c314dfe28683 Mon Sep 17 00:00:00 2001 From: Dennis Schiese <135758800+dschiese@users.noreply.github.com> Date: Sun, 18 Feb 2024 23:02:58 +0100 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 4f13f86..0093ce3 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,17 @@ This service is created for the qanary-explanations-service. It's used to read t ## Usage This service is used with the included Qanary-components repository as a submodule as it's path is hard-coded yet. To use this tool it is also required to use the Qanary-commons version provided in since this includes the log-writing to files. + + +## Prequisteries +This service uses the Qanary-components-repository as a submodule and these components should be used when running a Qanary pipeline. Therefore this approach is a local one. + +## Functioning +The service finds the paths to the local components where the log files are stored. In a scheduled method these log files are parsed and the queries are stored in a triplestore. The data which is stored follows this pattern: + +```sparql +?component ex:hasAnnotationType ?annotationType . +?annotationType ex:hasInputQuery ?inputQuery +``` + +Afterwards this data can be fetched to receive component, annotationType and the query. Within the qanary-explanation-service this data can be used to create explanation for input data.