Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dschiese authored Feb 18, 2024
1 parent 537e6e0 commit b07407d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <INSERT-HERE> 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.

0 comments on commit b07407d

Please sign in to comment.