This repo contains the files for the ArkivGPT project. The project is to create summaries of construction cases from archives. The project uses docker containers to run the different parts of the system. The system consists of a frontend, gateway, processor and OCR system. The frontend is the web UI presented to the user. The gateway is the API gateway system. The processor is the system talking to OCR, GeoDoc and the GPT. The OCR is the OCR system.
- Docker
- Docker Compose
- GeoDoc clientid and key
- OpenAI GPT key, endpoint and deployment name
Create the following files:
- GeoDoc.clientid
- GeoDoc.key
- GPT.key
- GPT.endpoint
- GPT.deploymentName
in the root of the project. The GeoDoc files should contain the clientid and key for the GeoDoc API. The GPT files should contain the key, endpoint and deployment name for the GPT API.
Clone this repository
git clone [email protected]:kartAI/ArkivGPT.gitChange dir into the folder
cd ArkivGPTUpdate the project to get the required submodules
git submodule update --init --recursiveRun the docker compose files
docker compose up --buildThe frontend should now be accessible at http://localhost
Swagger API reference is accessible at http://localhost/swagger/index.html
The API itself is accessible at http://localhost/api/
The web UI presented to the user
The API gateway system
The processor talking to OCR, GeoDoc and the GPT
The OCR system