Replace copied tool utils to library ones

yuancu · yuancu · commit a6ad35331a87 · 2025-08-10T23:49:16.000+08:00
Signed-off-by: Yuanchun Shen &lt;yuanchu@amazon.com&gt;
diff --git a/src/main/java/org/opensearch/agent/tools/AbstractRetrieverTool.java b/src/main/java/org/opensearch/agent/tools/AbstractRetrieverTool.java
@@ -16,13 +16,13 @@
 import org.apache.commons.lang3.StringUtils;
 import org.opensearch.action.search.SearchRequest;
 import org.opensearch.action.search.SearchResponse;
-import org.opensearch.agent.tools.utils.ToolHelper;
 import org.opensearch.common.xcontent.LoggingDeprecationHandler;
 import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.xcontent.NamedXContentRegistry;
 import org.opensearch.core.xcontent.XContentParser;
 import org.opensearch.ml.common.spi.tools.Tool;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.search.SearchHit;
 import org.opensearch.search.builder.SearchSourceBuilder;
 import org.opensearch.transport.client.Client;
@@ -96,7 +96,7 @@ protected <T> SearchRequest buildSearchRequest(Map<String, String> parameters) t
 
     @Override
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         SearchRequest searchRequest;
         try {
             searchRequest = buildSearchRequest(parameters);
diff --git a/src/main/java/org/opensearch/agent/tools/CreateAlertTool.java b/src/main/java/org/opensearch/agent/tools/CreateAlertTool.java
@@ -39,6 +39,7 @@
 import org.opensearch.ml.common.transport.prediction.MLPredictionTaskAction;
 import org.opensearch.ml.common.transport.prediction.MLPredictionTaskRequest;
 import org.opensearch.ml.common.utils.StringUtils;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.transport.client.Client;
 
 import com.google.gson.reflect.TypeToken;
@@ -134,7 +135,7 @@ public boolean validate(Map<String, String> parameters) {
 
     @Override
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         Map<String, String> tmpParams = new HashMap<>(parameters);
         if (!tmpParams.containsKey("indices") || Strings.isEmpty(tmpParams.get("indices"))) {
             throw new IllegalArgumentException(
diff --git a/src/main/java/org/opensearch/agent/tools/CreateAnomalyDetectorTool.java b/src/main/java/org/opensearch/agent/tools/CreateAnomalyDetectorTool.java
@@ -44,6 +44,7 @@
 import org.opensearch.ml.common.spi.tools.WithModelTool;
 import org.opensearch.ml.common.transport.prediction.MLPredictionTaskAction;
 import org.opensearch.ml.common.transport.prediction.MLPredictionTaskRequest;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.transport.client.Client;
 
 import com.google.common.collect.ImmutableMap;
@@ -169,7 +170,7 @@ public CreateAnomalyDetectorTool(Client client, String modelId, String modelType
      */
     @Override
     public <T> void run(Map<String, String> parameters, ActionListener<T> listener) {
-        parameters = ToolHelper.extractInputParameters(parameters, attributes);
+        parameters = ToolUtils.extractInputParameters(parameters, attributes);
         final String tenantId = parameters.get(TENANT_ID_FIELD);
         Map<String, String> enrichedParameters = enrichParameters(parameters);
         String indexName = enrichedParameters.get("index");
diff --git a/src/main/java/org/opensearch/agent/tools/DynamicTool.java b/src/main/java/org/opensearch/agent/tools/DynamicTool.java
@@ -15,7 +15,6 @@
 import org.apache.commons.text.StringSubstitutor;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.opensearch.agent.tools.utils.ToolHelper;
 import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.common.bytes.BytesReference;
@@ -26,6 +25,7 @@
 import org.opensearch.core.xcontent.XContentParser;
 import org.opensearch.ml.common.spi.tools.Tool;
 import org.opensearch.ml.common.spi.tools.ToolAnnotation;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.rest.DynamicRestRequestCreator;
 import org.opensearch.rest.DynamicToolExecutor;
 import org.opensearch.rest.RestRequest;
@@ -116,7 +116,7 @@ public boolean validate(Map<String, String> map) {
 
     @Override
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         RestRequest.Method method = RestRequest.Method.valueOf(parameters.get(METHOD_KEY));
         String uri = parameters.get(URI_KEY);
         String requestBody = parameters.get(REQUEST_BODY_KEY);
diff --git a/src/main/java/org/opensearch/agent/tools/LogPatternTool.java b/src/main/java/org/opensearch/agent/tools/LogPatternTool.java
@@ -31,6 +31,7 @@
 import org.opensearch.core.common.util.CollectionUtils;
 import org.opensearch.core.xcontent.NamedXContentRegistry;
 import org.opensearch.ml.common.spi.tools.ToolAnnotation;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.search.SearchHit;
 import org.opensearch.sql.plugin.transport.PPLQueryAction;
 import org.opensearch.sql.plugin.transport.TransportPPLQueryRequest;
@@ -107,7 +108,8 @@ protected String getQueryBody(String queryText) {
     }
 
     @Override
-    public <T> void run(Map<String, String> parameters, ActionListener<T> listener) {
+    public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         String dsl = parameters.get(INPUT_FIELD);
         String ppl = parameters.get(PPL_FIELD);
         if (!StringUtils.isBlank(dsl)) {
diff --git a/src/main/java/org/opensearch/agent/tools/PPLTool.java b/src/main/java/org/opensearch/agent/tools/PPLTool.java
@@ -52,6 +52,7 @@
 import org.opensearch.ml.common.spi.tools.WithModelTool;
 import org.opensearch.ml.common.transport.prediction.MLPredictionTaskAction;
 import org.opensearch.ml.common.transport.prediction.MLPredictionTaskRequest;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.search.SearchHit;
 import org.opensearch.search.builder.SearchSourceBuilder;
 import org.opensearch.sql.plugin.transport.PPLQueryAction;
@@ -197,7 +198,7 @@ public PPLTool(
     @SuppressWarnings("unchecked")
     @Override
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         final String tenantId = parameters.get(TENANT_ID_FIELD);
         extractFromChatParameters(parameters);
         String indexName = getIndexNameFromParameters(parameters);
diff --git a/src/main/java/org/opensearch/agent/tools/RAGTool.java b/src/main/java/org/opensearch/agent/tools/RAGTool.java
@@ -16,7 +16,6 @@
 import java.util.Map;
 
 import org.opensearch.action.ActionRequest;
-import org.opensearch.agent.tools.utils.ToolHelper;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.xcontent.NamedXContentRegistry;
 import org.opensearch.ml.common.FunctionName;
@@ -29,6 +28,7 @@
 import org.opensearch.ml.common.spi.tools.WithModelTool;
 import org.opensearch.ml.common.transport.prediction.MLPredictionTaskAction;
 import org.opensearch.ml.common.transport.prediction.MLPredictionTaskRequest;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.transport.client.Client;
 
 import com.google.gson.Gson;
@@ -97,7 +97,7 @@ public Object parse(Object o) {
     }
 
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
 
         final String tenantId = parameters.get(TENANT_ID_FIELD);
 
diff --git a/src/main/java/org/opensearch/agent/tools/SearchAlertsTool.java b/src/main/java/org/opensearch/agent/tools/SearchAlertsTool.java
@@ -11,7 +11,6 @@
 import java.util.Map;
 
 import org.apache.commons.lang3.StringUtils;
-import org.opensearch.agent.tools.utils.ToolHelper;
 import org.opensearch.commons.alerting.AlertingPluginInterface;
 import org.opensearch.commons.alerting.action.GetAlertsRequest;
 import org.opensearch.commons.alerting.action.GetAlertsResponse;
@@ -22,6 +21,7 @@
 import org.opensearch.ml.common.spi.tools.Parser;
 import org.opensearch.ml.common.spi.tools.Tool;
 import org.opensearch.ml.common.spi.tools.ToolAnnotation;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.transport.client.Client;
 import org.opensearch.transport.client.node.NodeClient;
 
@@ -72,7 +72,7 @@ public Object parse(Object o) {
 
     @Override
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         final String tableSortOrder = parameters.getOrDefault("sortOrder", "asc");
         final String tableSortString = parameters.getOrDefault("sortString", "monitor_name.keyword");
         final int tableSize = parameters.containsKey("size") && StringUtils.isNumeric(parameters.get("size"))
diff --git a/src/main/java/org/opensearch/agent/tools/SearchAnomalyDetectorsTool.java b/src/main/java/org/opensearch/agent/tools/SearchAnomalyDetectorsTool.java
@@ -23,7 +23,6 @@
 import org.opensearch.ad.transport.GetAnomalyDetectorResponse;
 import org.opensearch.agent.tools.utils.ToolConstants;
 import org.opensearch.agent.tools.utils.ToolConstants.DetectorStateString;
-import org.opensearch.agent.tools.utils.ToolHelper;
 import org.opensearch.common.lucene.uid.Versions;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.common.io.stream.NamedWriteableRegistry;
@@ -37,6 +36,7 @@
 import org.opensearch.ml.common.spi.tools.Parser;
 import org.opensearch.ml.common.spi.tools.Tool;
 import org.opensearch.ml.common.spi.tools.ToolAnnotation;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.search.SearchHit;
 import org.opensearch.search.builder.SearchSourceBuilder;
 import org.opensearch.search.sort.SortOrder;
@@ -96,7 +96,7 @@ public Object parse(Object o) {
     // future to cover a sufficient amount of potential questions the agent will need to handle.
     @Override
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         final String detectorName = parameters.getOrDefault("detectorName", null);
         final String detectorNamePattern = parameters.getOrDefault("detectorNamePattern", null);
         final String indices = parameters.getOrDefault("indices", null);
diff --git a/src/main/java/org/opensearch/agent/tools/SearchAnomalyResultsTool.java b/src/main/java/org/opensearch/agent/tools/SearchAnomalyResultsTool.java
@@ -14,7 +14,6 @@
 import org.opensearch.action.search.SearchResponse;
 import org.opensearch.ad.client.AnomalyDetectionNodeClient;
 import org.opensearch.agent.tools.utils.ToolConstants;
-import org.opensearch.agent.tools.utils.ToolHelper;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.common.io.stream.NamedWriteableRegistry;
 import org.opensearch.index.IndexNotFoundException;
@@ -27,6 +26,7 @@
 import org.opensearch.ml.common.spi.tools.Parser;
 import org.opensearch.ml.common.spi.tools.Tool;
 import org.opensearch.ml.common.spi.tools.ToolAnnotation;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.search.SearchHit;
 import org.opensearch.search.SearchHits;
 import org.opensearch.search.builder.SearchSourceBuilder;
@@ -86,7 +86,7 @@ public Object parse(Object o) {
     // future to cover a sufficient amount of potential questions the agent will need to handle.
     @Override
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         final String detectorId = parameters.getOrDefault("detectorId", null);
         final Boolean realTime = parameters.containsKey("realTime") ? Boolean.parseBoolean(parameters.get("realTime")) : null;
         final Double anomalyGradeThreshold = parameters.containsKey("anomalyGradeThreshold")
diff --git a/src/main/java/org/opensearch/agent/tools/SearchMonitorsTool.java b/src/main/java/org/opensearch/agent/tools/SearchMonitorsTool.java
@@ -16,7 +16,6 @@
 import org.apache.lucene.search.join.ScoreMode;
 import org.opensearch.action.search.SearchRequest;
 import org.opensearch.action.search.SearchResponse;
-import org.opensearch.agent.tools.utils.ToolHelper;
 import org.opensearch.commons.alerting.AlertingPluginInterface;
 import org.opensearch.commons.alerting.action.SearchMonitorRequest;
 import org.opensearch.commons.alerting.model.ScheduledJob;
@@ -31,6 +30,7 @@
 import org.opensearch.ml.common.spi.tools.Parser;
 import org.opensearch.ml.common.spi.tools.Tool;
 import org.opensearch.ml.common.spi.tools.ToolAnnotation;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.search.SearchHit;
 import org.opensearch.search.builder.SearchSourceBuilder;
 import org.opensearch.search.sort.SortOrder;
@@ -86,7 +86,7 @@ public Object parse(Object o) {
     // future to cover a sufficient amount of potential questions the agent will need to handle.
     @Override
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         final String monitorId = parameters.getOrDefault("monitorId", null);
         final String monitorName = parameters.getOrDefault("monitorName", null);
         final String monitorNamePattern = parameters.getOrDefault("monitorNamePattern", null);
diff --git a/src/main/java/org/opensearch/agent/tools/WebSearchTool.java b/src/main/java/org/opensearch/agent/tools/WebSearchTool.java
@@ -29,11 +29,11 @@
 import org.jsoup.nodes.Element;
 import org.jsoup.select.Elements;
 import org.opensearch.agent.ToolPlugin;
-import org.opensearch.agent.tools.utils.ToolHelper;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.ml.common.spi.tools.Tool;
 import org.opensearch.ml.common.spi.tools.ToolAnnotation;
 import org.opensearch.ml.common.utils.StringUtils;
+import org.opensearch.ml.common.utils.ToolUtils;
 import org.opensearch.threadpool.ThreadPool;
 
 import com.google.common.collect.ImmutableMap;
@@ -101,7 +101,7 @@ public WebSearchTool(ThreadPool threadPool) {
 
     @Override
     public <T> void run(Map<String, String> originalParameters, ActionListener<T> listener) {
-        Map<String, String> parameters = ToolHelper.extractInputParameters(originalParameters, attributes);
+        Map<String, String> parameters = ToolUtils.extractInputParameters(originalParameters, attributes);
         try {
             // common search parameters
             String query = parameters.getOrDefault("query", parameters.get("question")).replaceAll(" ", "+");
diff --git a/src/main/java/org/opensearch/agent/tools/utils/ToolHelper.java b/src/main/java/org/opensearch/agent/tools/utils/ToolHelper.java
@@ -5,23 +5,17 @@
 
 package org.opensearch.agent.tools.utils;
 
-import static org.opensearch.ml.common.utils.StringUtils.gson;
-
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 
-import org.apache.commons.text.StringSubstitutor;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.action.ActionResponse;
 import org.opensearch.ml.common.utils.StringUtils;
 import org.opensearch.sql.plugin.transport.TransportPPLQueryResponse;
 
-import com.google.gson.reflect.TypeToken;
-
 import lombok.extern.log4j.Log4j2;
 
 @Log4j2
@@ -95,60 +89,4 @@ public static <T extends ActionResponse> ActionListener<T> getPPLTransportAction
     ) {
         return ActionListener.wrap(r -> { listener.onResponse(TransportPPLQueryResponse.fromActionResponse(r)); }, listener::onFailure);
     }
-
-    /**
-     * Extracts required parameters from the input parameter map based on tool attributes.
-     * If the attributes contain a list of required parameters, only those parameters are extracted.
-     * Otherwise, all parameters are returned.
-     * @param parameters The input parameters map to extract from
-     * @param attributes The tool attributes containing required parameter information
-     * @return A map containing only the required parameters or all parameters if no required parameters are specified
-     */
-    public static Map<String, String> extractRequiredParameters(Map<String, String> parameters, Map<String, ?> attributes) {
-        Map<String, String> extractedParameters = new HashMap<>();
-        if (parameters == null) {
-            return extractedParameters;
-        }
-        if (attributes != null && attributes.containsKey(ToolConstants.TOOL_REQUIRED_PARAMS)) {
-            List<String> requiredParameters = StringUtils
-                .parseStringArrayToList((String) attributes.get(ToolConstants.TOOL_REQUIRED_PARAMS));
-            if (requiredParameters != null) {
-                for (String requiredParameter : requiredParameters) {
-                    extractedParameters.put(requiredParameter, parameters.get(requiredParameter));
-                }
-            }
-        } else {
-            extractedParameters.putAll(parameters);
-        }
-        return extractedParameters;
-    }
-
-    /**
-     * Extracts all relevant parameters including required parameters and nested parameters from the 'input' field.
-     * First extracts required parameters, then processes the 'input' field if present.
-     * The 'input' field is expected to contain a JSON string that can be parsed into a map of additional parameters.
-     * Variable substitution is performed on the 'input' field using the format ${parameters.key}.
-     *
-     * <p>This method is copied from <a href="https://github.com/opensearch-project/ml-commons/blob/190b2dfc141a6709e18dcd6ca531cb3402877fa5/ml-algorithms/src/main/java/org/opensearch/ml/engine/tools/ToolUtils.java#L36">org.opensearch.ml.engine.tools.ToolUtils.extractInputParameters</a>
-     *
-     * @param parameters The input parameters map to extract from
-     * @param attributes The tool attributes containing parameter requirements
-     * @return A map containing all extracted parameters including those from the 'input' field
-     */
-    public static Map<String, String> extractInputParameters(Map<String, String> parameters, Map<String, ?> attributes) {
-        Map<String, String> extractedParameters = extractRequiredParameters(parameters, attributes);
-        if (extractedParameters.containsKey("input")) {
-            try {
-                StringSubstitutor stringSubstitutor = new StringSubstitutor(parameters, "${parameters.", "}");
-                String input = stringSubstitutor.replace(parameters.get("input"));
-                extractedParameters.put("input", input);
-                Map<String, String> inputParameters = gson
-                    .fromJson(input, TypeToken.getParameterized(Map.class, String.class, String.class).getType());
-                extractedParameters.putAll(inputParameters);
-            } catch (Exception exception) {
-                log.info("fail extract parameters from key 'input' due to{}", exception.getMessage());
-            }
-        }
-        return extractedParameters;
-    }
 }
