add routing workflow

Author: alexcheng1982

core/pom.xml

@@ -10,6 +10,7 @@
   </parent>
 
   <artifactId>agentic-patterns-core</artifactId>
+  <name>Agentic Patterns :: Core</name>
 
   <properties>
     <maven.compiler.source>21</maven.compiler.source>

core/src/main/java/com/javaaidev/agenticpatterns/core/PromptTemplateHelper.java

@@ -2,6 +2,11 @@
 
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
+import java.util.function.Function;
+import org.jspecify.annotations.Nullable;
 import org.springframework.core.io.ClassPathResource;
 
 public class PromptTemplateHelper {
@@ -13,4 +18,20 @@ public static String loadPromptTemplateFromClasspath(String resource) {
       throw new AgentExecutionException("Prompt template not found: " + resource, e);
     }
   }
+
+  public static Map<String, Object> mergeMap(@Nullable Map<String, Object> map1,
+      @Nullable Map<String, Object> map2) {
+    var m1 = Optional.ofNullable(map1)
+        .orElseGet(HashMap::new);
+    var m2 = Optional.ofNullable(map2)
+        .orElseGet(HashMap::new);
+    var result = new HashMap<String, Object>();
+    result.putAll(m1);
+    result.putAll(m2);
+    return result;
+  }
+
+  public static <T, R> R safeGet(@Nullable T obj, Function<T, R> extractor, R defaultValue) {
+    return Optional.ofNullable(obj).map(extractor).orElse(defaultValue);
+  }
 }

evaluator-optimizer/pom.xml

@@ -10,6 +10,7 @@
   </parent>
 
   <artifactId>agentic-patterns-evaluator-optimizer</artifactId>
+  <name>Agentic Patterns :: Evaluator-Optimizer</name>
 
   <properties>
     <maven.compiler.source>21</maven.compiler.source>

evaluator-optimizer/src/main/java/com/javaaidev/agenticpatterns/evaluatoroptimizer/Evaluation.java

@@ -2,6 +2,12 @@
 
 import org.jspecify.annotations.Nullable;
 
+/**
+ * Evaluation result
+ *
+ * @param passed   Passed or not passed
+ * @param feedback Feedback if not passed
+ */
 public record Evaluation(boolean passed, @Nullable String feedback) {
 
 }

evaluator-optimizer/src/main/java/com/javaaidev/agenticpatterns/evaluatoroptimizer/EvaluatorOptimizerAgent.java

@@ -6,6 +6,9 @@
 import org.slf4j.LoggerFactory;
 
 /**
+ * Evaluator-Optimizer Agent, refer to the <a
+ * href="https://javaaidev.com/docs/agentic-patterns/patterns/evaluator-optimizer">pattern</a>
+ *
  * @param <Request>
  * @param <Response>
  */
@@ -19,14 +22,34 @@ public abstract class EvaluatorOptimizerAgent<Request, Response> {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(EvaluatorOptimizerAgent.class);
 
+  /**
+   * The maximum number of evaluation iterations, default to 3
+   *
+   * @return Maximum number of iterations
+   */
   protected int getMaxIterations() {
     return 3;
   }
 
+  /**
+   * Build the agent to generation initial result
+   *
+   * @return the agent, see {@linkplain TaskExecutionAgent}
+   */
   protected abstract TaskExecutionAgent<Request, Response> buildInitialResultAgent();
 
+  /**
+   * Build the agent to evaluate the result
+   *
+   * @return the agent, see {@linkplain TaskExecutionAgent}
+   */
   protected abstract TaskExecutionAgent<Response, Evaluation> buildEvaluationAgent();
 
+  /**
+   * Build the agent to optimize the result
+   *
+   * @return the agent, see {@linkplain TaskExecutionAgent}
+   */
   protected abstract TaskExecutionAgent<OptimizationInput<Response>, Response> buildOptimizationAgent();
 
   public Response call(@Nullable Request request) {

evaluator-optimizer/src/main/java/com/javaaidev/agenticpatterns/evaluatoroptimizer/PromptBasedEvaluatorOptimizerAgent.java

@@ -8,6 +8,12 @@
 import org.jspecify.annotations.Nullable;
 import org.springframework.ai.chat.client.ChatClient;
 
+/**
+ * A {@linkplain EvaluatorOptimizerAgent} implementation uses prompts for subtask agents
+ *
+ * @param <Request>
+ * @param <Response>
+ */
 public abstract class PromptBasedEvaluatorOptimizerAgent<Request, Response> extends
     EvaluatorOptimizerAgent<Request, Response> {
 

examples/pom.xml

@@ -9,7 +9,9 @@
     <version>3.4.1</version>
     <relativePath/>
   </parent>
+
   <artifactId>agentic-patterns-examples</artifactId>
+  <name>Agentic Patterns :: Examples</name>
 
   <properties>
     <java.version>21</java.version>
@@ -48,6 +50,11 @@
       <artifactId>agentic-patterns-parallelization-workflow</artifactId>
       <version>${agentic-patterns.version}</version>
     </dependency>
+    <dependency>
+      <groupId>com.javaaidev</groupId>
+      <artifactId>agentic-patterns-routing-workflow</artifactId>
+      <version>${agentic-patterns.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.springframework.ai</groupId>
       <artifactId>spring-ai-openai-spring-boot-starter</artifactId>

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

@@ -0,0 +1,126 @@
+package com.javaaidev.agenticpatterns.examples.routingworkflow;
+
+import com.javaaidev.agenticpatterns.core.PromptTemplateHelper;
+import com.javaaidev.agenticpatterns.examples.routingworkflow.CustomerSupportAgent.CustomerSupportRequest;
+import com.javaaidev.agenticpatterns.examples.routingworkflow.CustomerSupportAgent.CustomerSupportResponse;
+import com.javaaidev.agenticpatterns.routingworkflow.RoutingWorkflowAgent;
+import com.javaaidev.agenticpatterns.taskexecution.TaskExecutionAgent;
+import java.lang.reflect.Type;
+import java.util.Map;
+import org.jspecify.annotations.Nullable;
+import org.springframework.ai.chat.client.ChatClient;
+import org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec;
+
+public class CustomerSupportAgent extends
+    RoutingWorkflowAgent<CustomerSupportRequest, CustomerSupportResponse> {
+
+  protected CustomerSupportAgent(ChatClient chatClient,
+      @Nullable Type responseType) {
+    super(chatClient, responseType);
+    initRoutes();
+  }
+
+  protected CustomerSupportAgent(ChatClient chatClient) {
+    super(chatClient);
+    initRoutes();
+  }
+
+  private void initRoutes() {
+    addRoutingChoice(new RoutingChoice<>("payment", "Handle requests about payment and refund",
+        new PaymentSupportAgent(chatClient)));
+    addRoutingChoice(new RoutingChoice<>("shipping", "Handle requests about shipping",
+        new ShippingSupportAgent(chatClient)));
+    addRoutingChoice(new RoutingChoice<>("general", "Handle general requests",
+        new GeneralSupportAgent(chatClient)));
+  }
+
+  public record CustomerSupportRequest(String question) {
+
+  }
+
+  public record CustomerSupportResponse(String answer) {
+
+  }
+
+  private static class PaymentSupportAgent extends
+      TaskExecutionAgent<CustomerSupportRequest, CustomerSupportResponse> {
+
+    protected PaymentSupportAgent(ChatClient chatClient) {
+      super(chatClient);
+    }
+
+    @Override
+    protected String getPromptTemplate() {
+      return "{question}";
+    }
+
+    @Override
+    protected @Nullable Map<String, Object> getPromptContext(
+        @Nullable CustomerSupportRequest customerSupportRequest) {
+      return Map.of(
+          "question",
+          PromptTemplateHelper.safeGet(customerSupportRequest, CustomerSupportRequest::question, "")
+      );
+    }
+
+    @Override
+    protected void updateRequest(ChatClientRequestSpec spec) {
+      spec.system("Pretend to be a customer support agent for payment, be polite and helper");
+    }
+  }
+
+  private static class ShippingSupportAgent extends
+      TaskExecutionAgent<CustomerSupportRequest, CustomerSupportResponse> {
+
+    protected ShippingSupportAgent(ChatClient chatClient) {
+      super(chatClient);
+    }
+
+    @Override
+    protected String getPromptTemplate() {
+      return "{question}";
+    }
+
+    @Override
+    protected @Nullable Map<String, Object> getPromptContext(
+        @Nullable CustomerSupportRequest customerSupportRequest) {
+      return Map.of(
+          "question",
+          PromptTemplateHelper.safeGet(customerSupportRequest, CustomerSupportRequest::question, "")
+      );
+    }
+
+    @Override
+    protected void updateRequest(ChatClientRequestSpec spec) {
+      spec.system("Pretend to be a customer support agent for shipping, be polite and helper");
+    }
+  }
+
+  private static class GeneralSupportAgent extends
+      TaskExecutionAgent<CustomerSupportRequest, CustomerSupportResponse> {
+
+    protected GeneralSupportAgent(ChatClient chatClient) {
+      super(chatClient);
+    }
+
+    @Override
+    protected String getPromptTemplate() {
+      return "{question}";
+    }
+
+    @Override
+    protected @Nullable Map<String, Object> getPromptContext(
+        @Nullable CustomerSupportRequest customerSupportRequest) {
+      return Map.of(
+          "question",
+          PromptTemplateHelper.safeGet(customerSupportRequest, CustomerSupportRequest::question, "")
+      );
+    }
+
+    @Override
+    protected void updateRequest(ChatClientRequestSpec spec) {
+      spec.system(
+          "Pretend to be a customer support agent for general questions, be polite and helper");
+    }
+  }
+}

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

@@ -0,0 +1,18 @@
+package com.javaaidev.agenticpatterns.examples.routingworkflow;
+
+import org.springframework.ai.chat.client.ChatClient;
+import org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class CustomerSupportConfiguration {
+
+  @Bean
+  public CustomerSupportAgent customerSupportAgent(
+      ChatClient.Builder chatClientBuilder,
+      SimpleLoggerAdvisor simpleLoggerAdvisor) {
+    return new CustomerSupportAgent(
+        chatClientBuilder.defaultAdvisors(simpleLoggerAdvisor).build());
+  }
+}

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

@@ -0,0 +1,24 @@
+package com.javaaidev.agenticpatterns.examples.routingworkflow;
+
+import com.javaaidev.agenticpatterns.examples.routingworkflow.CustomerSupportAgent.CustomerSupportRequest;
+import com.javaaidev.agenticpatterns.examples.routingworkflow.CustomerSupportAgent.CustomerSupportResponse;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/customer_support")
+public class CustomerSupportController {
+
+  private final CustomerSupportAgent customerSupportAgent;
+
+  public CustomerSupportController(CustomerSupportAgent customerSupportAgent) {
+    this.customerSupportAgent = customerSupportAgent;
+  }
+
+  @PostMapping
+  public CustomerSupportResponse customerSupport(@RequestBody CustomerSupportRequest request) {
+    return customerSupportAgent.call(request);
+  }
+}