Skip to content

Commit

Permalink
tune catindex tool description
Browse files Browse the repository at this point in the history
Signed-off-by: Yaliang Wu <[email protected]>
  • Loading branch information
ylwu-amzn committed Feb 21, 2024
1 parent f5c96c6 commit 94ee0b9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/tutorials/agent_framework/build_your_own_chatbot.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ POST _plugins/_ml/agents/_register
},
{
"type": "CatIndexTool",
"description": "Use this tool to get OpenSearch index information: (health, status, index, uuid, primary count, replica count, docs.count, docs.deleted, store.size, primary.store.size). \nIt takes 2 optional arguments named `index` which is a comma-delimited list of one or more indices to get information from (default is an empty list meaning all indices), and `local` which means whether to return information from the local node only instead of the cluster manager node (default is false)."
"description": "\nUse this tool to get OpenSearch index information: (health, status, index, uuid, primary count, replica count, docs.count, docs.deleted, store.size, primary.store.size). \n\nIt takes 2 optional arguments\n1. `indices`: it is a string list of one or more indices to get information from\n2. `local`: if it's true means return information from the local node only instead of the cluster manager node (default is false).\n\nSample input for get index information of specific index:\n{'indices': ['index-name1,index-name2']}\n\nSample input for get specific index formation on local node:\n{'indices': ['index-name1,index-name2'], 'local': 'true'}\n\nSample input for get all index formation on local node:\n{'local': 'true'}\n\nSample input for get all index formation on cluster manager node:\n{'local': 'false'} \nor just provide empty string ''\n"
},
{
"type": "SearchAnomalyDetectorsTool"
Expand Down

0 comments on commit 94ee0b9

Please sign in to comment.