code improvement

Author: alexcheng1982

chain-workflow/README.md

@@ -0,0 +1,6 @@
+# Chain Workflow Agent
+
+Implementation
+of [Chain Workflow pattern](https://javaaidev.com/docs/agentic-patterns/patterns/chain-workflow)
+
+See [doc](https://javaaidev.com/docs/agentic-patterns/reference-implementation/chain-workflow-agent)

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

@@ -8,7 +8,14 @@
 import org.springframework.ai.chat.client.ChatClient;
 import org.springframework.core.Ordered;
 
-public abstract class ChainStepAgent<Req, Res> extends TaskExecutionAgent<Req, Res> implements
+/**
+ * A step in the chain
+ *
+ * @param <Request>  Task input type
+ * @param <Response> Task output type
+ */
+public abstract class ChainStepAgent<Request, Response> extends
+    TaskExecutionAgent<Request, Response> implements
     Ordered {
 
   protected ChainStepAgent(ChatClient chatClient,
@@ -22,6 +29,14 @@ protected ChainStepAgent(ChatClient chatClient,
     super(chatClient, responseType, observationRegistry);
   }
 
-  protected abstract Res call(Req request, Map<String, Object> context,
-      WorkflowChain<Req, Res> chain);
+  /**
+   * Call the current step
+   *
+   * @param request Task input
+   * @param context Shared context between different steps
+   * @param chain   The chain, see {@linkplain WorkflowChain}
+   * @return Task output
+   */
+  protected abstract Response call(Request request, Map<String, Object> context,
+      WorkflowChain<Request, Response> chain);
 }

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

@@ -3,15 +3,21 @@
 import com.javaaidev.agenticpatterns.taskexecution.TaskExecutionAgent;
 import io.micrometer.observation.ObservationRegistry;
 import java.lang.reflect.Type;
-import java.util.ArrayList;
-import java.util.List;
+import java.util.concurrent.CopyOnWriteArrayList;
 import org.jspecify.annotations.Nullable;
 import org.springframework.ai.chat.client.ChatClient;
 
+/**
+ * Chain Workflow agent, refer to <a
+ * href="https://javaaidev.com/docs/agentic-patterns/patterns/chain-workflow">doc</a>
+ *
+ * @param <Request>  Task input type
+ * @param <Response> Task output type
+ */
 public class ChainWorkflowAgent<Request, Response> extends
     TaskExecutionAgent<Request, Response> {
 
-  private final List<ChainStepAgent<Request, Response>> stepAgents = new ArrayList<>();
+  private final CopyOnWriteArrayList<ChainStepAgent<Request, Response>> stepAgents = new CopyOnWriteArrayList<>();
 
   protected ChainWorkflowAgent(
       ChatClient chatClient,
@@ -26,6 +32,11 @@ public ChainWorkflowAgent(
     super(chatClient, responseType, observationRegistry);
   }
 
+  /**
+   * Add a step in the chain
+   *
+   * @param stepAgent A step in the chain
+   */
   public void addStep(ChainStepAgent<Request, Response> stepAgent) {
     stepAgents.add(stepAgent);
   }

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

@@ -10,6 +10,12 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.core.OrderComparator;
 
+/**
+ * Chain to manage steps
+ *
+ * @param <Request>  Task input type
+ * @param <Response> Task output type
+ */
 public class WorkflowChain<Request, Response> {
 
   private final Deque<ChainStepAgent<Request, Response>> agents;
@@ -22,6 +28,13 @@ public WorkflowChain(List<ChainStepAgent<Request, Response>> agents) {
     LOGGER.info("Added {} agents to the chain", this.agents.size());
   }
 
+  /**
+   * Call next step in the chain
+   *
+   * @param request      Task input
+   * @param lastResponse Last task output
+   * @return Task output
+   */
   public Response callNext(Request request, @Nullable Response lastResponse) {
     if (agents.isEmpty()) {
       return lastResponse;

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

@@ -72,10 +72,10 @@ protected String getPromptTemplate() {
     }
 
     @Override
-    protected @Nullable Map<String, Object> getPromptContext(
-        @Nullable ArticleWritingRequest articleWritingRequest) {
+    protected Map<String, Object> getPromptContext(
+        @Nullable ArticleWritingRequest request) {
       return Map.of(
-          "topic", AgentUtils.safeGet(articleWritingRequest, ArticleWritingRequest::topic, "")
+          "topic", AgentUtils.safeGet(request, ArticleWritingRequest::topic, "")
       );
     }
   }
@@ -153,12 +153,12 @@ protected ArticleImprovementResponse call(ArticleImprovementRequest request,
     }
 
     @Override
-    protected @Nullable Map<String, Object> getPromptContext(
-        @Nullable ArticleImprovementRequest articleImprovementRequest) {
+    protected Map<String, Object> getPromptContext(
+        @Nullable ArticleImprovementRequest request) {
       return Map.of(
           "instruction", instruction,
           "article",
-          AgentUtils.safeGet(articleImprovementRequest, ArticleImprovementRequest::article, "")
+          AgentUtils.safeGet(request, ArticleImprovementRequest::article, "")
       );
     }
 

examples/src/main/java/com/javaaidev/agenticpatterns/examples/evaluatoroptimizer/CodeGenerationAgent.java

@@ -29,9 +29,9 @@ protected String getInitialResultPromptTemplate() {
 
   @Override
   protected @Nullable Map<String, Object> buildInitialResultPromptContext(
-      @Nullable CodeGenerationRequest codeGenerationRequest) {
+      @Nullable CodeGenerationRequest request) {
     return Map.of("input",
-        AgentUtils.safeGet(codeGenerationRequest, CodeGenerationRequest::input, ""));
+        AgentUtils.safeGet(request, CodeGenerationRequest::input, ""));
   }
 
   @Override

examples/src/main/java/com/javaaidev/agenticpatterns/examples/routingworkflow/CustomerSupportAgent.java

@@ -13,16 +13,19 @@
 import org.springframework.ai.chat.client.ChatClient;
 import org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec;
 
+/**
+ * A routing workflow agent for customer support
+ */
 public class CustomerSupportAgent extends
     RoutingWorkflowAgent<CustomerSupportRequest, CustomerSupportResponse> {
 
-  protected CustomerSupportAgent(ChatClient chatClient,
+  public CustomerSupportAgent(ChatClient chatClient,
       @Nullable Type responseType, @Nullable ObservationRegistry observationRegistry) {
     super(chatClient, responseType, observationRegistry);
     initRoutes();
   }
 
-  protected CustomerSupportAgent(ChatClient chatClient,
+  public CustomerSupportAgent(ChatClient chatClient,
       @Nullable ObservationRegistry observationRegistry) {
     super(chatClient, observationRegistry);
     initRoutes();
@@ -65,10 +68,10 @@ protected String getPromptTemplate() {
 
     @Override
     protected @Nullable Map<String, Object> getPromptContext(
-        @Nullable CustomerSupportRequest customerSupportRequest) {
+        @Nullable CustomerSupportRequest request) {
       return Map.of(
           "question",
-          AgentUtils.safeGet(customerSupportRequest, CustomerSupportRequest::question, "")
+          AgentUtils.safeGet(request, CustomerSupportRequest::question, "")
       );
     }
 
@@ -92,11 +95,11 @@ protected String getPromptTemplate() {
     }
 
     @Override
-    protected @Nullable Map<String, Object> getPromptContext(
-        @Nullable CustomerSupportRequest customerSupportRequest) {
+    protected Map<String, Object> getPromptContext(
+        @Nullable CustomerSupportRequest request) {
       return Map.of(
           "question",
-          AgentUtils.safeGet(customerSupportRequest, CustomerSupportRequest::question, "")
+          AgentUtils.safeGet(request, CustomerSupportRequest::question, "")
       );
     }
 
@@ -121,10 +124,10 @@ protected String getPromptTemplate() {
 
     @Override
     protected @Nullable Map<String, Object> getPromptContext(
-        @Nullable CustomerSupportRequest customerSupportRequest) {
+        @Nullable CustomerSupportRequest request) {
       return Map.of(
           "question",
-          AgentUtils.safeGet(customerSupportRequest, CustomerSupportRequest::question, "")
+          AgentUtils.safeGet(request, CustomerSupportRequest::question, "")
       );
     }
 

routing-workflow/src/main/java/com/javaaidev/agenticpatterns/routingworkflow/package-info.java

@@ -0,0 +1,4 @@
+@NullMarked
+package com.javaaidev.agenticpatterns.routingworkflow;
+
+import org.jspecify.annotations.NullMarked;