feat: Using Prompt Registry Templates in SpringAI

core-services/prompt-registry/pom.xml

@@ -38,10 +38,10 @@
   </scm>
   <properties>
     <project.rootdir>${project.basedir}/../../</project.rootdir>
-    <coverage.complexity>75%</coverage.complexity>
+    <coverage.complexity>73%</coverage.complexity>
     <coverage.line>87%</coverage.line>
     <coverage.instruction>89%</coverage.instruction>
-    <coverage.branch>100%</coverage.branch>
+    <coverage.branch>75%</coverage.branch>
     <coverage.method>75%</coverage.method>
     <coverage.class>100%</coverage.class>
   </properties>
@@ -64,6 +64,11 @@
       <groupId>org.springframework</groupId>
       <artifactId>spring-web</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.springframework.ai</groupId>
+      <artifactId>spring-ai-model</artifactId>
+      <optional>true</optional>
+    </dependency>
     <dependency>
       <groupId>com.sap.cloud.sdk.cloudplatform</groupId>
       <artifactId>cloudplatform-connectivity</artifactId>

core-services/prompt-registry/src/main/java/com/sap/ai/sdk/prompt/registry/spring/SpringAiConverter.java

@@ -0,0 +1,49 @@
+package com.sap.ai.sdk.prompt.registry.spring;
+
+import com.sap.ai.sdk.prompt.registry.model.PromptTemplateSubstitutionResponse;
+import com.sap.ai.sdk.prompt.registry.model.SingleChatTemplate;
+import com.sap.ai.sdk.prompt.registry.model.Template;
+import java.util.List;
+import javax.annotation.Nonnull;
+import lombok.val;
+import org.springframework.ai.chat.messages.AssistantMessage;
+import org.springframework.ai.chat.messages.Message;
+import org.springframework.ai.chat.messages.SystemMessage;
+import org.springframework.ai.chat.messages.UserMessage;
+
+/** Utility class for prompt registry related operations in a Spring context. */
+public class SpringAiConverter {
+
+  private SpringAiConverter() {
+    // Utility class, no instantiation allowed
+  }
+
+  /**
+   * Get a SpringAI list of messages from a Prompt Registry Response.
+   *
+   * @param promptResponse the response from Prompt Registry.
+   * @return list of SpringAI messages.
+   */
+  @Nonnull
+  public static List<Message> promptTemplateToMessages(
+      @Nonnull final PromptTemplateSubstitutionResponse promptResponse) {
+
+    val res = promptResponse.getParsedPrompt();
+
+    // TRANSFORM TEMPLATE TO SPRING AI MESSAGES
+    return res.stream()
+        .map(
+            (Template t) -> {
+              final SingleChatTemplate message = (SingleChatTemplate) t;
+              return (Message)
+                  switch (message.getRole()) {
+                    case "system" -> new SystemMessage(message.getContent());
+                    case "user" -> new UserMessage(message.getContent());
+                    case "assistant" -> new AssistantMessage(message.getContent());
+                    default ->
+                        throw new IllegalArgumentException("Unknown role: " + message.getRole());
+                  };
+            })
+        .toList();
+  }
+}

core-services/prompt-registry/src/test/java/com/sap/ai/sdk/prompt/registry/spring/SpringAiConverterTest.java

@@ -0,0 +1,69 @@
+package com.sap.ai.sdk.prompt.registry.spring;
+
+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
+import com.sap.ai.sdk.core.AiCoreService;
+import com.sap.ai.sdk.prompt.registry.PromptClient;
+import com.sap.ai.sdk.prompt.registry.model.PromptTemplateSubstitutionRequest;
+import com.sap.cloud.sdk.cloudplatform.connectivity.DefaultHttpDestination;
+import com.sap.cloud.sdk.cloudplatform.connectivity.HttpDestination;
+import java.util.List;
+import java.util.Map;
+import lombok.val;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.springframework.ai.chat.messages.Message;
+import org.springframework.ai.chat.messages.SystemMessage;
+import org.springframework.ai.chat.messages.UserMessage;
+
+public class SpringAiConverterTest {
+  @RegisterExtension
+  private static final WireMockExtension WM =
+      WireMockExtension.newInstance().options(wireMockConfig().dynamicPort()).build();
+
+  private final HttpDestination DESTINATION = DefaultHttpDestination.builder(WM.baseUrl()).build();
+  private final AiCoreService SERVICE = new AiCoreService().withBaseDestination(DESTINATION);
+
+  @Test
+  void testPromptRegistryToSpringAi() {
+    var client = new PromptClient(SERVICE);
+    val promptResponse =
+        client.parsePromptTemplateByNameVersion(
+            "categorization",
+            "0.0.1",
+            "java-e2e-test",
+            "default",
+            false,
+            PromptTemplateSubstitutionRequest.create()
+                .inputParams(Map.of("inputExample", "I love football")));
+
+    List<Message> messages = SpringAiConverter.promptTemplateToMessages(promptResponse);
+    assertThat(messages)
+        .isEqualTo(
+            List.of(
+                new SystemMessage(
+                    "You classify input text into the two following categories: Finance, Tech, Sports, Politics"),
+                new UserMessage("I love football")));
+  }
+
+  @Test
+  void testInvalidRoleThrowsException() {
+    var client = new PromptClient(SERVICE);
+    val errorPrompt =
+        client.parsePromptTemplateByNameVersion(
+            "categorization",
+            "0.0.1",
+            "error",
+            "default",
+            false,
+            PromptTemplateSubstitutionRequest.create()
+                .inputParams(Map.of("inputExample", "I love football")));
+
+    assertThatThrownBy(() -> SpringAiConverter.promptTemplateToMessages(errorPrompt))
+        .isInstanceOf(IllegalArgumentException.class)
+        .hasMessageContaining("Unknown role: error");
+  }
+}

core-services/prompt-registry/src/test/resources/mappings/error.json

@@ -0,0 +1,26 @@
+{
+  "request": {
+    "method": "POST",
+    "url": "/v2/lm/scenarios/categorization/promptTemplates/error/versions/0.0.1/substitution?metadata=false"
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/json"
+    },
+    "jsonBody": {
+      "parsedPrompt": [
+        {
+          "role": "assistant",
+          "content": "What can I help you with?"
+        },
+        {
+          "role": "error",
+          "content": "What is this?"
+        }
+      ]
+    }
+  }
+}
+
+

core-services/prompt-registry/src/test/resources/mappings/templatesInputParams.json

@@ -0,0 +1,26 @@
+{
+  "request": {
+    "method": "POST",
+    "url": "/v2/lm/scenarios/categorization/promptTemplates/java-e2e-test/versions/0.0.1/substitution?metadata=false"
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/json"
+    },
+    "jsonBody": {
+      "parsedPrompt": [
+        {
+          "role": "system",
+          "content": "You classify input text into the two following categories: Finance, Tech, Sports, Politics"
+        },
+        {
+          "role": "user",
+          "content": "I love football"
+        }
+      ]
+    }
+  }
+}
+
+

docs/release_notes.md

@@ -25,6 +25,8 @@
 - [Orchestration] Deprecated `OrchestrationAiModel.IBM_GRANITE_13B_CHAT` with no replacement.
 - [OpenAI] [Introduced SpringAI integration with our OpenAI client.](https://sap.github.io/ai-sdk/docs/java/spring-ai/openai)
   - Added `OpenAiChatModel`
+- [Prompt Registry] [Using Prompt Registry Templates in SpringAI.](https://sap.github.io/ai-sdk/docs/java/ai-core/prompt-registry#using-templates-in-springai)
+  - Added `SpringAiConverter`
 
 ### 📈 Improvements
 

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/PromptRegistryController.java

@@ -1,5 +1,8 @@
 package com.sap.ai.sdk.app.controllers;
 
+import com.sap.ai.sdk.foundationmodels.openai.OpenAiClient;
+import com.sap.ai.sdk.foundationmodels.openai.OpenAiModel;
+import com.sap.ai.sdk.foundationmodels.openai.spring.OpenAiChatModel;
 import com.sap.ai.sdk.prompt.registry.PromptClient;
 import com.sap.ai.sdk.prompt.registry.model.PromptTemplateDeleteResponse;
 import com.sap.ai.sdk.prompt.registry.model.PromptTemplateListResponse;
@@ -9,10 +12,19 @@
 import com.sap.ai.sdk.prompt.registry.model.PromptTemplateSubstitutionRequest;
 import com.sap.ai.sdk.prompt.registry.model.PromptTemplateSubstitutionResponse;
 import com.sap.ai.sdk.prompt.registry.model.SingleChatTemplate;
+import com.sap.ai.sdk.prompt.registry.spring.SpringAiConverter;
 import java.io.File;
 import java.io.IOException;
 import java.util.List;
 import java.util.Map;
+import lombok.val;
+import org.springframework.ai.chat.client.ChatClient;
+import org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor;
+import org.springframework.ai.chat.memory.InMemoryChatMemoryRepository;
+import org.springframework.ai.chat.memory.MessageWindowChatMemory;
+import org.springframework.ai.chat.messages.Message;
+import org.springframework.ai.chat.model.Generation;
+import org.springframework.ai.chat.prompt.Prompt;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.core.io.Resource;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -99,4 +111,29 @@ List<PromptTemplateDeleteResponse> deleteTemplate() {
         .map(template -> client.deletePromptTemplate(template.getId()))
         .toList();
   }
+
+  @GetMapping("/promptRegistryToSpringAi")
+  Generation promptRegistryToSpringAi() {
+    val openAiClient = new OpenAiChatModel(OpenAiClient.forModel(OpenAiModel.GPT_4O_MINI));
+    val repository = new InMemoryChatMemoryRepository();
+    val memory = MessageWindowChatMemory.builder().chatMemoryRepository(repository).build();
+    val advisor = MessageChatMemoryAdvisor.builder(memory).build();
+    val cl = ChatClient.builder(openAiClient).defaultAdvisors(advisor).build();
+
+    val promptResponse =
+        new PromptClient()
+            .parsePromptTemplateByNameVersion(
+                "categorization",
+                "0.0.1",
+                "java-e2e-test",
+                "default",
+                false,
+                PromptTemplateSubstitutionRequest.create()
+                    .inputParams(Map.of("inputExample", "I love football")));
+
+    final List<Message> messages = SpringAiConverter.promptTemplateToMessages(promptResponse);
+    val prompt = new Prompt(messages);
+    val response = cl.prompt(prompt).call().chatResponse();
+    return response != null ? response.getResult() : null;
+  }
 }

sample-code/spring-app/src/main/resources/static/index.html

@@ -1051,6 +1051,18 @@ <h2>📚 Prompt Registry</h2>
                                     </div>
                                 </div>
                             </li>
+                            <li class="list-group-item">
+                                <div class="info-tooltip">
+                                    <button type="submit"
+                                            formaction="/prompt-registry/promptRegistryToSpringAi"
+                                            class="link-offset-2-hover link-underline link-underline-opacity-0 link-underline-opacity-75-hover endpoint">
+                                        <code>/prompt-registry/promptRegistryToSpringAi</code>
+                                    </button>
+                                    <div class="tooltip-content">
+                                        Get a SpringAI list of messages from a Prompt Registry Response.
+                                    </div>
+                                </div>
+                            </li>
                         </ul>
                     </div>
                 </div>

sample-code/spring-app/src/test/java/com/sap/ai/sdk/app/controllers/PromptRegistryTest.java

@@ -85,4 +85,12 @@ void history() {
     assertThat(deletedTemplate).hasSize(1);
     assertThat(deletedTemplate.get(0).getMessage()).contains("successful");
   }
+
+  @Test
+  void promptRegistryToSpringAi() {
+    var controller = new PromptRegistryController();
+    var ChatResponse = controller.promptRegistryToSpringAi();
+    assertThat(ChatResponse).isNotNull();
+    assertThat(ChatResponse.getOutput().getText()).contains("Sports");
+  }
 }