You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by xt...@apache.org on 2025/09/27 07:26:46 UTC
(flink-agents) 03/03: [api] Add function tool to represent a tool keeping method in api.
This is an automated email from the ASF dual-hosted git repository.
xtsong pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
commit 23ff0e135198fe4e5bb736e5f78a46270ae0281f
Author: WenjinXie <we...@gmail.com>
AuthorDate: Fri Sep 26 16:24:15 2025 +0800
[api] Add function tool to represent a tool keeping method in api.
---
.../java/org/apache/flink/agents/api/Agent.java | 19 ++--------
.../agents/api/AgentsExecutionEnvironment.java | 20 ++---------
.../flink/agents/api/tools/FunctionTool.java | 42 ++++++++++++++++++++++
.../org/apache/flink/agents/api/tools/Tool.java | 7 ++++
.../agents/integration/test/ReActAgentExample.java | 16 ++++++---
.../org/apache/flink/agents/plan/AgentPlan.java | 4 ++-
.../plan/AgentPlanDeclareToolMethodTest.java | 9 +++--
7 files changed, 73 insertions(+), 44 deletions(-)
diff --git a/api/src/main/java/org/apache/flink/agents/api/Agent.java b/api/src/main/java/org/apache/flink/agents/api/Agent.java
index b3520cf..5b5f57a 100644
--- a/api/src/main/java/org/apache/flink/agents/api/Agent.java
+++ b/api/src/main/java/org/apache/flink/agents/api/Agent.java
@@ -18,7 +18,6 @@
package org.apache.flink.agents.api;
-import org.apache.flink.agents.api.annotation.Tool;
import org.apache.flink.agents.api.resource.ResourceDescriptor;
import org.apache.flink.agents.api.resource.ResourceType;
import org.apache.flink.agents.api.resource.SerializableResource;
@@ -27,7 +26,6 @@ import org.apache.flink.api.java.tuple.Tuple3;
import javax.annotation.Nullable;
import java.lang.reflect.Method;
-import java.lang.reflect.Modifier;
import java.util.HashMap;
import java.util.Map;
@@ -93,27 +91,14 @@ public class Agent {
*
* @param name The name indicate the resource.
* @param type The type of the resource.
- * @param instance The serializable resource object, or the resource descriptor, or the tool
- * method.
+ * @param instance The serializable resource object, or the resource descriptor.
*/
public Agent addResource(String name, ResourceType type, Object instance) {
if (resources.get(type).containsKey(name)) {
throw new IllegalArgumentException(String.format("%s %s already defined.", type, name));
}
- if (instance instanceof Method) {
- Method tool = (Method) instance;
- if (!Modifier.isStatic(tool.getModifiers())) {
- throw new IllegalArgumentException("Only static methods are supported");
- }
-
- Tool toolAnnotation = tool.getAnnotation(Tool.class);
- if (toolAnnotation == null) {
- throw new IllegalArgumentException("Method must be annotated with @Tool");
- }
-
- resources.get(ResourceType.TOOL).put(name, tool);
- } else if (instance instanceof SerializableResource) {
+ if (instance instanceof SerializableResource) {
resources.get(type).put(name, instance);
} else if (instance instanceof ResourceDescriptor) {
resources.get(type).put(name, instance);
diff --git a/api/src/main/java/org/apache/flink/agents/api/AgentsExecutionEnvironment.java b/api/src/main/java/org/apache/flink/agents/api/AgentsExecutionEnvironment.java
index 624c79a..07f5474 100644
--- a/api/src/main/java/org/apache/flink/agents/api/AgentsExecutionEnvironment.java
+++ b/api/src/main/java/org/apache/flink/agents/api/AgentsExecutionEnvironment.java
@@ -18,7 +18,6 @@
package org.apache.flink.agents.api;
-import org.apache.flink.agents.api.annotation.Tool;
import org.apache.flink.agents.api.configuration.Configuration;
import org.apache.flink.agents.api.resource.ResourceDescriptor;
import org.apache.flink.agents.api.resource.ResourceType;
@@ -31,8 +30,6 @@ import org.apache.flink.table.api.bridge.java.StreamTableEnvironment;
import javax.annotation.Nullable;
-import java.lang.reflect.Method;
-import java.lang.reflect.Modifier;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@@ -205,27 +202,14 @@ public abstract class AgentsExecutionEnvironment {
*
* @param name The name indicate the resource.
* @param type The type of the resource.
- * @param instance The serializable resource object, or the resource descriptor, or the tool
- * method.
+ * @param instance The serializable resource object, or the resource descriptor.
*/
public AgentsExecutionEnvironment addResource(String name, ResourceType type, Object instance) {
if (resources.get(type).containsKey(name)) {
throw new IllegalArgumentException(String.format("%s %s already defined.", type, name));
}
- if (instance instanceof Method) {
- Method tool = (Method) instance;
- if (!Modifier.isStatic(tool.getModifiers())) {
- throw new IllegalArgumentException("Only static methods are supported");
- }
-
- Tool toolAnnotation = tool.getAnnotation(Tool.class);
- if (toolAnnotation == null) {
- throw new IllegalArgumentException("Method must be annotated with @Tool");
- }
-
- resources.get(ResourceType.TOOL).put(name, tool);
- } else if (instance instanceof SerializableResource) {
+ if (instance instanceof SerializableResource) {
resources.get(type).put(name, instance);
} else if (instance instanceof ResourceDescriptor) {
resources.get(type).put(name, instance);
diff --git a/api/src/main/java/org/apache/flink/agents/api/tools/FunctionTool.java b/api/src/main/java/org/apache/flink/agents/api/tools/FunctionTool.java
new file mode 100644
index 0000000..3ccba67
--- /dev/null
+++ b/api/src/main/java/org/apache/flink/agents/api/tools/FunctionTool.java
@@ -0,0 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.agents.api.tools;
+
+import org.apache.flink.agents.api.resource.ResourceType;
+import org.apache.flink.agents.api.resource.SerializableResource;
+
+import java.lang.reflect.Method;
+
+/** Tool keeps a method, will be converted to tool after compile. */
+public class FunctionTool extends SerializableResource {
+ private final Method method;
+
+ public FunctionTool(Method method) {
+ this.method = method;
+ }
+
+ @Override
+ public ResourceType getResourceType() {
+ return ResourceType.TOOL;
+ }
+
+ public Method getMethod() {
+ return method;
+ }
+}
diff --git a/api/src/main/java/org/apache/flink/agents/api/tools/Tool.java b/api/src/main/java/org/apache/flink/agents/api/tools/Tool.java
index 862b704..e2b8060 100644
--- a/api/src/main/java/org/apache/flink/agents/api/tools/Tool.java
+++ b/api/src/main/java/org/apache/flink/agents/api/tools/Tool.java
@@ -21,6 +21,8 @@ package org.apache.flink.agents.api.tools;
import org.apache.flink.agents.api.resource.ResourceType;
import org.apache.flink.agents.api.resource.SerializableResource;
+import java.lang.reflect.Method;
+
/**
* Simplified base class for all tools. Focus on essential tool functionality without
* overcomplicated features.
@@ -59,4 +61,9 @@ public abstract class Tool extends SerializableResource {
public final String getDescription() {
return metadata.getDescription();
}
+
+ /** Get tool keeps a method. */
+ public static FunctionTool fromMethod(Method method) {
+ return new FunctionTool(method);
+ }
}
diff --git a/e2e-test/integration-test/src/main/java/org/apache/flink/agents/integration/test/ReActAgentExample.java b/e2e-test/integration-test/src/main/java/org/apache/flink/agents/integration/test/ReActAgentExample.java
index 2dd08af..ad7f170 100644
--- a/e2e-test/integration-test/src/main/java/org/apache/flink/agents/integration/test/ReActAgentExample.java
+++ b/e2e-test/integration-test/src/main/java/org/apache/flink/agents/integration/test/ReActAgentExample.java
@@ -21,13 +21,13 @@ package org.apache.flink.agents.integration.test;
import org.apache.flink.agents.api.Agent;
import org.apache.flink.agents.api.AgentsExecutionEnvironment;
import org.apache.flink.agents.api.agents.ReActAgent;
-import org.apache.flink.agents.api.annotation.Tool;
import org.apache.flink.agents.api.annotation.ToolParam;
import org.apache.flink.agents.api.chat.messages.ChatMessage;
import org.apache.flink.agents.api.chat.messages.MessageRole;
import org.apache.flink.agents.api.prompt.Prompt;
import org.apache.flink.agents.api.resource.ResourceDescriptor;
import org.apache.flink.agents.api.resource.ResourceType;
+import org.apache.flink.agents.api.tools.Tool;
import org.apache.flink.agents.integrations.chatmodels.ollama.OllamaChatModelConnection;
import org.apache.flink.agents.integrations.chatmodels.ollama.OllamaChatModelSetup;
import org.apache.flink.api.common.functions.MapFunction;
@@ -45,12 +45,14 @@ import org.apache.flink.types.Row;
import java.util.List;
public class ReActAgentExample {
- @Tool(description = "Useful function to add two numbers.")
+ @org.apache.flink.agents.api.annotation.Tool(
+ description = "Useful function to add two numbers.")
public static double add(@ToolParam(name = "a") Double a, @ToolParam(name = "b") Double b) {
return a + b;
}
- @Tool(description = "Useful function to multiply two numbers.")
+ @org.apache.flink.agents.api.annotation.Tool(
+ description = "Useful function to multiply two numbers.")
public static double multiply(
@ToolParam(name = "a") Double a, @ToolParam(name = "b") Double b) {
return a * b;
@@ -81,11 +83,15 @@ public class ReActAgentExample {
.addResource(
"add",
ResourceType.TOOL,
- ReActAgentExample.class.getMethod("add", Double.class, Double.class))
+ Tool.fromMethod(
+ ReActAgentExample.class.getMethod(
+ "add", Double.class, Double.class)))
.addResource(
"multiply",
ResourceType.TOOL,
- ReActAgentExample.class.getMethod("multiply", Double.class, Double.class));
+ Tool.fromMethod(
+ ReActAgentExample.class.getMethod(
+ "multiply", Double.class, Double.class)));
// Declare the ReAct agent.
Agent agent = getAgent();
diff --git a/plan/src/main/java/org/apache/flink/agents/plan/AgentPlan.java b/plan/src/main/java/org/apache/flink/agents/plan/AgentPlan.java
index 035b089..c7d388e 100644
--- a/plan/src/main/java/org/apache/flink/agents/plan/AgentPlan.java
+++ b/plan/src/main/java/org/apache/flink/agents/plan/AgentPlan.java
@@ -396,7 +396,9 @@ public class AgentPlan implements Serializable {
}
} else if (type == ResourceType.TOOL) {
for (Map.Entry<String, Object> kv : entry.getValue().entrySet()) {
- extractTool((Method) kv.getValue());
+ extractTool(
+ ((org.apache.flink.agents.api.tools.FunctionTool) kv.getValue())
+ .getMethod());
}
}
}
diff --git a/plan/src/test/java/org/apache/flink/agents/plan/AgentPlanDeclareToolMethodTest.java b/plan/src/test/java/org/apache/flink/agents/plan/AgentPlanDeclareToolMethodTest.java
index 9ebb259..d74d3ce 100644
--- a/plan/src/test/java/org/apache/flink/agents/plan/AgentPlanDeclareToolMethodTest.java
+++ b/plan/src/test/java/org/apache/flink/agents/plan/AgentPlanDeclareToolMethodTest.java
@@ -143,12 +143,15 @@ class AgentPlanDeclareToolMethodTest {
agent.addResource(
"calculate",
ResourceType.TOOL,
- TestAgent.class.getMethod(
- "calculate", Double.class, Double.class, String.class))
+ Tool.fromMethod(
+ TestAgent.class.getMethod(
+ "calculate", Double.class, Double.class, String.class)))
.addResource(
"getWeather",
ResourceType.TOOL,
- TestAgent.class.getMethod("getWeather", String.class, String.class));
+ Tool.fromMethod(
+ TestAgent.class.getMethod(
+ "getWeather", String.class, String.class)));
checkToolCall(new AgentPlan(agent));
}