add java doc for function

Signed-off-by: xinyual <[email protected]>
xinyual · Dec 9, 2024 · e29c011 · e29c011
1 parent 411dc73
commit e29c011
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/ml-algorithms/src/main/java/org/opensearch/ml/engine/utils/AgentModelsSearcher.java b/ml-algorithms/src/main/java/org/opensearch/ml/engine/utils/AgentModelsSearcher.java
@@ -24,7 +24,13 @@ public AgentModelsSearcher(Map<String, Tool.Factory> toolFactories) {
         }
     }
 
-    public SearchRequest constructQueryRequestToSearchModelId(String candidateModelId) {
+    /**
+     * Construct a should query to search all agent which containing candidate model Id
+    
+     @param candidateModelId the candidate model Id
+     @return a should search request towards agent index.
+     */
+    public SearchRequest constructQueryRequestToSearchModelIdInsideAgent(String candidateModelId) {
         SearchRequest searchRequest = new SearchRequest(ML_AGENT_INDEX);
         BoolQueryBuilder shouldQuery = QueryBuilders.boolQuery();
         for (String keyField : relatedModelIdSet) {

diff --git a/plugin/src/main/java/org/opensearch/ml/action/models/DeleteModelTransportAction.java b/plugin/src/main/java/org/opensearch/ml/action/models/DeleteModelTransportAction.java
@@ -264,7 +264,7 @@ public void onFailure(Exception e) {
 
     private void checkAgentBeforeDeleteModel(String modelId, ActionListener<Boolean> actionListener) {
         // check whether agent are using them
-        SearchRequest searchAgentRequest = agentModelsSearcher.constructQueryRequestToSearchModelId(modelId);
+        SearchRequest searchAgentRequest = agentModelsSearcher.constructQueryRequestToSearchModelIdInsideAgent(modelId);
         client.search(searchAgentRequest, ActionListener.wrap(searchResponse -> {
             SearchHit[] searchHits = searchResponse.getHits().getHits();
             if (searchHits.length == 0) {

diff --git a/plugin/src/test/java/org/opensearch/ml/action/models/DeleteModelTransportActionTests.java b/plugin/src/test/java/org/opensearch/ml/action/models/DeleteModelTransportActionTests.java
@@ -812,7 +812,7 @@ private void prepare() throws IOException {
         }).when(client).execute(eq(GetSearchPipelineAction.INSTANCE), any(), any());
         configDataMap = Map
             .of("single_model_id", "test_id", "list_model_id", List.of("test_id"), "test_map_id", Map.of("model_id", "test_id"));
-        doAnswer(invocation -> new SearchRequest()).when(agentModelsSearcher).constructQueryRequestToSearchModelId(any());
+        doAnswer(invocation -> new SearchRequest()).when(agentModelsSearcher).constructQueryRequestToSearchModelIdInsideAgent(any());
 
         GetResponse getResponse = prepareMLModel(MLModelState.REGISTERED, null, false);
         doAnswer(invocation -> {