Merge pull request #195 from milderhc/get-collection

Add VectorStoreRecordCollectionOptions interface and make getCollecti…

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

@@ -3,6 +3,7 @@
 import com.microsoft.semantickernel.connectors.data.jdbc.JDBCVectorStore;
 import com.microsoft.semantickernel.connectors.data.jdbc.JDBCVectorStoreOptions;
 import com.microsoft.semantickernel.connectors.data.jdbc.JDBCVectorStoreQueryProvider;
+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;
@@ -88,7 +89,10 @@ public void getCollectionNamesAsync(QueryProvider provider) {
         List<String> collectionNames = Arrays.asList("collection1", "collection2", "collection3");
 
         for (String collectionName : collectionNames) {
-            vectorStore.getCollection(collectionName, Hotel.class, null).createCollectionAsync().block();
+            vectorStore.getCollection(collectionName,
+                    JDBCVectorStoreRecordCollectionOptions.<Hotel>builder()
+                    .withRecordClass(Hotel.class)
+                    .build()).createCollectionAsync().block();
         }
 
         List<String> retrievedCollectionNames = vectorStore.getCollectionNamesAsync().block();

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

@@ -1,8 +1,11 @@
 package com.microsoft.semantickernel.tests.connectors.memory.redis;
 
+import com.microsoft.semantickernel.connectors.data.redis.RedisHashSetVectorStoreRecordCollectionOptions;
+import com.microsoft.semantickernel.connectors.data.redis.RedisJsonVectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.connectors.data.redis.RedisStorageType;
 import com.microsoft.semantickernel.connectors.data.redis.RedisVectorStore;
 import com.microsoft.semantickernel.connectors.data.redis.RedisVectorStoreOptions;
+import com.microsoft.semantickernel.data.VectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.tests.connectors.memory.Hotel;
 import com.redis.testcontainers.RedisContainer;
 import org.junit.jupiter.api.BeforeAll;
@@ -36,6 +39,18 @@ public static JedisPooled buildClient(RedisStorageType storageType) {
         }
     }
 
+    private static VectorStoreRecordCollectionOptions<String, Hotel> getRecordCollectionOptions(RedisStorageType storageType) {
+        if (storageType == RedisStorageType.JSON) {
+            return RedisJsonVectorStoreRecordCollectionOptions.<Hotel>builder()
+                    .withRecordClass(Hotel.class)
+                    .build();
+        } else {
+            return RedisHashSetVectorStoreRecordCollectionOptions.<Hotel>builder()
+                    .withRecordClass(Hotel.class)
+                    .build();
+        }
+    }
+
     @ParameterizedTest
     @EnumSource(RedisStorageType.class)
     public void getCollectionNamesAsync(RedisStorageType storageType) {
@@ -46,7 +61,7 @@ public void getCollectionNamesAsync(RedisStorageType storageType) {
         List<String> collectionNames = Arrays.asList("collection1", "collection2", "collection3");
 
         for (String collectionName : collectionNames) {
-            vectorStore.getCollection(collectionName, Hotel.class, null).createCollectionAsync().block();
+            vectorStore.getCollection(collectionName, getRecordCollectionOptions(storageType)).createCollectionAsync().block();
         }
 
         List<String> retrievedCollectionNames = vectorStore.getCollectionNamesAsync().block();

samples/semantickernel-concepts/semantickernel-syntax-examples/src/main/java/com/microsoft/semantickernel/samples/syntaxexamples/memory/AzureAISearch_DataStorage.java

@@ -15,6 +15,7 @@
 import com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService;
 import com.microsoft.semantickernel.connectors.data.azureaisearch.AzureAISearchVectorStore;
 import com.microsoft.semantickernel.connectors.data.azureaisearch.AzureAISearchVectorStoreOptions;
+import com.microsoft.semantickernel.connectors.data.azureaisearch.AzureAISearchVectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.data.VectorStoreRecordCollection;
 import com.microsoft.semantickernel.data.recordattributes.VectorStoreRecordDataAttribute;
 import com.microsoft.semantickernel.data.recordattributes.VectorStoreRecordKeyAttribute;
@@ -125,8 +126,9 @@ public static void dataStorageWithAzureAISearch(
         String collectionName = "skgithubfiles";
         var collection = azureAISearchVectorStore.getCollection(
             collectionName,
-            GitHubFile.class,
-            null);
+            AzureAISearchVectorStoreRecordCollectionOptions.<GitHubFile>builder()
+                    .withRecordClass(GitHubFile.class)
+                    .build());
 
         // Create collection if it does not exist and store data
         collection

samples/semantickernel-concepts/semantickernel-syntax-examples/src/main/java/com/microsoft/semantickernel/samples/syntaxexamples/memory/InMemory_DataStorage.java

@@ -8,6 +8,7 @@
 import com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService;
 import com.microsoft.semantickernel.data.VectorStoreRecordCollection;
 import com.microsoft.semantickernel.data.VolatileVectorStore;
+import com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.data.recordattributes.VectorStoreRecordDataAttribute;
 import com.microsoft.semantickernel.data.recordattributes.VectorStoreRecordKeyAttribute;
 import com.microsoft.semantickernel.data.recordattributes.VectorStoreRecordVectorAttribute;
@@ -101,7 +102,10 @@ public static void inMemoryDataStorage(
         var volatileVectorStore = new VolatileVectorStore();
 
         String collectionName = "skgithubfiles";
-        var collection = volatileVectorStore.getCollection(collectionName, GitHubFile.class, null);
+        var collection = volatileVectorStore.getCollection(collectionName,
+                VolatileVectorStoreRecordCollectionOptions.<GitHubFile>builder()
+                        .withRecordClass(GitHubFile.class)
+                        .build());
 
         // Create collection if it does not exist and store data
         List<String> ids = collection

samples/semantickernel-concepts/semantickernel-syntax-examples/src/main/java/com/microsoft/semantickernel/samples/syntaxexamples/memory/JDBC_DataStorage.java

@@ -8,6 +8,7 @@
 import com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService;
 import com.microsoft.semantickernel.connectors.data.jdbc.JDBCVectorStore;
 import com.microsoft.semantickernel.connectors.data.jdbc.JDBCVectorStoreOptions;
+import com.microsoft.semantickernel.connectors.data.jdbc.JDBCVectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.connectors.data.mysql.MySQLVectorStoreQueryProvider;
 import com.microsoft.semantickernel.data.VectorStoreRecordCollection;
 import com.microsoft.semantickernel.data.recordattributes.VectorStoreRecordDataAttribute;
@@ -132,8 +133,9 @@ public static void dataStorageWithMySQL(
 
         String collectionName = "skgithubfiles";
         var collection = jdbcVectorStore.getCollection(collectionName,
-            GitHubFile.class,
-            null);
+            JDBCVectorStoreRecordCollectionOptions.<GitHubFile>builder()
+                    .withRecordClass(GitHubFile.class)
+                    .build());
 
         // Create collection if it does not exist and store data
         List<String> ids = collection

samples/semantickernel-concepts/semantickernel-syntax-examples/src/main/java/com/microsoft/semantickernel/samples/syntaxexamples/memory/Redis_DataStorage.java

@@ -9,6 +9,7 @@
 import com.azure.core.util.MetricsOptions;
 import com.azure.core.util.TracingOptions;
 import com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService;
+import com.microsoft.semantickernel.connectors.data.redis.RedisJsonVectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.connectors.data.redis.RedisVectorStore;
 import com.microsoft.semantickernel.connectors.data.redis.RedisVectorStoreOptions;
 import com.microsoft.semantickernel.data.VectorStoreRecordCollection;
@@ -120,7 +121,10 @@ public static void dataStorageWithRedis(
             .build();
 
         String collectionName = "skgithubfiles";
-        var collection = vectorStore.getCollection(collectionName, GitHubFile.class, null);
+        var collection = vectorStore.getCollection(collectionName,
+                RedisJsonVectorStoreRecordCollectionOptions.<GitHubFile>builder()
+                    .withRecordClass(GitHubFile.class)
+                    .build());
 
         // Create collection if it does not exist and store data
         List<String> ids = collection

semantickernel-experimental/src/main/java/com/microsoft/semantickernel/connectors/data/azureaisearch/AzureAISearchVectorStore.java

@@ -5,7 +5,9 @@
 import com.azure.search.documents.indexes.models.SearchIndex;
 import com.microsoft.semantickernel.data.VectorStore;
 import com.microsoft.semantickernel.data.VectorStoreRecordCollection;
+import com.microsoft.semantickernel.data.VectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.data.recorddefinition.VectorStoreRecordDefinition;
+import com.microsoft.semantickernel.exceptions.SKException;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.List;
 import javax.annotation.Nonnull;
@@ -34,44 +36,34 @@ public AzureAISearchVectorStore(@Nonnull SearchIndexAsyncClient client,
      * Gets a new instance of {@link AzureAISearchVectorStoreRecordCollection}
      *
      * @param collectionName   The name of the collection.
-     * @param recordClass      The class type of the record.
-     * @param recordDefinition The record definition.
+     * @param options          The options for the collection.
      * @return The collection.
      */
     @Override
     public final <Key, Record> VectorStoreRecordCollection<Key, Record> getCollection(
         @Nonnull String collectionName,
-        @Nonnull Class<Key> keyClass,
-        @Nonnull Class<Record> recordClass,
-        @Nullable VectorStoreRecordDefinition recordDefinition) {
-        if (!keyClass.equals(String.class)) {
-            throw new IllegalArgumentException("Azure AI Search only supports string keys");
+        @Nonnull VectorStoreRecordCollectionOptions<Key, Record> options) {
+        if (!options.getKeyClass().equals(String.class)) {
+            throw new SKException("Azure AI Search only supports string keys");
+        }
+        if (options.getRecordClass() == null) {
+            throw new SKException("Record class is required");
         }
 
-        return (VectorStoreRecordCollection<Key, Record>) getCollection(
-            collectionName, recordClass, recordDefinition);
-    }
-
-    public <Record> AzureAISearchVectorStoreRecordCollection<Record> getCollection(
-        @Nonnull String collectionName,
-        @Nonnull Class<Record> recordClass,
-        @Nullable VectorStoreRecordDefinition recordDefinition) {
-        if (options.getVectorStoreRecordCollectionFactory() != null) {
-            return options.getVectorStoreRecordCollectionFactory()
+        if (this.options.getVectorStoreRecordCollectionFactory() != null) {
+            return (VectorStoreRecordCollection<Key, Record>) this.options
+                .getVectorStoreRecordCollectionFactory()
                 .createVectorStoreRecordCollection(
                     client,
                     collectionName,
-                    recordClass,
-                    recordDefinition);
+                    options.getRecordClass(),
+                    options.getRecordDefinition());
         }
 
-        return new AzureAISearchVectorStoreRecordCollection<>(
+        return (VectorStoreRecordCollection<Key, Record>) new AzureAISearchVectorStoreRecordCollection<>(
             client,
             collectionName,
-            AzureAISearchVectorStoreRecordCollectionOptions.<Record>builder()
-                .withRecordClass(recordClass)
-                .withRecordDefinition(recordDefinition)
-                .build());
+            (AzureAISearchVectorStoreRecordCollectionOptions<Record>) options);
     }
 
     /**

semantickernel-experimental/src/main/java/com/microsoft/semantickernel/connectors/data/azureaisearch/AzureAISearchVectorStoreRecordCollectionOptions.java

@@ -2,6 +2,7 @@
 package com.microsoft.semantickernel.connectors.data.azureaisearch;
 
 import com.azure.search.documents.SearchDocument;
+import com.microsoft.semantickernel.data.VectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.data.VectorStoreRecordMapper;
 import com.microsoft.semantickernel.data.recorddefinition.VectorStoreRecordDefinition;
 import javax.annotation.Nonnull;
@@ -12,12 +13,11 @@
  *
  * @param <Record> the record type
  */
-public class AzureAISearchVectorStoreRecordCollectionOptions<Record> {
-
+public class AzureAISearchVectorStoreRecordCollectionOptions<Record>
+    implements VectorStoreRecordCollectionOptions<String, Record> {
     private final Class<Record> recordClass;
     @Nullable
     private final VectorStoreRecordMapper<Record, SearchDocument> vectorStoreRecordMapper;
-
     @Nullable
     private final VectorStoreRecordDefinition recordDefinition;
 
@@ -31,6 +31,16 @@ public static <Record> Builder<Record> builder() {
         return new Builder<>();
     }
 
+    /**
+     * Gets the key class.
+     *
+     * @return the key class
+     */
+    @Override
+    public Class<String> getKeyClass() {
+        return String.class;
+    }
+
     /**
      * Gets the record class.
      *

semantickernel-experimental/src/main/java/com/microsoft/semantickernel/connectors/data/jdbc/JDBCVectorStore.java

@@ -2,7 +2,9 @@
 package com.microsoft.semantickernel.connectors.data.jdbc;
 
 import com.microsoft.semantickernel.data.VectorStoreRecordCollection;
+import com.microsoft.semantickernel.data.VectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.data.recorddefinition.VectorStoreRecordDefinition;
+import com.microsoft.semantickernel.exceptions.SKException;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import reactor.core.publisher.Mono;
 import reactor.core.scheduler.Schedulers;
@@ -55,53 +57,42 @@ public static Builder builder() {
      * Gets a collection from the vector store.
      *
      * @param collectionName   The name of the collection.
-     * @param recordClass      The class type of the record.
-     * @param recordDefinition The record definition.
+     * @param options          The options for the collection.
      * @return The collection.
      */
     @Override
     public <Key, Record> VectorStoreRecordCollection<Key, Record> getCollection(
-        @Nonnull String collectionName, @Nonnull Class<Key> keyClass,
-        @Nonnull Class<Record> recordClass,
-        @Nullable VectorStoreRecordDefinition recordDefinition) {
-        if (keyClass != String.class) {
-            throw new IllegalArgumentException("Redis only supports string keys");
+        @Nonnull String collectionName,
+        @Nonnull VectorStoreRecordCollectionOptions<Key, Record> options) {
+        if (!options.getKeyClass().equals(String.class)) {
+            throw new SKException("JDBC only supports string keys");
+        }
+        if (options.getRecordClass() == null) {
+            throw new SKException("Record class is required");
         }
 
-        return (VectorStoreRecordCollection<Key, Record>) getCollection(
-            collectionName,
-            recordClass,
-            recordDefinition);
-    }
-
-    /**
-     * Gets a collection from the vector store.
-     *
-     * @param collectionName   The name of the collection.
-     * @param recordClass      The class type of the record.
-     * @param recordDefinition The record definition.
-     * @return The collection.
-     */
-    public <Record> JDBCVectorStoreRecordCollection<Record> getCollection(
-        @Nonnull String collectionName,
-        @Nonnull Class<Record> recordClass,
-        @Nullable VectorStoreRecordDefinition recordDefinition) {
         if (this.options != null && this.options.getVectorStoreRecordCollectionFactory() != null) {
-            return this.options.getVectorStoreRecordCollectionFactory()
+            return (VectorStoreRecordCollection<Key, Record>) this.options
+                .getVectorStoreRecordCollectionFactory()
                 .createVectorStoreRecordCollection(
                     dataSource,
                     collectionName,
-                    recordClass,
-                    recordDefinition);
+                    options.getRecordClass(),
+                    options.getRecordDefinition());
         }
 
-        return new JDBCVectorStoreRecordCollection<>(
+        JDBCVectorStoreRecordCollectionOptions<Record> jdbcOptions = (JDBCVectorStoreRecordCollectionOptions<Record>) options;
+        return (VectorStoreRecordCollection<Key, Record>) new JDBCVectorStoreRecordCollection<>(
             dataSource,
             collectionName,
             JDBCVectorStoreRecordCollectionOptions.<Record>builder()
-                .withRecordClass(recordClass)
-                .withRecordDefinition(recordDefinition)
-                .withQueryProvider(this.queryProvider)
+                .withCollectionsTableName(jdbcOptions.getCollectionsTableName())
+                .withPrefixForCollectionTables(jdbcOptions.getPrefixForCollectionTables())
+                .withQueryProvider(jdbcOptions.getQueryProvider() == null ? queryProvider
+                    : jdbcOptions.getQueryProvider())
+                .withRecordClass(jdbcOptions.getRecordClass())
+                .withRecordDefinition(jdbcOptions.getRecordDefinition())
+                .withVectorStoreRecordMapper(jdbcOptions.getVectorStoreRecordMapper())
                 .build());
     }
 

semantickernel-experimental/src/main/java/com/microsoft/semantickernel/connectors/data/jdbc/JDBCVectorStoreRecordCollectionOptions.java

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 package com.microsoft.semantickernel.connectors.data.jdbc;
 
+import com.microsoft.semantickernel.data.VectorStoreRecordCollectionOptions;
 import com.microsoft.semantickernel.data.VectorStoreRecordMapper;
 import com.microsoft.semantickernel.data.recorddefinition.VectorStoreRecordDefinition;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
@@ -11,7 +12,8 @@
 import static com.microsoft.semantickernel.connectors.data.jdbc.JDBCVectorStoreQueryProvider.DEFAULT_COLLECTIONS_TABLE;
 import static com.microsoft.semantickernel.connectors.data.jdbc.JDBCVectorStoreQueryProvider.DEFAULT_PREFIX_FOR_COLLECTION_TABLES;
 
-public class JDBCVectorStoreRecordCollectionOptions<Record> {
+public class JDBCVectorStoreRecordCollectionOptions<Record>
+    implements VectorStoreRecordCollectionOptions<String, Record> {
     private final Class<Record> recordClass;
     private final VectorStoreRecordMapper<Record, ResultSet> vectorStoreRecordMapper;
     private final VectorStoreRecordDefinition recordDefinition;
@@ -43,6 +45,16 @@ public static <Record> Builder<Record> builder() {
         return new Builder<>();
     }
 
+    /**
+     * Gets the key class.
+     *
+     * @return the key class
+     */
+    @Override
+    public Class<String> getKeyClass() {
+        return String.class;
+    }
+
     /**
      * Gets the record class.
      * @return the record class