add AI prompts and completions

Author: alexcheng1982

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

@@ -16,7 +16,8 @@ public abstract class AbstractAgenticWorkflow<Request, Response> implements
 
   protected AbstractAgenticWorkflow(@Nullable String name,
       @Nullable ObservationRegistry observationRegistry) {
-    this.name = Objects.requireNonNullElseGet(name, () -> this.getClass().getSimpleName());
+    this.name = Objects.requireNonNullElseGet(name,
+        () -> this.getClass().getSimpleName());
     this.observationRegistry = observationRegistry;
   }
 
@@ -30,7 +31,8 @@ public Response execute(@Nullable Request request) {
     if (observationRegistry == null || observationRegistry.isNoop()) {
       return doExecute(request);
     }
-    var observationContext = new WorkflowExecutionObservationContext(getName(), request);
+    var observationContext = new WorkflowExecutionObservationContext(
+        getName(), request);
     var observation =
         WorkflowExecutionObservationDocumentation.WORKFLOW_EXECUTION.observation(
             null,

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

@@ -26,9 +26,11 @@ public class AgentUtils {
    */
   public static String loadPromptTemplateFromClasspath(String resource) {
     try {
-      return new ClassPathResource(resource).getContentAsString(StandardCharsets.UTF_8);
+      return new ClassPathResource(resource).getContentAsString(
+          StandardCharsets.UTF_8);
     } catch (IOException e) {
-      throw new AgentExecutionException("Prompt template not found: " + resource, e);
+      throw new AgentExecutionException(
+          "Prompt template not found: " + resource, e);
     }
   }
 
@@ -39,7 +41,8 @@ public static String loadPromptTemplateFromClasspath(String resource) {
    * @param map2 Second map
    * @return Merged map
    */
-  public static Map<String, Object> mergeMap(@Nullable Map<String, Object> map1,
+  public static Map<String, Object> mergeMap(
+      @Nullable Map<String, Object> map1,
       @Nullable Map<String, Object> map2) {
     var m1 = Optional.ofNullable(map1)
         .orElseGet(HashMap::new);
@@ -51,7 +54,8 @@ public static Map<String, Object> mergeMap(@Nullable Map<String, Object> map1,
     return result;
   }
 
-  public static <T, R> R safeGet(@Nullable T obj, Function<T, R> extractor, R defaultValue) {
+  public static <T, R> R safeGet(@Nullable T obj, Function<T, R> extractor,
+      R defaultValue) {
     return Optional.ofNullable(obj).map(extractor).orElse(defaultValue);
   }
 

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

@@ -22,7 +22,8 @@ public class CustomWorkflowBuilder<Request, Response> extends
    * @param action Action to run
    * @return Current builder
    */
-  public CustomWorkflowBuilder<Request, Response> action(Function<Request, Response> action) {
+  public CustomWorkflowBuilder<Request, Response> action(
+      Function<Request, Response> action) {
     this.action = Objects.requireNonNull(action, "Action cannot be null");
     return this;
   }

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

@@ -6,7 +6,8 @@
 
 public record ParameterizedTypeImpl(@Nullable Type rawType,
                                     Type[] actualTypeArguments,
-                                    @Nullable Type ownerType) implements ParameterizedType {
+                                    @Nullable Type ownerType) implements
+    ParameterizedType {
 
   @Override
   public Type[] getActualTypeArguments() {

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

@@ -24,7 +24,8 @@ private static Type doResolveType(final ResolvableType type) {
       return Object.class;
     }
     var generics = type.getGenerics();
-    var paraType = new ParameterizedTypeImpl(type.resolve(), new Type[generics.length],
+    var paraType = new ParameterizedTypeImpl(type.resolve(),
+        new Type[generics.length],
         null);
     for (int i = 0; i < generics.length; i++) {
       var nestedType = generics[i];

core/src/main/java/com/javaaidev/agenticpatterns/core/observation/AgentExecutionObservationContext.java

@@ -2,7 +2,8 @@
 
 import io.micrometer.observation.transport.RequestReplySenderContext;
 
-public class AgentExecutionObservationContext extends RequestReplySenderContext<Object, Object> {
+public class AgentExecutionObservationContext extends
+    RequestReplySenderContext<Object, Object> {
 
   private final String agentName;
 

core/src/main/java/com/javaaidev/agenticpatterns/core/observation/AgentExecutionObservationDocumentation.java

@@ -5,7 +5,8 @@
 import io.micrometer.observation.ObservationConvention;
 import io.micrometer.observation.docs.ObservationDocumentation;
 
-public enum AgentExecutionObservationDocumentation implements ObservationDocumentation {
+public enum AgentExecutionObservationDocumentation implements
+    ObservationDocumentation {
   AGENT_EXECUTION {
     @Override
     public Class<? extends ObservationConvention<? extends Context>> getDefaultConvention() {

core/src/main/java/com/javaaidev/agenticpatterns/core/observation/ChatModelCompletionContentObservationFilter.java

@@ -0,0 +1,82 @@
+package com.javaaidev.agenticpatterns.core.observation;
+
+import io.micrometer.common.KeyValue;
+import io.micrometer.observation.Observation;
+import io.micrometer.observation.ObservationFilter;
+import java.util.List;
+import java.util.Objects;
+import org.springframework.ai.chat.messages.AbstractMessage;
+import org.springframework.ai.chat.model.Generation;
+import org.springframework.ai.chat.observation.ChatModelObservationContext;
+import org.springframework.ai.content.Content;
+import org.springframework.ai.observation.ObservabilityHelper;
+import org.springframework.util.CollectionUtils;
+import org.springframework.util.StringUtils;
+
+public class ChatModelCompletionContentObservationFilter implements
+    ObservationFilter {
+
+  @Override
+  public Observation.Context map(Observation.Context context) {
+    if (!(context instanceof ChatModelObservationContext chatModelObservationContext)) {
+      return context;
+    }
+
+    var prompts = processPrompts(chatModelObservationContext);
+    var completions = processCompletion(chatModelObservationContext);
+
+    chatModelObservationContext.addHighCardinalityKeyValue(new KeyValue() {
+      @Override
+      public String getKey() {
+        return "gen_ai.prompt";
+      }
+
+      @Override
+      public String getValue() {
+        return ObservabilityHelper.concatenateStrings(prompts);
+      }
+    });
+
+    chatModelObservationContext.addHighCardinalityKeyValue(new KeyValue() {
+      @Override
+      public String getKey() {
+        return "gen_ai.completion";
+      }
+
+      @Override
+      public String getValue() {
+        return ObservabilityHelper.concatenateStrings(completions);
+      }
+    });
+
+    return chatModelObservationContext;
+  }
+
+  private List<String> processPrompts(
+      ChatModelObservationContext chatModelObservationContext) {
+    var instructions = chatModelObservationContext.getRequest()
+        .getInstructions();
+    return CollectionUtils.isEmpty(instructions)
+        ? List.of()
+        : instructions.stream().map(Content::getText).toList();
+  }
+
+  private List<String> processCompletion(
+      ChatModelObservationContext context) {
+    if (context.getResponse() == null) {
+      return List.of();
+    }
+
+    var results = context.getResponse().getResults();
+    if (CollectionUtils.isEmpty(results)) {
+      return List.of();
+    }
+
+    return results.stream()
+        .map(Generation::getOutput)
+        .filter(Objects::nonNull)
+        .map(AbstractMessage::getText)
+        .filter(StringUtils::hasText)
+        .toList();
+  }
+}

core/src/main/java/com/javaaidev/agenticpatterns/core/observation/DefaultAgentExecutionObservationConvention.java

@@ -18,12 +18,14 @@ public String getName() {
   }
 
   @Override
-  public KeyValues getLowCardinalityKeyValues(AgentExecutionObservationContext context) {
+  public KeyValues getLowCardinalityKeyValues(
+      AgentExecutionObservationContext context) {
     return KeyValues.of(agentName(context));
   }
 
   @Override
-  public KeyValues getHighCardinalityKeyValues(AgentExecutionObservationContext context) {
+  public KeyValues getHighCardinalityKeyValues(
+      AgentExecutionObservationContext context) {
     return KeyValues.of(
         agentExecutionInput(context),
         agentExecutionOutput(context)
@@ -36,17 +38,21 @@ private KeyValue agentName(AgentExecutionObservationContext context) {
     );
   }
 
-  private KeyValue agentExecutionInput(AgentExecutionObservationContext context) {
+  private KeyValue agentExecutionInput(
+      AgentExecutionObservationContext context) {
     return KeyValue.of(
         HighCardinalityKeyNames.AGENT_EXECUTION_INPUT,
-        context.getCarrier() != null ? AgentUtils.toJson(context.getCarrier()) : KeyValue.NONE_VALUE
+        context.getCarrier() != null ? AgentUtils.toJson(context.getCarrier())
+            : KeyValue.NONE_VALUE
     );
   }
 
-  private KeyValue agentExecutionOutput(AgentExecutionObservationContext context) {
+  private KeyValue agentExecutionOutput(
+      AgentExecutionObservationContext context) {
     return KeyValue.of(
         HighCardinalityKeyNames.AGENT_EXECUTION_OUTPUT,
-        context.getResponse() != null ? AgentUtils.toJson(context.getResponse())
+        context.getResponse() != null ? AgentUtils.toJson(
+            context.getResponse())
             : KeyValue.NONE_VALUE
     );
   }

core/src/main/java/com/javaaidev/agenticpatterns/core/observation/DefaultWorkflowExecutionObservationConvention.java

@@ -17,12 +17,14 @@ public String getName() {
   }
 
   @Override
-  public KeyValues getLowCardinalityKeyValues(WorkflowExecutionObservationContext context) {
+  public KeyValues getLowCardinalityKeyValues(
+      WorkflowExecutionObservationContext context) {
     return KeyValues.of(workflowName(context));
   }
 
   @Override
-  public KeyValues getHighCardinalityKeyValues(WorkflowExecutionObservationContext context) {
+  public KeyValues getHighCardinalityKeyValues(
+      WorkflowExecutionObservationContext context) {
     return KeyValues.of(
         workflowExecutionInput(context),
         workflowExecutionOutput(context)
@@ -35,17 +37,21 @@ private KeyValue workflowName(WorkflowExecutionObservationContext context) {
     );
   }
 
-  private KeyValue workflowExecutionInput(WorkflowExecutionObservationContext context) {
+  private KeyValue workflowExecutionInput(
+      WorkflowExecutionObservationContext context) {
     return KeyValue.of(
         HighCardinalityKeyNames.WORKFLOW_EXECUTION_INPUT,
-        context.getCarrier() != null ? AgentUtils.toJson(context.getCarrier()) : KeyValue.NONE_VALUE
+        context.getCarrier() != null ? AgentUtils.toJson(context.getCarrier())
+            : KeyValue.NONE_VALUE
     );
   }
 
-  private KeyValue workflowExecutionOutput(WorkflowExecutionObservationContext context) {
+  private KeyValue workflowExecutionOutput(
+      WorkflowExecutionObservationContext context) {
     return KeyValue.of(
         HighCardinalityKeyNames.WORKFLOW_EXECUTION_OUTPUT,
-        context.getResponse() != null ? AgentUtils.toJson(context.getResponse())
+        context.getResponse() != null ? AgentUtils.toJson(
+            context.getResponse())
             : KeyValue.NONE_VALUE
     );
   }