feat: implement tests for search index tool

[yuye-aws]

Description

Implement test script and runner for search index tool. You can run tests by
npm run test -- src/tests/search_index/search_index.test.ts
Remember to specify SEARCH_INDEX_AGENT_ID in .env first.

Issues Resolved

Implement test script and runner for search index tool.

Check List

• New functionality includes testing.
  • All tests pass, including unit test, integration test and doctest
• New functionality has been documented.
  • New functionality has javadoc added
  • 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.

[joshuali925]

looks good, minor comments. Seems this tool is not used by react agent directly? If it doesn't use any LLM or embeddings model then UT and IT should cover it, adding it here can be optional.

Also could you attach a flow template you used to create the agent? thanks

[joshuali925]

sorry i didn't realize options.agentIdKey isn't passed when provider is agent_framework

could you revert this and change

skills-eval/src/providers/factory/index.ts

Line 37 in f8c0d38

return new AgentFrameworkApiProvider();

to

return new AgentFrameworkApiProvider(undefined, options.agentIdKey);

[yuye-aws]

Sure.

[yuye-aws]

With this change, we no longer need a switch case for PROVIDERS.SEARCH_INDEX_TOOL

[joshuali925]

there's a search response interface provided import { SearchResponse } from '@opensearch-project/opensearch/api/types';

Suggested change

	})) as ApiResponse<DSLResponse>;
	})) as ApiResponse<SearchResponse>;

[yuye-aws]

Thanks for reminding me. I will change the type.

[yuye-aws]

Seems this tool is not used by react agent directly? If it doesn't use any LLM or embeddings model then UT and IT should cover it, adding it here can be optional.

Can I test this tool with both flow agent and conversational agent? I think we can just add a new runner for search index tool.

[yuye-aws]

Also could you attach a flow template you used to create the agent? thanks

The flow template is:

POST /_plugins/_ml/agents/_register
{
  "name": "Test_Agent_For_Search_Index_Tool",
  "type": "flow",
  "description": "this is a test agent for search index tool",
  "memory": {
    "type": "demo"
  },
  "tools": [
    {
      "type": "SearchIndexTool"
    }
  ]
}

In which file should I attach the flow template?

[joshuali925]

"type": "flow",

thanks, i think flow agent case can be covered by unit tests, since there's no model logic involved. I don't mind this PR adding them here, but if this will be used by a conversational agent that uses LLM, it would be better to add those tests