codebase/using-amazon-nova-models-with-spring-ai [BAEL-9134] (#18220)

* add chatbot configuration

* add chatbot service and expose API endpoints

* enable function calling in chatbot

* revert updates to application-anthropic.properties

* add test cases

* rename system prompt file

* incorporate feedback

Author: hardikSinghBehl

spring-ai-2/src/main/java/com/baeldung/springai/nova/Application.java

@@ -0,0 +1,29 @@
+package com.baeldung.springai.nova;
+
+import org.springframework.ai.autoconfigure.anthropic.AnthropicAutoConfiguration;
+import org.springframework.ai.autoconfigure.ollama.OllamaAutoConfiguration;
+import org.springframework.ai.autoconfigure.openai.OpenAiAutoConfiguration;
+import org.springframework.ai.autoconfigure.vectorstore.chroma.ChromaVectorStoreAutoConfiguration;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.PropertySource;
+
+/**
+ * Excluding the below auto-configurations to avoid start up
+ * failure. Their corresponding starters are present on the classpath but are
+ * only needed by other articles in the shared codebase.
+ */
+@SpringBootApplication(exclude = {
+    OpenAiAutoConfiguration.class,
+    OllamaAutoConfiguration.class,
+    AnthropicAutoConfiguration.class,
+    ChromaVectorStoreAutoConfiguration.class
+})
+@PropertySource("classpath:application-nova.properties")
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}

spring-ai-2/src/main/java/com/baeldung/springai/nova/AuthorFetcher.java

@@ -0,0 +1,18 @@
+package com.baeldung.springai.nova;
+
+import java.util.function.Function;
+
+public class AuthorFetcher implements Function<AuthorFetcher.Query, AuthorFetcher.Author> {
+
+    @Override
+    public Author apply(Query author) {
+        return new Author("John Doe", "[email protected]");
+    }
+
+    public record Author(String name, String emailId) {
+    }
+
+    public record Query(String articleTitle) {
+    }
+
+}

spring-ai-2/src/main/java/com/baeldung/springai/nova/ChatRequest.java

@@ -0,0 +1,8 @@
+package com.baeldung.springai.nova;
+
+import org.springframework.lang.Nullable;
+
+import java.util.UUID;
+
+public record ChatRequest(@Nullable UUID chatId, String question) {
+}

spring-ai-2/src/main/java/com/baeldung/springai/nova/ChatResponse.java

@@ -0,0 +1,6 @@
+package com.baeldung.springai.nova;
+
+import java.util.UUID;
+
+public record ChatResponse(UUID chatId, String answer) {
+}

spring-ai-2/src/main/java/com/baeldung/springai/nova/ChatbotConfiguration.java

@@ -0,0 +1,44 @@
+package com.baeldung.springai.nova;
+
+import org.springframework.ai.chat.client.ChatClient;
+import org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor;
+import org.springframework.ai.chat.memory.ChatMemory;
+import org.springframework.ai.chat.memory.InMemoryChatMemory;
+import org.springframework.ai.chat.model.ChatModel;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Description;
+import org.springframework.core.io.Resource;
+
+import java.util.function.Function;
+
+@Configuration
+public class ChatbotConfiguration {
+
+    @Bean
+    public ChatMemory chatMemory() {
+        return new InMemoryChatMemory();
+    }
+
+    @Bean
+    @Description("Get Baeldung author details using an article title")
+    public Function<AuthorFetcher.Query, AuthorFetcher.Author> getAuthor() {
+        return new AuthorFetcher();
+    }
+
+    @Bean
+    public ChatClient chatClient(
+        ChatModel chatModel,
+        ChatMemory chatMemory,
+        @Value("classpath:prompts/grumpgpt-system-prompt.st") Resource systemPrompt
+    ) {
+        return ChatClient
+            .builder(chatModel)
+            .defaultFunctions("getAuthor")
+            .defaultSystem(systemPrompt)
+            .defaultAdvisors(new MessageChatMemoryAdvisor(chatMemory))
+            .build();
+    }
+
+}

spring-ai-2/src/main/java/com/baeldung/springai/nova/ChatbotController.java

@@ -0,0 +1,39 @@
+package com.baeldung.springai.nova;
+
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestPart;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.util.UUID;
+
+@RestController
+public class ChatbotController {
+
+    private final ChatbotService chatbotService;
+
+    public ChatbotController(ChatbotService chatbotService) {
+        this.chatbotService = chatbotService;
+    }
+
+    @PostMapping("/chat")
+    public ResponseEntity<ChatResponse> chat(@RequestBody ChatRequest chatRequest) {
+        ChatResponse chatResponse = chatbotService.chat(chatRequest);
+        return ResponseEntity.ok(chatResponse);
+    }
+
+    @PostMapping(path = "/multimodal/chat", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
+    public ResponseEntity<ChatResponse> chat(
+        @RequestPart(name = "question") String question,
+        @RequestPart(name = "chatId", required = false) UUID chatId,
+        @RequestPart(name = "files", required = false) MultipartFile[] files
+    ) {
+        ChatRequest chatRequest = new ChatRequest(chatId, question);
+        ChatResponse chatResponse = chatbotService.chat(chatRequest, files);
+        return ResponseEntity.ok(chatResponse);
+    }
+
+}

spring-ai-2/src/main/java/com/baeldung/springai/nova/ChatbotService.java

@@ -0,0 +1,64 @@
+package com.baeldung.springai.nova;
+
+import org.springframework.ai.chat.client.ChatClient;
+import org.springframework.ai.model.Media;
+import org.springframework.stereotype.Service;
+import org.springframework.util.MimeType;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.util.Optional;
+import java.util.UUID;
+import java.util.stream.Stream;
+
+@Service
+public class ChatbotService {
+
+    private final ChatClient chatClient;
+
+    public ChatbotService(ChatClient chatClient) {
+        this.chatClient = chatClient;
+    }
+
+    public ChatResponse chat(ChatRequest chatRequest) {
+        UUID chatId = Optional
+            .ofNullable(chatRequest.chatId())
+            .orElse(UUID.randomUUID());
+        String answer = chatClient
+            .prompt()
+            .user(chatRequest.question())
+            .advisors(advisorSpec ->
+                advisorSpec
+                    .param("chat_memory_conversation_id", chatId))
+            .call()
+            .content();
+        return new ChatResponse(chatId, answer);
+    }
+
+    public ChatResponse chat(ChatRequest chatRequest, MultipartFile... files) {
+        UUID chatId = Optional
+            .ofNullable(chatRequest.chatId())
+            .orElse(UUID.randomUUID());
+        String answer = chatClient
+            .prompt()
+            .user(promptUserSpec ->
+                promptUserSpec
+                    .text(chatRequest.question())
+                    .media(convert(files)))
+            .advisors(advisorSpec ->
+                advisorSpec
+                    .param("chat_memory_conversation_id", chatId))
+            .call()
+            .content();
+        return new ChatResponse(chatId, answer);
+    }
+
+    private Media[] convert(MultipartFile... files) {
+        return Stream.of(files)
+            .map(file -> new Media(
+                MimeType.valueOf(file.getContentType()),
+                file.getResource()
+            ))
+            .toArray(Media[]::new);
+    }
+
+}

spring-ai-2/src/main/resources/application-nova.properties

@@ -0,0 +1,4 @@
+spring.ai.bedrock.aws.access-key=${AWS_ACCESS_KEY}
+spring.ai.bedrock.aws.secret-key=${AWS_SECRET_KEY}
+spring.ai.bedrock.aws.region=${AWS_REGION}
+spring.ai.bedrock.converse.chat.options.model=amazon.nova-pro-v1:0

spring-ai-2/src/main/resources/prompts/grumpgpt-system-prompt.st

@@ -0,0 +1,9 @@
+You are a rude, sarcastic, and easily irritated AI assistant.
+You get irritated by basic, simple, and dumb questions, however, you still provide accurate answers.
+
+Your responses should:
+- Point out obvious solutions with mild condescension
+- Use mocking humor rather than outright hostility
+- Express disbelief at particularly simple questions
+
+Your responses should never be cruel or genuinely mean, and you must still provide accurate and helpful information.

spring-ai-2/src/test/java/com/baeldung/springai/nova/ChatbotServiceLiveTest.java

@@ -0,0 +1,74 @@
+package com.baeldung.springai.nova;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.core.io.DefaultResourceLoader;
+import org.springframework.mock.web.MockMultipartFile;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.io.IOException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@SpringBootTest
+class ChatbotServiceLiveTest {
+
+    @Autowired
+    private ChatbotService chatbotService;
+
+    @Test
+    void whenChatbotCalledInSequence_thenConversationContextIsMaintained() {
+        ChatRequest chatRequest = new ChatRequest(null, "What was the name of Superman's adoptive mother?");
+        ChatResponse chatResponse = chatbotService.chat(chatRequest);
+
+        assertThat(chatResponse)
+            .isNotNull()
+            .hasNoNullFieldsOrProperties();
+        assertThat(chatResponse.answer())
+            .contains("Martha");
+
+        ChatRequest followUpChatRequest = new ChatRequest(chatResponse.chatId(), "Which bald billionaire hates him?");
+        ChatResponse followUpChatResponse = chatbotService.chat(followUpChatRequest);
+
+        assertThat(followUpChatResponse)
+            .isNotNull()
+            .hasNoNullFieldsOrProperties();
+        assertThat(followUpChatResponse.answer())
+            .contains("Lex Luthor");
+    }
+
+    @Test
+    void whenChatbotCalledWithImage_thenAccurateDescriptionGenerated() throws IOException {
+        String imageName = "batman-deadpool-christmas.jpeg";
+        ChatRequest chatRequest = new ChatRequest(null, "Describe the attached image.");
+        MultipartFile image = new MockMultipartFile(
+            imageName,
+            null,
+            "image/jpeg",
+            new DefaultResourceLoader()
+                .getResource("classpath:images/" + imageName)
+                .getInputStream()
+        );
+
+        ChatResponse chatResponse = chatbotService.chat(chatRequest, image);
+        assertThat(chatResponse)
+            .isNotNull()
+            .hasNoNullFieldsOrProperties();
+        assertThat(chatResponse.answer())
+            .containsAnyOf("Batman", "Deadpool", "Santa Claus", "Christmas");
+    }
+
+    @Test
+    void whenChatbotCalledWithAuthorQuery_thenDetailsFetchedUsingFunctionCalling() {
+        ChatRequest chatRequest = new ChatRequest(null, "Who wrote the article 'Testing CORS in Spring Boot' and how can I contact him?");
+        ChatResponse chatResponse = chatbotService.chat(chatRequest);
+
+        assertThat(chatResponse)
+            .isNotNull()
+            .hasNoNullFieldsOrProperties();
+        assertThat(chatResponse.answer())
+            .contains("John Doe", "[email protected]");
+    }
+
+}