Expose a general function for agent execution #268

ruanyl · 2024-09-04T08:55:07Z

Description

This PR adds an assistant client to both public(UI) and server which currently exposes the agent execute API

Issues Resolved

[List any issues this PR will resolve]

Check List

New functionality includes testing.
- All tests pass, including unit test, integration test.
New functionality has user manual doc added.
Commits are signed per the DCO using --signoff.

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: Yulong Ruan <[email protected]>

Hailong-am · 2024-09-04T09:22:38Z

server/services/assistant_client.ts

+    agentName: string,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    parameters: Record<string, any>


do we want to support executeAgent with agent id?

I also considered this, but we don't have use case at the moment which requires to execute agent with id directly, so I decided to not add it for now, we can add it when it's needed.

Knowledge base needs to execute by agent id directly

@qianheng-aws may have a requirement to execute agent id directly

I see, let me add that

@Hailong-am @qianheng-aws Updated, could you take another look?

looks good to me.

Signed-off-by: Yulong Ruan <[email protected]>

chishui

How do we allow other plugins to overwrite assistantClient and provide their own customized functionalities?

Signed-off-by: Yulong Ruan <[email protected]>

ruanyl · 2024-09-04T10:13:29Z

How do we allow other plugins to overwrite assistantClient and provide their own customized functionalities?

Could you provide a use case or example?

Signed-off-by: gaobinlong <[email protected]>

gaobinlong

LGTM.

qianheng-aws · 2024-09-05T05:36:22Z

public/services/assistant_client.ts

+  constructor(private http: HttpSetup) {}
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  executeAgent = (agentId: string, parameters: Record<string, any>, options?: Options) => {


Will there be chance that executeAgent and executeAgentByName combined to be one API? Seems the only difference is that they pass different parameters in the query field

Otherwise, we need to add active method in both these 2 functions.

this is the APIs of public(UI), they will call the corresponding server APIs, and in server side, they will end up with calling one single function.

opensearch-trigger-bot · 2024-09-05T06:19:06Z

The backport to 2.x failed:

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

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/dashboards-assistant/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/dashboards-assistant/backport-2.x
# Create a new branch
git switch --create backport/backport-268-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 88aa96b70df878dffccc689811c7ded29a7d490d
# Push it to GitHub
git push --set-upstream origin backport/backport-268-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/dashboards-assistant/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-268-to-2.x.

* feat: add assistant client to public and server Signed-off-by: Yulong Ruan <[email protected]> * tweaks Signed-off-by: Yulong Ruan <[email protected]> * fix path Signed-off-by: Yulong Ruan <[email protected]> * update changelog Signed-off-by: Yulong Ruan <[email protected]> * feat: support both execute agent by name and by id Signed-off-by: Yulong Ruan <[email protected]> * fix(public): support execute agent by name or id Signed-off-by: Yulong Ruan <[email protected]> --------- Signed-off-by: Yulong Ruan <[email protected]> Signed-off-by: gaobinlong <[email protected]> Co-authored-by: gaobinlong <[email protected]> (cherry picked from commit 88aa96b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

opensearch-trigger-bot · 2024-09-06T05:56:51Z

The backport to 2.17 failed:

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

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/dashboards-assistant/backport-2.17 2.17
# Navigate to the new working tree
pushd ../.worktrees/dashboards-assistant/backport-2.17
# Create a new branch
git switch --create backport/backport-268-to-2.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 88aa96b70df878dffccc689811c7ded29a7d490d
# Push it to GitHub
git push --set-upstream origin backport/backport-268-to-2.17
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/dashboards-assistant/backport-2.17

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

opensearch-trigger-bot · 2024-09-06T06:01:56Z

The backport to 2.17 failed:

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

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/dashboards-assistant/backport-2.17 2.17
# Navigate to the new working tree
pushd ../.worktrees/dashboards-assistant/backport-2.17
# Create a new branch
git switch --create backport/backport-268-to-2.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 88aa96b70df878dffccc689811c7ded29a7d490d
# Push it to GitHub
git push --set-upstream origin backport/backport-268-to-2.17
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/dashboards-assistant/backport-2.17

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

* feat: add assistant client to public and server Signed-off-by: Yulong Ruan <[email protected]> * tweaks Signed-off-by: Yulong Ruan <[email protected]> * fix path Signed-off-by: Yulong Ruan <[email protected]> * update changelog Signed-off-by: Yulong Ruan <[email protected]> * feat: support both execute agent by name and by id Signed-off-by: Yulong Ruan <[email protected]> * fix(public): support execute agent by name or id Signed-off-by: Yulong Ruan <[email protected]> --------- Signed-off-by: Yulong Ruan <[email protected]> Signed-off-by: gaobinlong <[email protected]> Co-authored-by: gaobinlong <[email protected]>

* feat: add assistant client to public and server Signed-off-by: Yulong Ruan <[email protected]> * tweaks Signed-off-by: Yulong Ruan <[email protected]> * fix path Signed-off-by: Yulong Ruan <[email protected]> * update changelog Signed-off-by: Yulong Ruan <[email protected]> * feat: support both execute agent by name and by id Signed-off-by: Yulong Ruan <[email protected]> * fix(public): support execute agent by name or id Signed-off-by: Yulong Ruan <[email protected]> --------- Signed-off-by: Yulong Ruan <[email protected]> Signed-off-by: gaobinlong <[email protected]> Co-authored-by: gaobinlong <[email protected]> (cherry picked from commit 88aa96b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* feat: add assistant client to public and server * tweaks * fix path * update changelog * feat: support both execute agent by name and by id * fix(public): support execute agent by name or id --------- Signed-off-by: Yulong Ruan <[email protected]> Signed-off-by: gaobinlong <[email protected]> Co-authored-by: gaobinlong <[email protected]>

ruanyl added 3 commits September 4, 2024 16:08

feat: add assistant client to public and server

eb8cf13

Signed-off-by: Yulong Ruan <[email protected]>

tweaks

aa3e483

Signed-off-by: Yulong Ruan <[email protected]>

fix path

493d293

Signed-off-by: Yulong Ruan <[email protected]>

ruanyl requested review from lezzago, joshuali925, anirudha, SuZhou-Joe, xluo-aws, gaobinlong, Hailong-am, wanglam and raintygao as code owners September 4, 2024 08:55

Hailong-am approved these changes Sep 4, 2024

View reviewed changes

update changelog

6d7dd87

Signed-off-by: Yulong Ruan <[email protected]>

chishui reviewed Sep 4, 2024

View reviewed changes

ruanyl added 2 commits September 4, 2024 18:01

feat: support both execute agent by name and by id

15bdf4d

Signed-off-by: Yulong Ruan <[email protected]>

fix(public): support execute agent by name or id

b3d4b22

Signed-off-by: Yulong Ruan <[email protected]>

gaobinlong added backport 2.x Trigger the backport flow to 2.x v2.17.0 labels Sep 4, 2024

Merge branch 'main' into expose-a-general-function-for-agent-execution

003da1b

Signed-off-by: gaobinlong <[email protected]>

gaobinlong approved these changes Sep 5, 2024

View reviewed changes

qianheng-aws reviewed Sep 5, 2024

View reviewed changes

ruanyl merged commit 88aa96b into opensearch-project:main Sep 5, 2024
8 of 9 checks passed

opensearch-trigger-bot bot added the failed backport label Sep 5, 2024

ruanyl added backport 2.x Trigger the backport flow to 2.x and removed backport 2.x Trigger the backport flow to 2.x labels Sep 6, 2024

opensearch-trigger-bot bot mentioned this pull request Sep 6, 2024

[Backport 2.x] Expose a general function for agent execution #276

Merged

ruanyl added the backport 2.17 label Sep 6, 2024

ruanyl added backport 2.17 and removed backport 2.17 labels Sep 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose a general function for agent execution #268

Expose a general function for agent execution #268

ruanyl commented Sep 4, 2024

Hailong-am Sep 4, 2024

ruanyl Sep 4, 2024

qianheng-aws Sep 4, 2024

qianheng-aws Sep 4, 2024

Hailong-am Sep 4, 2024 •

edited

Loading

ruanyl Sep 4, 2024

ruanyl Sep 4, 2024

Hailong-am Sep 4, 2024

qianheng-aws Sep 5, 2024

chishui left a comment

ruanyl commented Sep 4, 2024

gaobinlong left a comment

qianheng-aws Sep 5, 2024

ruanyl Sep 5, 2024

opensearch-trigger-bot bot commented Sep 5, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

Expose a general function for agent execution #268

Expose a general function for agent execution #268

Conversation

ruanyl commented Sep 4, 2024

Description

Issues Resolved

Check List

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Hailong-am Sep 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chishui left a comment

Choose a reason for hiding this comment

ruanyl commented Sep 4, 2024

gaobinlong left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Sep 5, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

opensearch-trigger-bot bot commented Sep 6, 2024

Hailong-am Sep 4, 2024 •

edited

Loading