code refactoring

Author: alexcheng1982

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

@@ -58,7 +58,7 @@ protected String getPromptTemplate() {
   }
 
   @Override
-  protected @Nullable List<SubtaskCreationRequest<AlgorithmArticleGenerationRequest>> createTasks(
+  protected List<SubtaskCreationRequest<AlgorithmArticleGenerationRequest>> createTasks(
       @Nullable AlgorithmArticleGenerationRequest request) {
     var languages = AgentUtils.safeGet(request,
         AlgorithmArticleGenerationRequest::languages, List.<String>of());

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

@@ -3,6 +3,7 @@
 import com.javaaidev.agenticpatterns.core.AgentUtils;
 import com.javaaidev.agenticpatterns.examples.routingworkflow.CustomerSupportAgent.CustomerSupportRequest;
 import com.javaaidev.agenticpatterns.examples.routingworkflow.CustomerSupportAgent.CustomerSupportResponse;
+import com.javaaidev.agenticpatterns.routingworkflow.RoutingChoice;
 import com.javaaidev.agenticpatterns.routingworkflow.RoutingWorkflowAgent;
 import com.javaaidev.agenticpatterns.taskexecution.TaskExecutionAgent;
 import io.micrometer.observation.ObservationRegistry;
@@ -37,7 +38,7 @@ private void initRoutes() {
   }
 
   @Override
-  protected String formatRequest(@Nullable CustomerSupportRequest request) {
+  protected String formatRoutingInput(@Nullable CustomerSupportRequest request) {
     return AgentUtils.safeGet(request, CustomerSupportRequest::question, "");
   }
 

parallelization-workflow/README.md

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

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

@@ -8,7 +8,7 @@
  *
  * @param taskId             Task id
  * @param task               Task, see {@linkplain TaskExecutionAgent}
- * @param requestTransformer Transform request to task inpu
+ * @param requestTransformer Transform request to task input
  * @param <Request>          Request type
  */
 public record SubtaskCreationRequest<Request>(

routing-workflow/README.md

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

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

@@ -0,0 +1,18 @@
+package com.javaaidev.agenticpatterns.routingworkflow;
+
+import com.javaaidev.agenticpatterns.taskexecution.TaskExecutionAgent;
+
+/**
+ * A routing choice
+ *
+ * @param name        Name of the route
+ * @param description Description of the route
+ * @param agent       Task of the route
+ * @param <Request>   Task input type
+ * @param <Response>  Task output type
+ */
+public record RoutingChoice<Request, Response>(String name,
+                                               String description,
+                                               TaskExecutionAgent<Request, Response> agent) {
+
+}

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

@@ -0,0 +1,16 @@
+package com.javaaidev.agenticpatterns.routingworkflow;
+
+import java.util.List;
+
+/**
+ * Routing request
+ *
+ * @param request    Original task input
+ * @param choices    Routing choices, see {@linkplain RoutingChoice}
+ * @param <Request>  Task input type
+ * @param <Response> Task output type
+ */
+public record RoutingRequest<Request, Response>(Request request,
+                                                List<RoutingChoice<Request, Response>> choices) {
+
+}

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

@@ -0,0 +1,11 @@
+package com.javaaidev.agenticpatterns.routingworkflow;
+
+/**
+ * Routing response
+ *
+ * @param name   Selected route name
+ * @param reason Reason for route selection
+ */
+public record RoutingResponse(String name, String reason) {
+
+}

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

@@ -4,7 +4,6 @@
 import com.javaaidev.agenticpatterns.taskexecution.TaskExecutionAgent;
 import io.micrometer.observation.ObservationRegistry;
 import java.lang.reflect.Type;
-import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.concurrent.CopyOnWriteArrayList;
@@ -15,6 +14,13 @@
 import org.springframework.ai.chat.client.ChatClient;
 import org.springframework.util.Assert;
 
+/**
+ * Routing Workflow agent, refer to <a
+ * href="https://javaaidev.com/docs/agentic-patterns/patterns/routing-workflow">doc</a>
+ *
+ * @param <Request>  Task input type
+ * @param <Response> Task output type
+ */
 public abstract class RoutingWorkflowAgent<Request, Response> extends
     TaskExecutionAgent<Request, Response> {
 
@@ -36,20 +42,11 @@ protected RoutingWorkflowAgent(ChatClient chatClient,
     routingAgent = new RoutingAgent(chatClient);
   }
 
-  public record RoutingChoice<Request, Response>(String name, String description,
-                                                 TaskExecutionAgent<Request, Response> agent) {
-
-  }
-
-  public record RoutingRequest<Request, Response>(Request request,
-                                                  List<RoutingChoice<Request, Response>> choices) {
-
-  }
-
-  public record RoutingResponse(String name, String reason) {
-
-  }
-
+  /**
+   * Add a new routing choice
+   *
+   * @param routingChoice Routing choice
+   */
   protected void addRoutingChoice(RoutingChoice<Request, Response> routingChoice) {
     routingChoices.add(routingChoice);
   }
@@ -59,9 +56,14 @@ protected String getPromptTemplate() {
     return "";
   }
 
+  /**
+   * Get the prompt template for routing
+   *
+   * @return Prompt template
+   */
   protected String getRoutingPromptTemplate() {
     return """
-        Goal: Select the best target to handle the input
+        Goal: Select the best target to handle the input from a list of choices
         
         Choices:
         {choices}
@@ -71,10 +73,22 @@ protected String getRoutingPromptTemplate() {
         """;
   }
 
-  protected String formatRequest(@Nullable Request request) {
+  /**
+   * Generate the input used by the default prompt template
+   *
+   * @param request Request
+   * @return Input for routing prompt template
+   */
+  protected String formatRoutingInput(@Nullable Request request) {
     return Objects.toString(request, "");
   }
 
+  /**
+   * Get values of variables used in the default prompt template
+   *
+   * @param routingRequest Routing request
+   * @return Values of variables
+   */
   protected @Nullable Map<String, Object> getRoutingPromptContext(
       @Nullable RoutingRequest<Request, Response> routingRequest) {
     Assert.notNull(routingRequest, "routing request cannot be null");
@@ -83,7 +97,7 @@ protected String formatRequest(@Nullable Request request) {
         .collect(Collectors.joining("\n"));
     return Map.of(
         "choices", choices,
-        "input", formatRequest(routingRequest.request())
+        "input", formatRoutingInput(routingRequest.request())
     );
   }
 
@@ -105,7 +119,11 @@ public Response doCall(@Nullable Request request) {
     return targetAgent.call(request);
   }
 
-  protected class RoutingAgent extends TaskExecutionAgent<RoutingRequest, RoutingResponse> {
+  /**
+   * Agent for the routing
+   */
+  protected class RoutingAgent extends
+      TaskExecutionAgent<RoutingRequest<Request, Response>, RoutingResponse> {
 
     protected RoutingAgent(ChatClient chatClient) {
       super(chatClient);
@@ -118,7 +136,7 @@ protected String getPromptTemplate() {
 
     @Override
     protected @Nullable Map<String, Object> getPromptContext(
-        @Nullable RoutingRequest routingRequest) {
+        @Nullable RoutingRequest<Request, Response> routingRequest) {
       return getRoutingPromptContext(routingRequest);
     }
   }