Merge pull request #12 from arey/feature/spring-ai-1.0.0-M6

Update Spring AI to 1.0.0-M6 and uses ToolCallback API

Author: arey

build.gradle

@@ -32,7 +32,7 @@ ext.webjarsLocatorLiteVersion = "1.0.1"
 ext.webjarsFontawesomeVersion = "4.7.0"
 ext.webjarsBootstrapVersion = "5.3.3"
 ext.webjarsMarkedVersion = "14.1.2"
-ext.springAiVersion = "1.0.0-M5"
+ext.springAiVersion = "1.0.0-M6"
 
 dependencies {
   // Workaround for AOT issue (https://github.com/spring-projects/spring-framework/pull/33949) -->

pom.xml

@@ -38,7 +38,7 @@
     <maven-checkstyle.version>3.6.0</maven-checkstyle.version>
     <nohttp-checkstyle.version>0.0.11</nohttp-checkstyle.version>
     <spring-format.version>0.0.43</spring-format.version>
-    <spring-ai.version>1.0.0-M5</spring-ai.version>
+    <spring-ai.version>1.0.0-M6</spring-ai.version>
   </properties>
 
   <dependencies>

src/main/java/org/springframework/samples/petclinic/genai/AIBeanConfiguration.java

@@ -32,7 +32,7 @@ public class AIBeanConfiguration {
 
 	@Bean
 	VectorStore vectorStore(EmbeddingModel embeddingModel) {
-		return new SimpleVectorStore(embeddingModel);
+		return SimpleVectorStore.builder(embeddingModel).build();
 	}
 
 }

src/main/java/org/springframework/samples/petclinic/genai/AIDataProvider.java

@@ -26,16 +26,18 @@
 import org.springframework.data.domain.Pageable;
 import org.springframework.samples.petclinic.owner.Owner;
 import org.springframework.samples.petclinic.owner.OwnerRepository;
+import org.springframework.samples.petclinic.owner.Pet;
+import org.springframework.samples.petclinic.vet.Vet;
 import org.springframework.stereotype.Service;
 
 import java.util.List;
-import java.util.Optional;
 
 /**
  * Functions that are invoked by the LLM will use this bean to query the system of record
  * for information such as listing owners and vets, or adding pets to an owner.
  *
  * @author Oded Shopen
+ * @author Antoine Rey
  */
 @Service
 public class AIDataProvider {
@@ -49,36 +51,34 @@ public AIDataProvider(OwnerRepository ownerRepository, VectorStore vectorStore)
 		this.vectorStore = vectorStore;
 	}
 
-	public OwnersResponse getAllOwners() {
+	public List<Owner> getAllOwners() {
 		Pageable pageable = PageRequest.of(0, 100);
 		Page<Owner> ownerPage = ownerRepository.findAll(pageable);
-		return new OwnersResponse(ownerPage.getContent());
+		return ownerPage.getContent();
 	}
 
-	public VetResponse getVets(VetRequest request) throws JsonProcessingException {
+	public List<String> getVets(Vet vet) throws JsonProcessingException {
 		ObjectMapper objectMapper = new ObjectMapper();
-		String vetAsJson = objectMapper.writeValueAsString(request.vet());
+		String vetAsJson = objectMapper.writeValueAsString(vet);
 
 		// Provide a limit of 50 results when zero parameters are sent
-		int topK = (request.vet() == null) ? 50 : 20;
+		int topK = (vet == null) ? 50 : 20;
 		SearchRequest sr = SearchRequest.builder().query(vetAsJson).topK(topK).build();
 
 		List<Document> topMatches = this.vectorStore.similaritySearch(sr);
-		List<String> results = topMatches.stream().map(Document::getContent).toList();
-		return new VetResponse(results);
+		return topMatches.stream().map(Document::getText).toList();
 	}
 
-	public AddedPetResponse addPetToOwner(AddPetRequest request) {
-		var ownerWithPet = ownerRepository.findById(request.ownerId()).map(existingOwner -> {
-			existingOwner.addPet(request.pet());
+	public Owner addPetToOwner(int ownerId, Pet pet) {
+		pet.setId(null); // Non persistent Pet
+		return ownerRepository.findById(ownerId).map(existingOwner -> {
+			existingOwner.addPet(pet);
 			return ownerRepository.save(existingOwner);
 		}).orElse(null);
-		return new AddedPetResponse(ownerWithPet);
 	}
 
-	public OwnerResponse addOwnerToPetclinic(OwnerRequest ownerRequest) {
-		ownerRepository.save(ownerRequest.owner());
-		return new OwnerResponse(ownerRequest.owner());
+	public Owner addOwnerToPetclinic(Owner owner) {
+		return ownerRepository.save(owner);
 	}
 
 }

src/main/java/org/springframework/samples/petclinic/genai/AIFunctionConfiguration.java

@@ -35,7 +35,7 @@ class ChatConfiguration {
 	private Resource systemResource;
 
 	@Bean
-	ChatClient chatClient(ChatClient.Builder chatClientBuilder, ChatMemory chatMemory) {
+	ChatClient chatClient(ChatClient.Builder chatClientBuilder, ChatMemory chatMemory, PetclinicTools petclinicTools) {
 		// @formatter:off
 		return chatClientBuilder
 			.defaultAdvisors(
@@ -44,7 +44,7 @@ ChatClient chatClient(ChatClient.Builder chatClientBuilder, ChatMemory chatMemor
 				new SimpleLoggerAdvisor()
 			)
 			.defaultSystem(systemResource)
-			.defaultFunctions("listOwners", "listVets", "addPetToOwner", "addOwnerToPetclinic")
+			.defaultTools(petclinicTools)
 			.build();
 		// @formatter:on
 	}

src/main/java/org/springframework/samples/petclinic/genai/ChatConfiguration.java

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2012-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.samples.petclinic.genai;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.ai.tool.annotation.Tool;
+import org.springframework.samples.petclinic.owner.Owner;
+import org.springframework.samples.petclinic.owner.Pet;
+import org.springframework.samples.petclinic.vet.Vet;
+import org.springframework.stereotype.Component;
+
+import java.util.List;
+
+/**
+ * This class defines the tools (also known as function) that the LLM provider will invoke
+ * when it requires more Information on a given topic. The currently available tools
+ * enable the LLM to get the list of owners and their pets, get information about the
+ * veterinarians, and add a pet to an owner.
+ *
+ * @author Oded Shopen
+ * @author Antoine Rey
+ */
+@Component
+class PetclinicTools {
+
+	private final static Logger LOGGER = LoggerFactory.getLogger(PetclinicTools.class);
+
+	private final AIDataProvider petclinicAiProvider;
+
+	PetclinicTools(AIDataProvider petclinicAiProvider) {
+		this.petclinicAiProvider = petclinicAiProvider;
+	}
+
+	@Tool(description = "List the owners that the pet clinic has")
+	public List<Owner> listOwners() {
+		return petclinicAiProvider.getAllOwners();
+	}
+
+	@Tool(description = "List the veterinarians that the pet clinic has")
+	public List<String> listVets(Vet vet) {
+		try {
+			return petclinicAiProvider.getVets(vet);
+		}
+		catch (JsonProcessingException e) {
+			LOGGER.error("Listing Veterinarians failed", e);
+			return null;
+		}
+	}
+
+	@Tool(description = ("""
+			Add a pet with the specified petTypeId, to an owner identified by the ownerId. \
+			The allowed Pet types IDs are only: \
+			1 - cat \
+			2 - dog \
+			3 - lizard \
+			4 - snake \
+			5 - bird \
+			6 - hamster"""))
+	public Owner addPetToOwner(Pet pet, Integer ownerId) {
+		return petclinicAiProvider.addPetToOwner(ownerId, pet);
+	}
+
+	@Tool(description = ("""
+			Add a new pet owner to the pet clinic. \
+			The Owner must include a first name and a last name as two separate words, \
+			plus an address and a 10-digit phone number"""))
+	public Owner addOwnerToPetclinic(Owner owner) {
+		return petclinicAiProvider.addOwnerToPetclinic(owner);
+	}
+
+}