Mind Map Studio Backend

Overview

The project is a backend part of the DIAL Mind Map Studio. Check the demo:

Developer environment

This project uses Python>=3.11 and Poetry>=2.1.1 as a dependency manager.

Check out Poetry's documentation on how to install it on your system before proceeding.

To install requirements:

poetry install

This will install all requirements for running.

IDE configuration

The recommended IDE is VSCode. Open the project in VSCode and install the recommended extensions.

The VSCode is configured to use PEP-8 compatible formatter Black.

Alternatively you can use PyCharm.

Set-up the Black formatter for PyCharm manually or install PyCharm>=2023.2 with built-in Black support.

Run locally

Run the development server locally:

make serve

Make on Windows

As of now, Windows distributions do not include the make tool. To run make commands, the tool can be installed using the following command (since Windows 10):

winget install GnuWin32.Make

For convenience, the tool folder can be added to the PATH environment variable as C:\Program Files (x86)\GnuWin32\bin. The command definitions inside Makefile should be cross-platform to keep the development environment setup simple.

Environment Variables

The Mind Map Studio application uses environment variables to configure authentication, API connections, and theming settings. Below is a list of environment variables used in this project.

Variable	Default	Description
DIAL_URL	Required to set	URL of the core DIAL server
RAG_MODEL	gpt-4o-2024-05-13	The deployment model name for the rag part.
GENERATOR_MODEL	gpt-4o-2024-08-06	The deployment model name for the graph generator part
DESCRIPTION_INDEX_DEPLOYMENT_NAME	gpt-4o-mini-2024-07-18	The deployment model name to generate descriptions for the images from the sources.