readme.md 882 Bytes
Newer Older
Sebastian Seufert's avatar
Sebastian Seufert committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
### Prerequisites ###
Check that SWI-Prolog has version `8.2.2` or higher.

### Starting

You can start the server using `run.pl`, starting a listener on port `4444` with a thread pool of 5 workers.

### Overview

The basic idea is to encapsulate the core logic into a web-based API that receives and responds JSON objects:

```mermaid
sequenceDiagram
    participant Client
    
    participant API
    Client->>API: HTTP Request
    API-->>Theory: Query
    loop Rules & Learning
        Theory-->>Theory: Irrelevancy / Explanation
    end
    Theory-->>API: Query Results
    API->>Client: HTTP Response
```

### Documentation ###

Ongoing. Please check the [Wiki](https://gitlab.rz.uni-bamberg.de/cogsys/dare2del/demonstrator/-/wikis/home) in the meantime.

Details that might change:

* Minor details in the JSON schemata
* HTTP status codes 
* Error and Exception Handling
Sebastian Seufert's avatar
moving  
Sebastian Seufert committed
35 36 37