Skip to content

Add escape output parameter #4179

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add escape output parameter #4179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14bcb07
add escape output parameter
Hailong-am Sep 18, 2025
c824105
Merge branch 'main' into chatbot_invalidpaylod
Hailong-am Sep 23, 2025
97c269a
rename parameter name
Hailong-am Sep 24, 2025
1192c34
update parameter name
Hailong-am Sep 24, 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
9 changes: 7 additions & 2 deletions common/src/main/java/org/opensearch/ml/common/utils/StringUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,16 @@ public static boolean isJson(String json) {
* prepareJsonValue("{\"key\":123}") → {\"key\":123} (valid JSON object, unchanged)
* </pre>
* @param input
* @param escapeJson
* @return
*/
public static String prepareJsonValue(String input) {
public static String prepareJsonValue(String input, boolean escapeJson) {
if (isJson(input)) {
return input;
if (!escapeJson) {
return input;
} else {
return escapeJson(input);
}
}
return escapeJson(input);
}
Expand Down
1 change: 1 addition & 0 deletions common/src/main/java/org/opensearch/ml/common/utils/ToolUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
public class ToolUtils {

public static final String TOOL_OUTPUT_FILTERS_FIELD = "output_filter";
public static final String TOOL_ESCAPE_OUTPUT = "escape_output";
public static final String TOOL_REQUIRED_PARAMS = "required_parameters";
public static final String NO_ESCAPE_PARAMS = "no_escape_params";

Expand Down
11 changes: 9 additions & 2 deletions common/src/test/java/org/opensearch/ml/common/utils/StringUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,14 +861,21 @@ public void testValidateFields_InvalidCharacterSet() {
@Test
public void prepareJsonValue_returnsRawIfJson() {
String json = "{\"key\": 123}";
String result = StringUtils.prepareJsonValue(json);
String result = StringUtils.prepareJsonValue(json, false);
assertSame(json, result); // branch where isJson(input)==true
}

@Test
public void prepareJsonValue_returnEscapeJsonIfForce() {
String json = "{\"key\": 123}";
String result = StringUtils.prepareJsonValue(json, true);
assertEquals("{\\\"key\\\": 123}", result);
}

@Test
public void prepareJsonValue_escapesBadCharsOtherwise() {
String input = "Tom & Jerry \"<script>";
String escaped = StringUtils.prepareJsonValue(input);
String escaped = StringUtils.prepareJsonValue(input, false);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something is misleading here, you are actually escaping the plain text, but passing "escape" parameter as false. May be rename "escape" parameter in the API definition, which should understand it is only about json string.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make sense, i will update it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename it to escapeJson

assertNotEquals(input, escaped);
assertFalse(StringUtils.isJson(escaped));
assertEquals("Tom & Jerry \\\"<script>", escaped);
Expand Down
7 changes: 6 additions & 1 deletion .../main/java/org/opensearch/ml/engine/algorithms/agent/MLConversationalFlowAgentRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import static org.opensearch.ml.common.conversation.ActionConstants.AI_RESPONSE_FIELD;
import static org.opensearch.ml.common.conversation.ActionConstants.MEMORY_ID;
import static org.opensearch.ml.common.conversation.ActionConstants.PARENT_INTERACTION_ID_FIELD;
import static org.opensearch.ml.common.utils.ToolUtils.TOOL_ESCAPE_OUTPUT;
import static org.opensearch.ml.common.utils.ToolUtils.TOOL_OUTPUT_FILTERS_FIELD;
import static org.opensearch.ml.common.utils.ToolUtils.filterToolOutput;
import static org.opensearch.ml.common.utils.ToolUtils.getToolName;
Expand Down Expand Up @@ -262,7 +263,11 @@ private void processOutput(
String outputKey = toolName + ".output";
Map<String, String> toolParameters = ToolUtils.buildToolParameters(params, previousToolSpec, tenantId);
String filteredOutput = parseResponse(filterToolOutput(toolParameters, output));
params.put(outputKey, StringUtils.prepareJsonValue(filteredOutput));
params
.put(
outputKey,
StringUtils.prepareJsonValue(filteredOutput, Boolean.parseBoolean(toolParameters.getOrDefault(TOOL_ESCAPE_OUTPUT, "false")))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we expecting customer to provide this settings: TOOL_ESCAPE_OUTPUT?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, as tool parameters whebln configure the agent.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An example

"user_inputs": {
    "description": "Agent Tool",
    "include_output_in_agent_response": True,
    "type": "AgentTool",
    "parameters": {
        "max_iteration": "10",
        "escape_output": "true"
    },
    "name": "AgentTool"
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just trying to understand, based on what condition/experience customer will try to set True/False on this parameter? How will customer determine if they need to set this or not? This seems too much details for customer to understand.

Copy link
Contributor Author

@Hailong-am Hailong-am Sep 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that depends on the use case, if the tool output will used to concat with other strings to build a prompt for LLM, that's a typical case we need to set it as true. That is the case for chatbot question suggestor which is a MLModelTool and leverage previous tool output to build the prompt for LLM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just trying to understand, based on what condition/experience customer will try to set True/False on this parameter? How will customer determine if they need to set this or not? This seems too much details for customer to understand.

+1

);
boolean traceDisabled = params.containsKey(DISABLE_TRACE) && Boolean.parseBoolean(params.get(DISABLE_TRACE));

if (previousToolSpec.isIncludeOutputInAgentResponse() || finalI == toolSpecs.size()) {
Expand Down
11 changes: 10 additions & 1 deletion ml-algorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/MLFlowAgentRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

package org.opensearch.ml.engine.algorithms.agent;

import static org.opensearch.ml.common.utils.ToolUtils.TOOL_ESCAPE_OUTPUT;
import static org.opensearch.ml.common.utils.ToolUtils.TOOL_OUTPUT_FILTERS_FIELD;
import static org.opensearch.ml.common.utils.ToolUtils.filterToolOutput;
import static org.opensearch.ml.common.utils.ToolUtils.getToolName;
Expand Down Expand Up @@ -114,7 +115,15 @@ public void run(MLAgent mlAgent, Map<String, String> params, ActionListener<Obje
String outputKey = toolName + ".output";
Map<String, String> toolParameters = ToolUtils.buildToolParameters(params, previousToolSpec, mlAgent.getTenantId());
String filteredOutput = parseResponse(filterToolOutput(toolParameters, output));
params.put(outputKey, StringUtils.prepareJsonValue(filteredOutput));
params
.put(
outputKey,
StringUtils
.prepareJsonValue(
filteredOutput,
Boolean.parseBoolean(toolParameters.getOrDefault(TOOL_ESCAPE_OUTPUT, "false"))
)
);
if (previousToolSpec.isIncludeOutputInAgentResponse() || finalI == toolSpecs.size()) {
if (toolParameters.containsKey(TOOL_OUTPUT_FILTERS_FIELD)) {
flowAgentOutput.add(ModelTensor.builder().name(outputKey).result(filteredOutput).build());
Expand Down
Loading