Skip to content

Add documentation for adding Maven dependencies #399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shekharrajak wants to merge 2 commits into
base: main
Choose a base branch
from
+64 −0
Open

Add documentation for adding Maven dependencies #399

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26823cf
Add documentation for adding Maven dependencies
Shekharrajak Dec 26, 2025
891f52f
Refactor Maven dependencies doc per review feedback
Shekharrajak Dec 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions docs/content/docs/get-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<properties>
<flink.version>1.20.3</flink.version>
<flink-agents.version>0.2-SNAPSHOT</flink-agents.version>
</properties>

<dependencies>
<!-- Flink Agents Core API -->
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-agents-api</artifactId>
<version>${flink-agents.version}</version>
</dependency>

<!-- Flink Agents Integration (example: OpenAI) -->
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-agents-integrations-chat-models-openai</artifactId>
<version>${flink-agents.version}</version>
</dependency>

<!-- Runtime (required for IDE/local execution) -->
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-agents-runtime</artifactId>
<version>${flink-agents.version}</version>
</dependency>

<!-- Flink dependencies (provided scope) -->
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-streaming-java</artifactId>
<version>${flink.version}</version>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-clients</artifactId>
<version>${flink.version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
```

{{< 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

Expand Down