TOGAF Expairt

An experimental project leveraging the power of AI to help architects to architect better. The project provides a REST server, a REST CLI, and an Indexer CLI.

Requirements

• Java 21
• Docker Compose

Two external services are required to run the application:

• Ollama
• Qdrant

Run

The application is available as a Docker image, an executable JAR, or a Docker Compose stack.

The following command will start the application using Docker Compose:

docker compose up

The Docker Compose stack will start all required services and the application itself. Moreover, the installation side models like LLM and embeddings will be downloaded and installed. Finally, the knowledge base will be indexed. So, once up and running, you can chat with the server using a CLI prompt:

docker run --rm -it --network host ghcr.io/tmorin/togaf-expairt:latest io.morin.togafexpairt.cli.RestClientCli

You can also force the re-indexation of the knowledge base:

docker run --rm -it --network host ghcr.io/tmorin/togaf-expairt:latest io.morin.togafexpairt.cli.IndexerCli

Configuration

Each key in the table below corresponds to an environment variable or a Java system property.

For instance, to set the togafexpairt.langchain4j.chat_model property, you can use the following command line:

java -Dtogafexpairt.langchain4j.chat_model=MISTRAL -jar togafexpairt-0.0.1-SNAPSHOT.jar

Or you can set the togafexpairt.langchain4j.chat_model environment variable:

togafexpairt_langchain4j_integration=MISTRAL java -jar togafexpairt-0.0.1-SNAPSHOT.jar

Key	Default	Enumeration
togafexpairt.langchain4j.chat_model	OLLAMA	MISTRAL, OLLAMA
togafexpairt.langchain4j.embedding_model	MINI_LM	MINI_LM, MINI_LM_Q, OLLAMA
togafexpairt.langchain4j.dimension	384
togafexpairt.langchain4j.max_memory_messages	20
togafexpairt.langchain4j.max_segment_size_in_chars	500
togafexpairt.langchain4j.max_overlap_size_in_chars	60
togafexpairt.langchain4j.max_embedded_content_result	30
togafexpairt.langchain4j.min_embedded_content_score	0.5
togafexpairt.langchain4j.query_routing_enabled	false
togafexpairt.mistral.model_name	mistral-medium
togafexpairt.mistral.api_key
togafexpairt.qdrant.host	localhost
togafexpairt.qdrant.port	6334
togafexpairt.ollama.chat_model_name	llama3.2:1b
togafexpairt.ollama.embedding_model_name	nomic-embed-text
togafexpairt.ollama.base_url	http://localhost:11434
togafexpairt.restserver.host	localhost
togafexpairt.restserver.port	9090
togafexpairt.rest_cli.prompt_url	http://localhost:9090/prompt

Build

Build the uber jar

./mvnw verify

Maintenance

Dependencies upgrade

./mvnw versions:display-dependency-updates

Release

./mvnw --batch-mode release:clean \
&& ./mvnw --batch-mode release:prepare \
  -DreleaseVersion=X.Y.Z \
  -DdevelopmentVersion=Y.X.Z-SNAPSHOT