code refactoring

Author: alexcheng1982

chain-workflow/src/main/java/com/javaaidev/agenticpatterns/chainworkflow/ChainWorkflowAgent.java

@@ -1,11 +1,10 @@
 package com.javaaidev.agenticpatterns.chainworkflow;
 
-import com.javaaidev.agenticpatterns.taskexecution.TaskExecutionAgent;
+import com.javaaidev.agenticpatterns.taskexecution.NoLLMTaskExecutionAgent;
 import io.micrometer.observation.ObservationRegistry;
 import java.lang.reflect.Type;
 import java.util.concurrent.CopyOnWriteArrayList;
 import org.jspecify.annotations.Nullable;
-import org.springframework.ai.chat.client.ChatClient;
 
 /**
  * Chain Workflow agent, refer to <a
@@ -15,21 +14,19 @@
  * @param <Response> Type of agent output
  */
 public class ChainWorkflowAgent<Request, Response> extends
-    TaskExecutionAgent<Request, Response> {
+    NoLLMTaskExecutionAgent<Request, Response> {
 
   private final CopyOnWriteArrayList<ChainStepAgent<Request, Response>> stepAgents = new CopyOnWriteArrayList<>();
 
   protected ChainWorkflowAgent(
-      ChatClient chatClient,
       @Nullable ObservationRegistry observationRegistry) {
-    super(chatClient, null, observationRegistry);
+    super(null, observationRegistry);
   }
 
   public ChainWorkflowAgent(
-      ChatClient chatClient,
       @Nullable Type responseType,
       @Nullable ObservationRegistry observationRegistry) {
-    super(chatClient, responseType, observationRegistry);
+    super(responseType, observationRegistry);
   }
 
   /**
@@ -50,9 +47,4 @@ private Response doCall(@Nullable Request request) {
     var chain = new WorkflowChain<>(stepAgents);
     return chain.callNext(request, null);
   }
-
-  @Override
-  protected String getPromptTemplate() {
-    return "";
-  }
 }

examples/src/main/java/com/javaaidev/agenticpatterns/examples/chainworkflow/ArticleGenerationAgent.java

@@ -0,0 +1,24 @@
+package com.javaaidev.agenticpatterns.examples.chainworkflow;
+
+import com.javaaidev.agenticpatterns.examples.chainworkflow.ArticleWritingAgent.ArticleWritingRequest;
+import com.javaaidev.agenticpatterns.examples.chainworkflow.ArticleWritingAgent.ArticleWritingResponse;
+import com.javaaidev.agenticpatterns.taskexecution.TaskExecutionAgent;
+import io.micrometer.observation.ObservationRegistry;
+import org.jspecify.annotations.Nullable;
+import org.springframework.ai.chat.client.ChatClient;
+
+class ArticleGenerationAgent extends
+    TaskExecutionAgent<ArticleWritingRequest, ArticleWritingResponse> {
+
+  protected ArticleGenerationAgent(ChatClient chatClient,
+      @Nullable ObservationRegistry observationRegistry) {
+    super(chatClient, ArticleWritingResponse.class, observationRegistry);
+  }
+
+  @Override
+  protected String getPromptTemplate() {
+    return """
+        Write an article about {topic}
+        """;
+  }
+}

examples/src/main/java/com/javaaidev/agenticpatterns/examples/chainworkflow/ArticleImprovementAgent.java

@@ -0,0 +1,59 @@
+package com.javaaidev.agenticpatterns.examples.chainworkflow;
+
+import com.javaaidev.agenticpatterns.chainworkflow.ChainStepAgent;
+import com.javaaidev.agenticpatterns.chainworkflow.WorkflowChain;
+import com.javaaidev.agenticpatterns.core.AgentUtils;
+import io.micrometer.observation.ObservationRegistry;
+import java.util.Map;
+import org.jspecify.annotations.Nullable;
+import org.springframework.ai.chat.client.ChatClient;
+
+class ArticleImprovementAgent extends
+    ChainStepAgent<ArticleImprovementRequest, ArticleImprovementResponse> {
+
+  private final String instruction;
+  private final int order;
+
+  protected ArticleImprovementAgent(ChatClient chatClient,
+      @Nullable ObservationRegistry observationRegistry, String instruction, int order) {
+    super(chatClient, ArticleImprovementResponse.class, observationRegistry);
+    this.instruction = instruction;
+    this.order = order;
+  }
+
+  @Override
+  protected String getPromptTemplate() {
+    return """
+        Goal: Improve an article by following the instruction:
+        
+        {instruction}
+        
+        Article content:
+        {article}
+        """;
+  }
+
+  @Override
+  protected ArticleImprovementResponse call(ArticleImprovementRequest request,
+      Map<String, Object> context,
+      WorkflowChain<ArticleImprovementRequest, ArticleImprovementResponse> chain) {
+    var response = this.call(request);
+    return chain.callNext(new ArticleImprovementRequest(response.article()), response);
+  }
+
+  @Override
+  protected Map<String, Object> getPromptContext(
+      @Nullable ArticleImprovementRequest request) {
+    return Map.of(
+        "instruction", instruction,
+        "article",
+        AgentUtils.safeGet(request, ArticleImprovementRequest::article, "")
+    );
+  }
+
+  @Override
+  public int getOrder() {
+    return order;
+  }
+
+}

examples/src/main/java/com/javaaidev/agenticpatterns/examples/chainworkflow/ArticleImprovementChainAgent.java

@@ -0,0 +1,48 @@
+package com.javaaidev.agenticpatterns.examples.chainworkflow;
+
+import com.javaaidev.agenticpatterns.chainworkflow.ChainWorkflowAgent;
+import io.micrometer.observation.ObservationRegistry;
+import java.util.List;
+import org.jspecify.annotations.Nullable;
+import org.springframework.ai.chat.client.ChatClient;
+
+class ArticleImprovementChainAgent extends
+    ChainWorkflowAgent<ArticleImprovementRequest, ArticleImprovementResponse> {
+
+  private final ChatClient chatClient;
+
+  protected ArticleImprovementChainAgent(
+      ChatClient chatClient,
+      @Nullable ObservationRegistry observationRegistry) {
+    super(ArticleImprovementResponse.class, observationRegistry);
+    this.chatClient = chatClient;
+    initStepAgents();
+  }
+
+  private void initStepAgents() {
+    var instructions = List.of(
+        """
+            Review the Structure
+            - Ensure the article has a clear introduction, body, and conclusion.
+            - Check if ideas flow logically from one section to another.
+            - Ensure paragraphs are well-organized and each one has a clear purpose.
+            """,
+        """
+            Improve Clarity and Conciseness
+            - Remove unnecessary words and redundant phrases.
+            - Simplify complex sentences for better readability.
+            - Use active voice where possible.
+            """,
+        """
+            Enhance Readability
+            - Break long paragraphs into shorter ones.
+            - Use bullet points or subheadings for easier scanning.
+            - Vary sentence length to maintain reader interest.
+            """
+    );
+    for (int i = 0; i < instructions.size(); i++) {
+      addStep(
+          new ArticleImprovementAgent(chatClient, observationRegistry, instructions.get(i), i));
+    }
+  }
+}

examples/src/main/java/com/javaaidev/agenticpatterns/examples/chainworkflow/ArticleImprovementRequest.java

@@ -0,0 +1,5 @@
+package com.javaaidev.agenticpatterns.examples.chainworkflow;
+
+record ArticleImprovementRequest(String article) {
+
+}

examples/src/main/java/com/javaaidev/agenticpatterns/examples/chainworkflow/ArticleImprovementResponse.java

@@ -0,0 +1,5 @@
+package com.javaaidev.agenticpatterns.examples.chainworkflow;
+
+record ArticleImprovementResponse(String article) {
+
+}

examples/src/main/java/com/javaaidev/agenticpatterns/examples/chainworkflow/ArticleWritingAgent.java

@@ -1,15 +1,9 @@
 package com.javaaidev.agenticpatterns.examples.chainworkflow;
 
-import com.javaaidev.agenticpatterns.chainworkflow.ChainStepAgent;
-import com.javaaidev.agenticpatterns.chainworkflow.ChainWorkflowAgent;
-import com.javaaidev.agenticpatterns.chainworkflow.WorkflowChain;
-import com.javaaidev.agenticpatterns.core.AgentUtils;
 import com.javaaidev.agenticpatterns.examples.chainworkflow.ArticleWritingAgent.ArticleWritingRequest;
 import com.javaaidev.agenticpatterns.examples.chainworkflow.ArticleWritingAgent.ArticleWritingResponse;
 import com.javaaidev.agenticpatterns.taskexecution.TaskExecutionAgent;
 import io.micrometer.observation.ObservationRegistry;
-import java.util.List;
-import java.util.Map;
 import org.jspecify.annotations.Nullable;
 import org.springframework.ai.chat.client.ChatClient;
 
@@ -48,123 +42,5 @@ public record ArticleWritingResponse(String article) {
 
   }
 
-  private record ArticleImprovementRequest(String article) {
 
-  }
-
-  private record ArticleImprovementResponse(String article) {
-
-  }
-
-  private static class ArticleGenerationAgent extends
-      TaskExecutionAgent<ArticleWritingRequest, ArticleWritingResponse> {
-
-    protected ArticleGenerationAgent(ChatClient chatClient,
-        @Nullable ObservationRegistry observationRegistry) {
-      super(chatClient, ArticleWritingResponse.class, observationRegistry);
-    }
-
-    @Override
-    protected String getPromptTemplate() {
-      return """
-          Write an article about {topic}
-          """;
-    }
-
-    @Override
-    protected Map<String, Object> getPromptContext(
-        @Nullable ArticleWritingRequest request) {
-      return Map.of(
-          "topic", AgentUtils.safeGet(request, ArticleWritingRequest::topic, "")
-      );
-    }
-  }
-
-  private static class ArticleImprovementChainAgent extends
-      ChainWorkflowAgent<ArticleImprovementRequest, ArticleImprovementResponse> {
-
-    protected ArticleImprovementChainAgent(
-        ChatClient chatClient,
-        @Nullable ObservationRegistry observationRegistry) {
-      super(chatClient, ArticleImprovementResponse.class, observationRegistry);
-      initStepAgents();
-    }
-
-    private void initStepAgents() {
-      var instructions = List.of(
-          """
-              Review the Structure
-              - Ensure the article has a clear introduction, body, and conclusion.
-              - Check if ideas flow logically from one section to another.
-              - Ensure paragraphs are well-organized and each one has a clear purpose.
-              """,
-          """
-              Improve Clarity and Conciseness
-              - Remove unnecessary words and redundant phrases.
-              - Simplify complex sentences for better readability.
-              - Use active voice where possible.
-              """,
-          """
-              Enhance Readability
-              - Break long paragraphs into shorter ones.
-              - Use bullet points or subheadings for easier scanning.
-              - Vary sentence length to maintain reader interest.
-              """
-      );
-      for (int i = 0; i < instructions.size(); i++) {
-        addStep(
-            new ArticleImprovementAgent(chatClient, observationRegistry, instructions.get(i), i));
-      }
-    }
-  }
-
-
-  private static class ArticleImprovementAgent extends
-      ChainStepAgent<ArticleImprovementRequest, ArticleImprovementResponse> {
-
-    private final String instruction;
-    private final int order;
-
-    protected ArticleImprovementAgent(ChatClient chatClient,
-        @Nullable ObservationRegistry observationRegistry, String instruction, int order) {
-      super(chatClient, ArticleImprovementResponse.class, observationRegistry);
-      this.instruction = instruction;
-      this.order = order;
-    }
-
-    @Override
-    protected String getPromptTemplate() {
-      return """
-          Goal: Improve an article by following the instruction:
-          
-          {instruction}
-          
-          Article content:
-          {article}
-          """;
-    }
-
-    @Override
-    protected ArticleImprovementResponse call(ArticleImprovementRequest request,
-        Map<String, Object> context,
-        WorkflowChain<ArticleImprovementRequest, ArticleImprovementResponse> chain) {
-      var response = this.call(request);
-      return chain.callNext(new ArticleImprovementRequest(response.article()), response);
-    }
-
-    @Override
-    protected Map<String, Object> getPromptContext(
-        @Nullable ArticleImprovementRequest request) {
-      return Map.of(
-          "instruction", instruction,
-          "article",
-          AgentUtils.safeGet(request, ArticleImprovementRequest::article, "")
-      );
-    }
-
-    @Override
-    public int getOrder() {
-      return order;
-    }
-  }
 }

examples/src/main/java/com/javaaidev/agenticpatterns/examples/parallelizationworkflow/AlgorithmArticleGenerationAgent.java

@@ -39,7 +39,8 @@ protected String getPromptTemplate() {
   @Override
   protected @Nullable Map<String, Object> getRequestPromptContext(
       @Nullable AlgorithmArticleGenerationRequest request) {
-    return AgentUtils.objectToMap(request);
+    return Map.of("algorithm",
+        AgentUtils.safeGet(request, AlgorithmArticleGenerationRequest::algorithm, ""));
   }
 
   @Override

examples/src/main/resources/application.yaml

@@ -7,7 +7,7 @@ spring:
       api-key: ${OPENAI_API_KEY:}
       chat:
         options:
-          model: gpt-4o-mini
+          model: gpt-4o
           temperature: 0.0
 logging:
   level:

parallelization-workflow/src/main/java/com/javaaidev/agenticpatterns/parallelizationworkflow/DirectAssembling.java

@@ -43,7 +43,7 @@ private Response doCall(@Nullable Request request) {
   /**
    * Assemble subtask execution results into the response
    *
-   * @param results Results of subtask execution
+   * @param results Results of subtask execution, see {@linkplain TaskExecutionResults}
    * @return Response
    */
   protected abstract Response assemble(TaskExecutionResults results);