Skip to content

Requirements

Software Requirements

Want to use our environment rather than yours?

If you are running this as part of an instructor-led workshop and have been provided a virtual machine, click here to learn about how to use it if you’d prefer it over using your own laptop.

AI Model Requirements

You will need an OpenAI API key to complete this workshop.
If your instructor provided a key, use that one. Otherwise, create an API key.

No instructor-provided key?

New OpenAI developer accounts receive $5 in free trial credits.
If you already used your credits, you’ll need to fund your account.

Tip

Don’t worry — this workshop is inexpensive. The total cost should not exceed $0.50 (~€0.43).
See the OpenAI pricing calculator.

Once you have a key, set it as an environment variable:

export OPENAI_API_KEY=<your-key>

$Env:OPENAI_API_KEY = <your-key>

Good to Know

Quarkus Dev Mode

Run your Quarkus app in dev mode from the project directory:

./mvnw quarkus:dev

Dev mode automatically recompiles your code on every change. Your app will be available at http://localhost:8080/.

Switching steps

Stop the running application (Ctrl+C) before starting the next step.

Dev UI

Quarkus ships with a Dev UI, available only in dev mode at http://localhost:8080/q/dev/. Think of it as your toolbox when building Quarkus applications.

Debugging

To debug an app in dev mode, put breakpoints in your code and attach your IDE debugger. In IntelliJ, use Run > Attach to Process and select the Quarkus process. Other IDEs (Eclipse, VSCode) support similar remote debugging.

Getting the Workshop Material

Either clone the repository with Git or download a ZIP archive.

With Git

git clone https://github.com/quarkusio/quarkus-langchain4j-workshop.git
cd quarkus-langchain4j-workshop

Direct Download

curl -L -o workshop.zip https://github.com/quarkusio/quarkus-langchain4j-workshop/archive/refs/heads/main.zip
unzip workshop.zip
cd quarkus-langchain4j-workshop-main

Pre-Warming Caches

This workshop requires downloading Maven dependencies and Docker images. To avoid bandwidth issues during the session, we recommend pre-downloading them.

Warm up Maven

./mvnw verify

Tip

This command not only downloads dependencies but also verifies your setup before the workshop.

Warm up Docker Images

  • Podman: podman pull pgvector/pgvector:pg17
  • Docker: docker pull pgvector/pgvector:pg17

Importing the Project in Your IDE

Tip

Open the project from section-1/step-01 in your IDE and use that directory throughout the workshop.

If you get stuck, simply switch to the step-xx directory of the last completed step.

Next Step

Once ready, you can pick one of these entries points to start the workshop: