Merge pull request #220 from milderhc/redis-vector-search

Add vector search for Redis JSON and HashSet

Author: Milder Hernandez

api-test/integration-tests/src/test/java/com/microsoft/semantickernel/tests/connectors/memory/Hotel.java renamed to api-test/integration-tests/src/test/java/com/microsoft/semantickernel/tests/connectors/memory/jdbc/Hotel.java

@@ -1,4 +1,4 @@
-package com.microsoft.semantickernel.tests.connectors.memory;
+package com.microsoft.semantickernel.tests.connectors.memory.jdbc;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -12,7 +12,7 @@ public class Hotel {
     @VectorStoreRecordKeyAttribute
     private final String id;
 
-    @VectorStoreRecordDataAttribute
+    @VectorStoreRecordDataAttribute(isFilterable = true)
     private final String name;
 
     @VectorStoreRecordDataAttribute

api-test/integration-tests/src/test/java/com/microsoft/semantickernel/tests/connectors/memory/jdbc/JDBCVectorStoreRecordCollectionTest.java

@@ -10,7 +10,6 @@
 import com.microsoft.semantickernel.data.vectorsearch.VectorSearchResult;
 import com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions;
 import com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions;
-import com.microsoft.semantickernel.tests.connectors.memory.Hotel;
 import com.mysql.cj.jdbc.MysqlDataSource;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;

api-test/integration-tests/src/test/java/com/microsoft/semantickernel/tests/connectors/memory/jdbc/JDBCVectorStoreTest.java

@@ -6,7 +6,6 @@
 import com.microsoft.semantickernel.connectors.data.jdbc.JDBCVectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.connectors.data.mysql.MySQLVectorStoreQueryProvider;
 import com.microsoft.semantickernel.connectors.data.postgres.PostgreSQLVectorStoreQueryProvider;
-import com.microsoft.semantickernel.tests.connectors.memory.Hotel;
 import com.mysql.cj.jdbc.MysqlDataSource;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.EnumSource;

api-test/integration-tests/src/test/java/com/microsoft/semantickernel/tests/connectors/memory/redis/Hotel.java

@@ -0,0 +1,98 @@
+package com.microsoft.semantickernel.tests.connectors.memory.redis;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.microsoft.semantickernel.data.vectorstorage.attributes.VectorStoreRecordDataAttribute;
+import com.microsoft.semantickernel.data.vectorstorage.attributes.VectorStoreRecordKeyAttribute;
+import com.microsoft.semantickernel.data.vectorstorage.attributes.VectorStoreRecordVectorAttribute;
+
+import java.util.List;
+
+public class Hotel {
+    @VectorStoreRecordKeyAttribute
+    private final String id;
+
+    @VectorStoreRecordDataAttribute(isFilterable = true)
+    private final String name;
+
+    @VectorStoreRecordDataAttribute
+    private final int code;
+
+    @JsonProperty("summary")
+    @VectorStoreRecordDataAttribute()
+    private final String description;
+
+    @JsonProperty("summaryEmbedding1")
+    @VectorStoreRecordVectorAttribute(dimensions = 8, distanceFunction = "euclidean")
+    private final List<Float> euclidean;
+
+    @JsonProperty("summaryEmbedding2")
+    @VectorStoreRecordVectorAttribute(dimensions = 8, distanceFunction = "cosineDistance")
+    private final List<Float> cosineDistance;
+
+    @JsonProperty("summaryEmbedding3")
+    @VectorStoreRecordVectorAttribute(dimensions = 8, distanceFunction = "dotProduct")
+    private final List<Float> dotProduct;
+    @VectorStoreRecordDataAttribute
+    private double rating;
+
+    public Hotel() {
+        this(null, null, 0, null, null, null, null, 0.0);
+    }
+
+    @JsonCreator
+    public Hotel(
+            @JsonProperty("id") String id,
+            @JsonProperty("name") String name,
+            @JsonProperty("code") int code,
+            @JsonProperty("summary") String description,
+            @JsonProperty("summaryEmbedding1") List<Float> euclidean,
+            @JsonProperty("summaryEmbedding2") List<Float> cosineDistance,
+            @JsonProperty("summaryEmbedding3") List<Float> dotProduct,
+            @JsonProperty("rating") double rating) {
+        this.id = id;
+        this.name = name;
+        this.code = code;
+        this.description = description;
+        this.euclidean = euclidean;
+        this.cosineDistance = euclidean;
+        this.dotProduct = euclidean;
+        this.rating = rating;
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public int getCode() {
+        return code;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public List<Float> getEuclidean() {
+        return euclidean;
+    }
+
+    public List<Float> getCosineDistance() {
+        return cosineDistance;
+    }
+
+    public List<Float> getDotProduct() {
+        return dotProduct;
+    }
+
+    public double getRating() {
+        return rating;
+    }
+
+    public void setRating(double rating) {
+        this.rating = rating;
+    }
+}

api-test/integration-tests/src/test/java/com/microsoft/semantickernel/tests/connectors/memory/redis/RedisHashSetVectorStoreRecordCollectionTest.java

@@ -6,7 +6,7 @@
 import com.microsoft.semantickernel.connectors.data.redis.RedisVectorStore;
 import com.microsoft.semantickernel.connectors.data.redis.RedisVectorStoreOptions;
 import com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollectionOptions;
-import com.microsoft.semantickernel.tests.connectors.memory.Hotel;
+import com.microsoft.semantickernel.tests.connectors.memory.jdbc.Hotel;
 import com.redis.testcontainers.RedisContainer;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.EnumSource;

api-test/integration-tests/src/test/java/com/microsoft/semantickernel/tests/connectors/memory/redis/RedisJsonVectorStoreRecordCollectionTest.java

@@ -41,7 +41,7 @@
         <dependency>
             <groupId>redis.clients</groupId>
             <artifactId>jedis</artifactId>
-            <version>5.1.0</version>
+            <version>5.2.0-beta5</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

api-test/integration-tests/src/test/java/com/microsoft/semantickernel/tests/connectors/memory/redis/RedisVectorStoreTest.java

@@ -118,17 +118,19 @@ public static void dataStorageWithAzureAISearch(
         OpenAITextEmbeddingGenerationService embeddingGeneration) {
 
         // Create a new Azure AI Search vector store
-        var azureAISearchVectorStore = com.microsoft.semantickernel.connectors.data.azureaisearch.AzureAISearchVectorStore.builder()
+        var azureAISearchVectorStore = com.microsoft.semantickernel.connectors.data.azureaisearch.AzureAISearchVectorStore
+            .builder()
             .withSearchIndexAsyncClient(searchClient)
             .withOptions(new AzureAISearchVectorStoreOptions())
             .build();
 
         String collectionName = "skgithubfiles";
-        var collection = (AzureAISearchVectorStoreRecordCollection<GitHubFile>) azureAISearchVectorStore.getCollection(
-            collectionName,
-            AzureAISearchVectorStoreRecordCollectionOptions.<GitHubFile>builder()
-                .withRecordClass(GitHubFile.class)
-                .build());
+        var collection = (AzureAISearchVectorStoreRecordCollection<GitHubFile>) azureAISearchVectorStore
+            .getCollection(
+                collectionName,
+                AzureAISearchVectorStoreRecordCollectionOptions.<GitHubFile>builder()
+                    .withRecordClass(GitHubFile.class)
+                    .build());
 
         // Create collection if it does not exist and store data
         collection
@@ -146,17 +148,17 @@ public static void dataStorageWithAzureAISearch(
         }
         var searchResult = results.get(0);
         System.out.printf("Search result with score: %f.%n Link: %s, Description: %s%n",
-                searchResult.getScore(), searchResult.getRecord().link, searchResult.getRecord().description);
+            searchResult.getScore(), searchResult.getRecord().link,
+            searchResult.getRecord().description);
     }
 
-
     private static Mono<List<VectorSearchResult<GitHubFile>>> search(
-            String searchText,
-            AzureAISearchVectorStoreRecordCollection<GitHubFile> recordCollection,
-            OpenAITextEmbeddingGenerationService embeddingGeneration) {
+        String searchText,
+        AzureAISearchVectorStoreRecordCollection<GitHubFile> recordCollection,
+        OpenAITextEmbeddingGenerationService embeddingGeneration) {
 
         return embeddingGeneration.generateEmbeddingsAsync(Collections.singletonList(searchText))
-                .flatMap(r -> recordCollection.searchAsync(r.get(0).getVector(), null));
+            .flatMap(r -> recordCollection.searchAsync(r.get(0).getVector(), null));
     }
 
     private static Mono<List<String>> storeData(

connectors/semantickernel-connectors-memory-redis/pom.xml

@@ -120,7 +120,7 @@
             <dependency>
                 <groupId>redis.clients</groupId>
                 <artifactId>jedis</artifactId>
-                <version>5.1.0</version>
+                <version>5.2.0-beta5</version>
             </dependency>
 
             <dependency>