diff --git a/docs/content/docs/get-started/installation.md b/docs/content/docs/get-started/installation.md index b1a86864..4e521a24 100644 --- a/docs/content/docs/get-started/installation.md +++ b/docs/content/docs/get-started/installation.md @@ -140,6 +140,70 @@ After building: - The Python package is installed and ready to use - The distribution JAR is located at: `dist/target/flink-agents-dist-*.jar` +## Maven Dependencies (Java Development) + +For developing Flink Agents applications in Java, add the following dependencies to your `pom.xml`: + +### Basic Dependencies for Agent Development + +**Required for developing Agent applications:** +- `flink-agents-api` - Core API interfaces and classes +- Integration modules - Add the specific integrations you need (e.g., `flink-agents-integrations-chat-models-openai`) + +**Additional dependencies for running in IDE:** +- `flink-agents-runtime` - Runtime execution engine (required for local execution/testing) +- Flink artifacts - `flink-streaming-java` and `flink-clients` with `provided` scope + +### Example pom.xml + +```xml + + 1.20.3 + 0.2-SNAPSHOT + + + + + + org.apache.flink + flink-agents-api + ${flink-agents.version} + + + + + org.apache.flink + flink-agents-integrations-chat-models-openai + ${flink-agents.version} + + + + + org.apache.flink + flink-agents-runtime + ${flink-agents.version} + + + + + org.apache.flink + flink-streaming-java + ${flink.version} + provided + + + + org.apache.flink + flink-clients + ${flink.version} + provided + + +``` + +{{< hint info >}} +**Note:** Replace `0.2-SNAPSHOT` with the actual release version when available. For SNAPSHOT versions, you may need to add the Apache snapshot repository to your `pom.xml`. +{{< /hint >}} ## Deploy to Flink Cluster