Skip to content
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.

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

[FEATURE] Tool development for Cat Index Tool #1547

Closed
ylwu-amzn opened this issue Oct 24, 2023 · 1 comment · Fixed by #1746
Closed

[FEATURE] Tool development for Cat Index Tool #1547

ylwu-amzn opened this issue Oct 24, 2023 · 1 comment · Fixed by #1746
Assignees
Labels
enhancement New feature or request

Comments

@ylwu-amzn
Copy link
Collaborator

ylwu-amzn commented Oct 24, 2023

Is your feature request related to a problem?

Agent framework (#1161 ) needs tools to extend functionality. This issue propose to add cat index tools to it.
The cat index tool should return main information of index

  • health status
  • shard info: primary/replica shard count, size
  • doc count

What solution would you like?
Build tool in ml-commons to retrieve all index information.
Agent framework (#1161 ) will provide a general tool framework. We can build search monitor/alerts tools with that framework.

  1. Build against the Tool interface on the agent_framework_dev branch: https://github.com/opensearch-project/ml-commons/blob/feature/agent_framework_dev/spi/src/main/java/org/opensearch/ml/common/spi/tools/Tool.java

  2. Review example tools in the Agent Framework POC commit: 1b85cff where there are 6 tools under ml-algorithms/src/main/java/org/opensearch/ml/engine/tools/. A good example is the CatIndices tool: https://github.com/opensearch-project/ml-commons/blob/feature/agent_framework_dev/ml-algorithms/src/main/java/org/opensearch/ml/engine/tools/CatIndexTool.java which shows how to use the NodeClient (IndicesAdminClient) to fetch Cluster Health statistics.

What alternatives have you considered?
N/A

Do you have any additional context?
#1161

@ohltyler
Copy link
Member

Closed via #1582

@github-project-automation github-project-automation bot moved this from In Progress to Done in ml-commons projects Nov 14, 2023
@dbwiddis dbwiddis mentioned this issue Dec 11, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

Successfully merging a pull request may close this issue.

4 participants