946 - User message template and variables cannot be null.

Author: dennysfredericci

core/deployment/src/test/java/io/quarkiverse/langchain4j/test/guardrails/InputGuardrailPromptTemplateTest.java

@@ -142,7 +142,7 @@ void shouldWorkWithMemoryIdAndOneItemFromList() {
     void shouldWorkWithNoUserMessage() {
         // UserMessage annotation is not provided, then no user message template should be available
         aiService.saySomething("Is this a parameter or a prompt?");
-        assertThat(guardrailValidation.spyUserMessageTemplate()).isNull();
+        assertThat(guardrailValidation.spyUserMessageTemplate()).isEmpty();
         assertThat(guardrailValidation.spyVariables()).isEmpty();
     }
 

core/deployment/src/test/java/io/quarkiverse/langchain4j/test/guardrails/OutputGuardrailPromptTemplateTest.java

@@ -139,7 +139,7 @@ void shouldWorkWithMemoryIdAndOneItemFromList() {
     void shouldWorkWithNoUserMessage() {
         // UserMessage annotation is not provided, then no user message template should be available
         aiService.saySomething("Is this a parameter or a prompt?");
-        assertThat(guardrailValidation.spyUserMessageTemplate()).isNull();
+        assertThat(guardrailValidation.spyUserMessageTemplate()).isEmpty();
         assertThat(guardrailValidation.spyVariables()).isEmpty();
     }
 

core/runtime/src/main/java/io/quarkiverse/langchain4j/guardrails/InputGuardrailParams.java

@@ -12,8 +12,8 @@
  * @param userMessage the user message, cannot be {@code null}
  * @param memory the memory, can be {@code null} or empty
  * @param augmentationResult the augmentation result, can be {@code null}
- * @param userMessageTemplate the user message template, can be {@code null} when @UserMessage is not provided.
- * @param variables the variable to be used with userMessageTemplate, can be {@code null} or empty
+ * @param userMessageTemplate the user message template, cannot be {@code null}
+ * @param variables the variable to be used with userMessageTemplate, cannot be {@code null}
  */
 public record InputGuardrailParams(UserMessage userMessage, ChatMemory memory,
         AugmentationResult augmentationResult, String userMessageTemplate,

core/runtime/src/main/java/io/quarkiverse/langchain4j/guardrails/OutputGuardrailParams.java

@@ -12,8 +12,8 @@
  * @param responseFromLLM the response from the LLM
  * @param memory the memory, can be {@code null} or empty
  * @param augmentationResult the augmentation result, can be {@code null}
- * @param userMessageTemplate the user message template, can be {@code null} when @UserMessage is not provided.
- * @param variables the variable to be used with userMessageTemplate, can be {@code null} or empty
+ * @param userMessageTemplate the user message template, cannot be {@code null}
+ * @param variables the variable to be used with userMessageTemplate, cannot be {@code null}
  */
 public record OutputGuardrailParams(AiMessage responseFromLLM, ChatMemory memory,
         AugmentationResult augmentationResult, String userMessageTemplate,

core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/aiservice/AiServiceMethodCreateInfo.java

@@ -1,5 +1,7 @@
 package io.quarkiverse.langchain4j.runtime.aiservice;
 
+import static org.apache.commons.lang3.StringUtils.EMPTY;
+
 import java.lang.reflect.Type;
 import java.util.List;
 import java.util.Map;
@@ -197,7 +199,7 @@ public String getUserMessageTemplate() {
         Optional<String> userMessageTemplateOpt = this.getUserMessageInfo().template()
                 .flatMap(AiServiceMethodCreateInfo.TemplateInfo::text);
 
-        return userMessageTemplateOpt.orElse(null);
+        return userMessageTemplateOpt.orElse(EMPTY);
     }
 
     public record UserMessageInfo(Optional<TemplateInfo> template,

core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/aiservice/AiServiceMethodImplementationSupport.java

@@ -273,7 +273,8 @@ private List<ChatMessage> messagesToSend(ChatMessage augmentedUserMessage,
                         try {
                             result = GuardrailsSupport.invokeOutputGuardrailsForStream(methodCreateInfo,
                                     new OutputGuardrailParams(AiMessage.from(chunk), chatMemory, actualAugmentationResult,
-                                            methodCreateInfo.getUserMessageTemplate(), templateVariables));
+                                            methodCreateInfo.getUserMessageTemplate(),
+                                            Collections.unmodifiableMap(templateVariables)));
                         } catch (Exception e) {
                             throw new GuardrailException(e.getMessage(), e);
                         }
@@ -365,7 +366,7 @@ private List<ChatMessage> messagesToSend(ChatMessage augmentedUserMessage,
         response = GuardrailsSupport.invokeOutputGuardrails(methodCreateInfo, chatMemory, context.chatModel, response,
                 toolSpecifications,
                 new OutputGuardrailParams(response.content(), chatMemory, augmentationResult, userMessageTemplate,
-                        templateVariables));
+                        Collections.unmodifiableMap(templateVariables)));
 
         // everything worked as expected so let's commit the messages
         chatMemory.commit();

core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/aiservice/GuardrailsSupport.java

@@ -37,7 +37,7 @@ public static void invokeInputGuardrails(AiServiceMethodCreateInfo methodCreateI
 
             result = invokeInputGuardRails(methodCreateInfo,
                     new InputGuardrailParams(userMessage, chatMemory, augmentationResult, userMessageTemplate,
-                            templateVariables));
+                            Collections.unmodifiableMap(templateVariables)));
         } catch (Exception e) {
             throw new GuardrailException(e.getMessage(), e);
         }