Ensure chat agent returns response when max iterations are reached #4031

pyek-bot · 2025-08-01T03:33:34Z

Description

Ensures that chat agent returns a response when max iterations are reached. Currently, it returns an empty response when max_iteration is even and no response (api times out) if max_iteration is odd. This PR resolves that issue.

Related Issues

Resolves #4011

Check List

New functionality includes testing.
New functionality has been documented.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Pavan Yekbote <pybot@amazon.com>

codecov · 2025-08-01T17:48:56Z

Codecov Report

❌ Patch coverage is 95.23810% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 80.64%. Comparing base (0db22c9) to head (85bc638).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
.../ml/engine/algorithms/agent/MLChatAgentRunner.java	95.23%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #4031   +/-   ##
=========================================
  Coverage     80.64%   80.64%           
- Complexity     8016     8025    +9     
=========================================
  Files           695      695           
  Lines         35023    35058   +35     
  Branches       3935     3942    +7     
=========================================
+ Hits          28244    28274   +30     
- Misses         5044     5047    +3     
- Partials       1735     1737    +2

Flag	Coverage Δ
ml-commons	`80.64% <95.23%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

dhrubo-os · 2025-08-01T18:18:40Z

ml-algorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/MLChatAgentRunner.java

    public static final String DATETIME_FORMAT_FIELD = "datetime_format";
    public static final String SYSTEM_PROMPT_FIELD = "system_prompt";

    private static final String DEFAULT_MAX_ITERATIONS = "10";


can customer configure this value?

yes, chat agent has a parameter max_iteration

jiapingzeng

Thanks for the quick fix!

ml-algorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/MLChatAgentRunner.java

rithin-pullela-aws

LGTM

Signed-off-by: Pavan Yekbote <pybot@amazon.com>

pyek-bot · 2025-08-01T21:03:59Z

Can a maintainer please add backport label for 3.1? Thanks!
cc: @dhrubo-os @ylwu-amzn

opensearch-trigger-bot · 2025-08-01T21:05:47Z

The backport to 3.1 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-3.1 3.1
# Navigate to the new working tree
cd .worktrees/backport-3.1
# Create a new branch
git switch --create backport/backport-4031-to-3.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f6a68bf2ffca0b68c0c677a0aca9125e42f13a46
# Push it to GitHub
git push --set-upstream origin backport/backport-4031-to-3.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-3.1

Then, create a pull request where the base branch is 3.1 and the compare/head branch is backport/backport-4031-to-3.1.

…pensearch-project#4031) * fix: mlchatagentrunner max iterations bug Signed-off-by: Pavan Yekbote <pybot@amazon.com> * fix: gradle spotless Signed-off-by: Pavan Yekbote <pybot@amazon.com> * feat: refactor some code and add test cases Signed-off-by: Pavan Yekbote <pybot@amazon.com> * refactor: move the last iteration check earlier Signed-off-by: Pavan Yekbote <pybot@amazon.com> --------- Signed-off-by: Pavan Yekbote <pybot@amazon.com> Co-authored-by: Dhrubo Saha <dhrubo@amazon.com>

pyek-bot · 2025-08-01T21:31:04Z

Raised manual backport PR: #4036

…4031) (#4036) * fix: mlchatagentrunner max iterations bug * fix: gradle spotless * feat: refactor some code and add test cases * refactor: move the last iteration check earlier --------- Signed-off-by: Pavan Yekbote <pybot@amazon.com> Co-authored-by: Dhrubo Saha <dhrubo@amazon.com>

pyek-bot added 2 commits July 31, 2025 20:33

fix: mlchatagentrunner max iterations bug

2f1e247

Signed-off-by: Pavan Yekbote <pybot@amazon.com>

fix: gradle spotless

7a1f0bd

Signed-off-by: Pavan Yekbote <pybot@amazon.com>

pyek-bot had a problem deploying to ml-commons-cicd-env-require-approval August 1, 2025 03:38 — with GitHub Actions Failure

pyek-bot had a problem deploying to ml-commons-cicd-env-require-approval August 1, 2025 03:38 — with GitHub Actions Error

Merge branch 'main' into chat_agent_max_iterations_fixes

c3fcbac

dhrubo-os had a problem deploying to ml-commons-cicd-env-require-approval August 1, 2025 03:46 — with GitHub Actions Failure

dhrubo-os had a problem deploying to ml-commons-cicd-env-require-approval August 1, 2025 03:46 — with GitHub Actions Error

feat: refactor some code and add test cases

b71c4b5

Signed-off-by: Pavan Yekbote <pybot@amazon.com>

pyek-bot changed the title ~~fix: mlchatagentrunner max iterations bug~~ Ensure chat agent returns response when max iterations are reached Aug 1, 2025

pyek-bot temporarily deployed to ml-commons-cicd-env-require-approval August 1, 2025 07:35 — with GitHub Actions Inactive

pyek-bot marked this pull request as ready for review August 1, 2025 07:35

pyek-bot requested review from HenryL27, Zhangxunmt, austintlee, b4sjoo, dhrubo-os, jngz-es, mingshl, model-collapse, rbhavna, xinyual, ylwu-amzn and zane-neo as code owners August 1, 2025 07:35

pyek-bot had a problem deploying to ml-commons-cicd-env-require-approval August 1, 2025 17:48 — with GitHub Actions Failure

pyek-bot had a problem deploying to ml-commons-cicd-env-require-approval August 1, 2025 17:48 — with GitHub Actions Error

pyek-bot mentioned this pull request Aug 1, 2025

[BUG] Chat Agent returns empty response when exceeding max iterations #4011

Closed

Merge branch 'main' into chat_agent_max_iterations_fixes

493b872

pyek-bot temporarily deployed to ml-commons-cicd-env-require-approval August 1, 2025 18:19 — with GitHub Actions Inactive

dhrubo-os reviewed Aug 1, 2025

View reviewed changes

jiapingzeng approved these changes Aug 1, 2025

View reviewed changes

ml-algorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/MLChatAgentRunner.java Outdated Show resolved Hide resolved

ml-algorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/MLChatAgentRunner.java Show resolved Hide resolved

rithin-pullela-aws approved these changes Aug 1, 2025

View reviewed changes

refactor: move the last iteration check earlier

85bc638

Signed-off-by: Pavan Yekbote <pybot@amazon.com>

pyek-bot temporarily deployed to ml-commons-cicd-env-require-approval August 1, 2025 18:52 — with GitHub Actions Inactive

ylwu-amzn approved these changes Aug 1, 2025

View reviewed changes

dhrubo-os approved these changes Aug 1, 2025

View reviewed changes

dhrubo-os merged commit f6a68bf into opensearch-project:main Aug 1, 2025
9 checks passed

pyek-bot had a problem deploying to ml-commons-cicd-env-require-approval August 1, 2025 20:51 — with GitHub Actions Error

pyek-bot had a problem deploying to ml-commons-cicd-env-require-approval August 1, 2025 20:51 — with GitHub Actions Failure

dhrubo-os added the backport 3.1 label Aug 1, 2025

pyek-bot mentioned this pull request Aug 1, 2025

[Backport 3.1] Ensure chat agent returns response for max_iteration #4036

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Ensure chat agent returns response when max iterations are reached #4031

Ensure chat agent returns response when max iterations are reached #4031

Uh oh!

pyek-bot commented Aug 1, 2025 •

edited

Loading

Uh oh!

codecov bot commented Aug 1, 2025 •

edited

Loading

Uh oh!

dhrubo-os Aug 1, 2025

Uh oh!

pyek-bot Aug 1, 2025

Uh oh!

jiapingzeng left a comment

Uh oh!

Uh oh!

Uh oh!

rithin-pullela-aws left a comment

Uh oh!

Uh oh!

pyek-bot commented Aug 1, 2025

Uh oh!

opensearch-trigger-bot bot commented Aug 1, 2025

Uh oh!

pyek-bot commented Aug 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Ensure chat agent returns response when max iterations are reached #4031

Ensure chat agent returns response when max iterations are reached #4031

Uh oh!

Conversation

pyek-bot commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

codecov bot commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dhrubo-os Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

pyek-bot Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

jiapingzeng left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rithin-pullela-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pyek-bot commented Aug 1, 2025

Uh oh!

opensearch-trigger-bot bot commented Aug 1, 2025

Uh oh!

pyek-bot commented Aug 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

pyek-bot commented Aug 1, 2025 •

edited

Loading

codecov bot commented Aug 1, 2025 •

edited

Loading