This is an automated email from the ASF dual-hosted git repository.
wenjin272 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
The following commit(s) were added to refs/heads/main by this push:
new 5d79b7bb [docs] Document custom job name in quickstart examples (#806)
5d79b7bb is described below
commit 5d79b7bb161f1f0054825b08615c456c81ec5f67
Author: Eugene <[email protected]>
AuthorDate: Mon Jun 8 18:46:17 2026 +0800
[docs] Document custom job name in quickstart examples (#806)
---
docs/content/docs/get-started/quickstart/react_agent.md | 6 ++++++
docs/content/docs/get-started/quickstart/skills_agent.md | 10 ++++++----
docs/content/docs/get-started/quickstart/workflow_agent.md | 8 ++++----
docs/content/docs/get-started/quickstart/yaml_agent.md | 6 ++++--
.../org/apache/flink/agents/examples/ReActAgentExample.java | 4 ++--
.../org/apache/flink/agents/examples/SkillsAgentExample.java | 4 ++--
.../flink/agents/examples/WorkflowMultipleAgentExample.java | 4 ++--
.../flink/agents/examples/WorkflowSingleAgentExample.java | 4 ++--
.../apache/flink/agents/examples/YamlWorkflowAgentExample.java | 4 ++--
python/flink_agents/examples/quickstart/react_agent_example.py | 4 ++--
.../flink_agents/examples/quickstart/skills_agent_example.py | 4 ++--
.../examples/quickstart/workflow_multiple_agent_example.py | 4 ++--
.../examples/quickstart/workflow_single_agent_example.py | 4 ++--
.../examples/quickstart/yaml_workflow_agent_example.py | 4 ++--
14 files changed, 40 insertions(+), 30 deletions(-)
diff --git a/docs/content/docs/get-started/quickstart/react_agent.md
b/docs/content/docs/get-started/quickstart/react_agent.md
index a4de2704..06058145 100644
--- a/docs/content/docs/get-started/quickstart/react_agent.md
+++ b/docs/content/docs/get-started/quickstart/react_agent.md
@@ -160,6 +160,9 @@ review_analysis_res_stream = (
# Print the analysis results to stdout.
review_analysis_res_stream.print()
+
+# Execute the Flink pipeline with the Flink job name.
+agents_env.execute("ReAct Agent Example Job")
```
{{< /tab >}}
@@ -199,6 +202,9 @@ DataStream<Object> reviewAnalysisResStream =
// Print the analysis results to stdout.
reviewAnalysisResStream.print();
+
+// Execute the Flink pipeline with the Flink job name.
+agentsEnv.execute("ReAct Agent Example Job");
```
{{< /tab >}}
diff --git a/docs/content/docs/get-started/quickstart/skills_agent.md
b/docs/content/docs/get-started/quickstart/skills_agent.md
index c0ace154..4828132d 100644
--- a/docs/content/docs/get-started/quickstart/skills_agent.md
+++ b/docs/content/docs/get-started/quickstart/skills_agent.md
@@ -221,9 +221,10 @@ answer_stream = (
.to_datastream()
)
-# Print the answers to stdout, then execute the Flink pipeline.
+# Print the answers to stdout.
answer_stream.print()
-agents_env.execute()
+# Execute the Flink pipeline with the Flink job name.
+agents_env.execute("Skills Agent Example Job")
```
{{< /tab >}}
@@ -249,9 +250,10 @@ DataStream<String> questionStream =
DataStream<Object> answerStream =
agentsEnv.fromDataStream(questionStream).apply(new
MathAgent()).toDataStream();
-// Print the answers to stdout, then execute the Flink pipeline.
+// Print the answers to stdout.
answerStream.print();
-agentsEnv.execute();
+// Execute the Flink pipeline with the Flink job name.
+agentsEnv.execute("Skills Agent Example Job");
```
{{< /tab >}}
diff --git a/docs/content/docs/get-started/quickstart/workflow_agent.md
b/docs/content/docs/get-started/quickstart/workflow_agent.md
index 549bc041..cc2520f1 100644
--- a/docs/content/docs/get-started/quickstart/workflow_agent.md
+++ b/docs/content/docs/get-started/quickstart/workflow_agent.md
@@ -312,8 +312,8 @@ review_analysis_res_stream = (
# Print the analysis results to stdout.
review_analysis_res_stream.print()
-# Execute the Flink pipeline.
-agents_env.execute()
+# Execute the Flink pipeline with the Flink job name.
+agents_env.execute("Workflow Agent Example Job")
```
{{< /tab >}}
@@ -340,8 +340,8 @@ DataStream<Object> reviewAnalysisResStream =
// Print the analysis results to stdout.
reviewAnalysisResStream.print();
-// Execute the Flink pipeline.
-agentsEnv.execute();
+// Execute the Flink pipeline with the Flink job name.
+agentsEnv.execute("Workflow Agent Example Job");
```
{{< /tab >}}
diff --git a/docs/content/docs/get-started/quickstart/yaml_agent.md
b/docs/content/docs/get-started/quickstart/yaml_agent.md
index a297e0ef..f90c3a16 100644
--- a/docs/content/docs/get-started/quickstart/yaml_agent.md
+++ b/docs/content/docs/get-started/quickstart/yaml_agent.md
@@ -234,7 +234,8 @@ review_analysis_res_stream = (
)
review_analysis_res_stream.print()
-agents_env.execute()
+# Execute the Flink pipeline with the Flink job name.
+agents_env.execute("YAML Agent Example Job")
```
{{< /tab >}}
@@ -272,7 +273,8 @@ DataStream<Object> reviewAnalysisResStream =
.toDataStream();
reviewAnalysisResStream.print();
-agentsEnv.execute();
+// Execute the Flink pipeline with the Flink job name.
+agentsEnv.execute("YAML Agent Example Job");
```
{{< /tab >}}
diff --git
a/examples/src/main/java/org/apache/flink/agents/examples/ReActAgentExample.java
b/examples/src/main/java/org/apache/flink/agents/examples/ReActAgentExample.java
index 12100ad7..fef67f32 100644
---
a/examples/src/main/java/org/apache/flink/agents/examples/ReActAgentExample.java
+++
b/examples/src/main/java/org/apache/flink/agents/examples/ReActAgentExample.java
@@ -141,8 +141,8 @@ public class ReActAgentExample {
// Print the analysis results to stdout.
reviewAnalysisResStream.print();
- // Execute the Flink pipeline.
- agentsEnv.execute();
+ // Execute the Flink pipeline with the Flink job name.
+ agentsEnv.execute("ReAct Agent Example Job");
}
// Create ReAct agent.
diff --git
a/examples/src/main/java/org/apache/flink/agents/examples/SkillsAgentExample.java
b/examples/src/main/java/org/apache/flink/agents/examples/SkillsAgentExample.java
index 8335dec0..6ca22c6b 100644
---
a/examples/src/main/java/org/apache/flink/agents/examples/SkillsAgentExample.java
+++
b/examples/src/main/java/org/apache/flink/agents/examples/SkillsAgentExample.java
@@ -65,7 +65,7 @@ public class SkillsAgentExample {
// Print the answers to stdout.
answerStream.print();
- // Execute the Flink pipeline.
- agentsEnv.execute();
+ // Execute the Flink pipeline with the Flink job name.
+ agentsEnv.execute("Skills Agent Example Job");
}
}
diff --git
a/examples/src/main/java/org/apache/flink/agents/examples/WorkflowMultipleAgentExample.java
b/examples/src/main/java/org/apache/flink/agents/examples/WorkflowMultipleAgentExample.java
index 1e56bc09..17ee7589 100644
---
a/examples/src/main/java/org/apache/flink/agents/examples/WorkflowMultipleAgentExample.java
+++
b/examples/src/main/java/org/apache/flink/agents/examples/WorkflowMultipleAgentExample.java
@@ -194,7 +194,7 @@ public class WorkflowMultipleAgentExample {
// Print the final product improvement suggestions to stdout.
productSuggestionResStream.print();
- // Execute the pipeline.
- agentsEnv.execute();
+ // Execute the Flink pipeline with the Flink job name.
+ agentsEnv.execute("Workflow Multiple Agent Example Job");
}
}
diff --git
a/examples/src/main/java/org/apache/flink/agents/examples/WorkflowSingleAgentExample.java
b/examples/src/main/java/org/apache/flink/agents/examples/WorkflowSingleAgentExample.java
index b2d49582..62c317fe 100644
---
a/examples/src/main/java/org/apache/flink/agents/examples/WorkflowSingleAgentExample.java
+++
b/examples/src/main/java/org/apache/flink/agents/examples/WorkflowSingleAgentExample.java
@@ -87,8 +87,8 @@ public class WorkflowSingleAgentExample {
// Print the analysis results to stdout.
reviewAnalysisResStream.print();
- // Execute the Flink pipeline.
- agentsEnv.execute();
+ // Execute the Flink pipeline with the Flink job name.
+ agentsEnv.execute("Workflow Agent Example Job");
}
public static File copyResource(String resourcePath) throws Exception {
diff --git
a/examples/src/main/java/org/apache/flink/agents/examples/YamlWorkflowAgentExample.java
b/examples/src/main/java/org/apache/flink/agents/examples/YamlWorkflowAgentExample.java
index 3f118809..b425ccd9 100644
---
a/examples/src/main/java/org/apache/flink/agents/examples/YamlWorkflowAgentExample.java
+++
b/examples/src/main/java/org/apache/flink/agents/examples/YamlWorkflowAgentExample.java
@@ -87,7 +87,7 @@ public class YamlWorkflowAgentExample {
// Print the analysis results to stdout.
reviewAnalysisResStream.print();
- // Execute the Flink pipeline.
- agentsEnv.execute();
+ // Execute the Flink pipeline with the Flink job name.
+ agentsEnv.execute("YAML Agent Example Job");
}
}
diff --git a/python/flink_agents/examples/quickstart/react_agent_example.py
b/python/flink_agents/examples/quickstart/react_agent_example.py
index 4602aeb5..2b517558 100644
--- a/python/flink_agents/examples/quickstart/react_agent_example.py
+++ b/python/flink_agents/examples/quickstart/react_agent_example.py
@@ -115,8 +115,8 @@ def main() -> None:
# Print the analysis results to stdout.
review_analysis_res_stream.print()
- # Execute the Flink pipeline.
- agents_env.execute()
+ # Execute the Flink pipeline with the Flink job name.
+ agents_env.execute("ReAct Agent Example Job")
if __name__ == "__main__":
diff --git a/python/flink_agents/examples/quickstart/skills_agent_example.py
b/python/flink_agents/examples/quickstart/skills_agent_example.py
index c9dd8f16..614e4040 100644
--- a/python/flink_agents/examples/quickstart/skills_agent_example.py
+++ b/python/flink_agents/examples/quickstart/skills_agent_example.py
@@ -69,8 +69,8 @@ def main() -> None:
# Print the answers to stdout.
answer_stream.print()
- # Execute the Flink pipeline.
- agents_env.execute()
+ # Execute the Flink pipeline with the Flink job name.
+ agents_env.execute("Skills Agent Example Job")
if __name__ == "__main__":
diff --git
a/python/flink_agents/examples/quickstart/workflow_multiple_agent_example.py
b/python/flink_agents/examples/quickstart/workflow_multiple_agent_example.py
index 09df650c..fafa5c30 100644
--- a/python/flink_agents/examples/quickstart/workflow_multiple_agent_example.py
+++ b/python/flink_agents/examples/quickstart/workflow_multiple_agent_example.py
@@ -172,8 +172,8 @@ def main() -> None:
# Print the final product improvement suggestions to stdout.
product_suggestion_res_stream.print()
- # Execute the pipeline.
- agents_env.execute()
+ # Execute the Flink pipeline with the Flink job name.
+ agents_env.execute("Workflow Multiple Agent Example Job")
if __name__ == "__main__":
diff --git
a/python/flink_agents/examples/quickstart/workflow_single_agent_example.py
b/python/flink_agents/examples/quickstart/workflow_single_agent_example.py
index c532698e..d05b328e 100644
--- a/python/flink_agents/examples/quickstart/workflow_single_agent_example.py
+++ b/python/flink_agents/examples/quickstart/workflow_single_agent_example.py
@@ -89,8 +89,8 @@ def main() -> None:
# Print the analysis results to stdout.
review_analysis_res_stream.print()
- # Execute the Flink pipeline.
- agents_env.execute()
+ # Execute the Flink pipeline with the Flink job name.
+ agents_env.execute("Workflow Agent Example Job")
if __name__ == "__main__":
diff --git
a/python/flink_agents/examples/quickstart/yaml_workflow_agent_example.py
b/python/flink_agents/examples/quickstart/yaml_workflow_agent_example.py
index 17c39952..9107e67b 100644
--- a/python/flink_agents/examples/quickstart/yaml_workflow_agent_example.py
+++ b/python/flink_agents/examples/quickstart/yaml_workflow_agent_example.py
@@ -83,8 +83,8 @@ def main() -> None:
# Print the analysis results to stdout.
review_analysis_res_stream.print()
- # Execute the Flink pipeline.
- agents_env.execute()
+ # Execute the Flink pipeline with the Flink job name.
+ agents_env.execute("YAML Agent Example Job")
if __name__ == "__main__":
