code improvement

Author: alexcheng1982

evaluator-optimizer/README.md

@@ -0,0 +1,6 @@
+# Evaluator-Optimizer Agent
+
+Implementation
+of [Evaluator-Optimizer pattern](https://javaaidev.com/docs/agentic-patterns/patterns/evaluator-optimizer)
+
+See [doc](https://javaaidev.com/docs/agentic-patterns/reference-implementation/evaluator-optimizer-agent)

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

@@ -30,8 +30,19 @@ protected PromptBasedEvaluatorOptimizerAgent(ChatClient generationChatClient,
     super(generationChatClient, evaluationChatClient, responseType, observationRegistry);
   }
 
+  /**
+   * Prompt template for the agent to generate initial result
+   *
+   * @return Prompt template
+   */
   protected abstract String getInitialResultPromptTemplate();
 
+  /**
+   * Prepare for the values of variables in the prompt template to generate initial result
+   *
+   * @param request Request
+   * @return Values of variables
+   */
   protected @Nullable Map<String, Object> buildInitialResultPromptContext(
       @Nullable Request request) {
     return new HashMap<>();
@@ -61,8 +72,19 @@ protected TaskExecutionAgent<Request, Response> buildInitialResultAgent(ChatClie
     return new GenerateInitialResultAgent(chatClient, responseType, observationRegistry);
   }
 
+  /**
+   * Prompt template for the agent to evaluate a result
+   *
+   * @return Prompt template
+   */
   protected abstract String getEvaluationPromptTemplate();
 
+  /**
+   * Prepare for the values of variables in the prompt template to evaluate a result
+   *
+   * @param response Response from a previous generation
+   * @return Values of variables
+   */
   protected @Nullable Map<String, Object> buildEvaluationPromptContext(
       @Nullable Response response) {
     return new HashMap<>();
@@ -92,8 +114,19 @@ protected TaskExecutionAgent<Response, Evaluation> buildEvaluationAgent(ChatClie
     return new EvaluateAgent(chatClient, observationRegistry);
   }
 
+  /**
+   * Prompt template for the agent to optimize a result
+   *
+   * @return Prompt template
+   */
   protected abstract String getOptimizationPromptTemplate();
 
+  /**
+   * Prepare for the values of variables in the prompt template to optimize a result
+   *
+   * @param optimizationInput Input for optimization
+   * @return Values of variables
+   */
   protected @Nullable Map<String, Object> buildOptimizationPromptContext(
       @Nullable OptimizationInput<Response> optimizationInput) {
     return new HashMap<>();

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

@@ -10,6 +10,9 @@
 import org.jspecify.annotations.Nullable;
 import org.springframework.ai.chat.client.ChatClient;
 
+/**
+ * An agent to generate code with evaluation feedbacks
+ */
 public class CodeGenerationAgent extends
     PromptBasedEvaluatorOptimizerAgent<CodeGenerationRequest, CodeGenerationResponse> {
 

task-execution/README.md

@@ -1,4 +1,4 @@
-# Task Execution
+# Task Execution Agent
 
 Implementation
 of [Task Execution pattern](https://javaaidev.com/docs/agentic-patterns/patterns/task-execution)