psi/README.md

# projekt-sztuczna-inteligencja

Projekt realizuje emulację agenta (oraz jego środowiska) poruszającego się po dyskretnej przestrzeni sklepu. Jego zadaniem jest rozkładanie produktów w celu maksymalizacji zysku właścicieli sklepu.

Preferowaną przeglądarkami do interakcji z projektem (na dzień 24.05.2021) są te korzystające z silnika [Blink](https://en.wikipedia.org/wiki/Blink_(browser_engine)) takie jak:
- [Chromium](https://www.chromium.org/)
- [Brave](https://brave.com/)
- [Vivaldi](https://vivaldi.com/)

## Uruchomienie projektu

Wymaga Pythona oraz pip.

Należy zainstalować zależności:
```sh
pip install -r requirements.txt
```

A następnie uruchomić serwer
```sh
cd src
python3 main.py
```

## Interakcja z projektem

Serwer prezentuje się na [http://localhost:5000](http://localhost:5000). Dostępne są następujące ścieżki API:
- `GET /api/types` - lista wszystkich możliwych kategorii i ich wartości
- `GET /api/types/<type>` - wartości danego typu `type`, np `/api/types/polka`
- `GET /api/types/defaults` - domyslne wartości wylistowane dla wszystkich typów
- `POST /api/decide` - przyjmuje `application/json` opisujące produkt i zwraca rodzaj półki na jaki produkt ma trafić. Przykładowe wartości znajdują się w pliku [test.sh](src/branch/main/test.sh)

Do tworzenia zapytań GET wystarczy dopisane ścieżki do adresu. Zapytania POST realizować można poprzez [Postman](https://www.postman.com/) lub [curl](https://curl.se/docs/manpage.html)