Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pandermatt/ba20-kenspace-backend
KenSpace: Explorative und komplexe Suchen auf unstrukturierte Dokumente
https://github.com/pandermatt/ba20-kenspace-backend
Last synced: 6 days ago
JSON representation
KenSpace: Explorative und komplexe Suchen auf unstrukturierte Dokumente
- Host: GitHub
- URL: https://github.com/pandermatt/ba20-kenspace-backend
- Owner: pandermatt
- Created: 2020-02-10T10:52:44.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-02-15T23:47:42.000Z (over 1 year ago)
- Last Synced: 2023-03-01T17:13:27.481Z (over 1 year ago)
- Language: Python
- Size: 921 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🪐🐍 BA20 KenSpace Backend
KenSpace: Explorative und komplexe Suchen auf unstrukturierte Dokumente
## Important Links
- https://github.com/pandermatt/BA20-KenSpace-Frontend
- https://github.com/pandermatt/BA20-KenSpace-Backend
- https://github.com/pandermatt/BA20-KenSpace-Documentation
- https://github.com/theCoder95/BA20-KenSpace-Research
## Developing
### Setup
```bash
git clone [email protected]:pandermatt/ba20-kenspace-backend.git
cd ba20-kenspace-backend
pip install -r requirements.txt
python -m spacy download en_core_web_sm
python -m spacy download de_core_news_sm
```
#### Configuration
```bash
cp application.example.yml application.yml
```
Fill in all your keys
To load the default configuration:
```bash
cp application.default.yml application.yml
```
### Data
The Data must be copied from or downloaded by yourself.
If you do not want to download the standard data, you can use the upload.
**Warning ⚠️:** The first generation of data may take a while
### Run
```bash
python app.py
```
or
for an easy installation, go to the Docker section.
## REST API
- `/upload/`: Upload your file to analyse
- Method: `POST`
- Params: `uploadType`: `csv`, `txt`, `whatsapp` or `zip`
- Files: `file` with `FILE_CONTENT`
- Headers: `Authorization: Bearer`
- Returns: Data insight and `filename` of the Model. This `filename` must be included in the Cluster Settings.
- `/queries/`: Generate your Queries
- Method: `GET`
- Params: `uuid`: Model ID, `deletedWords`: Array of Deleted- / Stop words, `settings`
- Headers: `Authorization: Bearer`
- Returns: queries as JSON
- `/auth/`: Generate your Queries
- Method: `GET`
- Headers: `Authorization: Bearer`
- Returns: `successful` if key is correct
- `/feedback/`: Submit feedback to your data
- Method: `POST`
- Params:
- `uuid`
- `isHelpful`
- `movieTitle`
- `similarClusterActive`
- `search`
- `facet`
- `delete`
- `resultCount`
- Headers: `Authorization: Bearer`
- Returns: queries as JSON
- Settings Type
- `display`: Title Column
- `content`: Content Column
- `filename`: Filename (response from upload)
- `language`: Language to Analyse
- `techniques`: `nltk` or `spacy`
- `clusterSize`: `large`, `medium` or `small`
- `itemToAnalyse`: `all` (display and content) or `content`
## Docker
Use the `Makefile`:
* `make build` builds the docker container
* `make run` runs the Flask App
## Access Docker file
```bash
docker exec -it docker_kenspace_backend bash
```
or
```bash
docker ps
docker exec -it bash
```
### Clean up docker
- List all containers (only IDs) `docker ps -aq`
- Stop all running containers `docker stop $(docker ps -aq)`
**WARNING:** this will delete all your docker images
- Remove all containers `docker rm $(docker ps -aq)`
- Remove all images `docker rmi $(docker images -q)`
# Contributors
 Pascal Andermatt
 Stefan Brunner