codebase/spring-ai-semantic-caching [BAEL-9489] (#18898)

* init project structure

* implement semantic caching

* add test case

* remove unnecessary configuration setting

* minor refactor

* desensitize flagged test data

Author: hardikSinghBehl

spring-ai-modules/pom.xml

@@ -25,6 +25,7 @@
         <module>spring-ai-introduction</module>
         <module>spring-ai-mcp</module>
         <module>spring-ai-multiple-llms</module>
+        <module>spring-ai-semantic-caching</module>
         <module>spring-ai-text-to-sql</module>
         <module>spring-ai-vector-stores</module>
     </modules>

spring-ai-modules/spring-ai-semantic-caching/pom.xml

@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.baeldung</groupId>
+        <artifactId>spring-ai-modules</artifactId>
+        <version>0.0.1</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>spring-ai-semantic-caching</artifactId>
+    <version>0.0.1</version>
+    <name>spring-ai-semantic-caching</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.ai</groupId>
+            <artifactId>spring-ai-starter-model-openai</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.ai</groupId>
+            <artifactId>spring-ai-starter-vector-store-redis</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <properties>
+        <java.version>21</java.version>
+        <spring-ai.version>1.0.3</spring-ai.version>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>org.springframework.ai</groupId>
+                <artifactId>spring-ai-bom</artifactId>
+                <version>${spring-ai.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

spring-ai-modules/spring-ai-semantic-caching/src/main/java/com/baeldung/semantic/cache/Application.java

@@ -0,0 +1,13 @@
+package com.baeldung.semantic.cache;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}

spring-ai-modules/spring-ai-semantic-caching/src/main/java/com/baeldung/semantic/cache/LLMConfiguration.java

@@ -0,0 +1,35 @@
+package com.baeldung.semantic.cache;
+
+import org.springframework.ai.embedding.EmbeddingModel;
+import org.springframework.ai.vectorstore.redis.RedisVectorStore;
+import org.springframework.boot.autoconfigure.data.redis.RedisProperties;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import redis.clients.jedis.JedisPooled;
+
+@Configuration
+@EnableConfigurationProperties(SemanticCacheProperties.class)
+class LLMConfiguration {
+
+    @Bean
+    JedisPooled jedisPooled(RedisProperties redisProperties) {
+        return new JedisPooled(redisProperties.getUrl());
+    }
+
+    @Bean
+    RedisVectorStore vectorStore(
+        JedisPooled jedisPooled,
+        EmbeddingModel embeddingModel,
+        SemanticCacheProperties semanticCacheProperties
+    ) {
+        return RedisVectorStore
+            .builder(jedisPooled, embeddingModel)
+            .contentFieldName(semanticCacheProperties.contentField())
+            .embeddingFieldName(semanticCacheProperties.embeddingField())
+            .metadataFields(
+                RedisVectorStore.MetadataField.text(semanticCacheProperties.metadataField()))
+            .build();
+    }
+
+}

spring-ai-modules/spring-ai-semantic-caching/src/main/java/com/baeldung/semantic/cache/SemanticCacheProperties.java

@@ -0,0 +1,11 @@
+package com.baeldung.semantic.cache;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@ConfigurationProperties(prefix = "com.baeldung.semantic.cache")
+record SemanticCacheProperties(
+    Double similarityThreshold,
+    String contentField,
+    String embeddingField,
+    String metadataField
+) {}

spring-ai-modules/spring-ai-semantic-caching/src/main/java/com/baeldung/semantic/cache/SemanticCachingService.java

@@ -0,0 +1,51 @@
+package com.baeldung.semantic.cache;
+
+import org.springframework.ai.document.Document;
+import org.springframework.ai.vectorstore.SearchRequest;
+import org.springframework.ai.vectorstore.VectorStore;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+import java.util.Optional;
+
+@Service
+@EnableConfigurationProperties(SemanticCacheProperties.class)
+class SemanticCachingService {
+
+    private final VectorStore vectorStore;
+    private final SemanticCacheProperties semanticCacheProperties;
+
+    SemanticCachingService(VectorStore vectorStore, SemanticCacheProperties semanticCacheProperties) {
+        this.vectorStore = vectorStore;
+        this.semanticCacheProperties = semanticCacheProperties;
+    }
+
+    void save(String question, String answer) {
+        Document document = Document
+            .builder()
+            .text(question)
+            .metadata(semanticCacheProperties.metadataField(), answer)
+            .build();
+        vectorStore.add(List.of(document));
+    }
+
+    Optional<String> search(String question) {
+        SearchRequest searchRequest = SearchRequest.builder()
+            .query(question)
+            .similarityThreshold(semanticCacheProperties.similarityThreshold())
+            .topK(1)
+            .build();
+        List<Document> results = vectorStore.similaritySearch(searchRequest);
+
+        if (results.isEmpty()) {
+            return Optional.empty();
+        }
+
+        Document result = results.getFirst();
+        return Optional
+            .ofNullable(result.getMetadata().get(semanticCacheProperties.metadataField()))
+            .map(String::valueOf);
+    }
+
+}

spring-ai-modules/spring-ai-semantic-caching/src/main/resources/application.yaml

@@ -0,0 +1,20 @@
+spring:
+  ai:
+    openai:
+      api-key: ${OPENAI_API_KEY}
+      embedding:
+        options:
+          model: text-embedding-3-small
+          dimensions: 512
+  data:
+    redis:
+      url: ${REDIS_URL}
+
+com:
+  baeldung:
+    semantic:
+      cache:
+        similarity-threshold: 0.8
+        content-field: question
+        embedding-field: embedding
+        metadata-field: answer

spring-ai-modules/spring-ai-semantic-caching/src/test/java/com/baeldung/semantic/cache/SemanticCacheLiveTest.java

@@ -0,0 +1,37 @@
+package com.baeldung.semantic.cache;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
+import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariables;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+
+import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
+
+@SpringBootTest
+@EnabledIfEnvironmentVariables({
+    @EnabledIfEnvironmentVariable(named = "OPENAI_API_KEY", matches = ".*"),
+    @EnabledIfEnvironmentVariable(named = "REDIS_URL", matches = ".*")
+})
+class SemanticCacheLiveTest {
+
+    @Autowired
+    private SemanticCachingService semanticCachingService;
+
+    @Test
+    void whenUsingSemanticCache_thenCacheReturnsAnswerForSemanticallyRelatedQuestion() {
+        String question = "How many sick leaves can I take?";
+        String answer = "No leaves allowed! Get back to work!!";
+        semanticCachingService.save(question, answer);
+
+        String rephrasedQuestion = "How many days sick leave can I take?";
+        assertThat(semanticCachingService.search(rephrasedQuestion))
+            .isPresent()
+            .hasValue(answer);
+
+        String unrelatedQuestion = "Can I get a raise?";
+        assertThat(semanticCachingService.search(unrelatedQuestion))
+            .isEmpty();
+    }
+
+}