xintongsong commented on code in PR #399:
URL: https://github.com/apache/flink-agents/pull/399#discussion_r2707313806
##########
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
+<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>
Review Comment:
Should this also be provided?
##########
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
+<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>
+```
Review Comment:
I have a feeling that there are too many dependencies need to be added for
execution in an IDE. This not only harms the user experience, but also makes
this document hard to maintain as the dependencies need to be added may change
in future and this document can easily become inconsistent. I wonder if we can
introduce a pom like `flink-agents-ide-supports`, which includes all
dependencies needed for the local execution. Of course this can be a separate
issue and should not block this PR.
cc @wenjin272
##########
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
+<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 >}}
Review Comment:
I think we can remove this hint and just use `0.2` w/o the `-SNAPSHOT`
suffix. The version will soon be available in 1-2 weeks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
